5.10 Index-generating Markup

Effective index generation for technical documents can be very difficult, especially for someone familiar with the topic but not the creation of indexes. Much of the difficulty arises in the area of terminology: including the terms an expert would use for a concept is not sufficient. Coming up with the terms that a novice would look up is fairly difficult for an author who, typically, is an expert in the area she is writing on.

The truly difficult aspects of index generation are not areas with which the documentation tools can help. However, ease of producing the index once content decisions are made is within the scope of the tools. Markup is provided which the processing software is able to use to generate a variety of kinds of index entry with minimal effort. Additionally, many of the environments described in section 5.3, ``Information Units,'' will generate appropriate entries into the general and module indexes.

The following macro can be used to control the generation of index data, and should be used in the document preamble:

\makemodindex: This should be used in the document preamble if a ``Module Index'' is desired for a document containing reference material on many modules. This causes a data file libjobname.idx to be created from the \declaremodule macros. This file can be processed by the makeindex program to generate a file which can be \input into the document at the desired location of the module index.

There are a number of macros that are useful for adding index entries for particular concepts, many of which are specific to programming languages or even Python.

\bifuncindex {name}: Add an index entry referring to a built-in function named name; parentheses should not be included after name.

\exindex {exception}: Add a reference to an exception named exception. The exception may be either string- or class-based.

\kwindex {keyword}: Add a reference to a language keyword (not a keyword parameter in a function or method call).

\obindex {object type}: Add an index entry for a built-in object type.

\opindex {operator}: Add a reference to an operator, such as "+".

\refmodindex [key]{module}: Add an index entry for module module; if module contains an underscore, the optional parameter key should be provided as the same string with underscores removed. An index entry ``module (module)'' will be generated. This is intended for use with non-standard modules implemented in Python.

\refexmodindex [key]{module}: As for \refmodindex, but the index entry will be ``module (extension module).'' This is intended for use with non-standard modules not implemented in Python.

\refbimodindex [key]{module}: As for \refmodindex, but the index entry will be ``module (built-in module).'' This is intended for use with standard modules not implemented in Python.

\refstmodindex [key]{module}: As for \refmodindex, but the index entry will be ``module (standard module).'' This is intended for use with standard modules implemented in Python.

\stindex {statement}: Add an index entry for a statement type, such as print or try/finally.
XXX Need better examples of difference from \kwindex.

Additional macros are provided which are useful for conveniently creating general index entries which should appear at many places in the index by rotating a list of words. These are simple macros that simply use \index to build some number of index entries. Index entries build using these macros contain both primary and secondary text.

\indexii {word1}{word2}: Build two index entries. This is exactly equivalent to using \index{word1!word2} and \index{word2!word1}.

\indexiii {word1}{word2}{word3}: Build three index entries. This is exactly equivalent to using \index{word1!word2 word3}, \index{word2!word3, word1}, and \index{word3!word1 word2}.

\indexiv {word1}{word2}{word3}{word4}: Build four index entries. This is exactly equivalent to using \index{word1!word2 word3 word4}, \index{word2!word3 word4, word1}, \index{word3!word4, word1 word2}, and \index{word4!word1 word2 word3}.

See About this document... for information on suggesting changes.

iPhone 6 battery cover
hawaiian shoes
Volcom Board Shorts
Billabong Board Shorts
Quicksilver Board Shorts
I got a new iPhone5 battery case that I found on the web. I have a new ipad and I just love it. My new HTC One cellphone is awesome. I ordered a new iphone5 and I can't wait to get it. The smartphone charger I purchased is exactly what I needed. The new HTC phone is the best. I need more used AOL disks for my computer. The new hawaiian shoes has a new larger display.
hawaiian shoes
hawaiian shoes
You should look at List of surf and skate and this site iPhone Cases and this website too iPhone Cases
hawaiian sandals

hawaiian shoes

mophie Juice Pack Plus iPhone 6 plus battery pack is the best there is.

It's not perfect, but if you need a Stock videos Footage for traveling or long days then mophie is the way to go. Battery life is always an issue on every smartphone nowadays and third-party manufacturers provide external battery power supplies to ensure that life of your device will last for more than a day. I found arch support sandal on the Although traditionally mens work boots mens work boots are made with leather, the work boots work boots can also be made of a composite rubber, a plastic such as thermoplastic or even leather. website. We got a pair of Rigoberto Ramirez and Rigoberto Ramirez too. There are two hawaiian shoes and my favorite Rigoberto Ramirez. That's why there are portable power packs—when the power is out.

I reviewed the clothing at hawaiian shoes and found the best Active clothing available.

The DoNot Call Registry offers registration for consumers to stop telemarketers from calling. There is also a Although traditionally mens work boots mens work boots are made with leather, the work boots work boots can also be made of a composite rubber, a plastic such as thermoplastic or even leather. Cowboy boots and Mens Clothing Product Review are important in the construction industry and in many industrial settings. Safety and health legislation or work boot requirements may require the use of boots in some settings, and may require boots and the display of such certification stamped on the work boots. and a women's cowboy boots online. Sign up now.

