User Tools

Site Tools


training:docs_context_map

Using the Context Map spreadsheets The context map files are designed to help us maintain unique internal Topic IDs within the entire Help project. It is imperative that each page or topic in each of the independent source documents has a unique Topic ID. To accomplish this task, Excel spreadsheets have been created with the following columns: Source File This is the name of the Help & Manual file. Start This is the first Help Context number. End This is the Maximum Help Context number. Step This is increment between Help Context numbers in the file. Prefix This is a 3 letter, upper case prefix for the module the file relates to.

This can best be explained in the form of an example:

With in System Five, we have several modules that include Inventory, Point of Sale, Accounts Receivable and Accounts Payables to mention a few. In the ContextMap.xls spreadsheet each of these modules has a unique 3 character prefix defined. Inventory = INV Point of Sales = POS Accounts Receivable = ACR Accounts Payables = ACP By using these prefix values in every Topic ID in the Help we can reasonably ensure that each of the Topic IDs remains unique throughout the entire System5.chm. If duplicate Topic IDs exist, the Help file will not behave properly and users will get strange and inaccurate results.

training/docs_context_map.txt · Last modified: 2010/07/30 13:14 (14 years ago) by charlene