Hypertext Markup Language-Based Static Master Index For Technical Documentation System
Publication Date: 2014-Nov-05
The IP.com Prior Art Database
Disclosed is a method to create a Hypertext Markup Language (HTML)-based static master index for an entire technical documentation collection using a master Darwin Information Typing Architecture (DITA) map file that refers to all topics in the collection using relative paths.
Page 01 of 1
Hypertext Markup Language - System
Historically, organizations have utilized information centers to deliver technical documentation. These information centers created dynamic master indexes for entire projects. Recently, however, some companies have switched to a technical documentation system that does not provide such an infrastructure. Specific information units can have indexes, but there is no master index with all information unit index entries combined and alphabetized. As a result, customers have no way of using an index to look up terms or phrases used in the documentation. Instead, they must use the table of contents or the search field to retrieve information.
The method disclosed herein creates a Hypertext Markup Language (HTML)-based static master index for an entire technical documentation collection. This correctly alphabetized, master index contains working links to all indexed topics.
Embodiments of the present invention include creating a master Darwin Information Typing Architecture (DITA) map file that refers to all topics in the collection using relative paths. By preserving these paths, the index links work if the output index HTML file is placed in the correct location in the technical information center collection. The master DITA map file is used to build HTML for the entire collection, but all output is then discarded except for the index file that is created.
The disclosed method requires little to no overhead.
The present disclosure m...