Centerlink (Talk | contribs) (Created page with "== Erikoistunnisteet ==") |
Centerlink (Talk | contribs) (Created page with "== Kotoistettava sisältö ==") |
||
| Line 131: | Line 131: | ||
In many cases, you can also enclose the text containing the pipe character between <nowiki><nowiki>...</nowiki> </nowiki> tags, like this <code><nowiki>{{Input|1=<nowiki>cmd1 | cmd2</nowiki></nowiki><nowiki>}}</nowiki></code>, which also displays {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}} | In many cases, you can also enclose the text containing the pipe character between <nowiki><nowiki>...</nowiki> </nowiki> tags, like this <code><nowiki>{{Input|1=<nowiki>cmd1 | cmd2</nowiki></nowiki><nowiki>}}</nowiki></code>, which also displays {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}} | ||
| − | == | + | == Kotoistettava sisältö == |
Everything that is translatable is contained within <nowiki><translate> and </translate></nowiki> tags. In most cases any images should be contained within the translatable section, as it is sometimes necessary to use localised versions of the images to explain a point. The rule of thumb is "If in doubt, include it!". | Everything that is translatable is contained within <nowiki><translate> and </translate></nowiki> tags. In most cases any images should be contained within the translatable section, as it is sometimes necessary to use localised versions of the images to explain a point. The rule of thumb is "If in doubt, include it!". | ||
There is a separate pages explaining general syntax with example code.
Adhering to these typographic guidelines will ensure that your documentation can be accurately and easily exported for translation purposes.
Use bold text to highlight
For example:
Use italic text to emphasise
Some examples:
| Tip |
|---|
| Programs are launched by users, components are used by programs |
Use this combination for replaceable or variable text.
Some examples:
KDE TechBase 
• 
• 
• ssh username@domain.name in Konsole.
rpm -q packagename will result in package-version-release.
Code should be presented in mono-spaced text, usually boxed, as shown below. Input text will be on a pale yellow background. For output text, the background colour will be violet-grey.
{{Input|1=<nowiki>
qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
rm -r ~/.kde/share/apps/nepomuk
rm -r ~/.kde4/share/apps/nepomuk
nepomukserver</nowiki>}} This will display like this: qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit rm -r ~/.kde/share/apps/nepomuk rm -r ~/.kde4/share/apps/nepomuk nepomukserver
{{Output|1=<nowiki>terminal output
is also shown as code,
but on a grey background</nowiki>}} which displays as terminal output is also shown as code, but on a grey background
| Note |
|---|
Note the use of 1=<nowiki> some text </nowiki> to avoid situations that break the display format |
{{Input|<syntaxhighlight lang="php" line>
# Initialise common code
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );
</syntaxhighlight>}} will result in
# Initialise common code
<code></code>It will
display like this.
<tt> </tt>is useful for displaying filenames and paths. This looks like this: a/path/to/here
The tags <blockquote> and </blockquote> should be used when quoting other works or other pages. This produces a proportional italic font, with some padding.
Here is an example of the display that you get by using the blockquote tags.
Even though the criteria above may be met, do not use Bold text in section headers or in links.
Bold text should be avoided in the text within these templates. Italic text for emphasis may still be used - use sparingly for maximum effect.
You can have various kinds of lists in your pages — bulleted, numbered or itemized. Find details on the Toolbox page.
After your text is written some markup is automatically added by the translation system. This means that whenever it sees a blank line, it starts a new unit. When your text is presented to translators, they typically see it one unit at a time, so it is important not to leave a blank lines in the middle of something that should be treated as a unit. Normally an entire paragraph should be kept in a single unit; and under no circumstance should a sentence be split between units!
If you need a linebreak in the middle of a section, the preferred way to achieve this is without breaking units is to use <br /> at the end of the line where you want to break to occur (not on a new line). If you need space between the lines add <br /><br />.
The translation system marks any translated unit as incompletely translated if it contains any kind of unbalanced brackets. If you need to have unbalanced brackets in your text, please add a balancing bracket in a comment tag, like this:
<!-- }} -->{{ A line
Another line}}<!-- {{ -->
This goes for all kinds of brackets, even ordinary parentheses. (Of course it is normally better to avoid blank lines within a mark up unit - see Keeping things together.)
{{Input|1=cmd1 {{!}} cnd2}} which displays cmd1 | cnd2
{{Input|1=cmd1 | cnd2}} you get instead cnd2
the problem being, that cmd2 is seen as a second parameter to the template, which in this case is not used.
{{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}, which also displays cmd1 | cmd2
Everything that is translatable is contained within <translate> and </translate> tags. In most cases any images should be contained within the translatable section, as it is sometimes necessary to use localised versions of the images to explain a point. The rule of thumb is "If in doubt, include it!".
