工具箱

    From KDE UserBase Wiki
    Revision as of 08:49, 28 March 2020 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
    The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

    資訊

    這個頁面提供一般工作用的格式範例


    添加介紹截圖和描述

    我們編寫程式的頂層頁面盡量以截圖和描述開始。具體實現代碼是

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

    格式化你的文字

    使用標題

    Each heading goes on its own line starting and ending with two or more '=' characters. Once there are more than a handful of headings on a page they automatically create a Table of Contents, so use them. The number of '=' characters determines their level in the Table of Contents, thus your headings should be '==Main section name==', '===Subsection name===', '====Sub-subheading name here====', and so on. Avoid using single '=', as that denotes a page heading and every wiki page already has one made from its name; for example, this page's title "Toolbox/zh-tw" appears as its page heading.

    使用粗體斜體

    用點(Blips)來指定粗體和斜體文字。

    用'''粗體文本'''(3個'符號)指定粗體文本以及''斜體文本''(2個'符號)指定斜體文本(中文的話還可以用「文本」來區分文字)。

    為了確保我們之後的翻譯輕松和准確,請遵守字體排印指導方針(涉及到文章的易讀性)

    加入程式碼片段

    We have templates to assist in correctly displaying code snippets. Examples of use in various situations are available on the typographical guideline page

    If you have problems displaying pipe characters in your code snippet, please see the explanation and markup detailed on Typographical Guidelines

    添加縮進

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

    Dates in a purely numerical format cause confusion, due to differences in expectations of geographical zones. Please format dates as

    18 Mar 2011

    with the month either spelled out completely or in abbreviated form, and the year in 4-digit format. The day may be single or double-digit.

    符號列表(bulleted)

    *是個用來做符號列表的符號。 **是表示第二層次:

    * Almonds
    
    * Nuts
    ** Cashews
    
    * Raisins
    

    顯示效果

    • Almonds
    • Nuts
      • Cashews
    • Raisins

    Enumerations

    編號列表用同樣的方式生成,用'#'。

    # Sift
    # Mix
    ## Stir thoroughly
    # Bake
    

    顯示效果

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

    For more details see wikimedia on lists.

    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
    

    顯示效果

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


    Workaround

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

    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'的情況下顯示。

    Example:

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

    Example:

    [[File:image.png|frame|left|this will be the caption]]
    

    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-tw|一般提示資訊}} 顯示

    資訊

    一般提示資訊


    {{Note/zh-tw|重要的資訊}} 顯示

    附注

    重要的資訊


    {{Tip/zh-tw|需要記住的有用資訊}}顯示

    提示

    需要記住的有用資訊


    {{Warning/zh-tw|這樣做很危險}} 顯示

    警告

    這樣做很危險


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


     見腳註


    在你句子或一行的末尾,如同你在普通書寫中表示一個腳註一樣。然後你需要添加{{Community-app-footnote/zh-tw}},它會顯示腳註,像是這樣子:



    這個程式的支援可以在它的專案首頁找到


    對現有頁面做重大修改

    如果一個頁面像是打開要做一段時間的編輯修改,可能會有衝突的危險- 其他某個人或許同時也在編輯,這時保存你的編輯會取消掉他們的修改,或者反過來也是一樣的。避免的方法是做一個臨時的詞條,直接掛在語言欄下面,使用{{Being_Edited/zh-tw}},它會顯示

    頁面編輯中

    此頁面當前正在編輯中
    如果這條提示存在過久,請通知irc.freenode.org的#kde-www頻道或去 Annew 的討論頁面報告

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


    編輯完成后不要忘了移除它!

    添加一個新的複雜頁面

    如果你在某個頁面上需要相當長一段時間的工作,比如說,數天,你或許要使用Construction/zh-tw模板- {{Construction/zh-tw}},顯示如下

    頁面施工中

    這是個新頁面,當前還在施工中,敬請期待!

    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 的子頁面

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