search

daisy / ebraille

Repository for developing use cases and standard for digital braille
17 stars 5 forks source link

Do not use cryptic class names #145

Closed egli closed 8 months ago

egli commented 9 months ago

The common set of class names that is used to tag ebraille should include names that at least somewhat indicate their meaning.

In particular the class name tn is way to cryptic and should probably be replaced with something that relates what is used for, such as (why not) transcriber-note, or even brl-transcriber-note (see #144)

jrbowden commented 8 months ago

Related to this is of course that all reserved class names should be fully documented.

On the subject of names, note that HTML does use cryptic names, such as p, tr, hr, li, to name a few. However, I do agree that our names should be recognisable to those who need them. An added complication is that not all braille codes have all the concepts needed for eBraille.

wfree-aph commented 8 months ago

Thanks. I am going to make changes soon and will include this in the list as it is a minor change and makes a lot of sense. I will look out for similar issues. Part of my thinking about keeping class names short was just to help, in a very minor way, to keep the file size to a minimum. It ultimately won't make a great difference though and being clear is more important.