An index helps readers easily find the content they want to read. To create a good index, you need the following.

• The index is created by someone who understands the document content well.

  • The index must not include unnecessary information.

• Tools are needed to make indexing work more productive.

  • You cannot work quickly if you have to create a PDF file every time you want to check the progress of the index.

ManualWorks provides various features that make indexing work more efficient.

Creating an Index Chapter

Create the chapter where the index list will appear. It is the same as creating a regular chapter, except that you select “Index” as the chapter type.

When you create an index chapter, a <1Preview> link appears next to the chapter title. With the preview, you can check the index in real time without creating a PDF file.

Setting Up the Index

Setting Index Terms

When you set words or phrases to index with a “Mark,” the index list is created automatically.

1. Switch the paragraph where you want to set an index entry to edit mode.

2. Place the cursor where you want to set the index entry.

3. Click the <Mark> link above the paragraph editing area.

4. Enter the word or phrase to index in the mark input box, and then click the <Add> button.

   • If you select a word or phrase in the paragraph editing area and then click <Mark>, the selected word or phrase appears in the mark input box.

5. The mark you set is displayed 1as follows.

Hierarchical Index Entries

Use a colon as a separator to create a hierarchical list. There is no limit on the number of levels, but for readability, do not use more than three levels.

fruit:grape:green grape

It appears in the PDF as follows.

Setting Multiple Index Entries at Once

Use a semicolon as a separator to create multiple index entries at once.

fruit;vegetable
fruit:tomato;vegetable:tomato

It appears in the PDF as follows.

Setting an Entry That Spans Multiple Pages

To set an index entry that spans multiple pages, set the start position as follows.

fruit(

Then set the end position as follows.

fruit)

It appears in the PDF as follows.

Following The Chicago Manual of Style, consecutive page numbers are abbreviated as follows.

Setting Formatting Options

Set formatting options in curly braces at the end of the entry.

fruit{b}

The available options are as follows.

b

Displays the text in bold.

i

Displays the text in italics.

c

Formats the text as code (displays it in a monospaced font).

You can set up to two options, in any order.

fruit{bi} // Bold and italic.
fruit{bc} // Bold and monospaced.

If you set subentries, you can set options separately before each colon.

fruit:grape{b}
fruit{b}:grape
fruit{b}:grape{i}
fruit{bi}:grape{bi}

If you set a sort key with @, set the options after the key.

2010@twenty ten{b}

Index List

Page Numbers

Page numbers appear in the PDF index list as follows.

• If the same page has multiple index entries with the same name, the page number is shown only once.

• For index entries set in the body text, only the page number is shown.

• For index entries set in notes, n is appended to the page number. It appears in the PDF as follows.

Grouping

Numbers

Entries that start with a number are grouped under Numbers.

0, 1, 2, 3, 4, 5, 6, 7, 8, 9

Korean

Korean entries are grouped by initial consonant. Double consonants are grouped with their related consonant.

ㄱ(ㄲ), ㄴ, ㄷ(ㄸ), ㄹ, ㅁ, ㅂ(ㅃ), ㅅ(ㅆ), ㅇ, ㅈ(ㅉ), ㅊ, ㅋ, ㅌ, ㅍ, ㅎ

Roman Alphabet

Roman alphabet entries are grouped by letter. Grouping is not case-sensitive.

A Á À Â Ä Ã Å a á à â ä ã å ª 
B b 
C Ç c ç 
D d 
E É È Ê Ë e é è ê ë 
F f ƒ 
G g 
H h 
I Í Ì Î Ï i ì í î ï 
J j 
K k 
L l 
M m 
N Ñ n ñ 
O Ó Ò Ô Ö Õ Ø o ó ò ô ö õ ø º 
P p 
Q q 
R r 
S s 
T t 
U Ú Ù Û Ü u ú ù û ü 
V v 
W w 
X x 
Y Ÿ y ÿ 
Z z

Chinese

Chinese characters are grouped by their pronunciation written in the Roman alphabet.

Japanese

Japanese hiragana entries are grouped into the following 10 groups.

あ, い, う, え, お 
か, き, く, け, こ, が, ぎ, ぐ, げ, ご 
さ, し, す, せ, そ, ざ, じ, ず, ぜ, ぞ 
た, ち, つ, て, と, だ, ぢ, づ, で, ど 
な, に, ぬ, ね, の 
は, ひ, ふ, へ, ほ, ば, び, ぶ, べ, ぼ, ぱ, ぴ, ぷ, ぺ, ぽ 
ま, み, む, め, も 
や, ゆ, よ 
ら, り, る, れ, ろ 
わ, を

Japanese kanji are grouped by their reading written in hiragana.

Special Characters

All characters that do not fall into the groups above are grouped under “Symbols.”

Changing the Sort Order and Group

Entries are sorted according to the default rules of each language. You can change the sort order as you want.

For example, if you set index entries as follows,

order:one
order:two
order:three

they appear in the PDF as follows.

In this case, it is better to sort them in logical order rather than by letter, as follows.

To sort them this way, enter a sort key with @ as the separator.

order:one@1
order:two@2
order:three@3

The same applies to groups. If you set an index entry as follows, it is included in the Numbers group.

2010

However, it is sometimes better to include it in the T group, according to how it is pronounced. In this case, set the index entry as follows.

2010@twenty ten

Configuring the Index Object

When you open the index chapter in the editor, it contains an index object. Edit this index object to set the following items.

Index Sort Mode

Select a sort mode as follows.

Letter by Letter

Sorts by letter.

Word by Word

Sorts by word.

The examples from The Chicago Manual of Style show the difference between the two.

Cross-References

In the “See” and “See also” fields of the index object, enter one entry per line in the format entry=referenced entry.

See, See under

EJB=Enterprise JavaBeans
KBS=Korean Broadcasting System

To display it as See under, add an underscore in front.

EJB=Enterprise JavaBeans
KBS=_Korean Broadcasting System

It appears in the PDF as follows.

See also, See also under

EJB=Enterprise JavaBeans
KBS=Korean Broadcasting System

To display it as See also under, add an underscore in front.

EJB=Enterprise JavaBeans
KBS=_Korean Broadcasting System

It appears in the PDF as follows.

Entering Special Characters

The special characters used to set up index entries are as follows.

: ; @ ( ) { } _

To use these characters in an index entry, put a backslash in front of them.

16\:9 aspect ratio
Java\; programming language

If you use both parentheses as a pair, you do not need to add backslashes.

// Both are displayed as JVM(Java Virtual Machine).

JVM(Java Virtual Machine)
JVM\(Java Virtual Machine\)

You do not need a backslash before an underscore unless the underscore appears at the very beginning of a See or See also entry.

KBS=_Korean Broadcasting System (See under Korean Broadcasting System)
KBS=\_Korean Broadcasting System (See _Korean Broadcasting System)