Skip to content

Latest commit

 

History

History
233 lines (150 loc) · 8.93 KB

EDITING.md

File metadata and controls

233 lines (150 loc) · 8.93 KB
Raw

Editorial guidelines | 编辑指南

Combining the English and Chinese text in one document makes it much easier to develop and maintain content in both languages in parallel. However, it is important to follow certain steps when creating or editing the source text.

(Note that the English version will be the authoritative version, since it is more widely accessible to developers around the world.)

同時包含英語及漢語的文檔結構使平行開發與內容維護得以化繁為簡。需要注意的是，W3C以英文版本为权威版本，因其更方便让世界各地的开发者閱讀。

Creating or modifying content | 添加或修正内容

When creating new content, you should always create markup for both English and Chinese versions.

添加新的内容文本時，请務必同時建立英文与中文的元素標記。

For example:
例如：

<p its-locale-filter-list="en" lang="en">The same text in English.</p>
<p its-locale-filter-list="zh" lang="zh">此為漢語文本。</p>

If you are able to create text in both English and Chinese, please do so. If you are only able to create text in one language, still create the dual structure in markup, but put the same text in both places. Then add class="translateme" to the text that needs translation.

若您可以書寫英、中文二種語言，請同時創建這二種語言的文本；若您只能書寫其中一種语言，请保持英、中文的元素標記结构，將单一语言添加在这两段標記中，並為該段落添加class="translateme"類別来提醒其他志愿者翻译此段落。

For example:
例如：

<p its-locale-filter-list="en" lang="en" class="translateme">此為漢語文本。</p>
<p its-locale-filter-list="zh" lang="zh">此為漢語文本。</p>

If you change existing text, and if that change requires a change in the parallel translation but you are unable to do so, add class="retranslateme" to the text that needs to be updated.

如果您打算修正現有的内容，并且該内容的另一个语言版本需要同时更新翻译，请您更新翻译或添加class="retranslateme"類別，提醒其他志愿者翻译此段落。

For example:
例如：

<p its-locale-filter-list="en" lang="en" class="retranslateme">Text in English.</p>
<p its-locale-filter-list="zh" lang="zh">此為更新後的漢語文本。</p>

If you need someone to check the translation you provided, add class="checkme" to the relevant tag.

如果您需要其他人检查您提供的翻译，请在相关标签中添加class="checkme"類別。

For example:
例如：

<p its-locale-filter-list="en" lang="en" class="checkme">Text in English.</p>
<p its-locale-filter-list="zh" lang="zh">此為漢語文本。</p>

The class names listed above produce special colouring effects in the displayed document.

上面列出的类所标记的元素在网页中会用特殊的颜色显示。

When text highlighted by the translateme, retranslateme, or checkme class is updated to a final translation, the class should be removed.

当标记为translateme、retranslateme或checkme的高亮文本更新为最终翻译时，请移除该类。

Markup tips | 標記小提示

Here are some tips on how to maintain the parallel language structure in markup. The principles in these example approaches should be extended to other markup as needed.

此文檔以元素標記来维护双重语言結構，下面是一些協助您依此原則進行編輯的小提示。在需要時，請自行擴展各原則中的範例標記。

  • The English text should always come before its corresponding Chinese text.

    英文内容永遠置於中文内容前方。

  • List elements need p elements inside them, and link anchors must go on the li tag.

    列表元素中，請使用p元素。链接锚点必须位于li标签上。

    <li id="abcd">
  <p its-locale-filter-list="en" lang="en" class="translateme">这是中国的文字。</p>
  <p its-locale-filter-list="zh" lang="zh">这是中国的文字。</p>
</li>

  • Headings should use spans for zh and en versions, and there should be a line break between spans.

    标题內应以span元素来分別包裹zh和en語言，两者间应有一个换行。

    <h2>
  <span its-locale-filter-list="en" lang="en">My heading</span>
  <span its-locale-filter-list="zh" lang="zh">我的标题</span>
