FuzzyBot: Updating to match new version of source page

2012-12-08T17:07:18Z

Updating to match new version of source page

Fengchao at 09:35, 26 November 2012

2012-11-26T09:35:04Z

Fengchao: Created page with "''有个单独的常规语法页面，包含了示例代码。''"

2012-11-26T09:34:28Z

Created page with "''有个单独的常规语法页面，包含了示例代码。''"

Fengchao: Created page with "排版准则"

2012-11-26T09:33:15Z

Created page with "排版准则"

New page

<languages />

''There is a separate pages explaining [[Special:myLanguage/Toolbox|general 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|1=''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 <code>ssh</code> '''''username@domain.name''''' in '''Konsole'''.
* In rpm-based distributions, the command <code>rpm -q</code> '''''packagename''''' will result in '''''package-version-release'''''.

== Mono-spaced Text ==

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.

* Code, whether single lines or blocks, use templates to ensure consistency

* Use the Input template like this: {{Input|1=<nowiki>{{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>}}</nowiki>}} This will display like this: {{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>}}

* Output works the same way: {{Output|1=<nowiki>{{Output|1=<nowiki>terminal output
is also shown as code,
but on a grey background</nowiki>}}</nowiki>}} which displays as {{Output|1=<nowiki>terminal output
is also shown as code,
but on a grey background</nowiki>}}

{{Note|1=Note the use of <code><nowiki>1=<nowiki> some text </nowiki></nowiki></code> to avoid situations that break the display format}}

* Starting an Input or Output template on a new line will break the display format if it is within lists. Simply continue on the same line if you need to correct this.

* You can also combine input/output areas with [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi syntaxhiglighting]. An input area like this {{Input|1=<nowiki>{{Input|<syntaxhighlight lang="php" line>
# Initialise common code
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );
</syntaxhighlight>}}</nowiki>
}} will result in {{Input|<syntaxhighlight lang="php" line>
# Initialise common code
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );
</syntaxhighlight>}}

* Single code words can be kept in-line by using {{Input|1=<nowiki><code></code></nowiki>}} It will <code>display</code> like this.

* {{Input|1=<nowiki><tt> </tt></nowiki>}} is useful for displaying filenames and paths. This looks like this: <tt> a/path/to/here </tt>

== Block Quotes ==

The tags <nowiki><blockquote></nowiki> and <nowiki></blockquote></nowiki> should be used when quoting other works or other pages. This produces a proportional italic font, with some padding.

<blockquote>Here is an example of the display that you get by using the blockquote tags.</blockquote>

== Text in Section Headers ==

Even though the criteria above may be met, do not use Bold text in section headers or in links.

== Text in Information, Note, Tip or Warning Templates ==

Bold text should be avoided in the text within these templates. Italic text for emphasis may still be used - use sparingly for maximum effect.

== Lists ==

You can have various kinds of lists in your pages — bulleted, numbered or itemized. Find details on the [[Special:myLanguage/Toolbox#Bulleted Lists|Toolbox]] page.

== Keeping things together ==

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 <nowiki> </nowiki> 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 <nowiki> </nowiki>.

== Unbalanced brackets ==

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: 
{{Input|1=
<nowiki>{{ A line

Another line}}</nowiki>
}}
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 [[Special:myLanguage/Typographical_Guidelines#Keeping_things_together|Keeping things together]].)

== Special Tags ==

* <nowiki> <keycap></nowiki> and <nowiki> </keycap> </nowiki> denote (keyboard) key names e.g. <keycap>Enter</keycap>
* <nowiki><keycap></keycap></nowiki> can also be used around groups of keys to be used concurrently, e.g. <keycap>Ctrl + Alt + F1</keycap> to launch a virtual terminal. (Note that "(space)+(space)" is used to link keys to be pressed concurrently).
* Sequences of menu choices should use <nowiki> <menuchoice> </nowiki>and <nowiki> </menuchoice> </nowiki> for example <menuchoice> View -> Message List -> Aggregation -> Standard Mailing List </menuchoice>
* In general, if the user needs to choose an element, even if it is not in a menu, the <nowiki><menuchoice></menuchoiсe></nowiki> markup should be used.

== The Problematic Pipe Symbol ==

In some situations the pipe symbol cannot be used - for instance when giving parameters in a template - as it has a system meaning. In such cases please use <nowiki>{{!}}</nowiki>. For example, if you want to display a command line containing the pipe character using the <nowiki>{{Input|...}}</nowiki> template, the simplest way to do it is this: <code><nowiki>{{Input|1=cmd1 {{!}} cmd2}}</nowiki></code> which displays {{Input|1=cmd1 {{!}} cmd2}}

 If you just write <code><nowiki>{{Input|1=cmd1 | cmd2}}</nowiki></code> you get instead {{Input|1=cmd1 | cmd2}}
the problem being, that <code>cmd2</code> is seen as a second parameter to the template, which in this case is not used.

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>}}

== Translatable Content ==

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!".

[[Category:Translator_Help]]

@@ Line 1: / Line 1: @@
 <languages />
-''有个单独的 [[Special:myLanguage/Toolbox|常规语法]] 页面，包含了示例代码。''
+''有个单独的[[Special:myLanguage/Toolbox|常规语法]]页面，包含了示例代码。''
 Adhering to these typographic guidelines will ensure that your documentation can be accurately and easily exported for translation purposes.

@@ Line 133: / Line 133: @@
 == Translatable Content ==
-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>&lt;translate> and &lt;/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!".
 [[Category:Translator_Help]]

Typographical Guidelines/zh-cn - Revision history

FuzzyBot: Updating to match new version of source page

Fengchao at 09:35, 26 November 2012

Fengchao: Created page with "''有个单独的 常规语法 页面，包含了示例代码。''"

Fengchao: Created page with "排版准则"

Fengchao: Created page with "''有个单独的常规语法页面，包含了示例代码。''"