工具箱

    From KDE UserBase Wiki
    Revision as of 09:06, 10 May 2012 by Qiii2006 (talk | contribs) (Created page with "标题也可以作为参数添加进去,但只会在提供'|thumb'的情况下显示。")

    资讯

    本页有常见任务所需的,格式相关代码


    添加介绍截图和介绍描述

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

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

    格式化你的文本

    使用标题

    新的页面不该继续使用这种语言栏。这种语言栏是之前旧的翻译模板,现在换用了新的页面翻译插件。

    使用粗体斜体

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

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

    为了确保我们之后的翻译轻松和准确,请遵守字体排印指导方针(涉及到文章的易读性)

    添加代码段

    为了确保我们之后的翻译轻松和准确,请遵守字体排印指导方针(涉及到文章的易读性)

    添加代码段

    添加缩进

    ":" 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)

    * 是个用来做符号列表的符号。**是表示第二层次:

    • Next point

    • Nuts
      • Cashews
    • Raisins

    </nowiki>}} 显示效果

    • Almonds
    • Nuts
      • Cashews
    • Raisins

    Enumerations

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

    # Sift
    # Mix
    ## Stir thoroughly
    # Bake
    

    显示效果

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

    混合符号列表和编号列表

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

    * Nuts
    *# Cashew
    *# Crazy
    * Other things
    

    显示效果

    • Nuts
      1. Cashew
      2. Crazy
    • Other things

    while

    # Nuts
    #* Cashew
    #* Crazy
    # Other things
    

    显示效果

    1. Nuts
      • Cashew
      • Crazy
    2. Other things

    Note

    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

    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

    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:

    * 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

    This displays like this:

    • First bullet
      • First sub bullet
      • Another sub bullet

        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:

    * 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

    This displays like this:

    • 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 allways, 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 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.

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

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

    附上图片

    添加单幅图片,居中

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

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

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

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

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

    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

    Information

    This is general information


    {{Note|Some important information at this point}} displays

    Note

    Some important information at this point


    {{Tip|A helpful piece of advice, something to remember}}displays

    Tip

    A helpful piece of advice, something to remember


    {{Warning|Take care - this is a dangerous thing to do}} 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. {{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:

    Remember

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


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


     See footnote


    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

    Currently Being Edited

    This page is currently being edited.
    If this notice persists for an unreasonable time, please either notify irc.freenode.org #kde-www or report on Claus chr's Talk page

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


    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

    Under Construction

    This is a new page, currently under 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:

    {{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:

    {{Next|Following Pagename|This page you should read later}}
    {{Prev|Previous Pagename|The page before this page}}


    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.