Boost C++ 库

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

PrevUpHomeNext

步骤 6:使用 XML 处理指令来控制索引内容。

有时,当您需要从索引中排除某些文本部分时,可以使用以下 XML 处理指令来实现。

指令

效果

<?BoostAutoIndex IgnoreSection?>

导致当前整个 section 从索引中排除。“section”指的是真正的“section”或任何同级 XML 元素:“dedication”、“toc”、“lot”、“glossary”、“bibliography”、“preface”、“chapter”、“reference”、“part”、“article”、“appendix”、“index”、“setindex”、“colophon”、“sect1”、“refentry”、“simplesect”、“section” 或 “partintro”。

<?BoostAutoIndex IgnoreBlock?>

导致当前整个文本块从索引中排除。文本块可以是上面列出的任何 section/chapter 元素,或段落、代码列表、表格等。完整列表为:“calloutlist”、“glosslist”、“bibliolist”、“itemizedlist”、“orderedlist”、“segmentedlist”、“simplelist”、“variablelist”、“caution”、“important”、“note”、“tip”、“warning”、“literallayout”、“programlisting”、“programlistingco”、“screen”、“screenco”、“screenshot”、“synopsis”、“cmdsynopsis”、“funcsynopsis”、“classsynopsis”、“fieldsynopsis”、“constructorsynopsis”、“destructorsynopsis”、“methodsynopsis”、“formalpara”、“para”、“simpara”、“address”、“blockquote”、“graphic”、“graphicco”、“mediaobject”、“mediaobjectco”、“informalequation”、“informalexample”、“informalfigure”、“informaltable”、“equation”、“example”、“figure”、“table”、“msgset”、“procedure”、“sidebar”、“qandaset”、“task”、“productionset”、“constraintdef”、“anchor”、“bridgehead”、“remark”、“highlights”、“abstract”、“authorblurb” 或 “epigraph”。

对于 Quickbook 用户,文件 auto_index_helpers.qbk 包含一个辅助模板,可帮助插入这些处理指令,例如

[AutoIndex IgnoreSection]

将导致该 section 不被索引。


PrevUpHomeNext