Contents

可爱的Python编辑约定

CPyUG社区>

ZPyUG

BPyUG

SPyUG

/推广Py/OBP~开放图书/可爱的Py/TPiP/杂项...

ACL

#acl LovPyBookGroup:read,write,delete,revert All:

交付后,所有章节的正文将使用以上ACL进行封闭,6个月后恢复,以便支持图书的销售,,,

可爱的Python编辑约定

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

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

再期愿: 2008-09-01 前必须完成所有内容撰写工作!

不得不愿: 2008-11-11 光棍节前可以见到全部排版小样!

终于可以愿: 2008-12-31 元旦节前可以见到全部排版小样!

终于再次发愿: Fwd: 与两位老师协商《可爱的Python》页码压缩事宜 ^{- OpenBookProject | Google 网上论坛} 可以顺利完成

终成正果！

2009-09-13 在互动网9周年庆生会进行发售宣传！

排版调整页数

文前内容~
 哲思社区总序 2页
 推荐序  1页+背白
 序     2页
 前言 4页
~~~~~~~~~~~~~~~~~~~~~
合计          8页
~~~~~~~~~~~~~~~~~~~~~
正文内容~
CDays内容     78页（包括一个背白）
KDays内容     72页
PCS内容       261页（其中PCS304应该是34页）
~~~~~~~~~~~~~~~~~~~~~
合计          411页
~~~~~~~~~~~~~~~~~~~~~
文后内容~
 附录总言         1页
 术语索引         15页+背白
 行者箴言         17页+背白
 跋             z序(4页)+15页(包含谢序和后记故事) = 19页+背白 最多15页
~~~~~~~~~~~~~~~~~~~~~
合计             55页
~~~~~~~~~~~~~~~~~~~~~
总计             474页

编辑分析

感谢新摧生婆的认真:

图书体例分析报告
- 回复080222 ZoomQuiet编辑意见
-5 PyDay 初体验和原始需求修改版

排版意见

讨论和进展

改进对策

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

技术入门图书的要点

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

可爱的Python成书要求

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

故事图谱

故事图谱图例设计和约定

追加书眉

建议根据MIND HACKS 的设计给图书的3大部分追加书眉

CDay*

将原先的 PyDays 修订成 CDay ~ 光盘故事
每天的进度故事使用统一的 CDay* 来标定,以便其它章节统一使用

KSay*

将原先的 KsDays 修订成 KDay ~ Karrigell故事
每天的进度故事使用统一的 KDay* 来标定,以便其它章节统一使用

PCS*

Python Cheat Sheet ~ Python 作弊条
将Py初学者作弊条汇集;常见任务处理;Py2.5 绝对简明手册 合成为 Python 作弊条!
根据前述两个实例故事的内容,选择相关知识点,统一体例成 PCS* 来标定,以便其它章节统一使用
建议由清风和张沋鹏協同快速完成; 并特邀现在 ZEUUX 成员的前博文编辑,方舟掺合!
同时参考好书 Python by Example

图例追加

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

CDay-5

CDay-4

体例追加

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

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

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

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

附图约定

说明图示,命名规范

正文内容:
图 KDay2-1 代码框架模板实例
|  |     | +-- 图片内容简述
|  |     +-- 章节图片序号
|  +-- 章节编号
+-- 附图 前缀词

attachment:KDay2-script-templet.png
|          |      |             +-- 统一使用 png 格式
|          |      +-- 附图内容简介
|          +-- 章节编号
+-- 维基语法,加载图片,不用印刷,只用于排版时认领图片,排版在此

这样，就将图片的印刷说明和截屏的图片文件名分离但关联起来了！

行文效果

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

字体建议

文字使用圆体比如说:Vera Sans YuanTi Mono
数字字母使用: Monaco
保证数字和字母，以及中文标点和代码标点有巨大的差异
- 特别是 0 vs Oo; I vs l
参考资料:
- 程序员最喜欢用的编程字体
- 常见黑体显示效果对比 - Nicky's blog

颜色建议

   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))

图标建议

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

截屏注意

提醒

不要出现多余工具条,只有地址栏和页面标签就足够了
尽量截取小的面积,将关键信息点包含就成,可以调节窗口大小,甚至使用 Ctrl+- 来缩小字体,,,
所有命令行相关的截屏，要统一字体和颜色(同前建议),同时Issue 843~Shell前导字串问题:
1. 演示要点时,都是 ~$ ls -lR 类似
2. 演示故事代码运行时, 都在 ~/LovelyPython$ 之后
  - 将SVN相关目录，链接过来就好
3. 注意,都应该有个空格前导

Bash配置

# Ubuntu 中 ~/.bashrc
case "$TERM" in
xterm-color)
    PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\$ '
    ;;
*)
    PS1='${debian_chroot:+($debian_chroot)}\w\$ '
    ;;
esac

字体配置

命令行中的:

浏览器中的:

桌面中的:

系统中的:

#Ubuntu 8.04 是 /etc/fonts/conf.avail/69-language-selector-zh-cn.conf
<fontconfig>
        <match target="pattern">
                <test qual="any" name="family">
                        <string>serif</string>
                </test>
                <edit name="family" mode="prepend" binding="strong">
                        <string>Monaco</string>
                        <string>Vera Sans YuanTi Mono</string>
                        <string>WenQuanYi Zen Hei</string>
...
        <match target="pattern">
                <test qual="any" name="family">
                        <string>sans-serif</string>
                </test>
                <edit name="family" mode="prepend" binding="strong">
                        <string>Monaco</string>
                        <string>Vera Sans YuanTi Mono</string>
                        <string>WenQuanYi Zen Hei</string>
