Boost C++ 库

...世界上最受推崇和专业设计的 C++ 库项目之一。 Herb SutterAndrei Alexandrescu, C++ 编码标准

PrevUpHomeNext

第46章. Quickbook 1.7

Joel de Guzman

Eric Niebler

根据 Boost 软件许可协议 1.0 版发布。(请参阅随附文件 LICENSE_1_0.txt 或访问 https://boost.ac.cn/LICENSE_1_0.txt 复制)

目录

简介
变更日志
命令行用法
命令行选项
语法概要
注释
文档结构
文档信息
章节
短语级别元素
字体样式
可替换
引用
简单格式
角色
行内代码
代码块
源代码模式
换行
锚点
链接
锚点链接
refentry 链接
代码链接
转义
单字符转义
Unicode 转义
图像
脚注
宏展开
模板展开
条件生成
块级别元素
xinclude
段落
列表
代码
转义回 QuickBook
预格式化
块引用
提示
标题
通用标题
预定义宏
模板
简介
表格
变量列表
包含
导入
纯文本块
语言版本
升级到新版本
稳定版本
Quickbook 1.6
Quickbook 1.7
安装和配置
Mac OS X
Windows 2000, XP, 2003, Vista, 7
Debian, Ubuntu
编辑器支持
Scintilla 文本编辑器
KDE 支持
常见问题解答
快速参考

简介

为什么要用五天手工编程完成可以用五年时间自动化完成的事情呢?

-- Terrence Parr, ANTLR/PCCTS 作者

嗯,QuickBook 最初是一个周末的黑客项目。它最初的目的是作为一个使用 Spirit 的示例应用程序。它是什么?您现在看到的这份文档,是由 QuickBook 自动生成的。这些文件是从一个主文件

生成的。最初名为 QuickDoc,这个永不消亡的有趣工具,在 Eric Niebler 的帮助下进化成了一个更强大的工具,他复活了这个项目,使其能够生成 BoostBook 而不是 HTML。BoostBook 文档格式是 DocBook 的扩展,DocBook 是一种基于 SGML 或 XML 的文档描述格式。

[Tip] 提示

您无需了解任何关于 BoostBookDocBook 的知识即可使用 QuickBook。对 DocBook 的基本了解可能会有所帮助,但不是必需的。对于真正高级的功能,您需要了解 DocBook,但您可以一开始忽略它,也许可以一直忽略下去。

QuickBook 是一种 WikiWiki 风格的文档工具,专为 C++ 文档设计,使用简单的规则和标记来完成简单的格式化任务。QuickBook 扩展了 WikiWiki 的概念。与 WikiWiki 一样,QuickBook 文档是简单的文本文件。单个 QuickBook 文档可以生成一套完整的、链接良好的 HTML 和 PostScript/PDF 文档,其中包含图像和语法着色的源代码。

功能包括

  • 生成 BoostBook xml,以生成 HTML、PostScript 和 PDF
  • 简单的标记,用于链接到 Doxygen 生成的实体
  • 宏系统,用于简单的文本替换
  • 简单的标记,用于斜体、粗体、预格式化、简介、代码示例、表格、URL、锚点、图像等。
  • 代码示例的自动语法着色
  • CSS 支持

PrevUpHomeNext