ubsicap / usfm

Unified Standard Format Markers
39 stars 18 forks source link

Improve search to include *all* markers? #146

Closed davidg-sil closed 1 year ago

davidg-sil commented 1 year ago

The web-pages (search engine) currently seem to do a good job if you're looking for a topic. But if you're looking to see what the spec says for, e.g. \k, or what \ip is supposed to mean, you're down to guessing or reading all of the documentation. There are clearly index entries for some of the markers, but it's by no means all.

klassenjm commented 1 year ago

Hi David,

The search utility provided via the sphinx document builder and the RTD ('read the docs') theme has proved to be awkward and inflexible.

The problem with search is being solved in the updated documentation for USFM and USX (together) at https://docs.usfm.bible. Try entering a marker in the search box at the top of that site. This will become the reference docs a bit later this year.