code Element

Module

The code element is an inline element declared by the XHTML 1.1 Text Module (Inline Phrasal)

Elements in the Text Module are:
span | br (Inline Structural Support Module)
em | strong | q | cite | abbr | acronym | code | var | kbd | samp | dfn (Inline Phrasal Support Module)
div | p (Block Structural Support Module)
h1 - h6 | blockquote | pre | address (Block Phrasal Support Module)

Description

The code element is used to mark up an extract of computer code, for example program code or XHTML. The contents of a code element are commonly rendered in a monospace font.

<div><code>#!/usr/bin/perl<br />print "$_ ..\n" for reverse ( 1 .. 10 );<br />print "Blast Off!\n";</code></div>

It is common to enclose longer lengths of code within a pre element (which is also usually rendered in monospace) so that whitespace formatting is preserved and the br tags are not necessary.

<pre><code>function createXHTMLElement ( eltname ) {
    var element;
    if ( document.createElementNS ) {
	element = document.createElementNS( 'http://www.w3.org/1999/xhtml', eltname );	
    }
    else {
	element = document.createElement( eltname );
    }
    return element;
}</code></pre>

function createXHTMLElement ( eltname ) {
    var element;
    if ( document.createElementNS ) {
	element = document.createElementNS( 'http://www.w3.org/1999/xhtml', eltname );	
    }
    else {
	element = document.createElement( eltname );
    }
    return element;
}

Note: You still have to be careful to escape any ampersand (&), less-than (<) and occasionally greater-than (>) characters within the code in order for your document to be well formed (see W3C Validation), unless you additionally enclose your code (inside the code element) in a CDATA Section.

code is an inline element and so can be used, for example, within a paragraph to mark up a code fragment.

See also the elements: samp, kbd and var.

#REQUIRED Attributes

There are no #REQUIRED attributes on the code element.

Specific Attributes

There are no specific attributes declared on the code element.

Common Attributes

From the Core Attribute Collection

class [ type NMTOKENS ]

One or more space separated classes

id [ type ID ]

A unique identifier for the element

style [ type CDATA ], from the Style Attribute Module (deprecated)

Element-specific styles

title [ type Text ]

Descriptive title for the element (in some user agents this may appear as a "tooltip" when the mouse hovers over the element)

xmlns [ type URI - #FIXED 'http://www.w3.org/1999/xhtml' ]

XML namespace

From the I18N Attribute Collection

dir [ type Enumeration (ltr | rtl) ], from the Bi-directional Text Module

Left-to-right or right-to-left directionality

xml:lang [ type LanguageCode ]

A language code for the element

From the Events Attribute Collection

All attributes in the Events Attribute Collection are supported:
onclick, ondblclick, onmousedown, onmouseup, onmouseover, onmousemove, onmouseout, onkeypress, onkeydown, onkeyup

Content Model

( #PCDATA | Inline.mix )*

See Content Model & Nesting for information about Content Model syntax and Nesting Groups.

Valid children of code

• #PCDATA
• From the Text Module: abbr, acronym, br, cite, code, dfn, em, kbd, q, samp, span, strong, var
• From the Hypertext Module: a
• From the Forms Module: button, input, label, select, textarea
• From the Images Module: img
• From the Presentation Module: b, big, i, small, sub, sup, tt
• From the Client-side Image Map Module: map
• From the Scripting Module: noscript, script
• From the Edit Module: del, ins
• From the Bi-directional Text Module: bdo
• From the Object Module: object
• From the Ruby Annotation Module: ruby

Valid parents of code

• From the Text Module: abbr, acronym, address, cite, code, dfn, div, em, h1 - h6, kbd, p, pre, q, samp, span, strong, var
• From the Hypertext Module: a
• From the List Module: dd, dt, li
• From the Tables Module: caption, td, th
• From the Forms Module: button, fieldset, label, legend
• From the Presentation Module: b, big, i, small, sub, sup, tt
• From the Edit Module: del, ins
• From the Bi-directional Text Module: bdo
• From the Object Module: object
• From the Ruby Annotation Module: rb, rt