samp element

Description

The samp element represents a sample or output from a program or script. This element is usually placed inside pre to take advantage of its characteristics: spaces and line breaks in the code are respected and rendered in the document.

When the samp element is containing a kbd element, it represents a computer sample that includes a command or text that was input by the user.

When the kbd element is containing a samp element, it represents a user input that's been made based on a computer output, like could be, a menu command.

Examples

In this example, the author talks about his experience with a program. The message returned by the computer is wrapped inside the samp element.

<p>When I entered the command, the computer answered <samp>Error: command not found</samp>. I'm at a loss here...</p>

In the second example, the samp element is used together with pre, to take advantage of its characteristics: spaces and line breaks in the code are respected and rendered in the document. This way, the text of the output can be pasted exactly as it was retrieved from the program. Additionally, the fixed-width characters of pre help in maintaining the tabulation of data.

<p>The results I got are shown below:</p>
<pre><samp>
Filesystem      Size  Used Avail Use% Mounted on
none            4,0K     0  4,0K   0% /sys/fs/cgroup
udev            990M  4,0K  990M   1% /dev
tmpfs           201M  1,2M  199M   1% /run
none            5,0M     0  5,0M   0% /run/lock
none           1001M   80K 1001M   1% /run/shm
none            100M   24K  100M   1% /run/user</samp></pre>

Filesystem      Size  Used Avail Use% Mounted on
none            4,0K     0  4,0K   0% /sys/fs/cgroup
udev            990M  4,0K  990M   1% /dev
tmpfs           201M  1,2M  199M   1% /run
none            5,0M     0  5,0M   0% /run/lock
none           1001M   80K 1001M   1% /run/shm
none            100M   24K  100M   1% /run/user

In the third example, the samp element is being used inside kbd, to mark up the menus in a computer program the user should access.

<p>To create a new document go to <kbd><samp>File</samp> → <samp>New</samp></kbd>.</p>

Now, an example with the samp element containing a piece of text previously input by the user. The latter is represented by the kbd element.

<pre><samp>Enter your search query: <kbd>balance.txt</kbd>
Searching...
No files where found that match your search query</samp></pre>

Enter your search query: balance.txt
Searching...
No files where found that match your search query

Attributes

Events