Indexing - On Premises 6.4

Author-it Knowledge Center

Knowing what to put in your index makes the difference between a good and a bad index. Word processors have got us used to the type of indexing where you think of a keyword and then mark every occurrence of it throughout the document. This is a very poor way of indexing, because it does not take context into account, and usually produces a list containing many meaningless entries.

A good index should let your readers find every pertinent statement made in your document. To create a good index for your document, make entries for:

  • Variations of the topic's heading.
  • The main concepts in the topic.
  • Categorization of subjects.
  • Synonyms.
  • Cross references, or entries that point to other entries in your index. For example, Modifying, See Changing. For more information, see Creating "See" Entries in the Index.

Indexing is a whole subject in its own right, and there are many readily available resources that go into much greater depth than we can here.

Author-it's indexing objects

Author-it provides two objects to help you build a good index. First is the Index object, which is the index itself and will automatically create a basic index for you. The second is the Index Entry object, which represents a single entry in the index.

You can create headings and sub-headings in your index by moving your Index Entry objects into a hierarchy within the Index object. When you do this, Author-it recommends that you use a title case for the heading and lower case for all entries under that heading.
https://kc.author-it.com/r/ooz5KllAj6ZToeyjdQd5hA/G36Nd58fNI93hbWpZh5STQ
kc.author-it.com
crawl=CC-MAIN-2021-10
899891
application/http; msgtype=response
sha1:RZO7KG64ZBBVP2DF7GBOTM6MTVNJOGZC
<urn:uuid:54f23951-65f0-400e-93e1-1460f1f7ea76>
2021-02-26T06:39:23Z
62.210.155.88
text/html
sha1:AX3ACP4SV7AAOTNN2EX4GXKHFU54IBKV
<urn:uuid:1a7c8acb-a0a2-454c-bc9b-d77866d816c8>
https://kc.author-it.com/r/ooz5KllAj6ZToeyjdQd5hA/G36Nd58fNI93hbWpZh5STQ
response
<urn:uuid:f7b3a5b3-be41-4454-a1a7-685838f0ba55>
isPartOf: CC-MAIN-2021-10
publisher: Common Crawl
description: Wide crawl of the web for February/March 2021
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-59.ec2.internal
software: Apache Nutch 1.18 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.2-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/