JuliaCN/julia_zh_cn

对照规范

Closed this issue · 2 comments

这几天一点点尝试着把英文部分逐段地插到arrays.rst的译文里,差不多总结出一些规范式的东西,目的其一是避免和rst格式的markup冲突,其二是为了在github里浏览和在readthedocs里浏览上一致。(github对rst的解析算不上完美)

  • 译文段落和原文段落顺序

在arrays.rst里,我尝试过原文在前,译文在后。后来决定改为译文在先,原文在后。会比较方便。

  • 原文里的doctest不再重复粘贴(为了精简),保证同一个doctest段只出一次。
  • 原文里的quoteblock,比如
Index assignment syntax is equivalent to a call to ``setindex!``::

      setindex!(A, X, I_1, I_2, ..., I_n)

注意到 :: 会自动把紧接着的内容作为quotation,一直到遇到空行才截止,所以遇到quotation的环境,最好不要把译文和原文交叉。好的例子是:

索引赋值语法等价于调用 ``setindex!``  :: 

      setindex!(A, X, I_1, I_2, ..., I_n)

.. Index assignment syntax is equivalent to a call to ``setindex!``::

..      setindex!(A, X, I_1, I_2, ..., I_n)

而不是

索引赋值语法等价于调用 ``setindex!``  :: 

.. Index assignment syntax is equivalent to a call to ``setindex!``::

      setindex!(A, X, I_1, I_2, ..., I_n)

  • 关于一句话开头的 ..
  1. 如果这一段之中没有双冒号 ::, 那么这句话当作comment处理。
  2. 如果这一段含有双冒号,那么rst将认为这里是quotation或者脚注之类。
  3. 如果是单冒号 :,那么rst会认为这是comment,但是却是reference。

所以复制原文过来的时候,尽可能地把结尾的冒号去掉,段中的冒号可以采用转义的办法
比如 :\:,或者直接去掉也可以。

转换成汉语的冒号 也行吧?

应该也可以。