编辑标记

    From KDE TechBase
    This page is a translated version of the page Edit Markup and the translation is 31% complete.
    Other languages:

    可用工具

    • 印刷指南制定了翻译时使用的标准格式,适用于官方文档(DocBook)或其它语言。请经常查看此文档,有时格式会根据翻译需要进行修改。

    工作流程 1

    修正旧的标记

    • 确保每个段落或字段落后面都有一个空行。
    • 许多页面都有多级缩进,这是早期 MediaWiki 文档遗留下来的,现在已经不接受这个格式,因为导出到其他格式时会出问题。所以请重写页面,只使用单级缩进。列表仍然可以使用多级缩进。
    • ASCII 笑脸也会导致问题,应该删除。可以用小 oxygen 图标代替。Wikimedia Commons 也提供了一些替代。
    • 内部链接例如 [[Translation Workflow]] 应该修改为 [[Special:myLanguage/Translation_Workflow|Translation Workflow]]
    • 输入文本有多种格式,例如 <code>, <pre> 和图表和方框。用户需要输入的文字应该使用输入模板 {{Input|1=input text (can be multi-line or single)}}. 很短的输入也可以使用 <code>,这样文字不会另起一行显示。
    • 终端的输出和出错信息应该替换为{{Output|1=terminal output}}
    • Every page should end with a Category statement. These must be standardized categories. A current list of categories can be found on any of the translators' pages linked from this language page
    • Make sure that there are no unbalanced brackets in any section. If you find unbalanced brackets then add the missing bracket(s) — possibly in a comment like this:
      <!--(--> a)
    • There should be a blank line between bullets in lists. See the sections on lists beginning with Bulleted Lists.
    • Tables should be split in a similar manner, so that there is a blank line between each row. The first and last items will need to have curly braces balanced.

    Stage 2 - Guide to new markup

    Marking Links for Translation

    • A stand-alone link, such as the application-names in Applications/Internet, should use the form [[Special:myLanguage/Ark|<translate>Ark </translate>]]
    • Where the link is within a sentence; the whole of the link should be kept within the translatable message.

    Special Tags

    • Identify all keyboard key-names, and tag, e.g. <keycap>Enter</keycap>
    • Include concurrent keypresses in the <keycap> tag, e.g. Ctrl + Alt + F1. Note that the separator is (space)+(space)
    • Treat menu sequences in a similar manner, using the <menuchoice> tag, e.g.System Settings -> Account Details -> Social Desktop. Note that the separator is (space)->(space)
    Warning
    NEVER add translate section tags (the ones that look like < !--T:18-- >). The software will do any handling of tags that is required, and manually changing them will break the system.


    Bold type

    • Identify program names and mark them as bold type, e.g. Klipper
    • Identify labels and names that cannot be changed by the user, and mark them as bold type.
    • Remove any bold type marking that were previously entered, but do not match this guideline. (See below for emphasizing a word or phrase.)
    • Window captions and Icon labels are also marked as bold type.

    Italics

    • Italics can be used to give emphasis as you might in non-technical writing
    • Use italics on the first appearance of an unfamiliar word or phrase, and if possible link it to #Glossary or a dictionary entry.
    • When referencing other (external) works, titles are italicized.

    Combined Bold and Italics

    • This should only be used in the context of an example where the user has to substitute text, e.g. "Your new addressbook records are in /home/user/share/contacts"
    Tip
    Simplified definitions - Programs are launched by users, components are used by programs


    Issues that cause Translate problems

    Several issues have been identified and discussed, and solutions proposed in the following sections:

    These are usually noticed after the first markup, and it may be necessary to re-arrange spacing and/or structure to avoid the problems.

    Almost finished

    • In the summary field at the bottom, enter that you are doing a markup edit.
    • Use Preview and read through the whole of your work. If you are satisfied, save the page.
    • Use this page to request release - you can add the URL of the page you have edited. Pasting your link there tells us that you believe the page to be ready for translators to work with. We will scan it, and if satisfied we will enable it for translation.