Document Elements
CNXML Elements
CNXML documents (commonly called modules) are comprised of a series of tags or elements. Since a large number of educational materials require extensive use of mathematics, we have included a special section on using CNXML with MathML, the W3C's recommendation for storing mathematics in XML. This can be found in Appendix A.
Each element may have several attributes, some of which are required and some are optional. In the following sections, each element is listed with its accompanying attributes. The attributes can be one of several types (see the XML specification for details on what these mean) :
- ID - an identifier. Must be unique within the document
- IDREF - refers to an ID attribute
- CDATA - ASCII text
Structural Tags
The module, section, and para tags give the document it's structure by separating it into logical divisions.
Module
Description
The module tag is the root document element of CNXML documents, commonly called "modules."
Attributes
- id - A unique module identifier
- Required
- ID
- levelmask - Currently unused, set to 0
- Required
- CDATA
- created - The date on which the module was created
- Required
- Should take the form YYYY-MM-DD.
- revised - The date on which the module was last edited
- Required
- Should take the form YYYY-MM-DD.
- version - The current version of the module
- Required
- CDATA
Children
- The first child of the module tag must always be a name tag containing the name of the module.
- The second child of the module tag must always be an authorlist tag.
- The third child of the module tag must always be a maintainerlist tag.
- The keywordlist tag may appear next, if it appears at all.
- The abstract tag must appear next.
- An objectives tag may appear after that.
- Following that must be one or more of the following tags: section, para, codeblock, definition, equation, list, figure, table, rule, example, and exercise.
Examples
<module
id="spec"
levelmask="0"
created="2000-11-20"
revised="2001-04-18"
version="2.0">
<name>CNXML 0.3 Language Specification</name>
.
.
.
</module>
Section
Description
The section tag is used to divide a module into sections, as its name suggests.
Attributes
- id - unique id
- Required
- ID
Children
The section tag must contain a name, followed by one or more of: section, definition, rule, para, equation, list, codeblock, figure, table, example, or exercise.
Examples
<para id="para1">
There are three ideal circuit elements. They are the
resistor, the capacitor, and the inductor.
</para>
<section id="res">
<name>Resistor</name>
<para id="para2">
.
.
.
</para>
</section>
<section id="cap">
<name>Capacitor</name>
<para id="para3">
.
.
.
</para>
</section>
<section id="ind">
<name>Inductor</name>
<para id="para4">
.
.
.
<para>
</section>
Para
Description
The para element contains a paragraph of possibly marked-up text.
Attributes
-
id - unique id
- Required
- ID
Children
A para tag may contain a mixture of plain text, and the following tags: emphasis, list, cnxn, link, equation, cite, codeline, definition, term, note, and rule. It may also contain MathML tags.
Examples
Two paragraphs from War and Peace.
<para id="para1">
Prince Andrei was on duty that day and in constant attendance on the
Commander in Chief.
</para>
<para id="para2">
At six o'clock in the evening Kutuzov went to the Emperor's
headquarters, and after remaining but a short time with him, went to
the Grand Marshal of the Court, Count Tolstoy.
</para>
Metadata Tags
These are tags that contain information about the module, and not necessarily module content.
Name
Description
The name tag provides a searchable name for a particular object such as a module, section or a figure.
Attributes
None
Children
ASCII text representing an object's name
Examples
<section id="intro">
<name>An Introduction to CNXML</name>
.
.
.
</section>
Authorlist
Description
The authorlist tag must appear immediately after the name tag in a module, and contains an author tag for each author who contributed in writing the module.
Attributes
None
Children
The authorlist tag must contain one or more author tags.
Examples
<authorlist>
<author id="coppin">
<firstname>Sarah</firstname>
<surname>Coppin</surname>
</author>
<author id="bmh">
<firstname>Brent</firstname>
<surname>Hendricks</surname>
</author>
<author id="drewlin">
<firstname>Andrew</firstname>
<surname>Lin</surname>
</author>
<author id="ricky">
<firstname>Ricky</firstname>
<surname>Radaelli-Sanchez</surname>
</author>
</authorlist>
Author
Description
The author tag gives information about a particular author of the document.
Attributes
- id - The author's unique identifier within the CNX system
- Required
- ID
- homepage - Author's web address
- Optional
- CDATA
Children
At the very least, author must contain a firstname tag followed by a surname tag. The optional honorific tag may precede the first name, and similarly, the optional lineage tag may follow the surname. Any number of othername tags may appear between first name and surname. Authors may also enter an email address by including the email tag as the last child of author.
Examples
<author id="ricky">
<firstname>Ricky</firstname>
<surname>Radaelli-Sanchez</surname>
</author>
<author id="obiwan">
<honorific>Sir</honorific>
<firstname>Alec</firstname>
<surname>Guinness</surname>
</author>
<author id="wlw" homepage="http://www.ece.rice.edu/~wlw">
<honorific>Dr.</honorific>
<firstname>William</firstname>
<othername>Lewis</othername>
<surname>Wilson</surname>
<lineage>Jr.</lineage>
<email>wlw@rice.edu</email>
</author>
Maintainerlist
Description
The maintainerlist tag must appear immediately after the authorlist tag in a module, and contains a maintainer tag for each person who keeps that module up to date.
Attributes
None
Children
The maintainerlist tag must contain one or more maintainer tags.
Examples
<maintainerlist>
<maintainer id="coppin">
<firstname>Sarah</firstname>
<surname>Coppin</surname>
</maintainer>
<maintainer id="bmh">
<firstname>Brent</firstname>
<surname>Hendricks</surname>
</maintainer>
<maintainer id="drewlin">
<firstname>Andrew</firstname>
<surname>Lin</surname>
</maintainer>
<maintainer id="ricky">
<firstname>Ricky</firstname>
<surname>Radaelli-Sanchez</surname>
</maintainer>
</maintainerlist>
Maintainer
Description
The maintainer tag gives information about a particular person who is in charge of keeping the document up to date.
Attributes
- id - The maintainer's unique identifier within the CNX system
- Required
- ID
- homepage - Maintainer's web address
- Optional
- CDATA
Children
Maintainer works the same as author. At the very least, maintainer must contain a firstname tag followed by a surname tag. The optional honorific tag may precede the first name, and similarly, the optional lineage tag may follow the surname. Any number of othername tags may appear between first name and surname. Maintainers may also enter an email address by including the email tag as the last child of maintainer.
Examples
<maintainer id="ricky">
<firstname>Ricky</firstname>
<surname>Radaelli-Sanchez</surname>
</maintainer>
<maintainer id="obiwan">
<honorific>Sir</honorific>
<firstname>Alec</firstname>
<surname>Guinness</surname>
</maintainer>
<maintainer id="wlw" homepage="http://www.ece.rice.edu/~wlw">
<honorific>Dr.</honorific>
<firstname>William</firstname>
<othername>Lewis</othername>
<surname>Wilson</surname>
<lineage>Jr.</lineage>
<email>wlw@rice.edu</email>
</maintainer>
Honorific
Description
The honorific tag is used to hold titles such as Dr. or Sir in the context of an author or maintainer tag. It is used in conjunction with firstname, othername, surname, and lineage to form a complete name.
Attributes
None
Children
ASCII text representing the author or maintainer's title.
Examples
<author id="wlw">
<honorific>Dr.</honorific>
<firstname>William</firstname>
<othername>Lewis</othername>
<surname>Wilson</surname>
<lineage>Jr.</lineage>
</author>
Firstname
Description
The firstname tag holds the firstname of the document's author or maintainer in the context of an author or maintainer tag. It is used in conjunction with honorific, othername, surname, and lineage to form a complete name.
Attributes
None
Children
ASCII text representing the author or maintainer's first name.
Examples
<author id="bmh">
<firstname>Brent</firstname>
<surname>Hendricks</surname>
</author>
Othername
Description
The othername can be used to contain middle names, nicknames, or other names that the document author or maintainer may wish to include in the context of an author or maintainer tag. It is used in conjunction with honorific, firstname, surname, and lineage to form a complete name.
Attributes
None
Children
ASCII text representing author or maintainer's "other names" like middle names or nicknames.
Examples
<author id="bmh">
<firstname>Brent</firstname>
<othername>Michael</othername>
<surname>Hendricks</surname>
</author>
<author id="rgb">
<firstname>Rich</firstname>
<othername>"The Man"</othername>
<surname>Baraniuk</surname>
</author>
Surname
Description
The surname tag holds the surname or last name of the document's author or maintainer in the context of an author or maintainer tag. It is used in conjunction with honorific, firstname, othername, and lineage to form a complete name.
Attributes
None
Children
ASCII text representing the author or maintainer's last name.
Examples
<author id="bmh">
<firstname>Brent</firstname>
<surname>Hendricks</surname>
</author>
Lineage
Description
The lineage tag can be used to hold genealogical parts of the author or maintainer's name, such as Jr. or III. It is used in the context of an author or maintainer tag in conjunction with honorific, firstname, othername, and surname to form a complete name.
Attributes
None
Children
ASCII text representing the "lineage" portion of an author or maintainer's name such as Jr. or III.
Examples
<author id="wlw">
<honorific>Dr.</honorific>
<firstname>William</firstname>
<othername>Lewis</othername>
<surname>Wilson</surname>
<lineage>Jr.</lineage>
</author>
Description
The email tag can be used to hold the author or maintainer's email address.
Attributes
None
Children
ASCII text representing the email address.
Examples
<author id="bmh">
<firstname>Brent</firstname>
<surname>Hendricks</surname>
<email>bmh@example.com</email>
</author>
Keywordlist
Description
The keywordlist tag may optionally appears as the fourth child tag of module (after maintainerlist), and contains a list of the keywords or phrases relevant to the module's topic.
Attributes
None
Children
The keywordlist tag must contain one or more keyword tags.
Examples
<keywordlist>
<keyword>Sample module</keyword>
<keyword>Test</keyword>
</keywordlist>
Keyword
Description
The keyword tag holds a single word or phrase relevant to the module in which it appears.
Attributes
None
Children
ASCII text representing the key word or phrase
Examples
<keyword>Fourier Series</keyword>
Abstract
Description
The abstract tag holds a brief summary or abstract of the document's contents.
Attributes
None
Children
The abstract tag may contain a combination of plain text, codeline, and emphasis tags. It may also contain MathML tags.
Examples
<abstract>
This module contains the specification for version 0.3 of
the Connexions Markup Language (CNXML). It is used for
marking up educational content for the Connexions project
and contains many improvements over 0.2 including a new
rule tag.
</abstract>
Lists, Tables, and Figures
These are the tags specific to adding lists, tables, and figures to the document.
List
Description
The list tag is used to create ordered or unordered lists of items.
Attributes
-
id - unique id
- Required
- ID
-
type - makes the list ordered or unordered
- Optional
- Possible values
- enumerated - numbers the list with the first item after the tag being the first element
- bulleted - creates a bulleted list of items
- Default is bulleted
Children
The list tag must contain one or more item tags.
Examples
The code below is an example of the list tag with the type attribute set to "enumerated".
<list id="grocerylist" type="enumerated">
<item>Milk</item>
<item>Eggs</item>
<item>Sugar</item>
</list>
It might be displayed as shown here.
- Milk
- Eggs
- Sugar
Item
Description
The item tag is used to specify an item of a list. It appears only as the child of list tags.
Attributes
- id - unique id
- Optional
- ID
Children
The item tag may contain a combination of plain text, and the following tags: emphasis, link, cnxn, list, codeline, definition, term, rule, note, and cite. It may also contain MathML tags.
Examples
<list type="enumerated">
<item><link src="http://www.rice.edu">Rice University</link></item>
<item><link src="http://www.columbia.edu">Columbia University</link></item>
<item><link src="http://www.stanford.edu">Stanford University</link></item>
</list>
Table
Description
The table tag is used to create tables. It is designed to be a generalized table. That is, there are not rows and columns. Instead, there are two separate sets of groupings. One set of groups is defined by the group tag, which contains elem tags or elements. The other set is defined by category tags. Both an elem and its category have a desc attribute with the same value that links them together.
Please note that the table tag will most likely be substantially altered in future releases of CNXML.
Attributes
-
id - unique id
- Required
- ID
-
orient - Determines which way the table is laid out.
- Required
- Possible values
- horizontal - elements with the same group are on top of each other (that is, group defines a column)
- vertical - elements with the same category are on top of each other (that is, category defines a column)
Children
The table tag contains one categories tag followed by one or more group tags.
Examples
The following table has groups of items that are defined by being a fruit or vegetable and by their color. For example, the first element is a red fruit.
<table id='table' orient='vertical'>
<categories>
<category desc='fruit'>Fruit</category>
<category desc='vegetable'>Vegetables</category>
</categories>
<group>
<elem desc='fruit'>Apple</elem>
<elem desc='vegetable'>Tomato</elem>
</group>
<group>
<elem desc='fruit'>Orange</elem>
<elem desc='vegetable'>Carrot</elem>
</group>
<group>
<elem desc='fruit'>Grape</elem>
<elem desc='vegetable'>Lettuce</elem>
</group>
</table>
and it might be rendered as shown in the figure below.
Table Example
| Fruit | Vegetables |
| Apple | Tomato |
| Orange | Carrot |
| Grape | Lettuce |
Figure 1 The first element is an apple which is a red fruit. One grouping is defined by the category tag's desc attribute. The other grouping is defined by the group tag.
Categories
Description
The categories tag groups all of the category tags together.
Attributes
None
Children
The categories tag must contain one or more category tags. The order of the category tags within the categories tag defines what order they will be displayed in.
Examples
See the table example.
Category
Description
Each category tag serves to group one set of things. The desc attribute, short for description, links the category to the element. The content of the category will be used as the header for the column or row defined by the category.
Attributes
-
desc - The value of the attribute will be used repeatedly to
link the category to specific elements (see elem) so it should be
short.
- Required
- ID
Children
It must contain plain text.
Examples
See the table example.
Group
Description
The group tag pulls together several elements, denoted by elem. Those elements are contained within the group tag.
Attributes
None
Children
The group tag must contain one or more elem tags.
Examples
See the table example.
Elem
Description
The elem tag contains the actual information of the table. Each element belongs to a group (specified by the group tag), and refers to a category (specified by the category tag).
Attributes
-
desc - desc is short for
description. The value of the attribute will be used to
link the element to a category.
- Required
- IDREF
-
id - a unique id
- Optional
- ID
Children
An elem tag must contain one or more of plain text or one of the following tags: cnxn, link, emphasis, codeline, and cite. It may also contain MathML tags.
Examples
See the table example.
Figure
Description
The figure tag provides the structure for creating a figure within a document. A figure could contain such things as an image, or a table, or several of these.
Attributes
-
id - unique id
- Required
- ID
-
orient - allows the writer to determine which way subfigures should be
arranged (irrelevant if there are no subfigures)
- Optional
- Possible values
- horizontal - subfigures will be placed next to each other
- vertical - subfigures will be placed on top of each other
- Default is horizontal.
Children
Examples
The following code for a figure might be displayed as shown below.
<figure id="fig1">
<name>A Happy Dog</name>
<media type="image" src="image1.jpg"/>
<caption>The dog displayed in this picture is enjoying a
comfortable bed.</caption>
</figure>
A Happy Dog
Figure 2 The dog displayed in this picture is enjoying a comfortable bed.
Subfigure
Description
A subfigure tag is used when you want to use more than one media tag or table tag, etc. inside of the same figure tag. It is only appropriate to use subfigures if the subfigures are related in some way. The usage of the subfigure tag is similar to that of figure, except that it cannot contain another subfigure tag.
Attributes
-
id - unique id
- Optional
- ID
Children
Examples
Here are two subfigures appearing in a figure whose orient attribute is set to "horizontal".
<figure orient="horizontal" id="horfig">
<subfigure id="subfig1">
<media type="image" src="image1.jpg"/>
</subfigure>
<subfigure id="subfig2">
<media type="image" src="image2.jpg"/>
</subfigure>
</figure>
This might be rendered as in the figure below.
|
|
|
Figure 3
Similarly, here are two subfigures appearing in a figure whose orient attribute is set to "vertical".
<figure orient="vertical" id="vertfig">
<subfigure id="subfig3">
<media type="image" src="image1.jpg"/>
<caption>Dog sitting</caption>
</subfigure>
<subfigure id="subfig4">
<media type="image" src="image2.jpg"/>
<caption>Dog standing</caption>
</subfigure>
</figure>
This might be rendered as in the figure below.
|
Dog sitting |
|
Dog standing |
Figure 4
Caption
Description
Caption is only used to provide a caption for a figure or a subfigure. The caption tag is distinct from the name tag in that it provides a possibly lengthy description of the figure for the reader's use and not an overall title or name.
Attributes
None
Children
The caption tag may contain a combination of plain text and the following tags: cnxn, link, emphasis, and codeline. It may also contain MathML tags.
Examples
In this example, notice the different roles played by the name tag and the caption tag.
<figure id="fig3">
<name>A Happy Dog</name>
<media type="image" src="image1.jpg"/>
<caption>The dog displayed in this picture is enjoying a
comfortable bed.</caption>
</figure>
This might be displayed as in the figure below.
A Happy Dog
Figure 5 The dog displayed in this picture is enjoying a comfortable bed.
Media
Description
The media tag inserts "media objects", such as images, applets, movies, sounds, or any valid mimetype, into CNXML documents.
Attributes
-
type - the type of media (i.e. sound, video, etc.) the media
tag contains
- Required
- Possible values
- image - a bitmapped image in a standard format such as gif, png, jpg, etc.
-
src - a relative or absolute URI indicating the path to the object.
- Required
- CDATA
Children
None
Examples
<media type="image" src="image1.jpg"/>
Examples and Exercises
These tags allow authors to embed examples and worked-out exercises in the module.
Example
Description
The example tag is used to contain an example of something. This is especially useful in connection with the definition tag where it can be used to give an example of the meaning of a term.
Attributes
-
id - unique id
- Required
- ID
Children
May contain an optional name tag as the first child.
The example tag must then contain one or more of the following tags: para, equation, list, codeblock, figure, and table.
Examples
<example id="example">
<para id="paraex1">
The Lincoln Memorial is an example of a monument.
</para>
</example>
This might be displayed as shown in the example.
The Lincoln Memorial is an example of a monument.
Exercise
Description
The exercise tag is used to create exercises, such as would be used in a text book of a college course. An exercise consists of two parts: a problem and a solution.
Attributes
- id - unique id
- Required
- ID
Examples
<exercise id="exer1">
<problem>
.
.
.
</problem>
<solution>
.
.
.
</solution>
</exercise>
Problem
Description
The problem tag is used to specify the problem portion of an exercise tag.
Attributes
None
Children
The problem tag must contain one or more of the following tags: rule, para, equation, list, codeblock, definition, figure, and table.
Examples
<problem>
<para id="prob_1">
What is the capital of Texas?
</para>
</problem>
Solution
Description
The solution tag is used to specify the solution portion of an exercise tag.
Attributes
None
Children
The solution tag must contain one or more of the following tags: para, equation, list, codeblock, figure, and table.
Examples
<solution>
<para id="prob_1">
Austin is the capital of Texas.
</para>
</solution>
Links and References
The cnxn, link, and cite tags provide ways for a document to refer to other Connexions modules, web materials, and printed works, respectively.
Cnxn
Description
The cnxn tag links to a Connexions system module or a tag inside a Connexions system module, possibly different from the current module.
Attributes
-
target - the id of the tag being linked to
- Optional
- CDATA
- If the target attribute is omitted, the link will default to the root element of the target module.
-
module - module that is linked to
- Optional
- CDATA
- If the module attribute is omitted, the link will default to the current module.
-
strength - strength or "relatedness" of the connection
- Required
- Possible values
- numeric value (0-9) where 0 is the lowest strength and 9 is the highest strength.
- version - the version of the module being liked to
- Optional
- CDATA
- If the version attribute is omitted, the link will default to the current version of the module.
Children
ASCII text that serves as the link text.
Examples
<cnxn target="figure12" module="m7473" strength="5">Figure 12</cnxn>
<cnxn target="para32" strength="9">As mentioned earlier</cnxn>
<cnxn module="m3423" strength="0">A previous module</cnxn>
Link
Description
The link tag is used to insert links to external resources.
Attributes
-
src - the URL of the resource being linked to
- Required
- CDATA
Children
The link tags must contain ASCII text to server as the link text.
Examples
<para id="linkexample">
<link src="http://www.laurynhill.com">Lauryn Hill</link> is
one of the most influential R&B artists to date. Having
performed with <link src="http://www.fugees.net">The
Fugees</link> and now solo, she is a defining force in
worlds of Rap, Hip-Hop and R&B. Her voice is powerful and
her <link src="http://www.laurynhill.com/lyrics">lyrics</link> are
moving. It is no wonder that she set records, taking away 5
awards at the 1999 Grammies.
</para>
Cite
Description
The cite tag is used to refer to non-electronic materials (one's without a hypertext link). It typically will contain the title of the work.
Attributes
None
Children
A cite tag can contain a combination of text and emphasis tags. It may also contain MathML tags.
Examples
<para id="citeexample">
<cite>A Tale of Two Cities</cite> is a classic novel by Mark Twain.
</para>
Definition and Rule
Definition are used to define words, phrases, etc. Rules are used to define such things as theorem, axiom, etc.
Definition
Description
Definition is used to define a word or a term.
Attributes
- id - unique id
- Required
- ID
Children
- The definition tag can contain only three type of tags: term, meaning, and example.
- The term tag is always required and is first.
- After that, at least one meaning tag is required. Multiple meaning tags are allowed in a definition.
- In addition, after each meaning tag you may put 0, 1, or many example tags. examples should following the meaning they relate to.
Examples
<definition id='quardef'>
<term>quarter</term>
<meaning>One fourth of something.</meaning>
<example id='defex1'>
<para id='parex1'>
"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='defex2'>
<para id='parex2'>
"The drink cost a quarter."
</para>
</example>
<example id='defex3'>
<para id='parex3'>
"She picked up a roll of quarters so that she could do
laundry."
</para>
</example>
</definition>
This definition might be displayed as follows.
"He cut the pie into quarters and gave all four people a piece."
"The drink cost a quarter."
"She picked up a roll of quarters so that she could do laundry."
Term
Description
Term marks the word or phrase being defined. It can be used in either a definition tag or in a sentence in a para.
Attributes
None
Examples
<para id='parterm2'>
A <term>square</term> is a rectangle with equal sides.
</para>
This might be displayed in the next paragraph.
A square is a rectangle with equal sides.
See also definition examples.
Meaning
Description
Meaning gives one definition of the word or phrase being defined in a definition. Each definition tag can have multiple meanings and therefore multiple meaning tags.
Attributes
None
Children
Meaning can contain a combination of text, codeline, equation, emphasis, cite, link, and cnxn tags. It may also contain MathML tags.
Examples
Please see the definition examples.
Rule
Description
Any type of "rule" such as theorems, axiom, lemmas, rule of thumb, etc. This tag is especially useful for mathematical texts.
Attributes
- id - a unique identifier
- Required
- ID
- type - the kind of rule: theorem, axiom, lemma, etc.
- Required
- CDATA
- The values are not explicitly defined by this specification, because it would be unfeasible to create an exaustive list. However, some suggestions are theorem, axiom, lemma, corollary, proposition.
Children
Example
<rule type='theorem' id='ruleexcode'>
<name>Pythagorean Theorem</name>
<statement>
<para id='ruleexp1'>
On a right triangle, the sum of the squares of the
sides equals the square of the hypotenus.
</para>
</statement>
<proof>
<para id='ruleexp2'>
Your favorite proof goes here.
</para>
</proof>
<example>
<para id='ruleexp3'>
Take a right triangle whose sides are of length 3, 4, and 5.
In this case the sum of the square of the two shorter sides is
9+16=25. The square of the hypotenus is 25. So the theorem holds.
</para>
</example>
<proof>
<para id='ruleexp4'>
Another proof could go here.
</para>
</proof>
<example>
<para id='ruleexp5'>
Another example could go here.
</para>
</example>
</rule>
Emphasizing
There are two tags in this section: emphasis and note. The emphasis tag is meant to convey verbal emphasis or stress (it is often presented visually in boldface or italics, but should not be used just to achieve that effect). The note tag is meant to convey an "out of line" note to the reader i.e. a warning, point of interest, etc.
Emphasis
Description
The emphasis tag is used to emphasize text in a CNXML document where emphasis 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 as a change in typeface.
Attributes
None
Children
The emphasis tag may only contain plain text.
Examples
<para id="emphexample">
In addition to bananas and ice cream, a proper banana split
requires whipped cream, nuts, <emphasis>and</emphasis>
cherries. Remember that the quality of the dessert depends
on the ice cream, so do <emphasis>not</emphasis> use a
generic brand.
</para>
Note
Description
The note tag is used to add a note about text in a CNXML document.
Attributes
-
type - the type of note
- Optional
- type
- The value of
type is left open to the author. The author can choose
different values that reflect the purpose of the note.
Some suggestions are:
- note
- aside
- point of interest
- warning
Children
The item tag may contain a combination of plain text, and the following tags: emphasis, link, cnxn, list, codeline, and term.
Examples
<para id="noteexample">
Chemistry lab was always a lot of fun. We played with a lot
of chemicals such as Sulfuric and Hydrocholic acid. <note
type="warning">Sulfuric and Hydrochloric Acid are very
dangerous. Please handle with caution</note>
</para>
Equations and Code
These tags are specialized for working with mathematics and computers. equation is for denoting especially important equations. codeline and codeblock are for displaying computer input or output.
Equation
Description
The equation tag is used to set off equations in CNXML documents. It is meant to be used with elements from MathML.
Attributes
- id - unique id
- Required
- ID
Children
The equation tag may optionally have name as the first child, to associate a name with the equation. The equation tag must also contain math marked up using MathML.
Examples
<equation id="eqn14">
<name>Euler's Identity</name>
<m:math xmlns:m="http://www.w3.org/1998/Math/MathML" mode="display">
<m:apply>
<m:eq />
<m:apply>
<m:plus />
<m:apply>
<m:exp/>
<m:apply>
<m:times />
<m:imaginaryi/>>
<m:ci type='constant'>π</m:ci>
</m:apply>
</m:apply>
<m:cn>1</m:cn>
</m:apply>
<m:cn>0</m:cn>
</m:apply>
</m:math>
</equation>
Codeline
Description
The codeline tag is used to insert a word or line of computer code (for example a command) into a document. When displayed, it will often be typeset in a fixed-width font.
Attributes
None
Examples
Enter the command <codeline>ls /etc</codeline> to
get a listing of configuration files.
Codeblock
Description
The codeblock tag is used to insert a segment of computer code into a document. When displayed, it will often be typeset in a fixed-width font and set apart from the document text.
Attributes
-
id - unique id
- Optional
- ID
Examples
<codeblock id="forloopexample">
for(i=0; i<size(list); i++) {
total = total + list[i];
}
</codeblock>