文档格式化
reST 输出文档中页眉和页脚的定制
7月28日
群英汇采用 reStructuredText(简称 reST)文本标记语言进行文档维护。在 cuirui 解决了 rst2pdf 对 reST 转换 PDF 的图片缩放问题之后,如何让生成的 PDF 更有表现力,下了一番功夫去研究。
- 页眉和页脚根据转换的格式(HTML,PDF),自动进行选择
- PDF 的页眉显示章节标题以及页码,而页脚则显示文档标题和公司名称及相关链接
- HTML 的页眉显示文档标题以及到官方文档的链接(公司网站该文档的安装位置),页脚显示网址
- 文档版本号和文档编译时间由 Debian 软件包配置文件中的 changelog 动态替换
阅读全部内容 »
在 reST 格式文档中,嵌入 Creative Commons 授权信息
7月9日
群英汇的用户手册文档以 Creative Commons 许可协议发布,但是仅仅在文档中用两个单词“Creative Commons”进行标识是不够的,因为:
- Creative Commons 不是一个,而是一组(六个)License 组成的许可协议家族
- 要在网站上的许可协议上,建立链接。链接到 creativecommons.org 网站上对应许可协议
- 只有在页面中建立到 creativecommons.org 的链接,才能被搜索引擎识别出网页/资源对应的许可协议
- 只有建立链接后,也才可能让您的共享资源,在 Search@CC 上搜索到
如何使用 reStructuredText 格式(简称 reST)编写的文档中嵌入 CC 许可证链接呢?我们公司的很多文档都是用 reST 格式维护的。
能否突破 reST 表格语法的局限
1月11日
reST 表格的局限
reST, reStructuredText 是也。今天写了一条博文:《团队致胜之道——群英汇的解决方案》。其中博文最后嵌入的表格,是用 reST 写的,然后用 DocBones 转换为 HTML。但是只能将表格的第一行设置为 Table Header,想同时将第一列也设置为表头格式,没有成功。
reST编号列表的语法注意事项
1月10日
昨天用 DocBones 工具创建了一个新文档 Subversion ChangeLog,并将部分内容贴在这里,即博文:Subversion 1.6 修改记录。即先用 reST 格式写文档,然后转换为 HTML,再将转换后的 HTML 粘贴在博客中。
本来准备在每个章节内,首先是编号列表,编号列表内是符号列表,但是出现了下面的问题:

最新评论