<< Chapter < Page Chapter >> Page >
A module describing the use of bibtexml with cnxml, as well as as introduction to the glossary tag.

Introduction

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

"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.

The 'glossary' tag

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] ).

Including a glossary

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:

    Document

  • name
  • metadata (optional)
  • content
When one wishes to add a glossary the structure will change to match the following:

    Document

  • name
  • metadata (optional)
  • content
  • glossary
Inside of the glossary tag one can add as many definitions as one wishes. For more information on the definition tag, seethe CNXML 0.5 specification .

Glossary example

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>

Linking to definitions in a 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>

Including bibtexml

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:

    Document

  • name
  • metadata (optional)
  • content
When one wishes to add a bibteXML reference section the structure will change to match the following:

    Document

  • name
  • metadata (optional)
  • content
  • glossary
  • file
It is possible to include either a glossary or a bibteXML file or both. The only restriction is that if you includeboth the glossary must precede the bibteXML file.
The 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:

Bibtexml example

<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&amp; Sons Ltd.</bib:publisher><bib:year>1989</bib:year><bib:address>Chichester</bib:address></bib:book></bib:entry></bib:file>

Each tag in the example code begins with a namespace prefix. In the case of bibteXML, the prefix is bib: .

Linking to bibliography

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>

Bibtexml tags

By looking at [link] one can see the types of tags that are available for use inbibteXML. Below I will attempt to give a brief explanation on the use of some of the bibteXML tags. For moreinformation and the complete specification please see BibteXML Homepage .

File

The file tag is the root tag of the bibteXML language. It denotes the beginning of the bibliography.

Children

The file tag must contain one or more entry tags.

Entry

The entry tag denotes the beginning of an individual bibliographical reference.

Children

The entry must contain one of the following containers:
  • article
  • book
  • booklet
  • manual
  • techreport
  • mastersthesis
  • phdthesis
  • inbook
  • incollection
  • proceedings
  • inproceedings
  • conference
  • unpublished
  • misc

Containers

Each of the possible children of entry (article, book, booklet, etc.) are containers for metadata on that specific type of entry.

Children

Every container tag must contain a different combination of bibteXML metadata tags . For more information on exactly which children a specificcontainer may possess, please see the BibteXMLHomepage .

Bibtexml metadata tags

Every child listed as a possible child of entry can contain metadata tags. These metadata tags are now listed.

    Metadata tag list

  • address
  • author
  • booktitle
  • chapter
  • edition
  • editor
  • howpublished
  • institution
  • journal
  • month
  • note
  • number
  • organization
  • pages
  • publisher
  • school
  • series
  • title
  • type
  • volume
  • year

Children

Every metadata tag can contain unicode text.

Questions & Answers

A golfer on a fairway is 70 m away from the green, which sits below the level of the fairway by 20 m. If the golfer hits the ball at an angle of 40° with an initial speed of 20 m/s, how close to the green does she come?
Aislinn Reply
cm
tijani
what is titration
John Reply
what is physics
Siyaka Reply
A mouse of mass 200 g falls 100 m down a vertical mine shaft and lands at the bottom with a speed of 8.0 m/s. During its fall, how much work is done on the mouse by air resistance
Jude Reply
Can you compute that for me. Ty
Jude
what is the dimension formula of energy?
David Reply
what is viscosity?
David
what is inorganic
emma Reply
what is chemistry
Youesf Reply
what is inorganic
emma
Chemistry is a branch of science that deals with the study of matter,it composition,it structure and the changes it undergoes
Adjei
please, I'm a physics student and I need help in physics
Adjanou
chemistry could also be understood like the sexual attraction/repulsion of the male and female elements. the reaction varies depending on the energy differences of each given gender. + masculine -female.
Pedro
A ball is thrown straight up.it passes a 2.0m high window 7.50 m off the ground on it path up and takes 1.30 s to go past the window.what was the ball initial velocity
Krampah Reply
2. A sled plus passenger with total mass 50 kg is pulled 20 m across the snow (0.20) at constant velocity by a force directed 25° above the horizontal. Calculate (a) the work of the applied force, (b) the work of friction, and (c) the total work.
Sahid Reply
you have been hired as an espert witness in a court case involving an automobile accident. the accident involved car A of mass 1500kg which crashed into stationary car B of mass 1100kg. the driver of car A applied his brakes 15 m before he skidded and crashed into car B. after the collision, car A s
Samuel Reply
can someone explain to me, an ignorant high school student, why the trend of the graph doesn't follow the fact that the higher frequency a sound wave is, the more power it is, hence, making me think the phons output would follow this general trend?
Joseph Reply
Nevermind i just realied that the graph is the phons output for a person with normal hearing and not just the phons output of the sound waves power, I should read the entire thing next time
Joseph
Follow up question, does anyone know where I can find a graph that accuretly depicts the actual relative "power" output of sound over its frequency instead of just humans hearing
Joseph
"Generation of electrical energy from sound energy | IEEE Conference Publication | IEEE Xplore" ***ieeexplore.ieee.org/document/7150687?reload=true
Ryan
what's motion
Maurice Reply
what are the types of wave
Maurice
answer
Magreth
progressive wave
Magreth
hello friend how are you
Muhammad Reply
fine, how about you?
Mohammed
hi
Mujahid
A string is 3.00 m long with a mass of 5.00 g. The string is held taut with a tension of 500.00 N applied to the string. A pulse is sent down the string. How long does it take the pulse to travel the 3.00 m of the string?
yasuo Reply
Who can show me the full solution in this problem?
Reofrir Reply
Got questions? Join the online conversation and get instant answers!
Jobilize.com Reply
Practice Key Terms 1

Get Jobilize Job Search Mobile App in your pocket Now!

Get it on Google Play Download on the App Store Now




Source:  OpenStax, Cnxml tutorial. OpenStax CNX. Jul 08, 2009 Download for free at http://cnx.org/content/col10121/1.10
Google Play and the Google Play logo are trademarks of Google Inc.

Notification Switch

Would you like to follow the 'Cnxml tutorial' conversation and receive update notifications?

Ask