Content-Based Style Tags (HTML & XHTML: The Definitive Guide, 4th Edition)

4.4. Content-Based Style Tags

It takes discipline to use the content-based styles, since it is easier to simply think of how your text should look, not necessarily what it may also mean. Once you get started using content-based styles, your documents will be more consistent and better lend themselves to automated searching and content compilation.

Content-Based Style Tags

Function:

Alter the appearance of text based upon the meaning, context, or usage of the text

Attributes:

CLASS
ONKEYUP

DIR
ONMOUSEDOWN

ID
ONMOUSEMOVE

LANG
ONMOUSEOUT

ONCLICK
ONMOUSEOVER

ONDBLCLICK
ONMOUSEUP

ONKEYDOWN
STYLE

ONKEYPRESS
TITLE

End tags:

Never omitted

Contains:

text

Used in:

text

While kumquats are not mentioned in Melville's
<cite>Moby Dick</cite>, it is nonetheless apparent
that the mighty cetacean represents the bitter 
"kumquat-ness" within every man. Indeed, when Ahab
spears the beast, its flesh is tough, much like the noble fruit.

Figure 4-7. Internet Explorer renders <cite> in italic

Use the <cite> tag to set apart any reference to another document, especially those in the traditional media, such as books, magazines, journal articles, and the like. If an online version of the referenced work exists, you also should enclose the citation within the <a> tag and make it a hyperlink to that online version.

The <cite> tag also has a hidden feature: it enables you or someone else to automatically extract a bibliography from your documents. It is easy to envision a browser that compiles tables of citations automatically, displaying them as footnotes or as a separate document entirely. The semantics of the <cite> tag go far beyond changing the appearance of the enclosed text; they enable the browser to present the content to the user in a variety of useful ways.

4.4.4. The <code> Tag

Software code warriors have become accustomed to a special style of text presentation for their source programs. The <code> tag is for them. It renders the enclosed text in a monospaced, teletype-style font like Courier, familiar to most programmers and readers of O'Reilly's series of books, including this one.

This following bit of en<code>ed text is rendered in monospaced font style by Netscape as shown in Figure 4-8:

The array reference <code>a[i]</code> is identical to
the pointer reference <code>*(a+i)</code>.

Figure 4-8. Use <code> to present computer-speak

You should use the <code> tag only for text that represents computer source code or other machine-readable content. While the <code> tag usually just makes text appear in a monospaced font, the implication is that it is source code and future browsers may add other display effects. For example, a programmer's browser might look for <code> segments and perform some additional text formatting like special indentation of loops and conditional clauses. If the only effect you desire is a monospaced font, use the <tt> tag instead.

4.4.5. The <dfn> Tag

Use <dfn> to tag those defining instances of special terms or phrases. It may not result in any formatting changes by the browser. Instead, <dfn> might assist in creating a document index or glossary.

For example, use the <dfn> tag to introduce a new phrase to the reader:

When analyzing annual crop yields, <dfn>rind spectroscopy</dfn> may prove useful. 
By comparing the relative levels of saturated hydrocarbons in fruit from adjacent 
trees, rind spectroscopy has been shown to be 87% effective in predicting an 
outbreak of trunk dropsy in trees under four years old.

Notice that we delimit only the first occurrence of "rind spectroscopy" with a <dfn> tag in the example. Good style tells us not to clutter the text with highlighted text. As with the many other content-related and physical style tags, the fewer the better.[21] As a general style, especially in technical documentation, set off new terms when they are first introduced to help your readers better understand the topic at hand, but resist tagging the terms thereafter.

[21]If you need convincing that less is better when applying the content-based and physical style tags, try reading a college textbook in which someone has highlighted what they considered important words and phrases with a yellow pen.

4.4.6. The Tag

The  tag tells the client browser to present the enclosed text with emphasis. For nearly all browsers, this means the text is rendered in italic. For example, the popular browsers will emphasize by italicizing the words "always" and "never" in the following HTML source:

Kumquat growers must <em>always</em> refer to kumquats 
as "the noble fruit," <em>never</em> as just a "fruit."

Adding emphasis to your text is a tricky business. Too little, and the emphatic phrases may be lost. Too much, and you lose the urgency. Like any seasoning, emphasis is best used sparingly.

Although invariably displayed in italic, the  tag has broader implications as well and someday browsers may render emphasized text with a different special effect. The  tag explicitly italicizes text; use it if all you want is italic. Besides emphasis, also consider using  when presenting new terms or as a fixed style when referring to a specific type of term or concept. For instance, one of O'Reilly's book styles is to specially format file and device names.  might be used to differentiate those terms from simple italic for emphasis.

4.4.7. The <kbd> Tag

Speaking of special style for technical concepts, there is the <kbd> tag. As you probably already suspect, it is used to indicate text that is typed on a keyboard. Its enclosed text typically is rendered by the browser in monospaced font style.

The <kbd> tag is most often used in computer-related documentation and manuals, such as in this example:

Type <kbd>quit</kbd> to exit the utility, or type
<kbd>menu</kbd> to return to the main menu.

4.4.8. The <samp> Tag

The <samp> tag indicates a sequence of literal characters that should have no other interpretation by the user. This tag is most often used when a sequence of characters is taken out of its normal context. For example, the following source:

