Using the <code> tag

Description

The code tag is used to insert a line or block of computer code (for example a command) into a document.

Example

This CNXML:


<para id="codeexample">
  Enter the command <code>ls /etc</code> to
  get a listing of configuration files.
</para>

Results in this display:

Enter the command ls /etc to get a listing of configuration files.

Example

This CNXML:


<code display="block" id="popup">
   function popUp() {
       var popmsg = 'Hello &amp; goodbye';
       alert($popmsg);
   }
</code>

Results in this display:


   function popUp() {
       var popmsg = 'Hello & goodbye';
       alert($popmsg);
   }

Note that ampersand and angle bracket characters (&, <, and >) must be escaped (what's this?). Their escaped equivalents are &, <, and >, respectively. Alternatively, one can insert <![CDATA[ before the code text and ]]> after it (what's this?) to eliminate the need for escaping.

Attributes(what's this?)

display (optional):
Possible values:
- inline - The code will be included in the current line of text (default).
- block - The code will be set apart from the surrounding text. If the display attribute is set to "block", then an id is required.
- none - The code will not be displayed.
lang (optional): Defines the language contained within the code block, e.g. "PHP," "Visual C#," or "FORTRAN."
id (required for block display code): A unique identifier, whose value must begin with a letter and contain only letters, numbers, hyphens, underscores, colons, and/or periods (no spaces).

Children(what's this?)

label (one, optional), title (one, optional), term, cite, cite-title, foreign, emphasis, sub, sup, code, preformat, quote, note, list, media, footnote, link, newline, space, caption, Unicode text

Parents(what's this?)

title (one, optional), label (one, optional), preformat, para, cite-title, cite, link, emphasis, term, sub, sup, quote, foreign, footnote, note, item, code, figure, subfigure, caption, commentary, meaning, entry, content, section, example, problem, solution, statement, proof, audio, flash, video, text, java-applet, image, labview, download

Close this window