DocbookConventions
397
Comment: Added TOC
|
2987
Refined list of labels, added images
|
Deletions are marked like this. | Additions are marked like this. |
Line 4: | Line 4: |
This page provides guidance on which Doc''''''Book tags should be used in different situations. [[TableOfContents(3)]] |
|
Line 10: | Line 14: |
== Referring to the user interface == The standard methods of tagging items in user interfaces are detailed below. === Buttons === For push buttons, use {{{<guibutton>Button Caption</guibutton>}}}. The caption should match the exact caption used by the button in the UI. The following controls should be referred to using the {{{<guibutton>}}} tag: * Normal push buttons attachment:button.png * Toggle buttons === Labels === For labels (such as the names of text entries and tabs), use {{{<guilabel>Label Text</guilabel>}}}. The label text should exactly match the text used in the UI, minus the trailing colon (":") if there is one. The following controls should be referred to using the {{{<guilabel>}}} tag: || '''Control''' || '''Image''' || '''Example''' || || Label || attachment:label.png || {{{Find the section named <guilabel>Cursor Blinking</guilabel>.}}} || || Text entry || attachment:label-textentry.png || {{{Type the name of the repository into the <guilabel>APT line</guilabel> box.}}} || || Checkbox || attachment:label-checkbox.png || {{{Check <guilabel>Vertical Scrolling</guilabel> to enable your touchpad to scroll up and down.}}} || || Radio button || attachment:label-radio.png || {{{Ensure that <guilabel>Only notify about available updates</guilabel> is selected.}}} || || Drop-down selection box || attachment:label-dropdown.png || {{{Select a country from the list labelled <guilabel>Download from</guilabel>.}}} || || Combo box || attachment:label-combo.png || {{{Type an IP address into the <guilabel>Network address</guilabel> box, or select a previous address from the list.}}} || || Slider || attachment:label-slider.png || {{{Slide <guilabel>Timeout</guilabel> to the right to increase the wait time.}}} || || Expander || attachment:label-expander.png || {{{Press <guilabel>Pressure sensitivity</guilabel> to see more options for this brush.}}} || == 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 |
This page provides guidance on which DocBook tags should be used in different situations.
TODO:
How DocBook tags are used
When to use a DocBook article, and when to use a DocBook book.
- 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
For push buttons, use <guibutton>Button Caption</guibutton>. The caption should match the exact caption used by the button in the UI.
The following controls should be referred to using the <guibutton> tag:
- Normal push buttons
- attachment:button.png
- Toggle buttons
Labels
For labels (such as the names of text entries and tabs), use <guilabel>Label Text</guilabel>. The label text should exactly match the text used in the UI, minus the trailing colon (":") if there is one.
The following controls should be referred to using the <guilabel> tag:
Control |
Image |
Example |
Label |
attachment:label.png |
Find the section named <guilabel>Cursor Blinking</guilabel>. |
Text entry |
attachment:label-textentry.png |
Type the name of the repository into the <guilabel>APT line</guilabel> box. |
Checkbox |
attachment:label-checkbox.png |
Check <guilabel>Vertical Scrolling</guilabel> to enable your touchpad to scroll up and down. |
Radio button |
attachment:label-radio.png |
Ensure that <guilabel>Only notify about available updates</guilabel> is selected. |
Drop-down selection box |
attachment:label-dropdown.png |
Select a country from the list labelled <guilabel>Download from</guilabel>. |
Combo box |
attachment:label-combo.png |
Type an IP address into the <guilabel>Network address</guilabel> box, or select a previous address from the list. |
Slider |
attachment:label-slider.png |
Slide <guilabel>Timeout</guilabel> to the right to increase the wait time. |
Expander |
attachment:label-expander.png |
Press <guilabel>Pressure sensitivity</guilabel> to see more options for this brush. |
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
DocumentationTeam/StyleGuide/DocbookConventions (last edited 2011-06-14 02:57:33 by 24-205-79-243)