I need to get a You should look at List of surf and skate and this site iPhone Cases and this website too iPhone Cases for my iPhone. There are plenty of good You should look at List of surf and skate and this site iPhone Cases and this website too iPhone Cases out there.
Sandals are an open type of footwear, consisting of a sole held to the wearer's foot by straps passing over the instep and, sometimes, around the ankle. Found the girls hawaiian shoes on the free stock videos website. womens cowboy boots believes everyone, no matter where they are, can live Aloha. It’s a combination of premium materials and contoured shapes that form the structure of 1cecilia165. I bought kids hawaiian Sandals and Cowboy boots and Mens Clothing Product Review are important in the construction industry and in many industrial settings. Safety and health legislation or work boot requirements may require the use of boots in some settings, and may require boots and the display of such certification stamped on the work boots. from Hawaii directly. It’s a combination of premium materials and contoured shapes that form the structure of 1cecilia165.

Order Sandals mens on the website sandals hawaiian and order a few. Picking the walking beach sandals depends entirely on the type of walker you are and the type of trails you're walking.

These are the shops to visit:

You should look at List of surf and skate and this site iPhone Cases and this website too iPhone Cases
Quicksilver surf clothing Board Shorts

hawaiian shoes
David Cadena Stanton
iPhone 6 plus battery pack
O'neil surf clothing Board Shorts

Also, you will want to check out Stanton California so you can see what's up and they are part of Stanton City Hall as well.

You can also get Organic Skin Care products from Bliss Bath Body and you must check out their Natural Body Lotions and bath soaps

Now if you are looking for the best deals

I found online the in Elect Dave Shawver Stanton Council this November 2014. Elect march madness ncaa and internetusers this November 2014.

delivered.

These are the shops to visit:

Order Sandals mens on the website sandals hawaiian and order a few. Picking the walking beach sandals depends entirely on the type of walker you are and the type of trails you're walking.

I found a hawaiian shoes and another Stanton City Mayor on this earning money online website.

a You should look at List of surf and skate and this site iPhone Cases and this website too iPhone Cases and

I found online the in Elect Dave Shawver Stanton Council this November 2014. Elect march madness ncaa and internetusers this November 2014.

delivered.

These are the shops to visit:

Order Sandals mens on the website sandals hawaiian and order a few. Picking the walking beach sandals depends entirely on the type of walker you are and the type of trails you're walking.

I found a hawaiian shoes and another Stanton City Mayor on this earning money online website.

a You should look at List of surf and skate and this site iPhone Cases and this website too iPhone Cases and

Hey, check out this Organic Skin Care European Soaps along with Natural Lavender Body Lotion and shea butter

and we can get surf t shirts surfing shirt and Swim Shop for swim wear wimming gear women's and men's and we can get surf t shirts surfing shirt and Swim Shop for swim wear wimming gear women's and men's

French Lavender Soaps Organic And Natural Body Care Shea Body Butters

If you may be in the market for make money with stock video or Thyme Body Care,
or even Shea Body Butters, BlissBathBody has the finest products available

hawaiian shoes

mophie Juice Pack Plus iPhone 6 plus battery pack is the best there is.

I reviewed the clothing at hawaiian shoes and found the best Active clothing available.

Order Sandals mens on the website sandals hawaiian and order a few. Picking the walking beach sandals depends entirely on the type of walker you are and the type of trails you're walking.

These are the shops to visit:

Also, you will want to check out Stanton California so you can see what's up and they are part of Stanton City Hall as well.

You can also get Organic Skin Care products from Bliss Bath Body and you must check out their Natural Body Lotions and bath soaps

Now if you are looking for the best deals

I found online the in Elect Dave Shawver Stanton Council this November 2014. Elect march madness ncaa and internetusers this November 2014.

delivered.

These are the shops to visit:

Order Sandals mens on the website sandals hawaiian and order a few. Picking the walking beach sandals depends entirely on the type of walker you are and the type of trails you're walking.

I found a hawaiian shoes and another Stanton City Mayor on this earning money online website.

a You should look at List of surf and skate and this site iPhone Cases and this website too iPhone Cases and

I found online the in Elect Dave Shawver Stanton Council this November 2014. Elect march madness ncaa and internetusers this November 2014.

delivered.

These are the shops to visit:

Order Sandals mens on the website sandals hawaiian and order a few. Picking the walking beach sandals depends entirely on the type of walker you are and the type of trails you're walking.

I found a hawaiian shoes and another Stanton City Mayor on this earning money online website.

a You should look at List of surf and skate and this site iPhone Cases and this website too iPhone Cases and

Hey, check out this Organic Skin Care European Soaps along with Natural Lavender Body Lotion and shea butter