The <samp>ae</samp> character sequence may be converted
to the &aelig; ligature if desired.

is rendered by Netscape as shown in Figure 4-9.

Figure 4-9. Setting off sample text using the <samp> tag

The special HTML reference for the "ae" ligature entity is æ and is converted to its appropriate æ ligature character by most browsers. For more information, see Appendix F, "Character Entities".

The <samp> tag is not used very often. It should be used in those few cases where special emphasis needs to be placed on small character sequences taken out of their normal context.

4.4.9. The Tag

Like the  tag, the  tag is for emphasizing text, except with more gusto. Browsers typically display the  tag differently than the  tag, usually by making the text bold (versus italic), so that users can distinguish between the two. For example, in the following text, the emphasized "never" appears in italic with Internet Explorer, while the  "forbidden" is rendered in bold characters (see Figure 4-10):

One should <em>never</em> make a disparaging remark
about the noble fruit. In particular, mentioning 
kumquats in conjunction with vulgar phrases is 
expressly <strong>forbidden</strong> by the Association
bylaws.

If common sense tells us that the  tag should be used sparingly, the  tag should appear in documents even more infrequently.  text is like shouting.  text is nothing short of a scream. Like a well-chosen epithet voiced by an otherwise taciturn person, restraint in the use of  makes its use that much more noticeable and effective.

Figure 4-10. Strong and emphasized text are rendered differently by Internet Explorer

4.4.10. The <var> Tag

The <var> tag, another computer-documentation trick, indicates a variable name or a user-supplied value. The tag is often used in conjunction with the <code> and <pre> tags for displaying particular elements of computer programming code samples and the like. <var>-tagged text typically is rendered in italics, as shown in Figure 4-11, which displays Internet Explorer's rendering of the following example:

The user should type
<pre>
  cp <var>source-file</var>  <var>dest-file</var>
</pre>
replacing the <var>source-file</var> with the name of 
the source file, and <var>dest-file</var> with the name
of the destination file.

Figure 4-11. The <var> tag typically appears in preformatted (<pre>) computer code

Like the other computer programming and documentation-related tags, the <var> tag not only makes it easy for users to understand and browse your documentation, but automated systems might someday use the appropriately tagged text to extract information and useful parameters mentioned in your document. Once again, the more semantic information you provide to your browser, the better it can present that information to the user.

4.4.11. The class, id, style, and title Attributes

Although each content-based tag has a defined style, you can override the style by defining a look for each tag. This new look can be applied to the content-based tags using either the style or class attributes. Section 8.1.1, "Inline Styles: The style Attribute" Section 8.3, "Style Classes"

You also may assign a unique id-entifier to the content-based style tag, as well as a less-rigorous title, using the respective attributes and their accompanying quote-enclosed string values. Section 4.1.1.4, "The id attribute" Section 4.1.1.5, "The title attribute"

4.4.12. The dir and lang Attributes

The dir attribute advises the browser as to which direction the text within the content-based style tag ought to be displayed, and lang lets you specify the language used within the tag. Section 3.6.1.1, "The dir attribute" Section 3.6.1.2, "The lang attribute"

4.4.13. Event Attributes

Things happen in and around a content-based tag's content, and, with the respective "on" attribute and value, you may react to that event by displaying a user dialog or activating some multimedia event. Section 12.3.3, "JavaScript Event Handlers"

4.4.14. Summary of Content-Based Tags

The various graphical browsers render text inside content-based tags in similar fashion; text-only browsers like Lynx have consistent styles for the tags. Table 4-1 summarizes these browsers' display styles for the native tags. However, style sheet definitions may override these native display styles.

Table 4-1. Content-Based Tags

Tag	Netscape	Internet Explorer	Lynx
`<abbr>`	n/a	n/a	n/a
`<acronym>`	n/a	n/a	n/a
`<cite>`	italic	italic	`monospace`
`<code>`	`monospace`	`monospace`	`monospace`
`<dfn>`	n/a	italic	n/a
`<em>`	italic	italic	`monospace`
`<kbd>`	`monospace`	`monospace bold`	`monospace`
`<samp>`	`monospace`	`monospace`	`monospace`
`<strong>`	bold	bold	`monospace`
`<var>`	italic	italic	`monospace`

4.4.15. Allowed Content

Any content-based style tag may contain any item allowed in text, including conventional text, anchors, images, and line breaks. In addition, other content-based and physical style tags can be embedded within the content.

4.4.16. Allowed Usage

Any content-based style tag may be used anywhere an item allowed in text is used. In practice, this means you can use the , <code>, and other similar tags anywhere in your document except inside <title>, <listing>, or <xmp> tagged segments. You can use text style tags in headings, too, but their effect may be overridden by the effects of the heading tag itself.

4.4.17. Combining Content-Based Styles

It may have occurred to you to combine two or more of the various content-based styles to create interesting and perhaps even useful hybrids. Thus, an emphatic citation might be achieved with:

<cite><em>Moby Dick</em></cite>

In practice, Dr. Frankenstein, the browser usually ignores the monster; as you can test by typing and viewing the example yourself, Moby Dick gets the citation without emphasis.

The HTML and XHTML standards do not require the browser to support every possible combination of content-based styles and does not define how the browser should handle such combinations. Someday, maybe. For now, it's best to choose one tag and be satisfied.