Toolbox/zh-cn: Difference between revisions
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
Line 186: | Line 186: | ||
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. | 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/Personal Information|Preferences-desktop-user.png| | |||
Settings for personal information handling}}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 enter 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 enter 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== | ==Illustrate Your Text== |
Revision as of 13:07, 8 August 2011
添加介绍截图和介绍描述
Whenever possible we begin an application's top-level page with this. The code to achieve it is
{|class="tablecenter vertical-centered" |[[Image:YourScreenshot.png|250px|thumb]] |Your descriptive text |}
不要添加i18n多语言栏
{{Template:I18n/Language Navigation Bar|Toolbox}} |
新的页面不该继续使用这种语言栏。这种语言栏是之前旧的翻译模板,现在换用了新的页面翻译插件。
添加介绍截图和描述
我们编写程序的顶层页面尽量以截图和描述开始。具体实现代码是
{| |[[Image:你上传的截图.png|250px|thumb]] |你的描述文本内容 |}
格式化你的文本
使用标题
- 标题自动成为你的目录的一部分,所以需要组织。他们在树中的位置由在标题两侧成对的'='字符规定的。避免使用一对单个字符 - 那象征了页面标题,应该使用自动页面标题( Avoid using a single one - that denotes a page heading, and the automatic page heading should be used)。你的大标题应该用'==文字写在这==',比大标题低一级的小标题用'===更多文字===',以此类推。
使用粗体和斜体
用点(Blips)来指定粗体和斜体文字。
用'''粗体文本'''(3个'符号)指定粗体文本以及''斜体文本''(2个'符号)指定斜体文本(中文的话还可以用「文本」来区分文字)。
为了确保我们之后的翻译轻松和准确,请遵守字体排印指导方针(涉及到文章的易读性)。
添加代码段
Add Indents
- ":" 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
===添加缩进===
Bulleted Lists
列表,编号列表(numbered)和符号列表(bulleted)
*是个用来做符号列表的符号。**是表示第二层次:
:* One star </span> <span class="mw-translate-fuzzy"> :* Next point </span> <span class="mw-translate-fuzzy"> :** Sub-point </span> * Raisins }}
produces
- Almonds
- Nuts
- Cashews
- Raisins
Enumerations
Enumerations are produced in the same way, using '#'.
# Sift # Mix ## Stir thoroughly # Bake
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:
* Nuts *# Cashew *# Crazy * Other things
produces
- Nuts
- Cashew
- Crazy
- Other things
while
# Nuts #* Cashew #* Crazy # Other things
produces
- Nuts
- Cashew
- Crazy
- Other things
Itemizations
Itemizations are produced using ; and : alternatively. They are best for giving short descriptions for a group of related objects.
;Animals : They move around and devour other creatures. ;Plants : They have roots and feed upon ground water and sun.
produces
- Animals
- They move around and devour other creatures.
- Plants
- They have roots and feed upon ground water and sun.
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 [[PageLayout]], 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 [[Special:myLanguage/PageLayout|Page Layout]], 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
[[Special:myLanguage/PageLayout|this page]]
which displays
Internal links to subsections of a page should look like this
[[Special:myLanguage/Tasks_and_Tools#Working_with_Languages|...]]
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:
</translate><span id="Working_with_Languages"></span><translate>
(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 </translate> and <translate> tags.
External links are slightly different so
[http://techbase.kde.org/Schedules our road map]
displays
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 Applications, you should use the AppItem
template. Simply enter
{| {{AppItem||System Settings/Personal Information|Preferences-desktop-user.png| Settings for personal information handling}}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 enter between the texts you get one section no matter how long the text is. |}
This gives the following display:
Settings for localized handling of numbers, dates, etc | |
A short text.
A few more short lines about the app. This is optional. | |
Shortcuts and Gestures | |
Another short text. If you do not type enter 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
[[Image:KMail-kde4.png|250px|center]]
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
{|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]] |}
displays
Note that all the parameters for one image are contained within [[...]], 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:
{{Info|This is general information}} displays
{{Note|Some important information at this point}} displays
{{Tip|A helpful piece of advice, something to remember}}displays
{{Warning|Take care - this is a dangerous thing to do}} displays
Where the strongest possible warning is needed, the Remember box can be used, but please use sparingly.
{{Remember|1=This is for things that definitely must not be forgotten}}
You can also change the heading:
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 an icon {{KDE3}} which displays Should you be writing about a KDE3 version and KDE SC 4 version on the same page, use icons for both - {{KDE4}} which displays
Other Useful Templates
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: {{Icon|list-add}}
. This will display the icon.
For this to work, the icon image must have been uploaded to the wiki. See Update an Image for an explanation on how to upload images. The .png files can usually be found here: usr/share/icons/oxygen. If possible use the 16x16 icon. The file name should have an Icon- prefix as in Icon-list-add.png — apart from the prefix the filename should exactly match the usual name. Note, that when using the template you should neither write the Icon- prefix nor the .png file type extension.
The icon can also be written as {{Plus}}
, and the icon as {{Minus}}
. You can also use {{Configure}}
to get the icon, and {{Exit}}
gets you the 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 {{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 {{Community-app-footnote}} which will create a footnote, like this:
Support for this application can be found from the project's home page
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 {{Being_Edited}} which will display
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 - {{Construction}}, which displays
Links to Pages in the Neighbourhood
You can add links to a preceding or a following page using the following templates as described here:
{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}
- ← The page before this page
- Toolbox/zh-cn
- This page you should read later →
For first pages with no preceeding page or last pages with no following page use this:
{{Next|Following Pagename|This page you should read later}}
- Toolbox/zh-cn
- This page you should read later →
{{Prev|Previous Pagename|The page before this page}}
- ← The page before this page
- Toolbox/zh-cn
Adding a List of Sub-Pages
== Subpages of {{FULLPAGENAME}} == {{Special:PrefixIndex/{{FULLPAGENAME}}/}}
is very useful when you want to list subpages with active links, such as
Subpages of Toolbox/zh-cn
It does, however, also list all "other-language" pages, so use with discretion.