<< Chapter < Page Chapter >> Page >

The link tag is used to provide a quick link to other Connexions modules, collections or external websites. The link tag can contain the following attributes.

  • strength - The Strength attribute can contain the values 1, 2, or 3 (with 3 being the strongest) specifying the relevance of the link.
  • url - a URL specifying the source or definition of theterm.
  • window - contains the possible values "replace" which results in the associated url opening in the present window, and "new" which result in the associated url opening in a new window or tab.
  • document - the id of another Connexions module or collection.
  • target-id - the id of a specific element (such as a para or section) in the current or another Connexions document.
  • resource - This reference points to a file that is associated with the term in question. The resource could be a pdf, text file, or any other supplementary resource.
  • version - The version of a Connexions module or collection. This attribute is used in conjunction with the document attribute.
  • id - A unique identifier, whose value must begin, with a letter and contain only letters, numbers, hyphens, underscores, colons, and/or periods (no spaces).

The target and document attributes can be used together or alone. If both are used then you will linkto a particular tag in another document. If only document is used, you will link to another document. If only target is used, you will link to a particular tag within the current document.

Cite

The cite tag is used to refer to non-electronic materials within a document, primarilycontaining the title of a work. Cite has several optional attributes:

  • url - a URL specifying the source or definition of theterm.
  • window - contains the possible values "replace" which results in the associated url opening in the present window, and "new" which result in the associated url opening in a new window or tab.
  • document - the id of another Connexions module or collection.
  • target-id - the id of a specific element (such as a para or section) in the current or another Connexions document.
  • resource - This reference points to a file that is associated with the term in question. The resource could be a pdf, text file, or any other supplementary resource.
  • version - The version of a Connexions module or collection. This attribute is used in conjunction with the document attribute.
  • id - A unique identifier, whose value must begin, with a letter and contain only letters, numbers, hyphens, underscores, colons, and/or periods (no spaces).

Quote

The quote tag is used to denote that some text is a direct quote from some othersource. The quote tag has a display attribute which denotes whether the quote is inline or block . Quote can also contain all of the attributes associated with cite .

<para id='steakquote'>Everyone has an opinion on how a steak should be cooked.<quote display='inline'>"A good steak should be pink in the middle and black on the outside."</quote>Although this may sound reasonable many remember the words of George Washington:<quote type='block'>"In any free country a man should have the ability to purchase a nice raresteak."</quote></para> Everyone has an opinion on how a steak should be cooked.

"A good steak should be pink in the middle and black on the outside."
Although this may sound reasonable many remember the words of George Washington:
"In any free country a man should have the ability topurchase a nice rare steak."

Foreign

The foreign tag is used to denote that a foreign word or phrase is being used. Foreign can also contain all of the attributes associated with cite .

<para id='steakquote2'>In many latin american countries steak is called<foreign>carne asada</foreign>.</para> In many latin american countries steak is called carne asada .

Document example code

Below is an example of what your document could look like if you included all the tags above to make a document aboutmaking a steak.

<document id='meat'><title>Grilling a Good Steak</title><content><section id='intro'><para id='intro'>I have eaten many steaks in my life and none have been more satisfying than the backyard-grill cooked steak. Maybe this isbecause of the relaxing nature of drinking a beer, being outside, and lounging that accompanies the grilling procedure.<note type='warning'>Excessive drinking or fun may result in overcooked or burned steak.</note>Maybe it is because of the aroma of the grill and the beef<emphasis>perfectly</emphasis>seasoned to your taste. Either way, this document shows how a good steak can be prepared.</para></section><section id='marinate_section'><para id='marinate'>To ensure the best flavor possible, it is necessary to marinate the beef. A steak<term>marinates</term>when left to sit in<term>marinade</term>, or prepared sauce, where it will absorb the flavor of the ingredients. Marinating may take as little as15 minutes or as long as 6 hours and should<emphasis>always</emphasis>be done in the refrigerator and<emphasis>not</emphasis>at room temperature.</para></section><section id='tobecontinued_section'><para id='tobecontinued'>I'll be adding to this document in<link document='m9006'>The Intermediate CNXML</link>which focuses on more advanced CNXML tags. For more marinades see the<link url='http://www.2eatcab.com'>Angus Beef website</link>. Finally, a good resource is the<cite>Steak Lover's Cookbook -- William Rice</cite>.</para></section></content></document>

See how Connexions would render this example .

Other required stuff

The first line in any XML file should be the XML declaration. (Strictly speaking, this is optional, but it's a good practiceto follow). The XML declaration looks like this: <?xml version="1.0" encoding="utf-8"?> , and must not be preceeded by any blank lines or whitespace. CNXML 0.6 only uses one schema, so there is no need to specificy specific DTDs. Below is an example of a correct CNXML 0.6 document tag containing the proper namespaces.

<document xmlns="http://cnx.rice.edu/cnxml" xmlns:m="http://www.w3.org/1998/Math/MathML"xmlns:md="http://cnx.rice.edu/mdml/0.4" xmlns:bib="http://bibtexml.sf.net/"xmlns:q="http://cnx.rice.edu/qml/1.0" id="m9000" module-id="" cnxml-version="0.6">

Conclusions

Remember that when composing documents it is always best to consult the CNXML Tag List for any questions regarding the exact usage of CNXML tags. For more advanced topics see The Intermediate CNXML or The Advanced CNXML , which concludes the cooking lesson.

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