Formatting in attribute class documentation

Question

Formatting in attribute class documentation

ahankinson opened this issue 7 years ago · 11 comments

In the attribute class documentation the individual class declarations are rendered as XML, rather than parsed out as HTML.

c.f. http://music-encoding.org/guidelines/dev/attribute-classes/att.classed.html

Is this intentional or is this something that needs to be tackled?

Answer 1 · 2018-06-09T01:29:31.000Z

This is intentional.

Answer 2 · 2018-06-09T12:11:14.000Z

It doesn't seem very friendly...

Answer 3 · 2018-06-19T09:07:24.000Z

Sorry, I do not understand this issue.

Answer 4 · 2018-06-19T09:10:17.000Z

The 'declaration' and 'constraint' sections of the attribute documentation are plain XML, and haven't been parsed out as more user-friendly markup.

Answer 5 · 2018-06-19T09:13:19.000Z

I see. I do not find it bad as it is with the constraint where we have both an explanatory sentence and the corresponding XML. I see it as a way for readers to learn more about how it works behind the scene.

Answer 6 · 2018-06-28T07:15:58.000Z

Just looking through this -- I still think there's a bug here. The "Attributes" section is always empty. I would expect to find the documentation for each of the attributes (at least the attribute name, but also a description if there is one) but it never seems to be there. The only way of finding out what attributes are in that class is to read the ODD declaration. Spot-checking a few:

http://music-encoding.org/guidelines/dev/attribute-classes/att.bibl.html
http://music-encoding.org/guidelines/dev/attribute-classes/att.cutout.html
http://music-encoding.org/guidelines/dev/attribute-classes/att.hairpin.vis.html

Also, these classes seem to be empty (probably others?)
http://music-encoding.org/guidelines/dev/attribute-classes/att.btrem.anl.html
http://music-encoding.org/guidelines/dev/attribute-classes/att.ambitus.vis.html

Answer 7 · 2018-06-28T08:41:17.000Z

Looks like we (in the sense of I) overlooked that. There should be the attributes listed, in a similar fashion as they are included in the elements' pages…

…

Am 28.06.2018 um 09:15 schrieb Andrew Hankinson ***@***.***>: Just looking through this -- I think there's a bug here, though. The "Attributes" section is always empty. I would expect to find the documentation for each of the attributes (at least the attribute name, but also a description if there is one) but it never seems to be there. The only way of finding out what attributes are in that class is to read the ODD declaration. Spot-checking a few: http://music-encoding.org/guidelines/dev/attribute-classes/att.bibl.html http://music-encoding.org/guidelines/dev/attribute-classes/att.cutout.html http://music-encoding.org/guidelines/dev/attribute-classes/att.hairpin.vis.html Also, these classes seem to be empty (probably others?) http://music-encoding.org/guidelines/dev/attribute-classes/att.btrem.anl.html http://music-encoding.org/guidelines/dev/attribute-classes/att.ambitus.vis.html — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

Answer 8 · 2018-06-29T06:12:37.000Z

OK; Can you take care of fixing that?

Answer 9 · 2018-06-29T07:38:47.000Z

will do

…

Am 29.06.2018 um 08:12 schrieb Andrew Hankinson ***@***.***>: OK; Can you take care of fixing that? — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub, or mute the thread.

Answer 10 · 2018-07-07T21:21:27.000Z

should be fixed for v3, will do dev in two weeks from now

Answer 11 · 2018-11-03T12:46:37.000Z

@ahankinson @kepper What's with this issue?