- More translation.
Obtained from: The FreeBSD Traditional Chinese project
This commit is contained in:
parent
20ce763030
commit
c08c590e35
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=30675
1 changed files with 103 additions and 122 deletions
|
@ -34,194 +34,179 @@
|
|||
<chapter id="writing-style">
|
||||
<title>¤å¥óªº¼¶¼g·®æ</title>
|
||||
|
||||
<para>In order to promote consistency between the myriad authors of the
|
||||
FreeBSD documentation, some guidelines have been drawn up for authors to
|
||||
follow.</para>
|
||||
<para>由於 FreeBSD 文件是由眾多作者所維護的,為了保持寫作風格的一貫性,
|
||||
於是就產生較有共識的寫作規則,請各位記得要遵守。</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Use American English spelling</term>
|
||||
<term>使用美式英語</term>
|
||||
|
||||
<listitem>
|
||||
<para>There are several variants of English, with different spellings
|
||||
for the same word. Where spellings differ, use the American English
|
||||
variant. <quote>color</quote>, not <quote>colour</quote>,
|
||||
<quote>rationalize</quote>, not <quote>rationalise</quote>, and so
|
||||
on.</para>
|
||||
<para>同一個字在不同種類的英語會有著不同的拼法。
|
||||
遇到拼字不同的情況,請採用美式英語拼法。 像是:
|
||||
請改用 <quote>color</quote>,而非 <quote>colour</quote>。
|
||||
請改用 <quote>rationalize</quote>,而非 <quote>rationalise</quote>
|
||||
等等類似字彙。</para>
|
||||
|
||||
<note>
|
||||
<para>The use of British English may be accepted in the case
|
||||
of a contributed article, however the spelling must be
|
||||
consistent within the whole document. The other documents
|
||||
such as books, web site, manual pages, etc. will have to use
|
||||
American English.</para>
|
||||
<para>若文章採用英式英語也可以接受,但必須全篇文章都採用同一拼法才行
|
||||
。 而文件的其他部份,像是書、網頁、 manual
|
||||
說明等則必須採用美式英語。</para>
|
||||
</note>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Do not use contractions</term>
|
||||
<term>不要用簡寫</term>
|
||||
|
||||
<listitem>
|
||||
<para>Do not use contractions. Always spell the phrase out in full.
|
||||
<quote>Don't use contractions</quote> would be wrong.</para>
|
||||
<para>請不要簡寫(contraction)。 請務必將完整的字寫出來。 比如:
|
||||
<quote>Don't use contractions</quote> 這句有用到簡寫,就要避免。</para>
|
||||
|
||||
<para>Avoiding contractions makes for a more formal tone, is more
|
||||
precise, and is slightly easier for translators.</para>
|
||||
<para>正式書面寫法避免簡寫的原因,乃是因為如此一來字句意思較精準,
|
||||
且對譯者會比較輕鬆些。</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Use the serial comma</term>
|
||||
<term>正確使用 serial comma 以及頓號</term>
|
||||
|
||||
<listitem>
|
||||
<para>In a list of items within a paragraph, separate each item from
|
||||
the others with a comma. Separate the last item from the others with
|
||||
a comma and the word <quote>and</quote>.</para>
|
||||
<para>英文段落通常會逗號(,)作為該句所提到的各項目的語氣區隔。
|
||||
並且會在最後一個提到的項目時,先加上逗號再接上 <quote>and</quote>,
|
||||
最後才是最後的項目。</para>
|
||||
|
||||
<para>For example, look at the following:</para>
|
||||
<para>舉個例子,看看下面這句:</para>
|
||||
|
||||
<blockquote>
|
||||
<para>This is a list of one, two and three items.</para>
|
||||
</blockquote>
|
||||
|
||||
<para>Is this a list of three items, <quote>one</quote>,
|
||||
<quote>two</quote>, and <quote>three</quote>, or a list of two items,
|
||||
<quote>one</quote> and <quote>two and three</quote>?</para>
|
||||
<para>那麼這一句到底是有三個項目(<quote>one</quote>、<quote>two</quote>
|
||||
、<quote>three</quote>)呢?或者是只有兩個項目(<quote>one</quote>、
|
||||
<quote>two and three</quote>)呢?</para>
|
||||
|
||||
<para>It is better to be explicit and include a serial comma:</para>
|
||||
<para>因此較妥的方式是以 serial comma 的方式,才能正確表達語意:</para>
|
||||
|
||||
<blockquote>
|
||||
<para>This is a list of one, two, and three items.</para>
|
||||
</blockquote>
|
||||
|
||||
<para>然而,在翻譯過程中,建議把逗號(,)部份改為頓號(、),並且
|
||||
<quote>and</quote> 的部份可略而不翻,以免語意頓塞。</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Avoid redundant phrases</term>
|
||||
<term>避免使用贅詞</term>
|
||||
|
||||
<listitem>
|
||||
<para>Try not to use redundant phrases. In particular, <quote>the
|
||||
command</quote>, <quote>the file</quote>, and <quote>man
|
||||
command</quote> are probably redundant.</para>
|
||||
<para>請試著避免使用贅詞(redundant phrase)。 尤其是
|
||||
<quote>這個指令</quote>、<quote>這個檔案</quote>、<quote>man
|
||||
指令</quote> 這幾個通常都是不必要的贅詞。</para>
|
||||
|
||||
<para>These two examples show this for commands. The second example
|
||||
is preferred.</para>
|
||||
<para>以指令(command)方面舉例,比較妥當的用法是第二句的例子:</para>
|
||||
|
||||
<informalexample>
|
||||
<para>Use the command <command>cvsup</command> to update your
|
||||
sources.</para>
|
||||
<para>使用 <command>cvsup</command> 指令來更新原始碼。</para>
|
||||
</informalexample>
|
||||
|
||||
<informalexample>
|
||||
<para>Use <command>cvsup</command> to update your sources.</para>
|
||||
<para>使用 <command>cvsup</command> 來更新原始碼。</para>
|
||||
</informalexample>
|
||||
|
||||
<para>These two examples show this for filenames. The second example
|
||||
is preferred.</para>
|
||||
<para>以檔案(filename)方面舉例,比較妥當的用法是第二句的例子:</para>
|
||||
|
||||
<informalexample>
|
||||
<para>… in the filename
|
||||
<filename>/etc/rc.local</filename>…</para>
|
||||
<para>… 在這個
|
||||
<filename>/etc/rc.local</filename> 檔案 …</para>
|
||||
</informalexample>
|
||||
|
||||
<informalexample>
|
||||
<para>… in
|
||||
<filename>/etc/rc.local</filename>…</para>
|
||||
<para>… 在
|
||||
<filename>/etc/rc.local</filename> 檔 …</para>
|
||||
</informalexample>
|
||||
|
||||
<para>These two examples show this for manual references. The second
|
||||
example is preferred (the second example uses
|
||||
<sgmltag>citerefentry</sgmltag>).</para>
|
||||
<para>以 man(manual)方面舉例,比較妥當的用法是第二句(有用到 SGML
|
||||
<sgmltag>citerefentry</sgmltag> tag):</para>
|
||||
|
||||
<informalexample>
|
||||
<para>See <command>man csh</command> for more
|
||||
information.</para>
|
||||
<para>請打 <command>man csh</command> 指令以參閱詳情說明。</para>
|
||||
</informalexample>
|
||||
|
||||
<informalexample>
|
||||
<para>See &man.csh.1;.</para>
|
||||
<para>詳情請參閱 &man.csh.1;。</para>
|
||||
</informalexample>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>Two spaces at the end of sentences</term>
|
||||
<term>每句後面加上兩個空白</term>
|
||||
|
||||
<listitem>
|
||||
<para>Always use two spaces at the end of sentences, as this
|
||||
improves readability, and eases use of tools such as
|
||||
<application>Emacs</application>.</para>
|
||||
<para>為增進文章之易讀,以及讓 <application>Emacs</application>
|
||||
之類的工具容易運用,請在每一完整句子後面加上兩個空白。</para>
|
||||
|
||||
<para>While it may be argued that a capital letter following
|
||||
a period denotes a new sentence, this is not the case, especially
|
||||
in name usage. <quote>Jordan K. Hubbard</quote> is a good
|
||||
example; it has a capital <literal>H</literal> following a
|
||||
period and a space, and there certainly is not a new sentence
|
||||
there.</para>
|
||||
<para>不過,句號(.)後面有接大寫字母,
|
||||
並不一定表示前一個句點所在處就是完整句子,
|
||||
尤其是名字部份常常會有這現象。 像是 <quote>Jordan K. Hubbard</quote>
|
||||
這人名就是很好的例證:句號後面接空白,然後是大寫的
|
||||
<literal>H</literal>,然而這肯定並不是兩段句子。</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>For more information about writing style, see <ulink
|
||||
url="http://www.bartleby.com/141/">Elements of
|
||||
Style</ulink>, by William Strunk.</para>
|
||||
<para>撰寫風格的相關細節,可參閱 William Strunk 所寫的 <ulink
|
||||
url="http://www.bartleby.com/141/">Elements of Style</ulink>。</para>
|
||||
|
||||
<sect1 id="writing-style-guide">
|
||||
<title>Style guide</title>
|
||||
|
||||
<para>To keep the source for the Handbook consistent when many different
|
||||
people are editing it, please follow these style conventions.</para>
|
||||
<para>由於 Handbook 是由眾多作者所維護,為了保持寫作風格的一貫性,
|
||||
請遵守下列撰寫風格。</para>
|
||||
|
||||
<sect2>
|
||||
<title>Letter case</title>
|
||||
<title>大小寫</title>
|
||||
|
||||
<para>Tags are entered in lower case, <literal><para></literal>,
|
||||
<emphasis>not</emphasis> <literal><PARA></literal>.</para>
|
||||
<para>Tag 的部份都是用小寫字母,譬如是用 <literal><para></literal>
|
||||
,<emphasis>而非</emphasis> <literal><PARA></literal>。</para>
|
||||
|
||||
<para>Text that appears in SGML contexts is generally written in upper
|
||||
case, <literal><!ENTITY…></literal>, and
|
||||
<literal><!DOCTYPE…></literal>, <emphasis>not</emphasis>
|
||||
<literal><!entity…></literal> and
|
||||
<literal><!doctype…></literal>.</para>
|
||||
<para>而 SGML 內文則是用大寫字母表示,像是:
|
||||
<literal><!ENTITY…></literal> 及
|
||||
<literal><!DOCTYPE…></literal>,
|
||||
<emphasis>而不是</emphasis>
|
||||
<literal><!entity…></literal> 及
|
||||
<literal><!doctype…></literal>。</para>
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>Acronyms</title>
|
||||
<title>縮寫字</title>
|
||||
|
||||
<para>Acronyms should generally be spelled out the first time
|
||||
they appear in a book, as in: "Network Time Protocol (<acronym
|
||||
role="Network Time Protocol">NTP</acronym>)." After the
|
||||
acronym has been defined, you should generally use the acronym
|
||||
only (not the whole term, unless it makes more sense
|
||||
contextually to use the whole term). Usually, acronyms are
|
||||
defined only one per book. But if you prefer, you can also
|
||||
define them the first time they appear in each chapter.</para>
|
||||
<para>縮寫字(acronym)通常在書中第一次提到時,必須同時列出完整拼法,
|
||||
比如:"Network Time Protocol (<acronym
|
||||
role="Network Time Protocol">NTP</acronym>)"。
|
||||
定義縮寫字之後,應該儘量只使用該縮寫字(而非完整詞彙,
|
||||
除非使用完整詞彙可以更能表達語意)來表達即可。
|
||||
通常每本書只會第一次提到時,才會列出完整詞彙,
|
||||
但若您高興也可以在每章第一次提到時又列出完整詞彙。</para>
|
||||
|
||||
<para>The first three uses of an acronym should be enclosed in
|
||||
<acronym> tags, with a <literal>role</literal> attribute
|
||||
with the full term defined. This allows a link to the
|
||||
glossary to be created, and for mouseovers to be rendered with
|
||||
the fully expanded term.</para>
|
||||
<para>此外,同一縮寫字在前三次使用時,須使用 <acronym> tag,
|
||||
並把完整詞彙附在 <literal>role</literal> 屬性內做說明。
|
||||
如此一來就會建立詞彙表,並且當滑鼠移至該縮寫字上方時,
|
||||
就會顯示完整詞彙。</para>
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>Indentation</title>
|
||||
<title>縮排</title>
|
||||
|
||||
<para>Each file starts with indentation set at column 0,
|
||||
<emphasis>regardless</emphasis> of the indentation level of the file
|
||||
which might contain this one.</para>
|
||||
<para><emphasis>無論</emphasis> 檔案縮排設定為何,
|
||||
每個檔案一開始的縮排(indentation)都是從 column 0 開始</para>
|
||||
|
||||
<para>Opening tags increase the indentation level by 2 spaces.
|
||||
Closing tags decrease the indentation level by 2 spaces. Blocks
|
||||
of 8 spaces at the start of a line should be replaced with a tab.
|
||||
Do not use
|
||||
spaces in front of tabs, and do not add extraneous whitespace at the
|
||||
end of a line. Content
|
||||
within elements should be indented by two spaces if the content runs
|
||||
over more than one line.</para>
|
||||
<para>未完的 tag 會以多兩個空白來增加縮排,
|
||||
結尾的 tag 則少兩個空白來縮減縮排。 若已達 8 個空白,則以 tab 取代之。
|
||||
此外,在 tab 前面不要再用空白,也不要在每行後面加上空白。
|
||||
每個 tag 的內文若超過一行的話,則接下來的就多兩個空白以做縮排。</para>
|
||||
|
||||
<para>For example, the source for this section looks something
|
||||
like:</para>
|
||||
<para>舉個例子,這節所用的寫法大致是下面這樣:</para>
|
||||
|
||||
<programlisting><![ CDATA [+--- This is column 0
|
||||
V
|
||||
|
@ -232,46 +217,42 @@ V
|
|||
<title>...</title>
|
||||
|
||||
<sect2>
|
||||
<title>Indentation</title>
|
||||
<title>縮排</title>
|
||||
|
||||
<para>Each file starts with indentation set at column 0,
|
||||
<emphasis>regardless</emphasis> of the indentation level of the file
|
||||
which might contain this one.</para>
|
||||
<para><emphasis>無論</emphasis> 檔案縮排設定為何,
|
||||
每個檔案一開始的縮排(indentation)都是從 column 0 開始。</para>
|
||||
|
||||
...
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>]]></programlisting>
|
||||
|
||||
<para>If you use <application>Emacs</application> or
|
||||
<application>XEmacs</application> to edit the files then
|
||||
<literal>sgml-mode</literal> should be loaded automatically, and the
|
||||
<application>Emacs</application> local variables at the bottom of each file should enforce these
|
||||
styles.</para>
|
||||
<para>若用 <application>Emacs</application> 或
|
||||
<application>XEmacs</application> 來編輯這檔,那麼會自動進入
|
||||
<literal>sgml-mode</literal> 模式,
|
||||
然後就會強制使用每個檔案最下方的環境設定。</para>
|
||||
|
||||
<para><application>Vim</application> users might want to configure
|
||||
their editor with:</para>
|
||||
<para><application>Vim</application> 愛用者也可以用下列設定來調整:</para>
|
||||
|
||||
<programlisting>augroup sgmledit
|
||||
autocmd FileType sgml set formatoptions=cq2l " Special formatting options
|
||||
autocmd FileType sgml set textwidth=70 " Wrap lines at 70 columns
|
||||
autocmd FileType sgml set shiftwidth=2 " Automatically indent
|
||||
autocmd FileType sgml set softtabstop=2 " Tab key indents 2 spaces
|
||||
autocmd FileType sgml set tabstop=8 " Replace 8 spaces with a tab
|
||||
autocmd FileType sgml set autoindent " Automatic indentation
|
||||
autocmd FileType sgml set formatoptions=cq2l " 特殊格式選項
|
||||
autocmd FileType sgml set textwidth=70 " 在 70 column 處即自動換行
|
||||
autocmd FileType sgml set shiftwidth=2 " 自動縮排 2 個空白
|
||||
autocmd FileType sgml set softtabstop=2 " 按 Tab 會自動轉為兩個空白縮排
|
||||
autocmd FileType sgml set tabstop=8 " 把 8 個空白轉為 tab
|
||||
autocmd FileType sgml set autoindent " 自動縮排
|
||||
augroup END</programlisting>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>Tag style</title>
|
||||
<title>Tag 風格</title>
|
||||
|
||||
<sect3>
|
||||
<title>Tag spacing</title>
|
||||
<title>Tag 空行</title>
|
||||
|
||||
<para>Tags that start at the same indent as a previous tag
|
||||
should be separated by a blank line, and those that are not
|
||||
at the same indent as a previous tag should not:</para>
|
||||
<para>同一縮排等級的 tag 要以空一行來做區隔,而不同縮排等級的則不必。
|
||||
比如:</para>
|
||||
|
||||
<informalexample>
|
||||
<programlisting><![ CDATA [<article>
|
||||
|
|
Loading…
Reference in a new issue