Starting with CNXML CNXML is a lightweight XML markup language for marking up educational content. The goal of CNXML is to convey the content of the material and not a particular presentation. The Connexions Project uses the Connexions Markup Language (CNXML) as its primary language for storing documents. Now let's get started!

CNXML Tags

Document All CNXML documents have as their root the document tag. Everything about the document including it's metadata and content are contained within the document tag. It is important that you understand the basic structure for a CNXML document. The structure is as follows: Document (root tag) Name (required) Metadata Section (optional) Content Section (required) There is some additional information that is required for the document to validate. This is explained under the section titled Other Required Stuff. The document tag has one required attribute: id - a unique ID given to the document (usually assigned to you by the Connexions project)

ID Requirements One major difference between CNXML and other markup languages is the id attribute requirement. Certain tags require that you include the id attribute. These tags are listed below: document para equation rule definition exercise list So, if you are going to use any of the above tags, be sure to add the id attribute and give it a unique 'id'. An example of this is shown below.


	      
  This is an example to illustrate the use of the id attribute.


  This paragraph has a different id than the last.

	     ]]>

Any tag can contain an id attribute. This is useful if you want to link to the information contained in a particular tag.

Namespaces The document tag should also contain any namespace declarations. Namespaces allow us to easily use other mark-up languages within CNXML without having to worry about whether tag name collision will occur. For simple documents using only CNXML, you need to include the CNXML namespace attribute xmlns='http://cnx.rice.edu/cnxml'. Any additional languages need to be declared as well and should be given their own prefixes. For example, to associate the MathML namespace with the prefix "m", include the following attribute: xmlns:m='http://www.w3.org/1998/Math/MathML'. This states that any tag with a prepended "m" will be interpreted as a MathML tag while any tag without a prefix will be interpreted as CNXML.

]]>

Name The name tag can be used with many CNXML tags to hold the name of its parent. This tag can only contain information in ASCII text. I mention it here to allow you to put in the name of the module (since I mentioned that it was the first required tag in the document tag). Grilling a Good Steak]]> Please see the CNXML 0.5 specification to see if a tag can be named.

Content Now that you have the document tag set up with an id and namespace info, the next thing to do with your document is add content. By 'content' I mean the text that will make up the bulk of your document. Strictly speaking the metadata should precede information about content, but we will leave this until later. All of this content is conveniently placed in the content tag. Every CNXML document will have one content tag. The body of the document will be here inside the content tag. Structural tags are the tags which are used inside of the content tag to give structure to the document. These tags are discussed below.

Structure Tags Some of the structure tags are section, para, document, and content. We have already discussed the document and content tags, so we will proceed with a short description and examples of the other other tags listed.

Para Text can be inserted into documents by using the para tag. Each para has a required id which must be unique within the document.



  I have eaten many steaks in my life and none have been more satisfying
  than the backyard-grill cooked steak.  Maybe this is because of the
  relaxing nature of drinking a beer, being outside, and lounging that
  accompanies the grilling procedure.  Maybe it is because of the aroma
  of the grill and the beef perfectly seasoned to your taste.  Either
  way, this document shows how a good steak can be prepared.
]]>

Section As often is the case in textbooks, chapters are divided into smaller sections. Because it is often necessary to segment text for better understanding and coherence, CNXML has included a section tag. The section tag has one required attribute, id, and a required first child tag, name.


		
  Ingredients
     ...



  Marinade
   ... 
     ... 
   ... 


  Grilling
   ... 
   ... 
]]>

Obviously ellipses would be replaced by appropriate text.

Inline Tags Inline tags are used to embed content and functionality inside of the structural tags. Some of the more commonly used tags are discussed below.

Emphasis The emphasis tag is used to emphasize text in a CNXML document where emphasis in text would be needed or desired. It is important to note that this refers to semantic emphasis and not a typeface, although many stylesheets may choose to render it visually with a different typeface.



  I have eaten many steaks in my life and none have been more satisfying
  than the backyard-grill cooked steak.  Maybe this is because of the
  relaxing nature of drinking a beer, being outside, and lounging that
  accompanies the grilling procedure.  Maybe it is because of the aroma
  of the grill and the beef perfectly seasoned to
  your taste.  Either way, this document shows how a good steak can be
  prepared.
]]>

Term The term tag is used to mark words or phrases which are being defined. However, its use is confined to either a para or definition tag. The term tag has one optional attribute: src - a URL specifying the source or definition of the term.



  To ensure the best flavor possible, it is necessary to marinate the
  beef.  A steak marinates when
  left to sit in a prepared sauce, or marinade, where it
  will absorb the flavors of the ingredients.  Marinating may take as
  little as 15 minutes or as long as 6 hours and should
  always be done in the refrigerator and
  not at room temperature.
]]>

