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


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.


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.


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.


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.


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


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 (‘’).


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

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


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


     <link rel="canonical" href=""/>
  2. Change previousPublishDate to reflect the date of the last publication.


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


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


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


     <link rel="canonical" href=""/>