diff options
Diffstat (limited to 'doc/mallard/C/mal_inline_output.page')
-rw-r--r-- | doc/mallard/C/mal_inline_output.page | 170 |
1 files changed, 0 insertions, 170 deletions
diff --git a/doc/mallard/C/mal_inline_output.page b/doc/mallard/C/mal_inline_output.page deleted file mode 100644 index c15336d..0000000 --- a/doc/mallard/C/mal_inline_output.page +++ /dev/null @@ -1,170 +0,0 @@ -<page xmlns="http://projectmallard.org/1.0/" - type="topic" - id="mal_inline_output"> - -<info> - <link type="guide" xref="mal_inline#elements"/> - - <revision version="0.1" date="2008-12-17" status="review"/> - - <credit type="author"> - <name>Shaun McCance</name> - <email>shaunm@gnome.org</email> - <years>2008-2009</years> - </credit> - - <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" /> - - <desc>Mark up the output from a computer program.</desc> -</info> - -<title>Computer Output</title> - -<synopsis><code mime="application/relax-ng-compact-syntax"> -mal_inline_output = element output { - <link xref="mal_attr_link">mal_attr_link</link> ?, - attribute style { xsd:NMTOKENS } ?, - attribute * - (mal:* | local:*) { text } *, - - <link xref="mal_inline">mal_inline</link> -} -</code></synopsis> - -<p>Use the <code>output</code> element to mark up text that is output -by a computer program. Typically, this is text output in a command-line -environment, although you may use the <code>output</code> element for -computer-generated text in a text box or similar control in a graphical -application. For messages and other labels in a graphical application, -use the <code xref="mal_inline_gui">gui</code> element.</p> - -<p>You can use the <code>style</code> attribute to indicate what type of text -is being marked up. Inside a <code xref="mal_block_screen">screen</code> -element, this may be used to format normal text, error text, and prompts -differently.</p> - - -<!-- BEGIN notes --> -<section id="notes"> - <title>Notes</title> - <list> - <item><p>The <code>output</code> element can contain a mixture of text and - any <link xref="mal_inline">general inline elements</link>.</p></item> - - <item><p>The <code>output</code> element can occur in any - general inline context, including inside most - <link xref="mal_inline">inline elements</link>, some - <link xref="mal_block#basic">basic block elements</link>, and certain - <link xref="mal_info">informational elements</link>.</p></item> - - <item><p>The <code>output</code> element can link to other pages or documents. - See <link xref="mal_attr_link"/> for more information.</p></item> - - <item><p>The <code>style</code> attribute takes a space-separated list of - style hints. Processing tools should adjust their behavior according to - those style hints they understand.</p></item> - - <item> - <p>Typical values for the <code>style</code> attribute include:</p> - <table rules="rows"><tr> - <td><p><code>output</code></p></td> - <td><p>Standard output from a running program</p></td> - </tr><tr> - <td><p><code>error</code></p></td> - <td><p>Standard error from a running program</p></td> - </tr><tr> - <td><p><code>prompt</code></p></td> - <td><p>The command prompt for an interactive shell</p></td> - </tr></table> - </item> - - <item><p>The <code>output</code> element can have attributes from external - namespaces. See <link xref="mal_external"/> for more information - on external-namespace attributes.</p></item> - - <item><p>The <code>output</code> element, together with the - <code xref="mal_inline_input">input</code> element, may be used to mark up - the contents of a <code xref="mal_block_screen">screen</code> element, - allowing processing tools to treat them differently.</p></item> - </list> -</section> -<!-- END notes --> - - -<!-- BEGIN examples --> -<section id="examples"> - <title>Examples</title> - - <p>Use <code>output</code> to mark up text generated by a program:</p> - - <example> - <code><![CDATA[ -The output of <cmd>echo $SHELL</cmd> is <output>/bin/bash</output> -if you use the Bourne-again shell. -]]></code> - <p>The output of <cmd>echo $SHELL</cmd> is <output>/bin/bash</output> if - you use the Bourne-again shell.</p> - </example> - - <p>Use <code>output</code> and <code xref="mal_inline_input">input</code> - inside a <code xref="mal_block_screen">screen</code> element:</p> - - <example> - <code><![CDATA[ -<screen> -<output style="prompt">$ </output><input>ls mal_inline_output.xml</input> -<output>mal_inline_output.xml</output> -</screen> -]]></code> -<screen> -<output style="prompt">$ </output><input>ls mal_inline_output.xml</input> -<output>mal_inline_output.xml</output> -</screen> - </example> - - <p>Use <code>output</code> for error text:</p> - - <example> - <code><![CDATA[ -<screen> -<output style="prompt">$ </output><input>ls mal.xml</input> -<output style="error">ls: mal.xml: No such file or directory</output> -</screen> -]]></code> -<screen> -<output style="prompt">$ </output><input>ls mal_inline_computeroutput.xml</input> -<output style="error">ls: mal_inline_computerouput.xml: No such file or directory</output> -</screen> - </example> -</section> -<!-- END examples --> - - -<!-- BEGIN processing --> -<section id="processing"> - <title>Processing Expectations</title> - - <p>Computer output is displayed in a fixed-width or wide font. Fixed-width - fonts tend to have more distinction between visually similar characters. - A border or background color may be used to make the beginning and end of - the output clear.</p> -</section> - - -<!-- BEGIN comparison --> -<section id="comparison"> - <title>Comparison to Other Formats</title> - <p>The <code>output</code> element is similar to the - <code href="http://www.docbook.org/tdg/en/html/computeroutput.html">computeroutput</code> - element in DocBook. When necessary, the <code>output</code> element may be used - with the <code>style</code> attribute <code>"prompt"</code> in place of DocBook's - <code href="http://www.docbook.org/tdg/en/html/prompt.html">prompt</code> - element. In some cases, it may be appropriate to use the <code>output</code> - element with the <code>style</code> attribute <code>"error"</code> in place - of DocBook's - <code href="http://www.docbook.org/tdg/en/html/errorname.html">errorname</code> and - <code href="http://www.docbook.org/tdg/en/html/errortext.html">errortext</code> - elements.</p> -</section> -<!-- END comparison --> - -</page> |