DocbookConventions
397
Comment: Added TOC
|
1571
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 === ---- CategoryDocteam |
TODO:
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
DocumentationTeam/StyleGuide/DocbookConventions (last edited 2011-06-14 02:57:33 by 24-205-79-243)