Boost C++ 库

...世界上最受推崇和设计精良的 C++ 库项目之一。 Herb SutterAndrei AlexandrescuC++ 编码规范

PrevUpHomeNext

第 47 章. 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