USFM 3 documentation

Question

Documentation for USFM 3 is available online (https://ubsicap.github.io/usfm/). However, the search functionality is limited; for example, typing a marker like “\tl” in the search box on the start page doesnꞌt give any results.
Is this documentation also available as a (searchabla) PDF?

Paulus+Kieviet

Answer 1

Paulus+Kieviet:

Documentation for USFM 3 is available online (https://ubsicap.github.io/usfm/). However, the search functionality is limited; for example, typing a marker like “\tl” in the search box on the start page doesnꞌt give any results.

One workaround to this is to use the Index found at the bottom of the home page. If you open the Index you can use Ctrl+F to search for a particular marker.

Comments

Hi there,

I also have the need to be able to search for markers. Right now, I need to know what /x and /xt are for. I don’t know what section they are under.

I am unable to do it at https://ubsicap.github.io/usfm and in the PDF. At this time I am unable to find the site index of the aforementioned page.

What’s a good way to search USFM documentation by marker?

Also, might this topic be more clearly named something like “How to search USFM documentation by marker?”?

Thanks so much.

(Update: I just found those markers in section 10- Cross References. But I am still interested to know how to search for future needs.)

---

Screenshot 2021-09-06 15.02.191218×720 80.6 KB

When you are in the documentation you can click on the title in the upper left. This will display the text on the right and at the bottom you should see the link to the index. Not very intuitive, but there it is.

Note that when you open the index you can search by using CTRL+F to search the current window.

---

Thanks so much anon848905! That’s a huge help.