• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# autoindex.idx index script file
2# for Boost.autoindex Quickbook Doxygen documentation Auto-indexing.
3
4# Copyright (c) 2011 Paul A. Bristow
5
6# Use, modification and distribution is subject to the Boost Software
7# License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
8# http://www.boost.org/LICENSE_1_0.txt)
9
10# Diagnostic output - useful during refinement of the index.
11# !debug your-choice-of-regular-expression-to-debug
12
13# Terms that you want to appear in the Index.
14# Term to display in index, and word(s) that are to be matched (as a regular expression).
15
16# Diagnostic while testing.
17#!debug regular-expression
18# For example
19#!debug \w*\<index\w*\>
20
21appendix
22chapter
23section
24
25AutoIndex
26Quickbook
27Boostbook
28Docbook
29Doxygen
30Document Object Model "DOM"
31XML
32html
33PDF
34XSL
35
36MSVC
37side-by-side
38stylesheet \<stylesheet\w*\>
39
40"XSL stylesheet" \<(XSL|stylesheet)\w*\>
41
42bjam
43jamfile
44Boost.Build
45
46"log file" \<log\w*\>
47
48C++
49
50macro
51function
52class
53typedef
54
55# Plural, and plurals.
56plural \<plural\w*\>
57
58# To allow plurals:
59index \<index\w*\>
60
61# Allow hyperlink and hyperlinking:
62hyperlink \<hyperlink\w*\>
63
64# Two word index term, allowing plurals.
65"side effect" \<side effect\w*\>
66
67text \<text\w*\>
68
69page \<page\w*\>
70appendix \<appendi\w*\>
71section \<section\w*\>
72chapter \<chapter\w*\>
73
74script
75
76verbose   \<\w*verbose\w*\>
77debug  \<debug\w*\>
78
79index term  "index term"
80
81!exclude junk
82# Exclude the index term junk from the index,
83# so that "junk" anywhere does not have an index entry.
84
85# Remove leading "A" or "The" prefixes from section titles.
86!rewrite-name "(?i)(?:A|The)\s+(.*)" "\1"
87
88!rewrite-name "Additional Implementation Notes" "Implementation Notes"
89
90
91
92
93
94