suttacentral/bilara-data

protocol for linking texts to matter

Opened this issue · 0 comments

rationale

The editions contain matter, which typically includes discussion of the texts. These can contain links to the relevant texts. However this is one-way: the texts do not contain links back to the matter. We should create a simple means for translators to add such links.

These links can be added to comment fields in Bilara.

The tricky part is that such a method should satisfy two requirements

  • linkable, i.e. we must be able to direct it to a stable URL on the web
  • human readable when printed.

method

In matter, paragraphs, etc. do not have numbers, so we cannot deep link to items within the essay. perhaps this should change, but for now I think we can avoid it.

What do have id attributes is the headings. These are required for creating the ToC. Since headings are also readable, we satisfy both our requirements.

Now we do not need to build any new software, just phrase the comment something like:

See discussion under {{heading}} in {{chapter}}.

For a specific example:

See discussion under <a href='https://suttacentral.net/edition/dn/en/sujato/general_introduction#general-item8'>Social Life</a> in the Introduction.

If a translator wishes, they can also create a special HTML file for /matter, call it /matter/studies.html. There they can collect studies on particular points, especially those that are too long for regular notes. Again, simply add an id to the headings and cite it in the comments. This can be added as an appendix in books.