Differences between revisions 19 and 21 (spanning 2 versions)

可爱的Python编辑约定

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

再愿: 2008-06-15 前必须完成所有撰写工作!

分析

感谢新摧生婆的认真:

[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 初体验和原始需求修改版]

对策

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

技术入门图书的要点

中心内容明确
整体内容足够
各章内容完备

可爱的Python成书要求

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

追加书眉

建议根据[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

故事图谱

[:/StoryMapping:故事图谱图例]

体例追加

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

{{{详细:: 表示以下内容出现在边条中将涉及内容指向后面的 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:图书排版效果讨论]

进度

[email protected]>
to      [email protected]
cc      zeuux-press <[email protected]>
date    Mon, Jun 2, 2008 at 10:31 PM
subject Re: [zeuux-press] [OBP:2367] Re: [LovelyPy]成书进度+TOC

关于LovelyPython的作者们，最近似乎都没什么动静么～

因为看到PCS中还有很多一部分没完成，前部分的PCS0～7及PCS100~199很多都有现成素材，所以想问下能否直接用这些素材，能的话就可以快速完成，LP的作者们感兴趣的话就一起编写吧，似乎时间不多了。我大概找了下wiki上的资源，如下：

+-- 环境篇 (运行Python 的最基础 PCS 0~10)
  |  +-- PCS0 如何安装Python        ok
  |  +-- PCS1 交互环境之命令行    ok
  |  +-- PCS2 交互环境之iPython  ok
  |  +-- PCS3 交互环境之winpy？
  |  +-- PCS4 常用自省   http://www.woodpecker.org.cn:9081/doc/abyteofpython_cn/chinese/ch07s07.html
  |  +-- PCS5 Python脚本文件
  |  +-- PCS6 Python与中文   http://wiki.woodpecker.org.cn/moin/ObpLovelyPython/CDay-1
  |  `-- PCS7 Python编码规范   http://wiki.woodpecker.org.cn/moin/PythonCodingRule
  +-- 语法篇 (Python 的基础实用语法 PCS 100~199)
  |  +-- PCS100 import   http://wiki.woodpecker.org.cn/moin/ObpLovelyPython/LpyQLearn-6-model
  |  +-- PCS101 内建数据类型   http://wiki.woodpecker.org.cn/moin/ObpLovelyPython/LpyQLearn-2-data
  |  +-- PCS102 for 循环   http://wiki.woodpecker.org.cn/moin/ObpLovelyPython/LpyQLearn-3-process ／ http://wiki.woodpecker.org.cn/moin/PyAbsolutelyZipManual
  |  +-- PCS103 缩进  http://www.woodpecker.org.cn:9081/doc/abyteofpython_cn/chinese/ch04s09.html
  |  +-- PCS104 注释  http://wiki.woodpecker.org.cn/moin/CodeCommentingRule
  |  +-- PCS105 对象  http://www.woodpecker.org.cn:9081/doc/abyteofpython_cn/chinese/ch04s07.html
  |  +-- PCS106 文件对象  
  |  +-- PCS107 字串格式化  http://www.woodpecker.org.cn/diveintopython/native_data_types/formatting_strings.html
  |  +-- PCS108 函式    http://wiki.woodpecker.org.cn/moin/ObpLovelyPython/LpyQLearn-4-func
  |  +-- PCS109 系统参数
  |  +-- PCS110 逻辑分支  http://wiki.woodpecker.org.cn/moin/ObpLovelyPython/LpyQLearn-3-process ／ http://wiki.woodpecker.org.cn/moin/PyAbsolutelyZipManual
  |  +-- PCS111 类  http://wiki.woodpecker.org.cn/moin/ObpLovelyPython/LpyQLearn-5-object
  |  +-- PCS112 判别式(动态)
  |  +-- PCS113 异常  http://wiki.woodpecker.org.cn/moin/ObpLovelyPython/LpyQLearn-3-process ／ http://wiki.woodpecker.org.cn/moin/PyAbsolutelyZipManual
  |  +-- PCS114 交互参数
  |  `-- PCS115 FP初体验

   +-- 模块篇 (Python 的常用模块介绍 PCS 200~299)
  |  +-- PCS200 os(.stat;.path)        ok
  |  +-- PCS201 cmd   在.../openbookproject/PyStandardLib_zh/multiPages/moin
  |  +-- PCS202 chardet
  |  +-- PCS203 epydoc
  |  +-- PCS204 ConfigParser        ok
  |  +-- PCS205 内建函式(enumerate)        ok
  |  +-- PCS206 thread
  |  +-- PCS207 threading        ok
  |  +-- PCS208 dict4ini        ok
  |  +-- PCS209 fnmatch        ok
  |  +-- PCS210 pickle        ok
  |  +-- PCS211 base64        ok
  |  +-- PCS212 shutil        ok
  |  +-- PCS213 time        ok
  |  `-- PCS214 ElementTree        ok
  +-- 框架篇 (Python 的应用框架介绍 PCS 300~399)
  |  +-- PCS300 CherryPy        ok
  |  +-- PCS301 Karrigell        ok
  |  +-- PCS302 Web.py        ok
  |  +-- PCS303 web2py        ok
  |  +-- PCS304 Django        ok

  |  +-- PCS305 TurboGears
  |  +-- PCS306 PyLons
  |  +-- PCS307 Quixote
  |  +-- PCS308 Zope
  |  `-- PCS310 LEO

未标注的是没找到的，其中模块篇似乎很多都在PyStandardLib_zh/multiPages/moin中有相应内容。加油了，everybody！

反馈

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

PageComment2

[:/PageCommentData:PageCommentData]

Diff for "ObpLovelyPyEditorRule"