TableOfContents

Include(ZPyUGnav)

可爱的Python编辑约定

2008-05-04 青年节前必须完成所有撰写工作!

分析

感谢新摧生婆的认真:

• [http://docs.google.com/Doc?id=ah9sz7kfxfhz_272b9rvdk 图书体例分析报告]

  • [http://docs.google.com/Doc?id=ah9sz7kfxfhz_30cv8mt6hm 回复080222 ZoomQuiet编辑意见]

• [http://docs.google.com/Doc?id=ah9sz7kfxfhz_34gqzhwcgt -5 PyDay 初体验和原始需求修改版]

对策

根据过往的修订,和几届编辑的沟通,基本清楚了

技术入门图书的要点

1. 中心内容明确
2. 整体内容足够
3. 各章内容完备

可爱的Python成书要求

1. 以实例故事为核心,展示社区体验,传达 Pythonic 思想
2. 选择和统一体例后半的 作弊条 形成呼应
3. 使用边条和书眉,将前后内容统一起来

追加书眉

建议根据[http://www.douban.com/subject/1395497/ MIND HACKS] 的设计给图书的3大部分追加书眉

CDay*

• 将原先的 PyDays 修订成 CDay ~ 光盘故事

• 每天的进度故事 使用统一的 CDay* 来标定,以便其它章节统一使用

KSay*

• 将原先的 KsDays 修订成 KDay ~ Karrigell故事

• 每天的进度故事 使用统一的 KDay* 来标定,以便其它章节统一使用

PCS*

• Python Cheat Sheet ~ Python 作弊条

• 将Py初学者作弊条汇集;常见任务处理;Py2.5 绝对简明手册 合成为 Python 作弊条!

• 根据前述两个实例故事 的内容,选择相关知识点,统一体例成 PCS* 来标定,以便其它章节统一使用

• 建议由 清风和张沋鹏協同快速完成; 并特邀 现在 ZEUUX 成员的前博文编辑,方舟掺合!

• 同时参考好书 [http://www.lightbird.net/py-by-example/ Python by Example]

图例追加

似在故事各个章节尾部追加 内容图谱 标定出读者在整个图书内容的阅读位置

• attachment:CDay-3.png

体例追加

为将实例故事中涉及知识点在不打断叙述的前提下进行友好提示,约定以下行文体例:

{{{详细:: 表示以下内容出现在边条中 将涉及内容指向后面的 PCS* 请编辑设计明确的图标来引导 }}}

{{{注意:: 表示以下内容出现在边条中 包含警告事项,可能涉及内容会指向后面的 PCS* 请编辑设计明确的图标来引导 }}}

{{{脚注:: 表示以下内容出现在脚注中 包含题外的信息，笔者心路，等等和正文有关， 但是不直接的信息 请编辑设计明确的图标来引导 }}}

附图约定

图片统一命名

图 Charpt-No.png
|  |      |  +-- 统一使用PNG格式提供
|  |      +-- 章节附图序号
|  +-- 章节序号
+-- 统一标识字

• e.g:

  • 图 CDay-4-2.png 意为 CDay -4 章节 第2附图

行文效果

所有代码已经执行的命令行效果将使用文本方式罗列!

字体建议

• 文字使用圆体 比如说:Vera Sans YuanTi Mono

• 数字字母使用: Monaco
• 保证数字和字母，以及中文标点和代码标点有巨大的差异

  • 特别是 0 vs Oo; I vs l

颜色建议

   1 # coding : utf-8
   2 import os
   3 export = []
   4 for root, dirs, files in os.walk('/media/cdrom0'):
   5     export.append("\n %s;%s;%s" % (root,dirs,files))
   6 open('mycd2.cdc', 'w').write(''.join(export))

• attachment:ipy-effect0.png
• attachment:ipy-effect1.png

图标建议

• 所有图书中涉及到的语言/软件/社区/团队 有标准logo的都应该尽量收集和正确的使用!

目录调整

Include(/TreeOfBook,,from="^##startInc$",to="^##endInc$")

排版意见

• [:/LayoutDiscuss:图书排版效果讨论]

反馈

创建 by -- ZoomQuiet [DateTime(2008-03-30T14:01:36Z)]