Differences between revisions 42 and 43

可爱的Python编辑约定

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

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

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

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

编辑分析

感谢新摧生婆的认真:

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

排版意见

[:/LayoutMointext:moin文本排版指南]
[:/LayoutDiscuss:图书排版效果讨论一次]
[:/ContentDiscuss:图书修订讨论]^{080723 14:00~}

讨论和进展

^{080828 15:00~}[:/NewEditorDicuss:老编Lisa 加入,MSN讨论进度]
[:/080613-irc:080613~IRC-讨论未果]
[:/080612-irc:080612~IRC-编辑讨论]
[:/080602-liz:080602~liz]

改进对策

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

技术入门图书的要点

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

可爱的Python成书要求

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

故事图谱

[:/StoryMapping:故事图谱图例设计和约定]

追加书眉

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

图例追加

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

CDay-5

attachment:LovPy-CDays-5.png

CDay-4

attachment:LovPy-CDays-4.png

体例追加

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

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

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

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

附图约定

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

行文效果

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

字体建议

文字使用圆体比如说: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的都应该尽量收集和正确的使用!

截屏注意

提醒

不要出现多余工具条,只有地址栏和页面标签就足够了
尽量截取小的面积,将关键信息点包含就成,可以调节窗口大小,甚至使用 Ctrl+- 来缩小字体,,,
所有命令行相关的截屏，要统一字体和颜色(同前建议),同时[http://code.google.com/p/openbookproject/issues/detail?id=843 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

字体配置

命令行中的:

attachment:cfg-font4shell.png

浏览器中的:

attachment:cfg-font4firefox.png

桌面中的:

attachment:cfg-font4desktop.png

系统中的:

#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>
...

目录调整

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

反馈

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

PageComment2

[:/PageCommentData:PageCommentData]

Diff for "ObpLovelyPyEditorRule"