Information UniverseIndexing Technologies |
| Home |
| About the Company |
| Clients and Projects |
| Indexing and Document Management |
| Writing |
| Research |
| Related Links |
| Site Index |
Types of indexes and indexing.
Traditional indexes
These common indexes are often found in the back of reference or technical books or as an access tool for a journal or newsletter. A well-written index can decrease the time to find specific information. Stand-alone indexes can be created in 30 to 40% less time than embedded indexes. Any minor changes to the pagination can be handled readily using dedicated indexing software. Dedicated indexing software packages such as Cindex or Macrex provide many functions that facilitate the indexing process. For example, dedicated indexing software will flag blind or circular cross-references ("See" and "See also"). Stand-alone indexes can be created for print-based documents as well as some hypertext documents. Use a stand-alone index when you:
Need an index fast.
Anticipate making substantial revisions to the next release of a document.
Need to keep current costs to a minimum.
Embedded Indexing
What is embedded indexing?
Embedded indexing is done in several different formats including MS Word, Pagemaker, Framemaker and other word processing and desktop publishing software. This is when the indexing is inserted in the document itself as hidden field tags that are compiled into an index when the tagging is all done. Use an embedded index when:
Adjusting the layout or formatting of a document
Making minor updates or additions to a document
Creating an index for an online or hypertext document
The flexibility of embedded indexes comes with a price, however. A document filled with embedded index markers can be tricky to edit without disturbing or inadvertently deleting some of the index markers. For example, if you move a paragraph with an end-of-range index marker to a new location in the document, you can easily corrupt that index entry - and the error may or may not be visibly apparent.
Two-step Indexing Process
Professional indexers will often create a stand-alone index first and then embed the index markers. This two-step process takes advantage of the many special functions provided by dedicated indexing software. The total time required can be about the same or at times a little more than for embedding the index markers directly. You can continue to make minor revisions to the original document files while the stand-alone index is being written. In some cases, you can publish the document immediately using the stand-alone index and then embed the index markers afterwards.
Indexing the Web
Hypertext indexes designed for the Internet are essentially a traditional index going interactive with hyperlinks to the text. The process is similar to embedded indexing in that you are inserting tags as access pointers in the text for use as links from the index. You can see a sample of this type of index when you go to the site index page on many web sites. These can be used for web sites, e-journals, and archives. They also serve well as a navigation aid for your web site visitors. XML is a newcomer to this area. A few publishers and some companies are using it to create indexes and documents for single source document publishing into different formats.
There are also publications available on the Web in Acrobat .pdf format and postscript formats. We can work with these through the Acrobat authoring software. If you are working with Acrobat files the best way of creating an index is to insert a stand-alone index and use a linker to automatically link the page numbers to the text. As for Acrobat’s Catalog function it seldom provides an index that allows for quickly finding relevant entries. A full text index will pull up every occurrence of each word in the document. It slows down the search for relevant material.
Online documentation
Help files in software applications
Often you will find indexes to software application help files within the application itself. Just check out MS Word’s help menu. You will find an index to all the topics included in the help files belonging to that application. There are several types of Help authoring software including RoboHelp, HTMLHelp and others that include indexing of the files that they produce. I can’t comment much on the details of this type of indexing and software as I have not used it but I do want you to know about it regardless of my inexperience in it.
Online user guides and manuals
Software documentation is increasingly being delivered on the same CD-ROM disk that the software is on or is included on a separate disk. Indexing these files would depend on the format of the files (pdf, HTML, Word etc.). The choice of the indexing method would depend on the format of the file, though Acrobat pdf files seem to predominate due to its cross-platform capability.
Metadata search engines
A metadata search engine differs from other types of search engines in the way it searches web pages. Instead of a full-text search it can search meta tags for index terms that describe each page. This process decreases the time to find relevant material. It also increases the relevancy of the material and reduces the number of irrelevant hits. This technique can be used for file archives stored on either CD-ROM, DVD-ROM, an intranet or an internet web site. It is often also used for developing digital libraries on commercial, university or governmental web sites or web portals. Because of the quantity of information involved, most of this type of work would be done by specially trained teams who have experience in this type of work. One exception is when such a project starts small and it is designed to be scaled up gradually.
< /a>Indexing tips and techniques
Limit page references
Limit single main headings to 5-7 page references. If you have more than that, create sub-headings that are context appropriate for the heading.
Example:
|
Not |
Do this |
|
Mars spacecraft, 2, 4, 6, 8-10, 26, 34-35, 45, 50-52, 65 |
Mars spacecraft |
|
|
Mars Exploration Rovers (MER), 2, 6, 26, 45, 50-52 |
|
|
Pathfinder, 4, 8-10, 34-35, 65 |
Write relevant entries
The goal of an index is to include relevant material. Often you will find a topic only mentioned in passing within a sentence. Other times it will be discussed for a paragraph or more, even for several pages. It is these discussions of the topic that you need to index as this will help your readers quickly find relevant material and not be searching for it through every occurrence of the word.
Concise writing
In both headings and sub-headings always put the most important word first. In the example Mars is not the most important word in the subheading, geology is.
|
Not |
Do this |
|
Mars exploration |
Mars exploration |
|
Mars geology |
geology |
Cross-references
A See reference should be used to direct the reader to the preferred term used in the index.
Spacecraft
See Mars spacecraft
Use a See Also reference to guide the reader to related information about the topic. Be careful not to refer to non-existent index terms.
Mars spacecraft
See also Mars exploration
Double postings
Many subheadings should be double posted as main headings. Just be sure that they have the same page references as the first entry.
|
First entry |
Sub-entry as main entry |
|
Mars Spacecraft |
Mars Exploration Rovers (MER), 26, 45 |
|
Mars Exploration Rovers (MER), 26, 45 |
Pathfinder, 4, 8-10 |
|
Pathfinder, 4, 8-10 |
Format
Many indexers prefer the indented over the run-in format for published indexes, This format is much easier to read than the run-in format. This example should show why.
|
First entry |
Sub-entry as main entry |
|
Mars Spacecraft |
Mars Spacecraft, |
|
Mars Exploration Rovers (MER), 26, 45 |
Mars Exploration Rovers (MER), 26, 45: Pathfinder, 4, 8-10, Viking, 12, 24, |
|
Pathfinder, 4, 8-10 |
|
|
Viking, 12, 24 |
Other aspects of formatting will depend on your company or publisher’s requirements. Above all strive for reliability in your work. This will make both the book and the index easier to use.
How to Hire an Indexer
< /a>There are cases where you may want to consider hiring an indexer to do the work. Any thoughts from "I’m too busy to index it" or It’s too big for me to index in time for publication" to "It needs a better index than I can do" are good reasons for hiring a professional indexer. Here I will give you the short and sweet version of how to hire an indexer.
The best place to find indexers would be online at the American Society of Indexers (ASI) Indexer Locator. You can search this with a variety of requirements including subject, location, software formats, etc.. ASI also has a Jobs hotline for posting to list subscribers. You can find ASI at www.asindexing.org then click the "Find an indexer" link.
You may want to make a list of indexers that you find as any one of them may be too busy to handle your job.
Contact your list and see who is available. The indexers will have questions regarding your work. Have this information available – subject, number of pages to be indexed, deadline, book format, index format, type of index required, and your contact information. Have some concept of what you can afford to pay the indexer for the proposed work. Traditional indexing is usually charge by the page while embedded and online indexing may be charged by the hour. At this point you can negotiate a final contract with the indexer. As this is an abbreviated version you can find more information at the ASI web site and Dan Connolly’s article listed below.
Resources
ASI - www.asindexing.org
STC Indexing SIG www.stcsig.org/idx/index.html
Articles, books and web sites
Indexing from A to Z by Hans H. Wellisch 2nd Edition
www.wrightinformation.com See articles page
www.informationuniverse.com (My web site)
Connolly’s "Hiring an Indexer" article at www.wfwbooks.com/howto.htm