排版准则

This page is a translated version of the page Typographical Guidelines and the translation is 65% complete.
Other languages:
English • ‎Lëtzebuergesch • ‎català • ‎dansk • ‎français • ‎italiano • ‎русский • ‎українська • ‎中文(中国大陆)‎ • ‎日本語

这些页面解释了页面布局语法,并且带有示例代码。

Flag-red.png
重要
遵循这些排版指南可以让您的文档准确方便地导出以供翻译。有些指南或许不适用于英语之外的语言。这些情况应该在特定语言的页面上注明,并在 翻译流程中做好链接。如果您的语言没有这种页面,那么请添加一个并在此处指明。


粗体字

用粗体字来突出

  • 窗口标题
  • 不能被用户自定义的一般化文本
  • 图标标题
  • 程序名字

比如:

  • 突出会复制到 Klipper 的所选文字。

斜体字

斜体文本起强调作用

  • 通常情况下想要强调的词语。
  • 引用的其他资源的标题。
  • 首次使用一个生僻词时。

例子:

  • 请在此时保存你的工作。
  • 相关细节可以在Samba 3 by Example找到....
  • KDE手册用Docbook格式编写。

Template:小贴士

粗体斜体并用

对于可替换的或者说可变的文本,请使用这种组合格式。

例子:

  • 要连接到你的远程服务器的话,在 Konsole 中键入 ssh [email protected]
  • 在基于rpm的发布包中,命令 rpm -q packagename 将输出 package-version-release

等宽文字

代码应该通过等宽文本显示,通常显示在框中,如下所示。输入文本将在淡黄色背景上。对于输出文本,背景颜色将为紫灰色。

  • 对于代码,无论是否是单行的,都应使用该模板以确保其平滑度
  • 请使用像这样的输入模板:
    {{Input|1=<nowiki>
    qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
    rm -r ~/.kde/share/apps/nepomuk
    rm -r ~/.kde4/share/apps/nepomuk
    nepomukserver</nowiki>}}
    这将会像这样显示:
    qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
    rm -r ~/.kde/share/apps/nepomuk
    rm -r ~/.kde4/share/apps/nepomuk
    nepomukserver


  • 输出文本也一样:
    {{Output|1=<nowiki>terminal output 
    is also shown as code, 
    but on a grey background</nowiki>}}
    被显示为
    terminal output 
    is also shown as code, 
    but on a grey background

Template:注意

  • 在新的一行上应用输入或输出模板将破坏列表中的显示格式 (如果你正在编辑列表的话) 。如果需要更正,在同一行上继续敲完模板就行了。
  • 你也可以把输入/输出区域和 GeSHi 语法高亮格式 混合使用。像这样的输入
    {{Input|<syntaxhighlight lang="php" line>
    # Initialise common code
    $preIP = dirname( __FILE__ );
    require_once( "$preIP/includes/WebStart.php" );
    </syntaxhighlight>}}
    产生的结果是
    1 # Initialise common code
    2 $preIP = dirname( __FILE__ );
    3 require_once( "$preIP/includes/WebStart.php" );
    
  • Single code words can be kept in-line by using
    <code></code>
    It will display like this. Note, that if the <code> tag is immediately preceded by a newline character, it will not display properly.
  • File names and paths should use the Path template (see below).
Warning.png
Warning
In-line code markup should be short! It looks strange - and ugly - if a string of code words is split between lines. And remember: even if it looks good in your browser, not everyone uses the same screen size! And even if your text looks good on all screen sizes translations may still suffer. It is best to use the Input template for code unless it is really short.


Note
Please avoid using shell commands or other code words as verbs. This does not translate well. Always treat code words as proper names.


Block Quotes

The tags <blockquote> and </blockquote> should be used when quoting other works or other pages. This produces a proportional italic font, with some padding.

Here is an example of the display that you get by using the blockquote tags.

Text in Section Headers

Even though the criteria above may be met, do not use Bold text in section headers or in links.

Text in Information, Note, Tip or Warning Templates

Bold text should be avoided in the text within these templates. Italic text for emphasis may still be used - use sparingly for maximum effect.

列表

You can have various kinds of lists in your pages — bulleted, numbered or itemized. Find details on the Toolbox page.

Keeping things together

After your text is written some markup is automatically added by the translation system. This means that whenever it sees a blank line, it starts a new unit. When your text is presented to translators, they typically see it one unit at a time, so it is important not to leave a blank lines in the middle of something that should be treated as a unit. Normally an entire paragraph should be kept in a single unit; and under no circumstance should a sentence be split between units!

If you need a linebreak in the middle of a section, the preferred way to achieve this without breaking units is to use <br /> at the end of the line where you want to break to occur (not on a new line). If you need space between the lines add <br /><br />.

Unbalanced brackets

The translation system marks any translated unit as incompletely translated if it contains any kind of unbalanced brackets. If you need to have unbalanced brackets in your text, please add a balancing bracket in a comment tag, like this:

<!-- }} -->{{ A line 

Another line}}<!-- {{ -->

This goes for all kinds of brackets, even ordinary parentheses. (Of course it is normally better to avoid blank lines within a mark up unit - see Keeping things together.)

Special Tags

Key presses and menu selections

  • <keycap> and </keycap> denote (keyboard) key names e.g. Enter
  • <keycap></keycap> can also be used around groups of keys to be used concurrently, e.g. Ctrl + Alt + F1 to launch a virtual terminal. (Note that "(space)+(space)" is used to link keys to be pressed concurrently).
  • Sequences of menu choices should use <menuchoice> and </menuchoice> for example View -> Message List -> Aggregation -> Standard Mailing List
  • In general, if the user needs to choose an element, even if it is not in a menu, the <menuchoice></menuchoiсe> markup should be used.
  • If you are contributing to a manual page, you should always use the markup describes above. For other pages, though, there is a template to enter menu selections: {{Menu|Top|sub|...}}. Fx, {{Menu | View | Message List | Aggregation | Standard Mailing List}} yields View Message List Aggregation Standard Mailing List
  • If you want to use the <menuchoice> but use → in stead of ->, you write & rarr; (without a space between '&' and r!) as in <menuchoice> View</menuchoice> & rarr; <menuchoice>Message List</menuchoice> which yields ViewMessage List. (Note, that the → character has to be outside of the menuchoice tags to be shown properly

Files and file paths

Traditionally, file names and paths have been marked up between <tt>...</tt> tags.

<tt>~/.kde/share</tt>

yields

~/.kde/share

There is now also a template for this, which should be preferred in new content for ordinary UserBase pages (but not for manual pages, please!):

{{Path | ~/.kde/share }}

yields

 ~/.kde/share 

The Problematic Pipe

In some situations the pipe symbol can't be used - for instance when adding parameters into a template. In any such case, please use {{!}} which will display as a pipe symbol. For example, if you want to display a command line containing the pipe character using the {{Input|...}} template, the simplest way to do it is this: {{Input|1=cmd1 {{!}} cmd2}} which displays

cmd1 | cmd2


If you just write {{Input|cmd1 | cmd2}} you get instead

cmd1 

the problem being, that cmd2 is seen as a second parameter to the template, which in this case is not used.

In many cases, you can also enclose the text containing the pipe character between <nowiki>... </nowiki> tags, like this {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}, which also displays

cmd1 | cmd2

可译内容

Everything that is translatable is contained within <translate> and </translate> tags. In most cases any images should be contained within the translatable section, as it is sometimes necessary to use localised versions of the images to explain a point. The rule of thumb is "If in doubt, include it!".


This page was last edited on 31 May 2021, at 17:37. Content is available under Creative Commons License SA 4.0 unless otherwise noted.