Specification: Braille Markup Extension Set Requirements

draft

2007-01-18

Version
0.1
Date
2007-01-18
Creator
Stefan Hofstetter

Reviewer
Joel Håkansson

Table of Content of all requirements

  1. Proper names
  2. Homographs
  3. Page size
  4. Output of tables
  5. Preformated braille
  6. Different Language and Braille versions
  7. Mapping for any input element
  8. E-Mail Adresses and links
  9. Distinct word identifier
  10. Italics
  11. Bold
  12. Cross-reference

Requirements (12)

Requirement 1 [contraction 2]:
Problem or idea
Proper names
Description of the problem or the idea
Some braille transcription rules prohibit some contractions in proper names to avoid confusion. Software does not know a priori if a word is a proper name.
Solution
Markup the word in the dtbook with a special value in the class attribute f. e. ( <w class="proper_name">)
Requirement 2 [contraction 2]:
Problem or idea
Homographs
Description of the problem or the idea
The same word may have different meaning and in rare case also different contractions.
Solution
Pre-Translate the rare variante during markup. A possible variant is using the showin attribute, f.e. <w showin="bxx"> and of course for the other output <w showin="xlp">
Requirement 3 [layout 3]:
Problem or idea
Page size
Description of the problem or the idea
How many rows and columns has the braille document or paper?
Solution
Part of the layout definer could be also in the meta data.
Requirement 4 [layout 3]:
Problem or idea
Output of tables
Description of the problem or the idea
Tables can have different layout depending on material and content. There has to be a way to select which layout to use on a specific table.
Solution
This is a layout problem. Maybe the layout definer or layout renderer needs some special information about the table, so we have to define new tags or attributes.
Requirement 5 [layout 3]:
Problem or idea
Preformated braille
Description of the problem or the idea
Actual braille might occur in a braille transcribing manual or similar training material.
Solution
Unicode...
Requirement 6 [meta 2]:
Problem or idea
Different Language and Braille versions
Description of the problem or the idea
Which language is the document, paragraph, word and so on.
Solution
xml:lang attribute in every element. The IETF RFC 4646 Specification shows the way of identifiying.
Requirement 7 [meta 2]:
Problem or idea
Mapping for any input element
Description of the problem or the idea
Some sort of map, for any input element in a given context, to an output format.
Solution
Part of the layout definer could be also in the meta data.
Requirement 8 [semantic 2]:
Problem or idea
E-Mail Adresses and links
Description of the problem or the idea
Tag literal computer items such as email addresses and actual links to web pages
Solution
Use the <a> tag for this kind of special semantic words. Maybe we need a special class value for emails or
Requirement 9 [semantic 2]:
Problem or idea
Distinct word identifier
Description of the problem or the idea
A word should have a distinct word identifier. This identifier allow a exact substitution with a braille or whatever representation.
Solution
An attribute in the word tag f. e. <w wid="345721">. The ID attribute has to be unique in the document, so we can't use that.
Requirement 10 [style 3]:
Problem or idea
Italics
Description of the problem or the idea
Italics have many meanings including at least emphasis, highlighting, symbol (like HTML var) and citation.
Solution
This is a layout problem. And not part of this extension.
Requirement 11 [style 3]:
Problem or idea
Bold
Description of the problem or the idea
Bold have many meanings including at least strong, highlighting and symbol (like HTML var).
Solution
This is a layout problem. And not part of this extension.
Requirement 12 [style 3]:
Problem or idea
Cross-reference
Description of the problem or the idea
Cross-reference to use and mention of styling. For example, an educational text might mention that words to be memorized are shown in "red".
Solution
This is a layout problem. And not part of this extension.