userinput/computeroutput patch - security section
Adam Sommer
asommer70 at gmail.com
Sun Jan 27 20:02:39 UTC 2008
Hello all,
> All text referencing commands entered have been tagged and identified by
> <userinput>. [1]
>
> All text referencing output are tagged and idenitified by
> <computeroutput>. [2]
>
>
Here's the way I interpret the use of the tags in question:
<userinput>[1] should be used whenever a command or application dialog
requests that the user provide input.
<computeroutput>[2] I agree should be used to display any output generated
from a command.
<command>[3] Should be used to reference commands entered from a
terminal. This could be classified as user input, but the tag seems to
me more for command text, arguments, and
switches.
<programlisting>[4] Should be used for any source code files, config
files, or parts of files referenced.
Attached is a modified diff of the two sections. I'm attaching it just as
an example and not suggesting it should be committed. If anyone else has an
opinion please comment so that we can update the Style Guide and hopefully
have a standard set of tags we use.
Thanks once again Gilbert for your work on the Server Guide, it's very
appreciated.
[1] http://www.docbook.org/tdg/en/html/userinput.html
[2] http://www.docbook.org/tdg/en/html/computeroutput.html
[3] http://www.docbook.org/tdg/en/html/command.html
[4] http://www.docbook.org/tdg/en/html/programlisting.html
--
Party On,
Adam
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20080127/f1055ed1/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: security.xml_tag_test.diff
Type: text/x-patch
Size: 9826 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20080127/f1055ed1/attachment.bin>
More information about the ubuntu-doc
mailing list