View source for Toolbox/zh-cn

<languages />
{{Info/zh-cn|本页有常见任务所需的，格式相关代码}}

==添加介绍截图和介绍描述== 

我们编写程序的顶层页面尽量以截图和描述开始。具体实现代码是

{{Input|1=<nowiki>{|class="tablecenter vertical-centered"
|[[Image:你上传的截图.png|250px|thumb]]
|描述
|}</nowiki>}}

==格式化你的文本== 

===使用标题=== 

<span class="mw-translate-fuzzy">
新的页面不该继续使用这种语言栏。这种语言栏是之前旧的翻译模板，现在换用了新的页面翻译插件。
</span>

===使用'''粗体'''和''斜体''=== 

用点（Blips）来指定粗体和斜体文字。

用<nowiki>'''粗体文本'''（3个'符号）</nowiki>指定'''粗体文本'''以及<nowiki>''斜体文本''（2个'符号）</nowiki>指定''斜体文本''（中文的话还可以用「文本」来区分文字）。

为了确保我们之后的翻译轻松和准确，请遵守''[[Typographical_Guidelines|字体排印指导方针（涉及到文章的易读性）]]。''

===添加代码段=== 

<span class="mw-translate-fuzzy">
为了确保我们之后的翻译轻松和准确，请遵守''[[Typographical_Guidelines|字体排印指导方针（涉及到文章的易读性）]]。''
</span>

<span class="mw-translate-fuzzy">
===添加代码段===
</span>

===添加缩进=== 

:"''':'''" is used for an indent, and was used in multiples in some old pages.  This is deprecated, and causes some problems, so the multiples will be removed as they are found.  A single "''':'''" indents by four characters.

=== Format Dates ===

===添加缩进===<span id="Bulleted Lists"></span>
=== 符号列表（bulleted） === 

<nowiki>*</nowiki> 是个用来做符号列表的符号。**是表示第二层次:<br />

<span class="mw-translate-fuzzy">
:* Next point
</span>

* Nuts
** Cashews

* Raisins
</nowiki>}}<!--{{-->
显示效果

* Almonds

* Nuts
** Cashews

* Raisins

=== Enumerations === 

Enumerations are produced in the same way, using '#'.

{{Input|1=<nowiki>
# Sift
# Mix
## Stir thoroughly
# Bake
</nowiki>}}

produces

# Sift
# Mix
## Stir thoroughly
# Bake

=== Combining Bulleted Lists and Enumerations ===

You can have an enumerated sublist in a bulleted list and vice versa, like this:

{{Input|1=<nowiki>
* Nuts
*# Cashew
*# Crazy
* Other things
</nowiki>}}

produces

* Nuts
*# Cashew
*# Crazy
* Other things

while

{{Input|1=<nowiki>
# Nuts
#* Cashew
#* Crazy
# Other things
</nowiki>}}

produces

# Nuts
#* Cashew
#* Crazy
# Other things

{{Note|1=Enumerations should never have blank lines in them: it breaks the sequence and numbering starts at one again. Similarly, there should never be blank lines before a sublist item whether enumerated or bulleted: it creates two levels of item markings (bullets or numbers)}}

{{Note|1=Please remember, that long lists are a problem for translators. With single level bulleted lists, place each bullet in a section of its own, i.e. make a blank line between bullets. With two levels of bullets the subitems must be kept in the same section as their top level bullet; if you have to use subbullets, please keep the sublists short! With enumerations involved, you must keep everything in one unit. Please try to avoid enumerations, and if you find that you must use them try to keep them short.}}

{{Remember|3=Workaround|1=Though it is important to avoid blank lines in enumerations and nested lists it is still possible to split such lists in several translations units. This is highly recommended!}}

To get each bullet and each sub bullet in its own translation unit you can enter something like this:

{{Input|1=<nowiki>* First bullet</translate>
<translate>
** First sub bullet</translate>
<translate>
** Another sub bullet<br /><br />This one consists of two paragraphs</translate>
<translate>
* The next main bullet</translate>
<translate>
** And so on</nowiki>}}

This displays like this:

* First bullet
** First sub bullet
** Another sub bullet<br /><br />This one consists of two paragraphs
* The next main bullet
** And so on

The same method should apply to the other kinds of lists.

If on the other hand you need to have more sections in the same item, you can do something like this to have each section in a translation unit of its own:

{{Input|1=<nowiki>* First bullet</translate>
<translate>
* Second bullet, first section.</translate><br /><br /><translate>Second section of the
second bullet. This section has a translation unit of its own</translate>
<translate>
* And so on</nowiki>}}

This displays like this:

* First bullet
* Second bullet, first section.<br /><br />Second section of the second bullet. This section has a translation unit of its own
* And so on

=== Itemizations ===

Itemizations are produced using ''';''' and ''':''' alternatively.  They are best for giving short descriptions for a group of related objects.

<!--}}-->{{Input|1=<nowiki>
;Animals
: They move around and devour other creatures.

;Plants
: They have roots and feed upon ground water and sun.
</nowiki>}}<!--{{-->
produces

;Animals
: They move around and devour other creatures.

;Plants
: They have roots and feed upon ground water and sun.

{{Note|1=As allways, please keep each item in a section of its own; it helps translators a lot.}}

===Add a Link=== 

There are three kinds of links to learn, internal ones, to another userbase page, internal links to a section of a userbase page, and external URL links.

For an internal link the format <nowiki>[[PageLayout]]</nowiki>, where you want to display the name of the page, does work, but it is not ideal, particularly for translation to docbook and for localisation.  It is better to use the form <nowiki>[[Special:myLanguage/PageLayout|Page Layout]]</nowiki>, because that allows translators to link correctly even though the page name is localised.  The result is that it directs to the correctly translated page, if one exists. You often need to include the link in a sentence, so in that case you would use 

{{Input|1=<nowiki>[[Special:myLanguage/PageLayout|this page]]</nowiki>}} which displays 
[[Special:myLanguage/PageLayout|this page]]

Internal links to subsections of a page should look like this {{Input|1=<nowiki>[[Special:myLanguage/Tasks_and_Tools#Working_with_Languages|...]]</nowiki>}}With this kind of link it is very important, that the page you link to has a subpage anchor immediately before the section you link to. It should look like this: {{Input|1=<nowiki></translate><span id="Working_with_Languages"></span><translate></nowiki>}}(in this example - the id should match the title of the section) and should be place immediately before the section headline with a blank line separating the anchor and the headline.

If the page containing the section that you link to is not yet marked up for translation, you should omit the <nowiki></translate> and <translate></nowiki> tags.

External links are slightly different so

{{Input|1=<nowiki>[http://techbase.kde.org/Schedules our road map]</nowiki>}} displays 
[http://techbase.kde.org/Schedules our road map], which would take you straight to the techbase page.

One last thing to note - when you preview your page, all links are live.  This gives you two benefits. You can check (by hovering) that your links are set up as you expected, and you can use a red link to create a new page.

=== Make an application list ===

If you want to make a list of applications like the ones in the subpages of [[Special:myLanguage/Applications|Applications]], you should use the <code>AppItem</code> template. Simply enter

{{Input|1=<nowiki>{|
{{AppItem|System Settings/Locale|Preferences-desktop-locale.png|
Settings for localized handling of numbers, dates, etc}}A short text.
A few more short lines about the app. This is optional.
|-
{{AppItem|System Settings/Shortcuts and Gestures|Preferences-desktop-keyboard.png|
Shortcuts and Gestures}}Another short text. If you do not type <keycap>Enter</keycap> between the texts
you get one section no matter how long the text is.
|}</nowiki>}}

This gives the following display:

{|
{{AppItem|System Settings/Locale|Preferences-desktop-locale.png|
Settings for localized handling of numbers, dates, etc}}A short text.
A few more short lines about the app. This is optional.
|-
{{AppItem|System Settings/Shortcuts and Gestures|Preferences-desktop-keyboard.png|
Shortcuts and Gestures}}Another short text. If you do not type <keycap>Enter</keycap> between the texts you get one section no matter how long the text is.
|}

Note, that you should not prepend "Special:myLanguage" to the page name - the template takes care of that. Also note, that you must give a title, even if the title is the same as the page name.

==Illustrate Your Text== 

===Add a single image, centered=== 

{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}

Note that you can change the position of the image, but the default is left.  The size of the image depends on the circumstances, but for screenshots I recommend no less than 250px and no more than 500px.

===Make the Image Clickable, and Add a Caption=== 

Where you need to show more detail, create a moderately sized image, clickable, so that the full-size can be seen.  Simply add the parameter '|thumb' within the image parentheses.

A caption can also be added as a parameter, but will only show if '|thumb' is present.

===Use Tables to Precisely Place Multiple Images=== 

{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|-
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]
|}</nowiki>}}

displays

{|class="tablecenter" style="border: 1px solid grey;"
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|-
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]
|}



Note that all the parameters for one image are contained within <nowiki>[[...]]</nowiki>, and cells are separated by '||'.  To start a new line, insert '|-' on an otherwise-empty line, then '|' at the start of the next one.

==Add Notes and Warnings== 

Where a note or warning is relevant within your text, use these templates:

<nowiki>{{Info|This is general information}}</nowiki> displays
{{Info|This is general information}}

<nowiki>{{Note|Some important information at this point}}</nowiki> displays
{{Note|Some important information at this point}}

<nowiki>{{Tip|A helpful piece of advice, something to remember}}</nowiki>displays
{{Tip|A helpful piece of advice, something to remember}}

<nowiki>{{Warning|Take care - this is a dangerous thing to do}}</nowiki> displays
{{Warning|Take care - this is a dangerous thing to do}}

Where the strongest possible warning is needed, the Remember box can be used, but please use sparingly.
<nowiki>{{Remember|1=This is for things that definitely must not be forgotten}}</nowiki>
{{Remember|1=This is for things that definitely must not be forgotten}}

You can also change the heading:

{{Remember|3=Don't Forget This!|1=You can use parameter number 3 to set an individual box heading:
{{Input|1=<nowiki>{{Remember|3=Don't Forget This!|1=You can use...}}</nowiki>}}}}

==KDE3 and KDE SC 4 Versions of Applications== 

By default, KDE SC 4 is assumed.  If the KDE SC 4 version is not yet ready for release, or where only a KDE 3 version exists, it may be necessary to document the KDE3 version.  In this case you should add the template {{tl|KDE3}} 
which displays {{KDE3}}
Should you be writing about a KDE3 version and KDE SC 4 version on the same page, use icons for both — {{tl|KDE4}} which displays {{KDE4}}

==Other Useful Templates== 
<span id="Inserting GUI Icons"></span>
=== Inserting GUI Icons ===

The best way to refer to icons in the GUI is to display it in the text. This can be done with a template like this: <code><nowiki>{{Icon|list-add}}</nowiki></code>. This will display the {{Icon|list-add}} icon.

For this to work, the icon image must have been uploaded to the wiki. See [[Special:myLanguage/Update_an_Image|Update an Image]] for an explanation on how to upload images. The .png files can usually be found here: <tt>usr/share/icons/oxygen</tt>. If possible use the 16x16 icon. The file name should have an <tt>Icon-</tt> prefix as in <tt>Icon-list-add.png</tt> &mdash; apart from the prefix the filename should exactly match the usual name. Note, that when using the template you should neither write the <tt>Icon-</tt> prefix nor the <tt>.png</tt> file type extension.

The {{Plus}} icon can also be written as <code><nowiki>{{Plus}}</nowiki></code>, and the {{Minus}} icon as <code><nowiki>{{Minus}}</nowiki></code>. You can also use <code><nowiki>{{Configure}}</nowiki></code> to get the {{Configure}} icon, and <code><nowiki>{{Exit}}</nowiki></code> gets you the {{Exit}} icon.

===Community Applications=== 

The final consideration concerns those applications which are not distributed as core KDE applications.  These need to be indicated by an icon, placing <nowiki>{{Community-app}}</nowiki>

{{Community-app}}

at the end of your sentence or line, just as you would to denote a footnote in general writing.  You then need to add <nowiki>{{Community-app-footnote}}</nowiki> which will create a footnote, like this:

{{Community-app-footnote}}

===Making Major Edits to Existing Pages=== 

If a page is likely to be open for editing for some time there is a danger of conflicts - someone else may edit at the same time, and saving your edit will cancel out theirs, or vice versa.  The way to avoid that is to make a temporary entry, directly under the language bar, using <nowiki>{{Being_Edited}}</nowiki> which will display

{{Being_Edited}}

''Don't forget to remove it when you have finished!''

===Adding a New Complex Page=== 

If you need to be able to work on a page for quite some time, over several days, for instance, you may like to use the Construction template - <nowiki>{{Construction}}</nowiki>, which displays

{{Construction}}

===Links to Pages in the Neighbourhood=== 

You can add links to a preceding or a following page using the following templates as described here:
{{Input|1=<nowiki>{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}</nowiki>}}
{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}

For first pages with no preceeding page or last pages with no following page use this:
{{Input|1=<nowiki>{{Next|Following Pagename|This page you should read later}}</nowiki>}}
{{Next|Following Pagename|This page you should read later}}
{{Input|1=<nowiki>{{Prev|Previous Pagename|The page before this page}}</nowiki>}}
{{Prev|Previous Pagename|The page before this page}}

==Adding a List of Sub-Pages== 

{{Input|1=<nowiki>== Subpages of {{FULLPAGENAME}} ==
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}

is very useful when you want to list subpages with active links, such as 

=== Subpages of {{FULLPAGENAME}}=== 

It does, however, also list all "other-language" pages, so use with discretion.

{{Special:PrefixIndex/{{FULLPAGENAME}}/}}


----


[[Category:贡献/zh-cn]]