-
Notifications
You must be signed in to change notification settings - Fork 5
教程 --> 使用提纲创建文档 #22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
教程 --> 使用提纲创建文档 #22
Conversation
OMlalala
commented
Mar 6, 2018
- 译文翻译完成
- resolve Tutorials-->Creating Documents from Outlines #2
livingworld
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
翻译的很棒,也让我受益了,我的评论在commit中,仅作参考。
| <t tx="omlalala.20180206205022.285">Put something like this in the body of the @rst node:: | ||
| <t tx="omlalala.20180206205022.285">在 @rst 节点的内容文本中, 输入:: | ||
|
|
||
| ############# |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
上下划线与标题等长
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
不同意 @livingworld 的修改.
原因
原文 under/overlines must be at least as long as the title, 其中, at least 表明, 上/下划线所含字符数, 可以多于标题所含字符数, 不必须等于标题所含字符数.
可能的形式
- 上/下划线所含字符数, 等于 标题所含字符数
###########
Hello World
###########
- 上/下划线所含字符数, 多于 标题所含字符数
###############
Hello World
###############
坑
比较的是字符数, 而不是上/下划线与标题在视觉上的长度
大妈意见
大妈在 slack 中意见:
骗人…一般统一80字符长
在 官方文档 中, 未找到相关说明, 猜想, 一般技术文档的标题, 不会超过 80 字符
我的意见
根据原文 under/overlines must be at least as long as the title, 可选择两种翻译
上/下划线所含字符数, 必须至少与标题所含字符数相等上/下划线所含字符数, 必须不少于标题所含字符数
看大家觉得哪个合适, 或是有其他更好的翻译.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@OMlalala 好的,我没看清楚...
LeoDocs_OM.leo
Outdated
| 另外, rst3 命令要求单元标题的上/下划线使用 "#" 字符. | ||
| </t> | ||
| <t tx="omlalala.20180206205022.286">Put introductory words in the body of the @rst node itself: | ||
| <t tx="omlalala.20180206205022.286">在 @rst 节点中, 输入正文: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
同意修改, 谢谢提醒.
LeoDocs_OM.leo
Outdated
| 2. **新节点的标题成为章节的标题.** | ||
|
|
||
| 3. Type the contents of the section in the body text of the node. | ||
| 3. 在节点的内容文本中, 输入章节的内容. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
『在节点的内容文本中, 输入章节的内容.』=》『在节点的正文文本中, 输入章节的内容.』
『在节点的内容文本中, 输入章节的内容.』=》『在节点的正文中, 输入章节的内容.』
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
同意按第二种方式修改, 谢谢提醒.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@OMlalala 对了,里面有几处,可以找找。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
你的意思是, 翻译 body text 时,
由 内容文本 改为 正文, 是吗?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@OMlalala 嗯,是呀,有好几处这样的。
LeoDocs_OM.leo
Outdated
| - **你通过重组节点, 重组你的文档.** | ||
|
|
||
| There is *no* need to change markup when reorganizing your document, a huge improvement over writing "raw" rST. | ||
| 重组文档时, *没有* 必要修改标记, 相比海量输入 "原始" rST, 这是一个巨大的进步. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
『相比海量输入 "原始" rST』=》『相比编写 "原始" rST』
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
同意修改, 谢谢提醒.
LeoDocs_OM.leo
Outdated
| - 如果当前节点是一个 @rst 节点, 或 @rst 节点的后代节点, rst3 命令适用于最近的祖先(ancestor) @rst 节点. | ||
|
|
||
| If @bool rst3_call_docutils is True, the rst3 command will call docutils automatically to create the output files. For more information about Leo settings, see `this section <tutorial-basics.html#configuring-leo>`_. | ||
| - 其他情况, rst3 命令适用于所有后代 @rst 树. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
『其他情况』=>『否则』
『适用于』=>『应用于』
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
同意修改, 谢谢提醒.
LeoDocs_OM.leo
Outdated
|
|
||
| 2. Leo has a default stylesheet that centers titles and makes them big and bold, so you can disregard messages such as:: | ||
|
|
||
| 2. Leo 有一个默认的样式表, 可以加大加粗标题, 所以你可以忽视如下信息:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
『可以加大加粗标题』=>『可以居中和加大加粗标题』
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这个都被你发现了, 厉害! 谢谢提醒!
LeoDocs_OM.leo
Outdated
| - 生成的 rST 的章节层级, 对应 Leo 中的提纲层级. | ||
|
|
||
| - Sections levels in the generated rST correspond to outline levels in Leo. | ||
| - 你通过重组对应的 @rst 树来重组你 rST 文档. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
『 你通过』=>『 你只需要通过』
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
同意修改, 谢谢提醒.
LeoDocs_OM.leo
Outdated
| - @rst-no-head 节点插入文本(或标记) , 无需 rST 标题. | ||
|
|
||
| - The @button make-sphinx node in LeoDocs.leo calls sphinx automatically. | ||
| - rst3 命令将忽视 @rst-ignore 节点和 @rst-ignore-tree 节点. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
『 @rst-ignore-tree 节点.』=>『 @rst-ignore-tree 树.』
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这个都被你发现了, 厉害! 谢谢提醒!
LeoDocs_OM.leo
Outdated
| - The rst3 command works acts on the nearest ancestor @rst node, if any, or on all descendant @rst nodes. | ||
|
|
||
| - @rst-no-head nodes insert text (or markup) without an rST headline. | ||
| - rst3 命令作用于最近的祖先 @rst 节点, 或所有 @rst 节点的所有后代. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if any ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
谢谢提醒.
补全后翻译为
rst3 命令作用于最近的祖先 @rst 节点, 如果有的话.
LeoDocs_OM.leo
Outdated
| - The overline and underline must be identical. | ||
| - 上/下划线必须包含4个字符 | ||
| - 上/下划线必须至少与标题等长 | ||
| - 上划线与下划线必须完全一样 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
建议修改
上划线符号与下划线符号必须相同.
原因
如 官方文档 所述, 标题的标记符号, 有多种形式, 如: = - ` : . ' " ~ ^ _ * + .
这里, 作者应该是强磁, 上下两处符号, 必须相同.