...

        <match target="pattern">
                <test qual="any" name="family">
                        <string>monospace</string>
                </test>
                <edit name="family" mode="prepend" binding="strong">
                        <string>Monaco</string>
                        <string>Vera Sans YuanTi Mono</string>
                        <string>WenQuanYi Zen Hei</string>
...

链接注意

为了读者输入网址的方便，建议:

所有外部URL 都配合提供压缩后的短访问地址,
例如:

Rockety 的Karrigell 使用体验,
访问地址:http://wiki.woodpecker.org.cn/moin/RocketyKarrigell
精巧地址:http://bit.ly/3wEwn3 
or http://tinyurl.com/4qz4ab
,,,

URL 压缩服务

http://bit.ly/
http://tinyurl.com/
都有快捷JS 工具,使用效果如下:

usage-bit.ly.png

从使用速度看,推荐使用 http://bit.ly/

目录调整

<<LovelyPython>>
+-- 启章
+-- CDays
  +-- -5 CDay Python初体验和原始需求
  +-- -4 CDay 可用的首个Python脚本
  +-- -3 CDay 通过函式进行功能化
  +-- -2 CDay 利用文本文件完成核心功能
  +-- -1 CDay 中文处理完成功能的实用化
  +-- CDay 0 感受软件工程进行发布的准备
  +-- CDay +1 首次重构优化数据结构
  +-- CDay +2 用户界面友好化
  +-- CDay +3 应用多线程再次优化
  \-- CDay N 基于Python的无尽探索
+-- KDays
  +-- KDay 0 Web开发启航
  +-- KDay 1 品尝KarriGell
  +-- KDay 2 通过表单直接完成功能！
  +-- KDay 3 使用第3方模块规范化表单
  +-- KDay 4 发现KS模式重构代码
  +-- KDay 5 通过session重构
  +-- KDay 6 利用XML人性化組織信息
  \-- KDay N 经验总结畅想web应用
+-- PCS
  +-- 环境篇 (运行Python 的最基础 PCS 0~10)
  |  +-- PCS0 如何安装Python
  |  +-- PCS1 交互环境之命令行
  |  +-- PCS2 交互环境之iPython
  |  +-- PCS3 交互环境之winpy
  |  +-- PCS4 常用自省
  |  +-- PCS5 Python脚本文件
  |  +-- PCS6 Python与中文
  |  \-- PCS7 Python编码规范
  +-- 语法篇 (Python 的基础实用语法 PCS 100~199)
  |  +-- PCS100 import
  |  +-- PCS101 内建数据类型
  |  +-- PCS102 for 循环
  |  +-- PCS103 缩进
  |  +-- PCS104 注释
  |  +-- PCS105 对象
  |  +-- PCS106 文件对象
  |  +-- PCS107 字串格式化
  |  +-- PCS108 函式
  |  +-- PCS109 系统参数
  |  +-- PCS110 逻辑分支
  |  +-- PCS111 类
  |  +-- PCS112 判别式(动态)
  |  +-- PCS113 异常
  |  +-- PCS114 交互参数
  |  \-- PCS115 FP初体验
  +-- 模块篇 (Python 的常用模块介绍 PCS 200~299)
  |  +-- PCS200 os(.stat;.path)
  |  +-- PCS201 cmd
  |  +-- PCS202 chardet
  |  +-- PCS203 epydoc
  |  +-- PCS204 ConfigParser
  |  +-- PCS205 内建函式(enumerate)
  |  +-- PCS206 thread
  |  +-- PCS207 threading
  |  +-- PCS208 dict4ini
  |  +-- PCS209 fnmatch
  |  +-- PCS210 pickle
  |  +-- PCS211 base64
  |  +-- PCS212 shutil
  |  +-- PCS213 time
  |  \-- PCS214 ElementTree
  +-- 框架篇 (Python 的应用框架介绍 PCS 300~399)
  |  +-- PCS300 CherryPy
  |  +-- PCS301 Karrigell
  |  +-- PCS302 Web.py
  |  +-- PCS303 web2py
  |  +-- PCS304 Django
  |  +-- PCS305 TurboGears
  |  +-- PCS306 PyLons
  |  +-- PCS307 Quixote
  |  +-- PCS308 Zope
  |  +-- PCS309 Template (Web应用中的模板系统对比)
  |  +-- PCS310 LEO
  |  \-- PCS311 MoinMoin 维基平台
  +-- 友邻篇 (涉及的非Python 相关知识点 PCS 400~499)
     +-- PCS400 GAE
     +-- PCS401 DHTML
     +-- PCS402 XML
     +-- PCS403 思维导图
     \-- PCS404 代码重构浅说
+-- 附录
  +-- 行者箴言
  +-- 资源索引
  +-- 练习解答
  +-- 术语索引
  \-- 后记
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
  !-- 实作篇 (实际运用Python的小实作 PCS 400~499)<风格不合，图书不纳，网络分享>
  [http://wiki.woodpecker.org.cn/moin/MicroProj 中挑选]
     +-- PCS400 读取google搜索信息
     +-- PCS401 从 whois 信息中提取网段信息
     +-- PCS402 找出两个文件中不同部分
     +-- PCS403 大文件排序
     \-- PCS404 大文件比较

反馈

创建 by -- ZoomQuiet [2008-03-30 14:01:36]

ObpLovelyPyEditorRule