[ceph.git] / ceph / src / boost / tools / auto_index / doc / autoindex.idx

# autoindex.idx index script file
# for Boost.autoindex Quickbook Doxygen documentation Auto-indexing.

# Copyright (c) 2011 Paul A. Bristow

# Use, modification and distribution is subject to the Boost Software
# License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)

# Diagnostic output - useful during refinement of the index.
# !debug your-choice-of-regular-expression-to-debug

# Terms that you want to appear in the Index.
# Term to display in index, and word(s) that are to be matched (as a regular expression).

# Diagnostic while testing.
#!debug regular-expression
# For example
#!debug \w*\<index\w*\>

appendix
chapter
section

AutoIndex
Quickbook
Boostbook
Docbook
Doxygen
Document Object Model "DOM"
XML
html
PDF
XSL

MSVC
side-by-side 
stylesheet \<stylesheet\w*\> 

"XSL stylesheet" \<(XSL|stylesheet)\w*\> 

bjam
jamfile
Boost.Build

"log file" \<log\w*\>

C++

macro
function
class
typedef

# Plural, and plurals.
plural \<plural\w*\> 

# To allow plurals:
index \<index\w*\>

# Allow hyperlink and hyperlinking:
hyperlink \<hyperlink\w*\>

# Two word index term, allowing plurals.
"side effect" \<side effect\w*\>

text \<text\w*\>

page \<page\w*\> 
appendix \<appendi\w*\> 
section \<section\w*\> 
chapter \<chapter\w*\> 

script

verbose   \<\w*verbose\w*\> 
debug  \<debug\w*\> 

index term  "index term"

!exclude junk
# Exclude the index term junk from the index,
# so that "junk" anywhere does not have an index entry.

# Remove leading "A" or "The" prefixes from section titles.
!rewrite-name "(?i)(?:A|The)\s+(.*)" "\1"

!rewrite-name "Additional Implementation Notes" "Implementation Notes"
Commit	Line	Data
7c673cae FG	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
	21	appendix
	22	chapter
	23	section
	24
	25	AutoIndex
	26	Quickbook
	27	Boostbook
	28	Docbook
	29	Doxygen
	30	Document Object Model "DOM"
	31	XML
	32	html
	33	PDF
	34	XSL
	35
	36	MSVC
	37	side-by-side
	38	stylesheet \<stylesheet\w*\>
	39
	40	"XSL stylesheet" \<(XSL\|stylesheet)\w*\>
	41
	42	bjam
	43	jamfile
	44	Boost.Build
	45
	46	"log file" \<log\w*\>
	47
	48	C++
	49
	50	macro
	51	function
	52	class
	53	typedef
	54
	55	# Plural, and plurals.
	56	plural \<plural\w*\>
	57
	58	# To allow plurals:
	59	index \<index\w*\>
	60
	61	# Allow hyperlink and hyperlinking:
	62	hyperlink \<hyperlink\w*\>
	63
	64	# Two word index term, allowing plurals.
65	"side effect" \<side effect\w*\>
66
67	text \<text\w*\>
68
69	page \<page\w*\>
70	appendix \<appendi\w*\>
71	section \<section\w*\>
72	chapter \<chapter\w*\>
73
74	script
75
76	verbose \<\wverbose\w\>
77	debug \<debug\w*\>
78
79	index 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