</h2>

  • Attribute ids should go on section elements, not h[1-6] elements.

    屬性id應跟随section元素，而非h[1-6]元素。

    <section id="h_my_heading">
  <h2>
    <span its-locale-filter-list="en" lang="en">English heading</span>
    <span its-locale-filter-list="zh" lang="zh">漢語標題</span>
  </h2>
  …

  • Attribute ids on dfn elements should start with xxdef, where xx is either zh or en.

    在dfn元素里的屬性id应该以xxdef开始，xx隨語言的不同作zh或en。

    <p its-locale-filter-list="en" lang="en">The <dfn id="endef_term">term</dfn> is a technical word.</p>
<p its-locale-filter-list="zh" lang="zh">这个<dfn id="zhdef_term">词汇</dfn>是一个技术用语。</p>

  • figcaptions should use spans for the different language versions.

    figcaption元素应以span元素来标示不同语言。

    <figure>
  <!-- 圖表內容。 -->
  <!-- Figure content. -->
  <figcaption>
    <span its-locale-filter-list="en" lang="en">English caption</span>
    <span its-locale-filter-list="zh" lang="zh">漢語說明</span>
  </figcaption>
</figure>

  • Use the following markup for Unicode codepoint names:

    请使用以下標記来表示Unicode碼位名稱：

    <span class="uname">U+3002 IDEOGRAPHIC FULL STOP</span> [。]

  • To link to a section, use the ReSpec feature, ie. link to the id on the section tag using the [[[ ]]] syntax.

    要链接到某个章节，请使用ReSpec特性，也就是使用[[[ ]]]语法链接到section标签上的id。

    [[[#mySectionId]]]

  • To link to a figure, use the ReSpec feature, ie. link to the id on the figure tag using the [[[ ]]] syntax.

    要链接到某个图片，请使用ReSpec特性，也就是使用[[[ ]]]语法链接到figure标签上的id。

    [[[#myFigureId]]]

For additional ideas about markup and styling in Internationalization Activity documents, especially wrt inline markup conventions, see https://www.w3.org/International/i18n-activity/guidelines/editing.

欲了解更多国际化标准计划文档里的標記和样式条约，尤其是行内標記的使用慣例，请查看https://www.w3.org/International/i18n-activity/guidelines/editing。

Rules for Punctuation | 标点符号用法

In Traditional Chinese text, you should use single quotation marks (「」) first, followed by double quotation marks (『』). In Simplified Chinese text, you should use double quotation marks (“”) first, followed by single quotation marks (‘’).

繁体中使用先单（「」）、后双（『』）的直角引号，简体中使用先双（“”）、后单（‘’）的弯引号。

Working on the language switching code | 语言切换功能

The code for the language switching function is implemented in the following TypeScript file:

语言切换功能的代码在如下TypeScript文件内实现：

src/script.ts

The compiled file is in:

编译后的文件在：

built/script.js

Compiling the TypeScript file requires installing Node.js and pnpm, and using the following commands:

编译该文件需要安装Node.js和pnpm，并运行：

pnpm install
pnpm build

Last-minute Pre-publication edits | 发布前的最后改动备忘录

Make the following changes to the respec file before pushing to GitHub:

发布至GitHub前，請对respec文件進行以下改动：

  1. Change the path in following code to the location of the document that is about to be published:

    將下列代碼內的路徑指向准备发布的文件路徑：

    <link rel="canonical" href="http://www.w3.org/TR/2015/WD-clreq-XXXXXXX/"/>

  2. Change previousPublishDate to reflect the date of the last publication.

    把previousPublishDate改为上一次发布的日期。

Make the following edits to the snapshot of the file that will be published to TR.

对准备发布至TR的版本快照進行以下编辑：

  1. Convert the content of the h1 tag to the following:

    把h1标签的内容改为：

    Requirements for Chinese Text Layout 
<span its-locale-filter-list="zh" lang="zh" lang="zh">中文排版需求</span>

  2. Remove:

    去除：

    <link rel="canonical" href="http://www.w3.org/TR/2015/WD-clreq-XXXXXXXX/"/>