Please find attached a description of the new EndNotes functionallity.
How do I add this to the LibLouis documentation and where should it go?
Thanks
Paul
--
Paul Wood, Chief Technical Officer
Torch Trust
Torch House, Torch Way,
Market Harborough, Leics. LE16 9HL, UK
Direct Line: +44(0)1858 438269
Tel: +44(0)1858 438260, Fax: +44(0)1858 438275
Email: [1]paulw@xxxxxxxxxxxxxx
Website: [2]www.torchtrust.org
____________________________________________________
Chief Executive: Dr Gordon Temple
Charity No. 1095904
Privileged/Confidential Information may be contained in this message.
If you are not the intended recipient please destroy this message
and kindly notify the sender by reply email. The computer from which
this mail originates is equipped with virus screening software.
However Torch Trust cannot guarantee that the mail and its attachments
are free from virus infection.
References
1. mailto:paulw@xxxxxxxxxxxxxx
2. http://www.torchtrust.org/
Liblouisutdml Endnotes
Introduction
This adds the use of endnotes to Liblouisutdml. A complete endnote is
defined as the link between a [1]reference character in the body of the
text and a [2]description at the end of the output document.
Use of Endnotes
The position of the reference character in the body of the text is
defined by the semantic action [3]noteref, which is then linked to a
[4]note (which can appear anywhere within the input file) with the same
id. The content of note will appear at the end of the output document,
along with its corresponding reference character and the page and line
numbers of where the reference character appears in the text.
A heading for the first endnote page can be set using the
[5]notesheader semantic action, and a small note can also be placed
after this heading, but before the endnotes, by using the
[6]notesdescription action.
The endnote page created will follow any formatting (page numbers,
headers, footers) from the last page in the document.
Output
The text some text <noteref id="1">1</noteref> some text in the input
file will produce some text 99#a some text in the output file (with
usual representation of numbers). The '99' in ascii is used as the
indicator for an endnote reference.
This will link up to the semantic action <note id="1">Endnote
Description</note>, which will produce a single endnote on the endnote
page that looks like this :#a p#g#b Endnote Description (with usual
representation of numbers and, in this example, the reference character
appearing on the 2nd line of the 7th page).
Configuration
endnotes
Usage : endnotes <yes/no>
Choose whether to use endnotes or not. Choosing 'no' will ignore
anything enclosed by all the semantic actions [7]shown below.
Styles
The semantic actions [8]note, [9]notesdescription, and [10]notesheader
have corresponding styles.
style note
Each endnote on the endnote page will use this style
style notesheader
The style used by the title on the endnote page
style notesdescription
The style used by the note just after the title on the endnote
page
The [11]noteref action will inherit its style.
Semantic Actions
note
1 Attribute
Usage :
.sem file : note elementSpecifier,id
input file : <elementSpecifier id="1">Endnote
Description</elementSpecifier>
Defines the endnote displayed at the bottom of the file. The id
attribute has to be unique, and be identical to the id attribute
in a noteref in the file in order to be displayed, but the note
action can appear before the corresponding noteref action if
needed.
noteref
1 Attribute
Usage :
.sem file : noteref elementSpecifier,id
input file : <elementSpecifier id="1">Endnote Reference
Character</elementSpecifier>
Defines the position where the endnote reference character
should be placed, as well as the endnote reference character in
the endnote at the bottom of the file. The order that these
appear in the input file determines the order that they appear
in the endnote section.
notesheader
No attributes
Usage :
.sem file : notesheader elementSpecifier
input file : <elementSpecifier>Endnote Page
Header</elementSpecifier>
The text enclosed defines the header to be placed at the top of
the first endnote page. For multiple of these defined in the
input, the last one is used.
notesdescription
No attributes
Usage :
.sem file : notesdescription elementSpecifier
input file : <elementSpecifier>Endnote Page
Text</elementSpecifier>
Defines some text to be placed after the [12]endnote page
header, but before the rest of the endnotes. Again, for multiple
definitions in the input file, the last one will be used.
References
1. file://localhost/tmp/Endnotes.html#semantic_noteref
2. file://localhost/tmp/Endnotes.html#semantic_note
3. file://localhost/tmp/Endnotes.html#semantic_noteref
4. file://localhost/tmp/Endnotes.html#semantic_note
5. file://localhost/tmp/Endnotes.html#semantic_notesheader
6. file://localhost/tmp/Endnotes.html#semantic_notesdescription
7. file://localhost/tmp/Endnotes.html#title_semantics
8. file://localhost/tmp/Endnotes.html#semantic_note
9. file://localhost/tmp/Endnotes.html#semantic_notesdescription
10. file://localhost/tmp/Endnotes.html#semantic_notesheader
11. file://localhost/tmp/Endnotes.html#semantic_noteref
12. file://localhost/tmp/Endnotes.html#semantic_notesheader
