Validating Map Layer Help

The WFDSS Documentation and Development teams perform this task to ensure that the ? Help are mapped correctly from the application to the help. You can use this feature to download a spreadsheet of the current ? Help mappings.

The Map Layer validation table contains the following columns:

• Type: The map layer type.
• Map Layer: The map layer in the WFDSS application.
• Help HTML: The file name listed on the Web tab of the Object Properties window in AuthorIT. Also the filename of the HTML file created during the publishing process. Changing this filename breaks the existing mapping, so be sure to update the this information from the Validate Map Layer Help button on the Administration > Support tab.
• HTML Title: The topic name that appears in AuthorIT Object Properties > Web tab > Heading field. This title also appears in the Help TOC.
• Help Link: The current status of the mapping.
  • Valid means that the help file listed appears when the Help link on that JSP page is clicked. (It does not mean that the content is valid, however. You need a live human to determine that.)
  • Invalid means that an error occurs when the help link on that JSP page is clicked.
  • N/A means that the No Context-Sensitive Help Available message appears when the help link is clicked for that page. This designation is particularly useful for identifying new application pages that need help.

Before verifying the map layer help mappings, you need the following:

• Understanding of how the application pages and the help pages relate to each other
• Administrator access on WFDSS Development or WFDSS Training system
• VPN access to Avocet and AuthorIT
• Author or Designer user role in AuthorIT

To validate map layer help:

1. In WFDSS, choose the Administration tab. The Administration page appears.
2. In the Support section, click Validate Map Layer Help. The Validate Map Layer Help page appears.
3. Sort the Help Link column. N/A links appear, followed by Invalid links.
4. For N/A links, do the following:
   1. In AuthorIT, search for the topic.
   2. Right-click to choose Properties from the menu. The Properties window opens.
   3. On the General tab, verify that the template is Topic Template.
   4. Choose the Web tab.
   5. Verify that the Heading field contains the topic title that you want to publish in the Help TOC and that Start Page is marked.
   6. Enter a Page Title. For example, WFDSS Help | Create Incident. (Use present-tense verb and abbreviated version of the title. This is what appears in the page tab of the browser window when the topic is published.)
   7. Enter a Filename. For example, WFDSSHelp_Create_Incident.html.
   8. Click Apply to continue working on Properties or click OK to save and exit the Object Properties window.
5. For Invalid links, do the following:
   1. Verify that the Help HTML and HTML Title match what's in the Help Validation table.
   2. In WFDSS, find the JSP and test the link.
   3. Go to avocet > authorit > publishing > XHTML pages > WFDSS help and verify that the page exists in the folder. (Sometimes, the publishing process hiccups and a page doesn't get published.)
   4. In AuthorIT, select the topic in question > right-click and choose Properties > choose Web tab.
   5. Verify that the information in the Object Properties matches the information in the WFDSS_JSP_Help_Map_master spreadsheet.
   6. Make any necessary changes.
   7. In the WFDSS_JSP_Help_Map_master spreadsheet, highlight the topic in yellow.
6. To add link a new map layer link to an existing AuthorIT topic do the following:
   1. Click View Map Layers without Links. The Assign Help to Page page appears.
   2. Click to select the type/map layer long name combination that matches your AuthorIT help topic.
   3. Type the HTML file name for your AuthorIT help topic.
   4. Click Check Topic to verify this is the correct topic.
   5. Click Accept to assign the help topic to the correct map layer.
7. Once you have finished correcting the mappings, republish the Help.
8. Verify the updated mappings in the WFDSS application.

You should perform this task at least once per release cycle, especially if the development team is adding a bunch of new features. Even if you don't yet have enough information to document a feature, at least try to create a placeholder topic in the Help so that the context-sensitive help is ready when you are.

-----------
Last updated on 12/12/2011 12:20:46 PM.

In This Section Administration To validate map layer help:

See Also Changing your Initial Page Filtering the User List Viewing User Role Requests Unlocking a User's Profile Re-enabling a Disabled Profile Granting User Role Requests Password Requirements Editing a User Profile Editing User Roles Sending a Broadcast Message Sending Group Emails Purging Broadcast Messages Validating Page Level Help Managing Notification Lists Understanding and Modifying the National Preparedness Level (NPL) and Geographic Area Preparedness Level (GAPL) in WFDSS

Reference Field Descriptions Glossary Resources Spatial Data Reference Landscape Data Source Reference Relative Risk Reference Organization Assessment Reference Fire Behavior Reference About the WFDSS Decision Editors