Skip to content

Add Timbl 7.0 API reference guide#18

Closed
antalvdb wants to merge 1 commit into
masterfrom
docs-7.0-api-guide
Closed

Add Timbl 7.0 API reference guide#18
antalvdb wants to merge 1 commit into
masterfrom
docs-7.0-api-guide

Conversation

@antalvdb

@antalvdb antalvdb commented Jul 3, 2026

Copy link
Copy Markdown
Member

Updates the API reference guide from the last released version (Timbl_6.3_API.tex, ILK Technical Report 10-03) to 7.0. Complements the 7.0 reference guide from #17.

Changes

  • New docs/texfiles/Timbl_7.0_API.tex + compiled docs/Timbl_7.0_API.pdf (the 6.3 source is kept)
  • Replace dead ilk.uvt.nl URLs with GitHub / languagemachines.github.io equivalents; link against libtimbl via pkg-config instead of libTimbl.a
  • Add a 6.3 → 7.0 changes section documenting the 6.8 API/ABI break: Unicode throughout (icu::UnicodeString overloads, Increment_u/Decrement_u), ValueDistributionClassDistribution (with backward-compatible aliases), the new Vfield-based dist_iterator interface, removal of StartServer(), C++17 requirement
  • Document the new API calls: Prune() (--prune), SetThreads() (--clones), confidence() (+vcf), NS_Test(), WriteInstanceBaseLevels(), GetCurrentWeights(), and the CL_Options constructor; SD added to the Weighting enum
  • Point the server chapter to the TimblServer package
  • Refresh all six annotated example programs to the current demos/api_test*.cxx sources, with outputs regenerated by running them against Timbl 7.0 (long repetitive blocks abbreviated)

The manual compiles cleanly with pdflatex; no build artifacts are committed.

🤖 Generated with Claude Code

Update the API reference guide from the last released version
(Timbl_6.3_API, ILK Technical Report 10-03) to 7.0:

- Replace dead ilk.uvt.nl URLs with GitHub /
  languagemachines.github.io equivalents; link against libtimbl via
  pkg-config instead of libTimbl.a
- Add a 6.3 -> 7.0 changes section documenting the 6.8 API/ABI break:
  Unicode throughout (icu::UnicodeString overloads, Increment_u /
  Decrement_u), ValueDistribution renamed to ClassDistribution (with
  backward-compatible aliases), the new Vfield-based dist_iterator
  interface, removal of StartServer(), C++17 requirement
- Document the new API calls: Prune() (--prune), SetThreads()
  (--clones), confidence() (+vcf), NS_Test(),
  WriteInstanceBaseLevels(), GetCurrentWeights(), and the
  CL_Options-based constructor; add SD to the Weighting enum
- Point the server chapter to the TimblServer package
- Refresh all six annotated example programs to the current
  demos/api_test*.cxx sources and regenerate their outputs with
  Timbl 7.0 (long repetitive blocks abbreviated)
- Ship the compiled docs/Timbl_7.0_API.pdf

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@kosloot

kosloot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

merged into develop

@kosloot kosloot closed this Jul 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants