To validate page level help mappings:
- In WFDSS, choose the tab. The Administration page appears.
- In the Support section, click Validate Page Level Help. The Validate Help page appears.
- Sort the Help Link column. N/A links appear, followed by Invalid links.
- For N/A links, do the following:
- In AuthorIT, search for the topic.
- Right-click to choose from the menu. The Properties window opens.
- On the tab, verify that the template is Topic Template.
- Choose the tab.
- Verify that the Heading field contains the topic title that you want to publish in the Help TOC and that Start Page is marked.
- 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.)
- Enter a Filename. For example, WFDSSHelp_Create_Incident.html.
- Click Apply to continue working on Properties or click OK to save and exit the Object Properties window.
- For Invalid links, do the following:
- Verify that the Help HTML and HTML Title match what's in the Help Validation table.
- In WFDSS, find the JSP and test the link.
- 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.)
- In AuthorIT, select the topic in question > right-click and choose > choose tab.
- Verify that the information in the Object Properties matches the information in the WFDSS_JSP_Help_Map_master spreadsheet.
- Make any necessary changes.
- In the WFDSS_JSP_Help_Map_master spreadsheet, highlight the topic in yellow.
- To add link a new .jsp file to an existing AuthorIT topic do the following:
- Click View Pages without Links. The Assign Help to Page page appears.
- Click to select the name/jsp combination that matches your AuthorIT help topic.
- Type the HTML file name for your AuthorIT help topic.
- Click Check Topic to verify this is the correct topic.
- Click Accept to assign the help topic to a .jsp file.
- Once you have finished correcting the mappings, republish the Help.
- 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/2/2011 4:05:11 PM.