TEIC / TEI

The Text Encoding Initiative Guidelines
https://www.tei-c.org
Other
280 stars 88 forks source link

Ruby: Need for additional guidelines or revisions for extensive annotations to text #2601

Open siddhacarya opened 1 month ago

siddhacarya commented 1 month ago

Looking at the examples for implementation of Ruby:

https://tei-c.org/release/doc/tei-p5-doc/en/html/CO.html#COHTGRB

they all seem for short annotations (such as furigana) applied to a few characters or words.

There are use cases where there are extensive annotations to long text passages with nested annotations and different classes of annotations. It is unclear from the documentation if and how the current Ruby scheme could be applied to these.

Some examples are given here:

https://drive.google.com/file/d/1iza3r_2fGIRQN2a0h_7sJp6eOEsTp0lF/view?usp=sharing

ebeshero commented 1 month ago

@siddhacarya Council subgroup at the Buenos Aires F2F found your examples very interesting. We recognize that our examples in the Guidelines show short annotations but we think that the structure of <ruby> encoding should work with the complex, multiple annotations you are sharing, because <ruby> elements are allowed to nest inside the contents of <rb> or <rt>.

We realize that we don't show examples of this in the Guidelines (yet), but encourage you to experiment with nesting the ruby element structures to see if they help with modeling the annotated commentaries in these manuscripts and woodblock prints!

ebeshero commented 1 month ago

...and perhaps one of these might become a new example for the Guidelines if the nested ruby structure might work!

ebeshero commented 1 month ago

@martindholmes @knagasaki Would you like to take a look at the examples and question in this ticket? Do you agree with our recommendation or have other suggestions?

martindholmes commented 1 month ago

I think I would encode longer annotations like this with note elements, but I don't see any reason why ruby wouldn't work.