Sind die Tags eindeutig, wie <tabelle></tabelle> oder <box></box> ist es nicht notwendig eine zusätzliche erklärende Anmerkung anzugeben. Bei nicht eindeutigen oder aus Abkürzungen bestehenden Tags, sollte hingegen eine erklärende Anmerkung verfasst werden. Je nachdem wie häufig dieser Tag in der Umsetzung verwendet wird, ist es sinnvoll die Anmerkung an den Anfang des Dokuments zu setzen. Auf eine erklärende Anmerkung kann bei häufig auftretenden Tags in Absprache mit der betroffenen Person, verzichtet werden.
Beispiel „erklärende Anmerkungen zu Tags“:
Original | Umsetzung |
---|---|
Wird in einem Tag die Hervorhebung beispielsweise einer Farbe ausgeschrieben, ist keine Anmerkung notwendig. Ist der Tag nicht verständlich, muss eine Anmerkung verwendet werden. | <anmerkung> Für gelbe Wörter wird <g></g> verwendet. </anmerkung>
Wird in einem Tag die Hervorhebung beispielsweise einer Farbe ausgeschrieben, ist <rot> keine Anmerkung </rot> notwendig. Ist der Tag nicht verständlich, <g> muss eine Anmerkung </g> verwendet werden. |