clreq

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.

当标记为translatemeretranslatemecheckme的高亮文本更新为最终翻译时,请移除该类。

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.

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

For additional ideas about markup and styling in Internationalization Activity documents, especially wrt inline markup conventions, see https://www.w3.org/International/docs/styleguide.

欲了解更多国际化标准计划文档里的標記和样式条约,尤其是wrt行内標記的使用慣例,请查看https://www.w3.org/International/docs/styleguide

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