Toolbox/zh-cn: Difference between revisions

From KDE UserBase Wiki
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(121 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages />
<languages />
{{Info/zh-cn|本页有常见任务所需的,格式相关代码}}
{{Info/zh-cn|本页介绍常见任务的格式代码和示例}}


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


Whenever possible we begin an application's top-level page with this.  The code to achieve it is
应用程序的顶层页面尽量以截图和描述开始。具体实现代码是


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


==不要添加i18n多语言栏==  
==格式化文本==  


{|style="width:75%; border:2px dotted #BCBCBC;" align="center"
===使用标题===
|<nowiki>{{Template:I18n/Language Navigation Bar|Toolbox}}</nowiki>
|}


<span class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
新的页面不该继续使用这种语言栏。这种语言栏是之前旧的翻译模板,现在换用了新的页面翻译插件。
每个标题独占以行,以两个或更多 '=' 字符开始和结束。页面有多个标题时,会自动创建目录。'=' 字符的个数决定目录中的层级。应该使用 '==标题==', '===次标题===', '====三级标题===='这样的层级。请避免使用单个 '=' ,这个层级作为 wiki 页面的名称使用;例如 "{{PAGENAME}}" 会成为页面的标题。
</span>
</div>


<span class="mw-translate-fuzzy">
===使用'''粗体'''和''斜体''===  
==添加介绍截图和描述==


我们编写程序的顶层页面尽量以截图和描述开始。具体实现代码是
用点(Blips)来指定粗体和斜体文字。
</span>
 
<span class="mw-translate-fuzzy">
<pre style="background:lemonchiffon">
{|
|[[Image:你上传的截图.png|250px|thumb]]
|你的描述文本内容
|}
</pre>
</span>


<span class="mw-translate-fuzzy">
<nowiki>'''粗体文本'''(3个'符号)</nowiki>指定'''粗体文本'''以及<nowiki>''斜体文本''(2个'符号)</nowiki>指定''斜体文本''(中文的话还可以用「文本」来区分文字)。
==格式化你的文本==
===使用标题===
:标题自动成为你的目录的一部分,所以需要组织。他们在树中的位置由在标题两侧成对的'='字符规定的。避免使用一对单个字符 - 那象征了页面标题,应该使用自动页面标题( Avoid using a single one - that denotes a page heading, and the automatic page heading should be used)。你的大标题应该用'==文字写在这==',比大标题低一级的小标题用'===更多文字===',以此类推。
</span>


<span class="mw-translate-fuzzy">
为了确保我们之后的翻译轻松和准确,请遵守''[[Typographical_Guidelines|字体排印指导方针]]。''
===使用'''粗体'''和''斜体''===
用点(Blips)来指定粗体和斜体文字。
</span>


用<nowiki>'''粗体文本'''(3个'符号)</nowiki>指定'''粗体文本'''以及<nowiki>''斜体文本''(2个'符号)</nowiki>指定''斜体文本''(中文的话还可以用「文本」来区分文字)。
===添加代码段===


<span class="mw-translate-fuzzy">
为了正确显示代码段,我们提供了辅助模板。具体使用方式请阅读[[Typographical_Guidelines|排版指导方针]]。
为了确保我们之后的翻译轻松和准确,请遵守''[[Typographical_Guidelines|字体排印指导方针(涉及到文章的易读性)]]。''
</span>


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


===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 ===
=== 格式化日期 ===


===添加缩进===<span id="Bulleted Lists"></span>
不同地区对纯数字的日期格式理解不一样,所以请使用 {{Input|1=<nowiki>2015-06-16</nowiki>}} 这样的完整日期格式,年份要使用四位数字。<span id="Bulleted Lists"></span>
=== Bulleted Lists ===  
=== 符号列表 ===  


<span class="mw-translate-fuzzy">
符号列表用<nowiki>*</nowiki> 标记,**表示第二层次:<br />
===列表,编号列表(numbered)和符号列表(bulleted)===
<nowiki>*</nowiki>是个用来做符号列表的符号。**是表示第二层次:
<nowiki>
:* One star
</span>


<span class="mw-translate-fuzzy">
<!--}}-->{{Input|1=<nowiki>
:* Next point
* Almonds
</span>


<span class="mw-translate-fuzzy">
* Nuts
:** Sub-point
** Cashews
</span>


* Raisins
* Raisins
</nowiki>}}<!--{{-->
</nowiki>}}<!--{{-->
produces
显示为:


* Almonds
* Almonds
Line 92: Line 63:
* Raisins
* Raisins


=== Enumerations ===  
=== 编号列表 ===  


Enumerations are produced in the same way, using '#'.
编号列表用同样的方式生成,用'#'


{{Input|1=<nowiki>
{{Input|1=<nowiki>
Line 103: Line 74:
</nowiki>}}
</nowiki>}}


produces
显示为:


# Sift
# Sift
Line 110: Line 81:
# Bake
# Bake


=== Combining Bulleted Lists and Enumerations ===
详情请阅读 [http://meta.wikimedia.org/wiki/Help:List wikimedia] 中的列表说明.
 
=== 混合符号列表和编号列表 ===


You can have an enumerated sublist in a bulleted list and vice versa, like this:
可以混合使用符号列表和编号列表,例如:


{{Input|1=<nowiki>
{{Input|1=<nowiki>
Line 121: Line 94:
</nowiki>}}
</nowiki>}}


produces
显示为:


* Nuts
* Nuts
Line 128: Line 101:
* Other things
* Other things


while


{{Input|1=<nowiki>
{{Input|1=<nowiki>
Line 137: Line 110:
</nowiki>}}
</nowiki>}}


produces
显示为:


# Nuts
# Nuts
Line 144: Line 117:
# Other things
# 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/zh-cn|1=编号列表中不应该有空行:空行会导致重新编号。同时,符号列表和编号列表的子列表中也不应该有空行,否则会产生两个子列表。}}


{{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.}}
{{Note/zh-cn|1=长列表会增加翻译难度。如果是单层符号列表,请在每行之间插入一个空行。这样的话每行都是一个单独的翻译单元。如果是多层符号列表,所有子列表必须和上层列表项放在同一个翻译单元中。所以如果必须使用多层列表,请尽量保持子列表的简短。如果是编号列表,所有的内容必须放在同一个翻译单元内。尽量避免使用编号列表,如果必须使用,请尽量简短。}}


{{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!}}
{{Remember/zh-cn|2=Workaround|1=在符号列表中应该避免空行和子列表,如果真的使用了,可以有一个方法将它们分割到多个翻译单元。}}


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>
{{Input|1=<nowiki>* First bullet &lt;/translate &gt;
<translate>
&lt;translate &gt;
** First sub bullet</translate>
** First sub bullet &lt;/translate &gt;
<translate>
&lt;translate &gt;
** Another sub bullet<br /><br />This one consists of two paragraphs</translate>
** Another sub bullet<br /><br />This one consists of two paragraphs &lt;/translate &gt;
<translate>
&lt;translate &gt;
* The next main bullet</translate>
* The next main bullet &lt;/translate &gt;
<translate>
&lt;translate &gt;
** And so on</nowiki>}}
** And so on</nowiki>}}


This displays like this:
显示为:


* First bullet
* First bullet
Line 170: Line 143:
** And so on
** 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>
{{Input|1=<nowiki>* First bullet &lt;/translate &gt;
<translate>
&lt;translate &gt;
* Second bullet, first section.</translate><br /><br /><translate>Second section of the
* Second bullet, first section. &lt;/translate&gt;<br /><br /> &lt;translate &gt; Second section of the
second bullet. This section has a translation unit of its own</translate>
second bullet. This section has a translation unit of its own &lt;/translate &gt;
<translate>
&lt;translate &gt;
* And so on</nowiki>}}
* And so on</nowiki>}}


This displays like this:
显示为:


* First bullet
* First bullet
Line 206: Line 179:
: They have roots and feed upon ground water and sun.
: 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.}}
{{Note|1=As always, 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.
有三种类型的链接可以学,内部链接,链接到另外一个userbase页面,和外部URL链接。


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
内部链接的话,你可以用这种格式<nowiki>[[PageLayout]]</nowiki>,直接显示页面的名称。但这种方式不太好,尤其是对于译成docbook文档,最好用这种形式<nowiki>[[PageLayout|Page Layout]]</nowiki>,避免了翻译者那边的问题。你经常需要在一个句子里包含链接,所以那种情况下你要用


{{Input|1=<nowiki>[[Special:myLanguage/PageLayout|this page]]</nowiki>}} which displays
{{Input|1=<nowiki>[[Special:myLanguage/PageLayout|这个页面]]</nowiki>}} 这样的话会显示
[[Special:myLanguage/PageLayout|this page]]
[[Special:myLanguage/PageLayout|这个页面]]


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.
Internal links to subsections of a page use character '#' (hash) and 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 declares the reference anchor. If the anchor contains space characters, replace them by character '_' (underscore) when calling the reference. If the reference is found, the section will be automatically displayed by your browser (if it manages anchors). If it is not the case, you will have to go down through the page to find the referenced section.


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 given as the URL and a text separated by a space and delimited by single square brackets as in {{Input|1=<nowiki>[https://en.wikipedia.org/wiki/KDE KDE's Wikipedia page]</nowiki>}} which gives [https://en.wikipedia.org/wiki/KDE KDE's Wikipedia page].


External links are slightly different so
=== Anchor declaration ===


{{Input|1=<nowiki>[http://techbase.kde.org/Schedules our road map]</nowiki>}} displays
Anchor declaration must be done immediatly BEFORE the referenced section, and followed by a blank line separating the anchor and its headline. In the following example just copy in the ID value, the title of associated section. It should look like this: 
[http://techbase.kde.org/Schedules our road map], which would take you straight to the techbase page.
{{Input|1=<nowiki>&lt;/translate&gt;<span id="Working with Languages"></span> &lt;translate&gt;</nowiki>}}


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.
If the page containing the section that you link to is not yet marked up for translation, you should omit the <nowiki>&lt;/translate &gt; and &lt;translate &gt;</nowiki> tags.
 
外部链接稍微有些不同,所以
 
{{Input|1=<nowiki>[http://techbase.kde.org/Schedules 我们的路线图]</nowiki>}}显示[http://techbase.kde.org/Schedules 我们的路线图] 会带你直达techbase页面。
 
最后需要注意的一点 - 当你预览你的页面时,链接已经生效可以用了。这对你有两个好处。你可以(悬停鼠标指针到链接上)检查是否你的链接设定的跟你期望的一样,并且你可以用一个红色链接来创建一个新页面。


=== Make an application list ===
=== Make an application list ===
Line 255: Line 234:
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.
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==  
=== Footnotes ===
 
Footnotes are rarely used in our pages, but if you need them you can place a <code><nowiki><ref></nowiki>''text''<nowiki></ref></nowiki></code> in the source where the footnote mark should appear. There has to be one <code><nowiki><references /></nowiki></code> somewhere in the source as well, usually towards the end of the page. This is where the text added by the <nowiki><ref></nowiki> tags will appear. For more info see the [http://en.wikipedia.org/wiki/Help:Footnotes Wikipedia help page].
 
==附上图片==  


===Add a single image, centered===  
===添加单幅图片,居中===  


<div class="mw-translate-fuzzy">
{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}
{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}
</div>
注意你能修改图片的位置,但默认位置是左侧(left)。图片的大小依赖于具体情况,但对于截图,我推荐时不小于250px以及不大于500px。
Also note that <code>Image:</code> and <code>File:</code> are synonyms.
So that  <code><nowiki>[[Image:KMail-kde4.png]]</nowiki></code> is the same as <code><nowiki>[[File:KMail-kde4.png]]</nowiki></code>. However <code>Image:</code> is deprecated, so prefer <code>File:</code> in new content.
see [http://www.mediawiki.org/wiki/Help:Images mediawiki] for more info.
<div class="mw-translate-fuzzy">
===使图片可点击,并添加标题===
</div>
在你需要展示更多细节的地方,创建一张适当大小的图片,图可以点击以便查看全尺寸的大图。简单的添加一个参数'|thumb'到图片括号内就行。
标题也可以作为参数添加进去,但只会在提供'|thumb'的情况下显示。
例如:
{{Input|1=<nowiki>[[File:file_name.png|thumb|this will be the caption]]</nowiki>}}
=== Add a caption without a thumbnail ===
Captions also appear on images marked up with the frame syntax.
例如:


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.
{{Input|1=<nowiki>[[File:image.png|frame|left|这是标题]]
</nowiki>}}


===Make the Image Clickable, and Add a Caption===  
===Prevent text from flowing around image===


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.
Sometimes you might not want the text to flow down the sides of your image. You can prevent this by adding a <code><nowiki> <br clear=all> </nowiki></code> tag between the file tag and the text in question.


A caption can also be added as a parameter, but will only show if '|thumb' is present.
Example:
{{Input|1=<nowiki>[[File:image.png]]
<br clear=all>
This text would normally flow down the sides of the image but now it will be found under the image
</nowiki>}}


===Use Tables to Precisely Place Multiple Images===  
<div class="mw-translate-fuzzy">
===用表格精确的放置多张图片===
</div>


{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"
{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"
Line 277: Line 294:
|}</nowiki>}}
|}</nowiki>}}


displays
显示


{|class="tablecenter" style="border: 1px solid grey;"
{|class="tablecenter" style="border: 1px solid grey;"
Line 287: Line 304:




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.
注意显示一张图片的所有参数都要被包含在<nowiki>[[...]]</nowiki>内,而且,多个单元(不同的图片)要用'||'分离。要开始新的一行,插入'|-'
 
For more details on Table formating see [http://www.mediawiki.org/wiki/Help:Tables mediawiki]
<span id="Embed a Video"></span>
=== Embed a Video ===
 
As of July 2012 the MediaWiki [http://www.mediawiki.org/wiki/Extension:EmbedVideo EmbedVideo] extension has been installed on userbase.kde. This means you can embed videos from various video hosting sites into the page content and have them display in line.


==Add Notes and Warnings==
EmbedVideo parser function expects to be called in any of the following ways:


Where a note or warning is relevant within your text, use these templates:
<nowiki> {{#ev:service|id}} </nowiki> <br />
<nowiki> {{#ev:service|id|width}}</nowiki><br />
<nowiki> {{#ev:service|id|width|align}}</nowiki><br />
<nowiki> {{#ev:service|id|width|align|desc}}</nowiki><br />
<nowiki> {{#evp:service|id|desc}}</nowiki><br />
<nowiki> {{#evp:service|id|desc|align}}</nowiki><br />
<nowiki> {{#evp:service|id|desc|align|width}}</nowiki><br />


<nowiki>{{Info|This is general information}}</nowiki> displays
Where: <br />
{{Info|This is general information}}
service is the name of a video sharing service (See "service name" in the list below)
id is the id of the video to include
width (optional) is the width in pixels of the viewing area (height will be determined automatically)
align (optional) is an alignment (float) attribute. May be "left" or "right".
desc (optional) is a short description to display beneath the video when it is aligned


<nowiki>{{Note|Some important information at this point}}</nowiki> displays
For example, to include the famous "evolution of dance" YouTube video, you'd enter:
{{Note|Some important information at this point}}
<pre>{{#ev:youtube|dMH0bHeiRNg}}</pre>


<nowiki>{{Tip|A helpful piece of advice, something to remember}}</nowiki>displays
And if you wanted scaled down to thumbnail size, on the right with a short description, you could use:
{{Tip|A helpful piece of advice, something to remember}}
<pre>{{#ev:youtube|dMH0bHeiRNg|100|right|This is an embedded video!}}</pre>


<nowiki>{{Warning|Take care - this is a dangerous thing to do}}</nowiki> displays
 
{{Warning|Take care - this is a dangerous thing to do}}
As of version 1.0, EmbedVideo supports embedding video content from the following services:
{| class="wikitable"
|-
! Site
! Service Name
|-
! [http://www.dailymotion.com/ Dailymotion]
| <tt>dailymotion</tt>
|-
! Div Share
| <tt>divshare</tt>
|-
! [http://edutopia.org Edutopia]
| <tt>edutopia</tt>
|-
! [http://www.funnyordie.com/ FunnyOrDie]
| <tt>funnyordie</tt>
|-
! [http://video.google.com/ Google Video]
| <tt>googlevideo</tt>
|-
! [http://interia.pl/ Interia]
| <tt>interia</tt> or <tt>interiavideo</tt>
|-
! [http://revver.com/ Revver]
| <tt>revver</tt>
|-
! [http://sevenload.com/ sevenload]
| <tt>sevenload</tt>
|-
! [http://teachertube.org TeacherTube]
| <tt>teachertube</tt>
|-
! [http://www.youtube.com/ YouTube]
| <tt>youtube</tt> and <tt>youtubehd</tt>
|-
! [http://www.vimeo.com Vimeo]
| <tt>vimeo</tt>
|}
<span id="Add Notes and Warnings"></span>
==添加附注(Notes)和警告(Warnings)==
 
{{Warning|2=Important|1=Indented boxes do not display correctly! Never put a colon in front of a box; it will make the box look very odd.}}
 
在需要添加跟你的文本有关的附注或警告的地方,用表格,像是这样的:
 
<nowiki>{{Info/zh-cn|常规提示信息}}</nowiki> displays
{{Info/zh-cn|常规提示信息}}
 
<nowiki>{{Note/zh-cn|重要的信息}}</nowiki> 显示
{{Note/zh-cn|重要的信息}}
 
<nowiki>{{Tip/zh-cn|需要记住的有用信息}}</nowiki>displays
{{Tip/zh-cn|需要记住的有用信息}}
 
<nowiki>{{Warning/zh-cn|这样做很危险}}</nowiki> 显示
{{Warning/zh-cn|这样做很危险}}


Where the strongest possible warning is needed, the Remember box can be used, but please use sparingly.
Where the strongest possible warning is needed, the Remember box can be used, but please use sparingly.
Line 311: Line 400:
You can also change the heading:
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:
{{Remember|2=Don't Forget This!|1=You can use parameter number 2 to set an individual box heading:
{{Input|1=<nowiki>{{Remember|3=Don't Forget This!|1=You can use...}}</nowiki>}}}}
{{Input|1=<nowiki>{{Remember|2=Don't Forget This!|1=You can use...}}</nowiki>}}}}
 
==Page Redirection==
You can make a page to redirect to another page automatically by using:
<pre>#REDIRECT [[Pagename]]</pre>


==KDE3 and KDE SC 4 Versions of Applications==  
==程序的KDE3和KDE SC 4版本区分==  


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}}  
默认情况下都是假定是KDE SC 4版本。如果KDE SC 4版本还没完成发布的话,有必要去写KDE3版本。在这种情况下,你应该添加图标<nowiki>{{KDE3}}</nowiki>,它会显示{{KDE3/tla}}。要是你在同一个页面里写KDE3版本和KDE SC 4版本,用这个图标 - {{tl|KDE4}},它会显示{{KDE4}}
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>
<span id="Inserting GUI Icons"></span>
=== Inserting GUI Icons ===
=== Inserting GUI Icons ===
Line 330: Line 421:
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.
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>
最后关心的一点是那些并不作为核心KDE应用程序发布的程序(译者注:大意应该是其他非KDE的社区开发的程序)。那些需要用图标指明,放置<nowiki>{{Community-app/zh-cn}}</nowiki>


{{Community-app}}
{{Community-app/zh-cn}}


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:
在你句子或一行的末尾,如同你在普通书写中表示一个脚注一样。然后你需要添加<nowiki>{{Community-app-footnote/zh-cn}}</nowiki>,它会显示脚注,像是这样子:


{{Community-app-footnote}}
{{Community-app-footnote/zh-cn}}


===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
如果一个页面像是打开要做一段时间的编辑修改,可能会有冲突的危险 - 其他某个人或许同时也在编辑,这时保存你的编辑会取消掉他们的修改,或者反过来也是一样的。避免的方法是做一个临时的词条,直接挂在语言栏下面,使用<nowiki>{{Being_Edited/zh-cn}}</nowiki>,它会显示


{{Being_Edited}}
{{Being_Edited/zh-cn}}


''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/zh-cn模板 - <nowiki>{{Construction/zh-cn}}</nowiki>,显示如下


{{Construction}}
{{Construction/zh-cn}}


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


You can add links to a preceding or a following page using the following templates as described here:
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>}}
{{Input|1=<nowiki>{{Prevnext2|prevpage=Previous Pagename|nextpage=Following Pagename|prevtext=The page before this page|nexttext=This page you should read later|index=Index page|indextext=Back to Menu}}</nowiki>}}
{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}
{{Prevnext2|prevpage=Previous Pagename|nextpage=Following Pagename|prevtext=The page before this page|nexttext=This page you should read later|index=Index page|indextext=Back to Menu}}
 
All six arguments are optional. For first pages with no preceeding page or last pages with no following page use this:
{{Input|1=<nowiki>{{Prevnext2|nextpage=Following Pagename|nexttext=This page you should read later}}</nowiki>}}
{{Prevnext2|nextpage=Following Pagename|nexttext=This page you should read later}}
{{Input|1=<nowiki>{{Prevnext2|prevpage=Previous Pagename|prevtext=The page before this page}}</nowiki>}}
{{Prevnext2|prevpage=Previous Pagename|prevtext=The page before this page}}
If you don't specify an <code>indexname</code> the name of the current page will be displayed.
 
{{Note|1=You should always specify a text for the pages you link to, and you should always use <code>Special:myLanguage</code> with your links; otherwise you create problems for the translators.}}
 
=== Links to bugs ===
 
You can link directly to a bug in Bugzilla by using this template:
 
<code><nowiki>{{Bug|123456}}</nowiki></code>


For first pages with no preceeding page or last pages with no following page use this:
Please do not forget to add the <code><nowiki><s> and </s></nowiki></code> to strike through a bug that is closed.
{{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}} ==
{{Input|1=<nowiki>== {{FULLPAGENAME}} 的子页面==
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}


is very useful when you want to list subpages with active links, such as
非常好用以便你想要列出子页面的链接,比如


=== Subpages of {{FULLPAGENAME}}===  
=== {{FULLPAGENAME}}的子页面===  


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

Latest revision as of 15:31, 30 December 2022

资讯

本页介绍常见任务的格式代码和示例


添加介绍截图和描述

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

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

格式化文本

使用标题

每个标题独占以行,以两个或更多 '=' 字符开始和结束。页面有多个标题时,会自动创建目录。'=' 字符的个数决定目录中的层级。应该使用 '==标题==', '===次标题===', '====三级标题===='这样的层级。请避免使用单个 '=' ,这个层级作为 wiki 页面的名称使用;例如 "Toolbox/zh-cn" 会成为页面的标题。

使用粗体斜体

用点(Blips)来指定粗体和斜体文字。

用'''粗体文本'''(3个'符号)指定粗体文本以及''斜体文本''(2个'符号)指定斜体文本(中文的话还可以用「文本」来区分文字)。

为了确保我们之后的翻译轻松和准确,请遵守字体排印指导方针

添加代码段

为了正确显示代码段,我们提供了辅助模板。具体使用方式请阅读排版指导方针

添加代码段

添加缩进

用":"进行缩进,有些老的页面有多层缩进。但是因为多层缩进会导致问题,现在已经不建议使用并会逐步删除。一个 ":" 会缩进四个字符。

格式化日期

不同地区对纯数字的日期格式理解不一样,所以请使用

2015-06-16

这样的完整日期格式,年份要使用四位数字。

符号列表

符号列表用* 标记,**表示第二层次:

* Almonds

* Nuts
** Cashews

* Raisins

显示为:

  • Almonds
  • Nuts
    • Cashews
  • Raisins

编号列表

编号列表用同样的方式生成,用'#'。

# Sift
# Mix
## Stir thoroughly
# Bake

显示为:

  1. Sift
  2. Mix
    1. Stir thoroughly
  3. Bake

详情请阅读 wikimedia 中的列表说明.

混合符号列表和编号列表

可以混合使用符号列表和编号列表,例如:

* Nuts
*# Cashew
*# Crazy
* Other things

显示为:

  • Nuts
    1. Cashew
    2. Crazy
  • Other things

# Nuts
#* Cashew
#* Crazy
# Other things

显示为:

  1. Nuts
    • Cashew
    • Crazy
  2. Other things

附注

编号列表中不应该有空行:空行会导致重新编号。同时,符号列表和编号列表的子列表中也不应该有空行,否则会产生两个子列表。


附注

长列表会增加翻译难度。如果是单层符号列表,请在每行之间插入一个空行。这样的话每行都是一个单独的翻译单元。如果是多层符号列表,所有子列表必须和上层列表项放在同一个翻译单元中。所以如果必须使用多层列表,请尽量保持子列表的简短。如果是编号列表,所有的内容必须放在同一个翻译单元内。尽量避免使用编号列表,如果必须使用,请尽量简短。


Workaround

在符号列表中应该避免空行和子列表,如果真的使用了,可以有一个方法将它们分割到多个翻译单元。


要将每个符号列表和子列表放入单独的翻译单元,可以使用下面形式:

* 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

显示为:

  • First bullet
    • First sub bullet
    • Another sub bullet

      This one consists of two paragraphs
  • The next main bullet
    • And so on

这个方法同样适用于其它列表。

如果希望同一项中有多个部分,可以用下面方法把每个部分放入单独的翻译单元:

* 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

显示为:

  • First bullet
  • Second bullet, first section.

    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.

;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.

Note

As always, please keep each item in a section of its own; it helps translators a lot.


添加链接

有三种类型的链接可以学,内部链接,链接到另外一个userbase页面,和外部URL链接。

内部链接的话,你可以用这种格式[[PageLayout]],直接显示页面的名称。但这种方式不太好,尤其是对于译成docbook文档,最好用这种形式[[PageLayout|Page Layout]],避免了翻译者那边的问题。你经常需要在一个句子里包含链接,所以那种情况下你要用

[[Special:myLanguage/PageLayout|这个页面]]

这样的话会显示

这个页面

Internal links to subsections of a page use character '#' (hash) and 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 declares the reference anchor. If the anchor contains space characters, replace them by character '_' (underscore) when calling the reference. If the reference is found, the section will be automatically displayed by your browser (if it manages anchors). If it is not the case, you will have to go down through the page to find the referenced section. External links are given as the URL and a text separated by a space and delimited by single square brackets as in

[https://en.wikipedia.org/wiki/KDE KDE's Wikipedia page]

which gives KDE's Wikipedia page.

Anchor declaration

Anchor declaration must be done immediatly BEFORE the referenced section, and followed by a blank line separating the anchor and its headline. In the following example just copy in the ID value, the title of associated section. It should look like this:

</translate><span id="Working with Languages"></span> <translate>

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.

外部链接稍微有些不同,所以

[http://techbase.kde.org/Schedules 我们的路线图]

显示我们的路线图 会带你直达techbase页面。

最后需要注意的一点 - 当你预览你的页面时,链接已经生效可以用了。这对你有两个好处。你可以(悬停鼠标指针到链接上)检查是否你的链接设定的跟你期望的一样,并且你可以用一个红色链接来创建一个新页面。

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

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.

Footnotes

Footnotes are rarely used in our pages, but if you need them you can place a <ref>text</ref> in the source where the footnote mark should appear. There has to be one <references /> somewhere in the source as well, usually towards the end of the page. This is where the text added by the <ref> tags will appear. For more info see the Wikipedia help page.

附上图片

添加单幅图片,居中

[[Image:KMail-kde4.png|250px|center]]

注意你能修改图片的位置,但默认位置是左侧(left)。图片的大小依赖于具体情况,但对于截图,我推荐时不小于250px以及不大于500px。

Also note that Image: and File: are synonyms. So that [[Image:KMail-kde4.png]] is the same as [[File:KMail-kde4.png]]. However Image: is deprecated, so prefer File: in new content.

see mediawiki for more info.

使图片可点击,并添加标题

在你需要展示更多细节的地方,创建一张适当大小的图片,图可以点击以便查看全尺寸的大图。简单的添加一个参数'|thumb'到图片括号内就行。

标题也可以作为参数添加进去,但只会在提供'|thumb'的情况下显示。

例如:

[[File:file_name.png|thumb|this will be the caption]]

Add a caption without a thumbnail

Captions also appear on images marked up with the frame syntax.

例如:

[[File:image.png|frame|left|这是标题]]

Prevent text from flowing around image

Sometimes you might not want the text to flow down the sides of your image. You can prevent this by adding a <br clear=all> tag between the file tag and the text in question.

Example:

[[File:image.png]]
<br clear=all>
This text would normally flow down the sides of the image but now it will be found under the image

用表格精确的放置多张图片

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

显示


注意显示一张图片的所有参数都要被包含在[[...]]内,而且,多个单元(不同的图片)要用'||'分离。要开始新的一行,插入'|-'

For more details on Table formating see mediawiki

Embed a Video

As of July 2012 the MediaWiki EmbedVideo extension has been installed on userbase.kde. This means you can embed videos from various video hosting sites into the page content and have them display in line.

EmbedVideo parser function expects to be called in any of the following ways:

{{#ev:service|id}}
{{#ev:service|id|width}}
{{#ev:service|id|width|align}}
{{#ev:service|id|width|align|desc}}
{{#evp:service|id|desc}}
{{#evp:service|id|desc|align}}
{{#evp:service|id|desc|align|width}}

Where:

service is the name of a video sharing service (See "service name" in the list below)
id is the id of the video to include
width (optional) is the width in pixels of the viewing area (height will be determined automatically)
align (optional) is an alignment (float) attribute. May be "left" or "right".
desc (optional) is a short description to display beneath the video when it is aligned

For example, to include the famous "evolution of dance" YouTube video, you'd enter:

{{#ev:youtube|dMH0bHeiRNg}}

And if you wanted scaled down to thumbnail size, on the right with a short description, you could use:

{{#ev:youtube|dMH0bHeiRNg|100|right|This is an embedded video!}}


As of version 1.0, EmbedVideo supports embedding video content from the following services:

Site Service Name
Dailymotion dailymotion
Div Share divshare
Edutopia edutopia
FunnyOrDie funnyordie
Google Video googlevideo
Interia interia or interiavideo
Revver revver
sevenload sevenload
TeacherTube teachertube
YouTube youtube and youtubehd
Vimeo vimeo

添加附注(Notes)和警告(Warnings)

Important

Indented boxes do not display correctly! Never put a colon in front of a box; it will make the box look very odd.


在需要添加跟你的文本有关的附注或警告的地方,用表格,像是这样的:

{{Info/zh-cn|常规提示信息}} displays

资讯

常规提示信息


{{Note/zh-cn|重要的信息}} 显示

附注

重要的信息


{{Tip/zh-cn|需要记住的有用信息}}displays

提示

需要记住的有用信息


{{Warning/zh-cn|这样做很危险}} 显示

警告

这样做很危险


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

Remember

This is for things that definitely must not be forgotten


You can also change the heading:

Don't Forget This!

You can use parameter number 2 to set an individual box heading:
{{Remember|2=Don't Forget This!|1=You can use...}}


Page Redirection

You can make a page to redirect to another page automatically by using:

#REDIRECT [[Pagename]]

程序的KDE3和KDE SC 4版本区分

默认情况下都是假定是KDE SC 4版本。如果KDE SC 4版本还没完成发布的话,有必要去写KDE3版本。在这种情况下,你应该添加图标{{KDE3}},它会显示 。要是你在同一个页面里写KDE3版本和KDE SC 4版本,用这个图标 - {{KDE4}},它会显示

有用的模板

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.

社区程序

最后关心的一点是那些并不作为核心KDE应用程序发布的程序(译者注:大意应该是其他非KDE的社区开发的程序)。那些需要用图标指明,放置{{Community-app/zh-cn}}


 见脚注


在你句子或一行的末尾,如同你在普通书写中表示一个脚注一样。然后你需要添加{{Community-app-footnote/zh-cn}},它会显示脚注,像是这样子:



这个程序的支持可以在它的项目主页找到


对现有页面做重大修改

如果一个页面像是打开要做一段时间的编辑修改,可能会有冲突的危险 - 其他某个人或许同时也在编辑,这时保存你的编辑会取消掉他们的修改,或者反过来也是一样的。避免的方法是做一个临时的词条,直接挂在语言栏下面,使用{{Being_Edited/zh-cn}},它会显示

页面编辑中

目前该页正在编辑
如本提示存在过久,请通知 irc.freenode.org 的 #kde-www 频道,或至Annew 的讨论页讨论

Note: Pages should not normally be marked for translation while they are being actively worked on


编辑完成后不要忘了移除它!

添加一个新的复杂页面

如果你在某个页面上需要相当长一段时间的工作,比如说,数天,你或许要使用Construction/zh-cn模板 - {{Construction/zh-cn}},显示如下

页面建设中

这是个新页面,当前还在建设中,敬请期待!


Links to Pages in the Neighbourhood

You can add links to a preceding or a following page using the following templates as described here:

{{Prevnext2|prevpage=Previous Pagename|nextpage=Following Pagename|prevtext=The page before this page|nexttext=This page you should read later|index=Index page|indextext=Back to Menu}}

All six arguments are optional. For first pages with no preceeding page or last pages with no following page use this:

{{Prevnext2|nextpage=Following Pagename|nexttext=This page you should read later}}
{{Prevnext2|prevpage=Previous Pagename|prevtext=The page before this page}}

If you don't specify an indexname the name of the current page will be displayed.

Note

You should always specify a text for the pages you link to, and you should always use Special:myLanguage with your links; otherwise you create problems for the translators.


Links to bugs

You can link directly to a bug in Bugzilla by using this template:

{{Bug|123456}}

Please do not forget to add the <s> and </s> to strike through a bug that is closed.

添加子页面列表

== {{FULLPAGENAME}} 的子页面==
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}

非常好用以便你想要列出子页面的链接,比如

Toolbox/zh-cn的子页面

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