Differences between revisions 6 and 8 (spanning 2 versions)

[LovPy]moin文本排版指南

根据和编辑MSN 的沟通结论，快速组织指南给美术编辑使用 ~ 注意，可使用底部的注释框随时反馈沟通!

交付和排版流程

原先编辑习惯排版流程

作者提交有排版效果的 word 文档,保证文字/图片/代码质量,以及排版的基础效果
编辑協同美术编辑,在作者排版上进行增补,沟通意见,确认几个经典章节的基准排版效果;同时完成所有文字/文法/出版校对
将原稿和 基准排版章节文档,交付专业的排版公司,使用专业排版软件进行精排
排版小样出来后,编辑核对,确认后,转交印刷厂照排付印

当前社区模式的建议流程

社区提交无排版效果的纯文本/代码/图片,保证文字/图片/代码质量;前同时提供网络版本的维基页面,以及排版建议
编辑協同美术编辑,在理解纯文本(结构化文本)/代码/图片基础上,参考维基页面(不要直接使用维基页面来排版!)完成所有文字/文法/出版校对;然后统一初排成所有章节的基准排版文档
将原稿和基准排版章节文档,交付专业的排版公司,使用专业排版软件进行精排
排版小样出来后,编辑核对,和社区共同确认后,转交印刷厂照排付印

当前SVN目录使用

所以,交付的文件以SVN仓库中的为准,在正式交付时,将提供一个版本号[changeset],作为约束,从该指定版本号检出的SVN内容是最终交付稿件!

下载URL： http://openbookproject.googlecode.com/svn/trunk/LovelyPython/

