Boost C++ 程式庫

...世界上最受推崇且設計精良的 C++ 程式庫專案之一。 Herb SutterAndrei Alexandrescu,《C++ 程式碼規範

PrevUpHomeNext

第 48 章. Quickbook 1.7

Joel de Guzman

Eric Niebler

依據 Boost 軟體授權條款 1.0 版發行。(請參閱隨附檔案 LICENSE_1_0.txt 或複製於 https://boost.dev.org.tw/LICENSE_1_0.txt)

目錄

簡介
變更紀錄
命令列用法
命令列選項
語法摘要
註解
文件結構
文件資訊
章節
片語層級元素
字型樣式
可取代文字
引用
簡易格式化
角色
行內程式碼
程式碼區塊
原始碼模式
換行
錨點
連結
錨點連結
refentry 連結
程式碼連結
跳脫字元
單字元跳脫
Unicode 跳脫
圖片
註腳
巨集展開
樣板展開
條件式產生
區塊層級元素
xinclude
段落
清單
程式碼
跳脫回 QuickBook
預先格式化
區塊引用
告示
標題
通用標題
巨集
預定義巨集
樣板
Blurb
表格
變數清單
include
import
純文字區塊
語言版本
升級到新版本
穩定版本
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 產生的實體
  • 巨集系統,用於簡單的文字替換
  • 簡單的標記,用於斜體、粗體、預先格式化的文字、簡短說明、程式碼範例、表格、網址、錨點、圖片等等
  • 程式碼範例自動語法高亮顯示
  • 支援 CSS

PrevUpHomeNext