CODEWITHSUNDEEP
htmlstandardsw3csemantic-markup
Lone Learner
Lone Learner

Reputation: 20698

What kind of text may be wrapped within HTML code tags?

I would like to know what kind of text belongs to the HTML <code> element and what does not?

For example, I know that this is a good usage of HTML <code> tag:

Use the <code>str()</code> function to convert the object into a string.

But I am not sure if these are good usages of the <code> tag:

1. The list of users can be found at <code>/etc/passwd</code>.
2. We need to wait for <code>200 OK</code> response before the next step.
3. Enter the <code>ls</code> command to obtain a directory listing.
4. Compile the source code in <code>foo.c</code> to <code>foo.o</code>.

Is there a standards-document or a W3C guideline document or a similarly authoritative reference that precisely defines what elements may belong to the HTML <code> element and what may not?

Upvotes: 2

Views: 162

Answers (2)

unor
unor

Reputation: 96737

The definition of the code element (from HTML 5.2) is:

The code element represents a fragment of computer code. This could be an XML element name, a file name, a computer program, or any other string that a computer would recognize.

This is what decides whether it’s allowed (i.e., semantic) to use the element or not. But you should also check if there is a more specific element available.

Reviewing your examples

Use the <code>str()</code> function to convert the object into a string.

This is fine.

The list of users can be found at <code>/etc/passwd</code>.

This is fine.

We need to wait for <code>200 OK</code> response before the next step.

You could consider using the samp element instead, which represents "sample or quoted output from another program or computing system".

Enter the <code>ls</code> command to obtain a directory listing.

You could consider using the kbd element instead, which represents "user input (typically keyboard input, […])".

Compile the source code in <code>foo.c</code> to <code>foo.o</code>.

This is fine.

Upvotes: 1

tao
tao

Reputation: 90312

There are no good or bad usages of <code> tag.

To be more precise, HTML spec (and browsers, for that matter) is not opinionated on the syntax of a <code> tag's content. It does not check if it's valid code in any existing programming language.

Any phrasing content is valid from HTML spec's point of view.
Any non-phrasing content is invalid.

The code tag is similar to <pre> tag and allows browsers (through their default stylesheets) and users to style content differently, based on the fact it is a different tag.

Many times, when code snippets, functions or method names (specific to programming) are used in other content, it is important (or at least desired) they are marked (and formatted) differently than normal text.
That is the intended purpose for which <code> tag was added to HTML.

This does not mean there's any mechanism in place stopping you from using it for any other purpose you may see fit, as long as it is fit for that purpose, given its limitation at only containing phrasing content.

Upvotes: 0

Related Questions