Note The note tag creates an "out of line" note to the reader, which could be a warning, point of interest, etc. The type of note is specified by an optional type attribute.



  I have eaten many steaks in my life and none have been more
  satisfying than the backyard-grill cooked steak.  Maybe this is
  because of the relaxing nature of drinking a beer, being outside,
  and lounging that accompanies the grilling procedure.  Excessive drinking or fun may result in overcooked or
  burned steak. Maybe it is because of the aroma of the grill
  and the beef perfectly seasoned to your taste.
  Either way, this document shows how a good steak can be prepared.
]]>

The above markup will display as: I have eaten many steaks in my life and none have been more satisfying than the backyard-grill cooked steak. Maybe this is because of the relaxing nature of drinking a beer, being outside, and lounging that accompanies the grilling procedure. Excessive drinking or fun may result in overcooked or burned steak. Maybe it is because of the aroma of the grill and the beef perfectly seasoned to your taste. Either way, this document shows how a good steak can be prepared.

CNXN and Link The cnxn and link tags are the two tags in CNXML used for linking to other documents. The difference in the two tags are that cnxns are used for linking to other documents in the Connexions system while links are used for linking to general documents on the internet. The cnxn tag has four attributes target - targets a specific tag document - targets a specific document by its ID version - targets a specific version of a document strength - designates the degree to which the linked information is related to the current document The version attribute is optional. When not specified the cnxn will default the link to the most current version of the document. It may seem pointless, but it is actually quite useful. If you specify a specific version of a document, it will never change, meaning important parts, such as paragraphs or figures, will not disappear without warning. The target and document attributes can be used together or alone. If both are used then you will link to 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. The strength attribute is optional. It can give the reader an indication of how related the additional information is to the current discussion. CNXN Example The cnxn tag does not have to have a description of the destination in order to be used. For example, let's say you want to link to a figure inside the page but are unsure what to name the cnxn. You could you use a cnxn similar to the one below:

]]>

When you use a cnxn such as the example above, a substitution will be made since no text was inserted into the tag. So, the above example would render as:

depending on whether or not the system was able to find a suitable substitution. In most cases you can use text in the cnxn to describe the destination as in:


		  Steak Figure
		  ]]>

The link tag, on the other hand, has only a required src tag which contains a URL for the target webpage.


		
  I'll be adding to this document in The
  Intermediate CNXML which focuses on more advanced CNXML tags.
  For more marinades see the Angus
  Beef website.  Finally, a good resource is the Steak
  Lover's Cookbook -- William Rice; Paperback.

		]]>

The above markup will display as: I'll be adding to this document in The Intermediate CNXML which focuses on more advanced CNXML tags. For more marinades see the Angus Beef website. Finally, a good resource is the Steak Lover's Cookbook -- William Rice; Paperback.

Cite The cite tag is used to refer to non-electronic materials within a document, primarily containing the title of a work. See .

Quote The quote tag is used to denote that some text is a direct quote from some other source. The quote tag has a type attribute which denotes whether the quote is inline or block.


  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 to purchase a nice rare
  steak."

]]> 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 to purchase a nice rare steak."

Foreign The foreign tag is used to denote that a foreign word or phrase is being used.


  In many latin american countries steak is called carne
  asada.

]]> 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 about making a steak.


	  
      Grilling a Good Steak

          

        
          
	    I have eaten many steaks in my life and none have been more
	    satisfying than the backyard-grill cooked steak.  Maybe this is
	    because of the relaxing nature of drinking a beer, being
	    outside, and lounging that accompanies the grilling procedure.
            Excessive drinking or fun may result in
	    overcooked or burned steak. Maybe it is because of the
	    aroma of the grill and the beef perfectly
	    seasoned to your taste.  Either way, this document shows how a
	    good steak can be prepared.
          
        

        	      
          
	    To ensure the best flavor possible, it is necessary to marinate
	    the beef.  A steak marinates when left to sit in
            marinade, or prepared sauce, where it will absorb
	    the flavor of the ingredients.  Marinating may take as little as
	    15 minutes or as long as 6 hours and should
            always be done in the refrigerator and
            not at room temperature.
          
        

        	      
          
	    I'll be adding to this document in The Intermediate CNXML which focuses on more
	    advanced CNXML tags.  For more marinades see the Angus Beef website.
	    Finally, a good resource is the Steak Lover's Cookbook --
	    William Rice.
          
        

      
      
	]]>

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 practice to follow). The XML declaration looks like this: ]]> , and must not be preceeded by any blank lines or whitespace. After this we declare what Document Type Definition (DTD) we'll be using for this document. (Strictly speaking, this is optional too. However, we must include it if we want to validate our document as CNXML). For flexibility, Connexions has made several DTDs available to allow authors to combine other markup languages with CNXML within a document. The DTD you specify will depend on which languages you wish to use in your document. For simple documents using only CNXML, the declaration is:

]]>

For CNXML with MathML the declaration would be:

]]>

Conclusions Remember that when composing documents it is always best to consult the CNXML Spec 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.