DocbookConventions

Differences between revisions 3 and 4
Revision 3 as of 2007-12-16 17:40:49
Size: 420
Editor: cpc3-with4-0-0-cust1001
Comment: Added to category
Revision 4 as of 2008-01-23 10:54:27
Size: 1571
Editor: cpc3-with4-0-0-cust432
Comment: Added new material
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
TODO: [[TableOfContents(3)]]

''TODO:
Line 10: Line 12:
''

== Referring to the user interface ==

The standard methods of tagging items in user interfaces are detailed below.

=== Buttons ===

attachment:button.png attachment:button-toggle.png

For push buttons, use {{{<guibutton>Button Caption</guibutton>}}}. The caption should match the exact caption used by the button in the UI.

=== Labels ===

attachment:label-textentry.png attachment:label-tab.png attachment:

For labels (such as the names of text entries, checkboxes and tabs), use {{{<guilabel>Label Text</guilabel>}}}. The label text should exactly match the text used in the UI.

== Referring to files and commands ==

This section describes the tags which should be used when referring to files, directories, and commands which the user inputs into the Terminal.

=== Files and directories ===

When referring to a file, use {{{<filename>/path/to/file</filename>}}}

Refer to directories using {{{<filename classname="directory">/path/to/directory</filename>}}}

Refer to file extensions using {{{<filename classname="extension">.ext</filename>}}}

=== Terminal Commands ===


TableOfContents(3)

TODO:

  1. How DocBook tags are used

  2. When to use a DocBook article, and when to use a DocBook book.

  3. How to markup screenshots and other graphics, sections, cross-refs, tables, etc.

Referring to the user interface

The standard methods of tagging items in user interfaces are detailed below.

Buttons

attachment:button.png attachment:button-toggle.png

For push buttons, use <guibutton>Button Caption</guibutton>. The caption should match the exact caption used by the button in the UI.

Labels

attachment:label-textentry.png attachment:label-tab.png attachment:

For labels (such as the names of text entries, checkboxes and tabs), use <guilabel>Label Text</guilabel>. The label text should exactly match the text used in the UI.

Referring to files and commands

This section describes the tags which should be used when referring to files, directories, and commands which the user inputs into the Terminal.

Files and directories

When referring to a file, use <filename>/path/to/file</filename>

Refer to directories using <filename classname="directory">/path/to/directory</filename>

Refer to file extensions using <filename classname="extension">.ext</filename>

Terminal Commands


CategoryDocteam

DocumentationTeam/StyleGuide/DocbookConventions (last edited 2011-06-14 02:57:33 by calipengo)