Typographical Guidelines: Difference between revisions
(Remove extraneous indent marks) |
(→Mono-spaced Text: Improve template description) |
||
| Line 42: | Line 42: | ||
Code should be presented in mono-spaced text, boxed, as shown below. Input text should use the background colour "aliceblue". For output text, the background colour should be white. | Code should be presented in mono-spaced text, boxed, as shown below. Input text should use the background colour "aliceblue". For output text, the background colour should be white. | ||
* Code, whether single lines or blocks,use | * Code, whether single lines or blocks,use templates to ensure consistency | ||
* | * Check '''Edit''' to see the code to use the Input template: | ||
{{Input|1= | {{Input|1= | ||
| Line 52: | Line 52: | ||
nepomukserver}} | nepomukserver}} | ||
Output works the same way: | * Output works the same way: | ||
{{Output|1= | {{Output|1= | ||
terminal output | terminal output | ||
Revision as of 11:29, 9 July 2010
There are separate pages explaining Page Layout and syntax with example code.
Adhering to these typographic guidelines will ensure that your documentation can be accurately and easily exported for translation purposes.
Bold Text
Use bold text to highlight
- Window titles
- Common labels that are not user-configurable
- Icon captions
- Program names
- For example:
- Highlighting a selection of text will copy it to klipper.
Italic Text
Use italic text to emphasise
- Words or phrases as in general writing.
- Titles when referencing other works.
- The first use of an unfamiliar word.
- Some examples:
- Save your work at this point.
- Details can be found in Samba 3 by Example....
- KDE Manuals are in Docbook format.
Tip Programs are launched by users, components are used by programs
Combined Bold and Italic Text
Use this combination for replaceable or variable text.
Some examples:
- To connect to your remote server, type ssh username@domain.name in Konsole.
- In rpm-based distributions, the command rpm -q packagename will result in package-version-release.
Mono-spaced Text
Code should be presented in mono-spaced text, boxed, as shown below. Input text should use the background colour "aliceblue". For output text, the background colour should be white.
- Code, whether single lines or blocks,use templates to ensure consistency
- Check Edit to see the code to use the Input template:
qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit rm -r ~/.kde/share/apps/nepomuk rm -r ~/.kde4/share/apps/nepomuk nepomukserver
- Output works the same way:
terminal output is also shown as code, but on a white background
Special Tags
- <keycap> and </keycap> denote (keyboard) key names e.g. Enter
- <keycap></keycap> can also be used around groups of keys to be used concurrently, e.g. Ctrl+Alt+F1 to launch a virtual terminal. (Note that Note that "+" is used to link keys to be pressed concurrently).
- Sequences of menu choices should use <menuchoice> and </menuchoice> for example
- (Note the use of "(space)->(space)" to denote the sequence of clicks.)