<< Chapter < Page | Chapter >> Page > |
As an author/editor, you will often times need a way to
include additional information in a document that does notactually appear in the flow of text. This information may
include a glossary, and bibliographic references. There are manyways to include this type of information, but for our purposes,
we have chosen to create a new CNXML tag named
glossary
, and have chosen to use an xml language
called bibteXML for references. The two are described below. Ihave also included the glossary and bibteXML file examples in
the source of this document. Scroll to the bottom of the page tosee how these examples would be rendered.
"BibteXML is a bibliography DTD for XML that expresses the content model of BibTeX, the bibliographic system for usewith LaTeX. It provides conversion tools for tagging your bibliographic data in XML, or export it to HTML or nativeBibTeX syntax, saving typing time."In plain language, this means that bibtexml is an XML version of the popular and widely accepted latex extensionbibtex. One can markup references in their document using semantic tags such as
author
and
editor
. More info will be provided below.
Often in textbooks there will be a list of definitions
included at the end of the book. In the same way, the
glossary
tag will contain a list of definitions
that will be included at the end of a module. One can linkto these definitions using the
term
tag (see
[link] ).
It is very easy to include a glossary in your CNXML document. In the Basic CNXML Tutorial it is stated that the structure usually resembles the following:
name
metadata
(optional)content
name
metadata
(optional)content
glossary
Following is an example of the code necessary to add a
glossary with one definition.
<glossary><definition id='quardef'><term>quarter</term><meaning><name>Meaning Name</name>One fourth of something.</meaning><example id='def'><para id='par'>"He cut the pie into quarters and gave all four people a
piece."</para></example><meaning>25 cents, a quarter of a dollar.</meaning><example id='def2'><para id='par2'>"The drink cost a quarter."</para></example><example id='def3'><para id='par3'>"She picked up a roll of quarters so that she could do
laundry."</para></example></definition></glossary>
Often, one will need to refer to a definition in the
glossary. To do this, one can use the
term
tag. By putting the
target-id
attribute in the term
tag, one can link to a definition. Simply set the value ofthe
target-id
attribute to the
id
of the
definition in the glossary, and that term will automaticallybecome a link to the definition in the glossary. Shown below
is an example of the term tag being used to link to thedefinition in the
definition
example :
<term target-id='quardef'>quarter</term>
It is very easy to include a bibteXML reference section in your CNXMLdocument. In the Basic CNXML Tutorial it is stated that the structure usually resembles the following:
name
metadata
(optional)content
name
metadata
(optional)content
glossary
file
file
tag is the root tag of the bibteXML
language. Inside of the file tag one will add other tags thatcorrespond to the different type of bibliographical
references. An example of a bibliography is given below:
<bib:file><bib:entry id="esbensen"><bib:book><bib:author>Kim Esbensen; Tonje Midtgaard; Suzanne Schonkopf</bib:author><bib:title>Multivariate Analysis in Practice</bib:title><bib:publisher>Camo AS</bib:publisher><bib:year>1994</bib:year><bib:address>Trondheim</bib:address></bib:book></bib:entry><bib:entry id="martens.nes"><bib:book><bib:author>Harald Martens; Tormod Nas</bib:author><bib:title>Multivariate Calibration</bib:title><bib:publisher>John Wiley& Sons Ltd.</bib:publisher><bib:year>1989</bib:year><bib:address>Chichester</bib:address></bib:book></bib:entry></bib:file>
bib:
.You will want to refer to an entry in the bibliography. To
do this, one can use the
cite
tag. By putting
the
target-id
attribute in the cite tag, one can link
to a bibliographic entry. Simply set the value of the
target-id
attribute to the
id
of the
bib:entry
, and that reference will automatically
become a link to the bibliographic entry. Shown belowis an example of the cite tag being used to link to the
bibliography in
[link] :
<cite target-id='esbensen'>Multivariate Analysis in Practice</cite>
The
file
tag is the root tag of the bibteXML
language. It denotes the beginning of the bibliography.
file
tag must
contain one or more
entry
tags.
The
entry
tag denotes the beginning of an
individual bibliographical reference.
entry
must contain
one of the following containers:
Each of the possible children of
entry
(article, book, booklet, etc.) are containers for metadata
on that specific type of entry.
metadata tags
. For
more information on exactly which children a specificcontainer may possess, please see the
BibteXMLHomepage .
Every child listed as a possible child of
entry
can contain metadata
tags. These metadata tags are now listed.
Notification Switch
Would you like to follow the 'Cnxml tutorial' conversation and receive update notifications?