./
|-- CDays           (CDays 实例故事代码)
|   |-- cday-1      (按照章节对应分立子目录收集)
|   +-- ..
|-- KDays           (KDays 实例故事代码)
|   |-- js          (共同JS表单验证模块)
|   |-- kday1       (按照章节对应分立子目录收集)
|   +-- ..
|-- PCS             (Python Cheat Sheet ~ Python 作弊条 内容)
|   |-- pcs-0       (按照章节对应分立子目录收集)
|   +-- ..
|-- exercise        (各章练习，按照章节对应收集)
|   |-- part1-CDays (CDays 实例故事练习，按照章节对应收集)
|   |   |-- cday-1  (按照章节对应收集)
|   |   +-- ..
|   |-- part2-KDays (KDays 实例故事练习，按照章节对应收集)
|   |   +-- ..
|   |-- part3-PCS   (PCS练习，按照章节对应收集)
|   |   +-- ..
|   `-- part4-Attach(附录练习，按照章节对应收集)
|       +-- ..
`-- pages           (图书主体正文 .moin 文本目录)
    |-- 4editor     (正文无关:图书编辑参考维基页面文本)
    |-- attachments (图书主体正文 对应各章附图/文)
    `-- reST        (正文无关:图书主体正文旧 reST格式文本)

moin 文本排版

由于SVN中提供的是无排版的纯文本,所以:

针对其的 基准排版 由美术编辑在理解后,自主进行;
除文字/代码/图片外一切图书排版,由编辑发挥专业素养主动进行,社区不进行干扰
社区提供对应的电子版本的维基页面(绝对相同的内容) 来进行对照/提示/参考

但是，基于长期的图书体验，社区谨提出以下排版建议

字体建议

本着技术阅读的体验，强烈建议排版时注意技术文档的字体！

参考

程序员最喜欢用的编程字体 http://www.2maomao.com/blog/best-programmer-fonts/
- 字体效果对比 http://www.lowing.org/fonts/allfonts.htm

建议

所有文字必须使用等宽字体!否则以下情况将无法对齐!!! attachment:2008-06-17-155149_319x149_scrot.png
所有E文使用 MONACO
- 下载: http://www.pa.msu.edu/ftp/pub/misc/tek-phaser/ttfonts/MONACO.TTF
所有中文使用圆体
- 常见黑体显示效果对比 http://www.osxcn.com/ubuntu/heiti-contrast.html
- 可以看到等宽字体中,只有 Vera Sans YuanTi Mono 在各种字体中都可以得到均匀清晰的效果
- 下载: http://download.coolcode.cn/vera-sans-yuanti.tar.gz

代码颜色

本着技术文档阅读的体验，强烈建议排版时注意代码颜色！

社区负责文字/代码/图片的质量,而编辑排版时,对代码更加要精确的再现,否则后果不言而喻!

Python 代码排版要求:
- 缩进空格是精确对应的(这和语法是绑定的如果缩进有问题,将无法运行!)
- 每层缩进建议是 4个半角空格
Python 代码颜色要求:
- 如果使用白底,则直接使用维基的页面效果如下:

   1 # coding : utf-8
   2 import os
   3 for root, dirs, files in os.walk('/media/cdrom0'):
   4   print root,dirs,files

如果使用深色底,则直接使用Vim效果如下: attachment:2008-06-17-154746_733x428_scrot.png
或是 Geditor 效果: attachment:2008-06-17-154617_626x272_scrot.png
总之,根据白底的语法着色,美观,合适的将代码的关键字/字串标志出来
其它 M$ 下面的各种编辑环境,只要支持语法着色的都可以!

版式/空间

本着原版图片阅读体验，强烈建议排版时注意页面的行间/页眉/页脚/页边的设计!

建议参考 O'REILLY 图书 "[http://www.douban.com/subject/1395497/ MIND HACKS]" 的设计对图书的各个内容块进行排版设计!

moin 内容块识别

虽然提供的是纯文本,但!其实是 MoinMoin 维基格式的结构化文本! 本身已经非常非常非常明确的将内容块的关系/结构表述清楚了!

超级无敌坚决建议编辑们稍微学习一下维基的语法就对 .moin 的结构化文本了若指掌了!
在图书撰写过程中,我们也特别注意,进行了非常小心的组织,没有使用过多的维基技巧,仅仅几类最最基础的结构化文本规则
详细的维基语法帮助: [http://wiki.woodpecker.org.cn/moin/%E5%B8%AE%E5%8A%A9-%E7%BC%96%E8%BE%91 帮助-编辑]

以下给出常见的结构化文本说明

标题

维基中使用单独行中前后的 = 进行标题/章节的聲明

= 大标题 =
== 二标题 ==
=== 三标题 ===
= 大标题 =

解析输出如下:

大标题

二标题

三标题

大标题

列表

引用

表格

包含

网络元素

反馈

创建 by -- ZoomQuiet [DateTime(2008-06-17T02:33:37Z)]

PageComment2

[:/PageCommentData:PageCommentData]

ObpLovelyPyEditorRule/LayoutMointext (last edited 2009-12-25 07:14:40 by localhost)

-  ⇤ ← Revision 6 as of 2008-06-17 06:57:01 → 
  Size: 3374
  Editor: ZoomQuiet
  Comment:
+   ← Revision 8 as of 2008-06-17 08:00:28 → ⇥
  Size: 6782
  Editor: ZoomQuiet
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 21:
-. 编辑協同美术编辑,在纯文本/代码/图片基础上,完成所有文字/文法/出版校对;然后统一初排出所有章节的`基准排版`文档
+. 编辑協同美术编辑,在理解`纯文本`(结构化文本)/代码/图片基础上,`参考维基页面`(不要直接使用维基页面来排版!)完成所有文字/文法/出版校对;然后统一初排成所有章节的`基准排版`文档
 Line 58:
+由于SVN中提供的是无排版的纯文本,所以:
 * 针对其的 `基准排版` 由美术编辑`在理解后`,自主进行; 
 * 除文字/代码/图片外一切图书排版,由编辑发挥专业素养主动进行,社区不进行干扰
 * 社区提供对应的 电子版本的维基页面(绝对相同的内容) 来进行对照/提示/参考
-Line 59:
+Line 63:
+`但是，基于长期的图书体验，社区谨提出以下排版建议`
-Line 60:
+Line 65:
-http://www.2maomao.com/blog/best-programmer-fonts/
+`本着技术阅读的体验，强烈建议排版时注意技术文档的字体！`
 参考:: 
  * 程序员最喜欢用的编程字体 http://www.2maomao.com/blog/best-programmer-fonts/
   * 字体效果对比 http://www.lowing.org/fonts/allfonts.htm
 建议::
  * 所有文字必须使用等宽字体!否则以下情况将无法对齐!!!
  attachment:2008-06-17-155149_319x149_scrot.png
  * 所有E文使用 MONACO
   * 下载: http://www.pa.msu.edu/ftp/pub/misc/tek-phaser/ttfonts/MONACO.TTF
  * 所有中文使用 圆体
   * 常见黑体显示效果对比 http://www.osxcn.com/ubuntu/heiti-contrast.html
   * 可以看到等宽字体中,只有 `Vera Sans YuanTi Mono` 在各种字体中都可以得到均匀清晰的效果
   * 下载: http://download.coolcode.cn/vera-sans-yuanti.tar.gz
   
=== 代码颜色 ===
`本着技术文档阅读的体验，强烈建议排版时注意代码颜色！`
-Line 62:
+Line 82:
-=== 颜色建议 ===
+社区负责 文字/代码/图片 的质量,而编辑排版时,对代码更加要精确的再现,否则后果不言而喻!
-Line 64:
+Line 84:
-=== 位置建议 ===
+ Python 代码排版要求:
   * 缩进空格是精确对应的(这和语法是绑定的如果缩进有问题,将无法运行!)
   * 每层缩进 建议是 `4个半角空格`
-Line 66:
+Line 88:
-=== 版式建议 ===
+ Python 代码颜色要求:
   * 如果使用白底,则直接使用 维基的页面效果 如下:
{{{#!python
# coding : utf-8
import os
for root, dirs, files in os.walk('/media/cdrom0'):
  print root,dirs,files
}}}
   * 如果使用深色底,则直接使用Vim效果 如下:
   attachment:2008-06-17-154746_733x428_scrot.png
   * 或是 Geditor 效果:
   attachment:2008-06-17-154617_626x272_scrot.png
   * 总之,根据白底的语法着色,美观,合适的将代码的关键字/字串 标志出来
   * 其它 M$ 下面的各种编辑环境,只要支持语法着色的都可以!
   

=== 版式/空间 ===
`本着原版图片阅读体验，强烈建议排版时注意页面的行间/页眉/页脚/页边 的设计!`

建议参考 O'REILLY 图书 ''' "[http://www.douban.com/subject/1395497/ MIND HACKS]" ''' 的设计对图书的各个内容块进行排版设计!
-Line 69:
+Line 111:
+虽然提供的是纯文本,但!其实是 MoinMoin 维基格式的结构化文本! `本身已经非常非常非常明确的将内容块的关系/结构表述清楚了!`
 * 超级无敌坚决建议编辑们稍微学习一下 维基的语法就对 `.moin` 的结构化文本了若指掌了!
 * 在图书撰写过程中,我们也特别注意,进行了非常小心的组织,没有使用过多的维基技巧,仅仅几类最最基础的结构化文本规则
 * 详细的维基语法帮助: '''[http://wiki.woodpecker.org.cn/moin/%E5%B8%AE%E5%8A%A9-%E7%BC%96%E8%BE%91 帮助-编辑]'''
 
`以下给出常见的结构化文本说明`
=== 标题 ===
维基中使用 单独行中前后的 `=` 进行标题/章节的聲明
{{{
= 大标题 =
== 二标题 ==
=== 三标题 ===
= 大标题 =
}}}
-Line 70:
+Line 126:
-=== 网络元素 ===
+解析输出如下:
= 大标题 =
== 二标题 ==
=== 三标题 ===
= 大标题 =
-Line 72:
+Line 132:
-=== 标题 ===
-Line 78:
+Line 137:
+=== 表格 ===

=== 包含 ===

=== 网络元素 ===

Diff for "ObpLovelyPyEditorRule/LayoutMointext"