How to create page-level Help topics
Every page of the K1000 and K2000 Administrator Console user interfaces (UIs) must have a page-level Help topic associated with it. When new UI pages are added, use the following procedure to create page-level Help topics.
To complete this procedure, you must be familiar with:
  1. Identify a UI page that does not have a Help topic
    Log in to the K1000 or K2000 Administrator Console or User Console and identify a UI page that does not have a Help topic associated with it. UI pages that have blue Help links in the upper right have page-level Help topics. Pages without blue Help links do not have page-level Help topics.
    Help Button Available
    Missing Help Button
  2. Create an XML file for the Help topic
    Using the XMetaL authoring tool, create an XML file and use the PHP filename of the UI page (minus the PHP extention) as the filename of the XML file. For example, the UI page settings_control_panel.php would have a page-level Help file named settings_control_panel.xml.
    PHP Filename
    XMetaL Authoring Tool
  3. Add content to the Help topic
    Using the XMetaL authoring tool, add a general description of the UI page, and tasks users can perform on the page, to the Help topic. Avoid describing any fields that appear on the page. Fields should be described in main Help system topics and in field-level Help, not in the page-level Help topics.
    Add Content in XMetaL
  4. Add cross references to the Help topic
    Using the XMetaL authoring tool, add the introductory phrase, For more information, which is contained in a DITA conref, then add cross reference links from the page-level Help topic to appropriate topics in the main Help system. Limit the number of links to four if possible.
    Add Links in XMetaL
  5. Check the Help topic in to the Tech Pubs Perforce repository
    Check the Help topic in to the appropriate repository in Perforce. For K1000, Admin-level pages reside in to the adminui folder, and System-level pages usually reside in the systemui folder. However, if a UI page is available at both the Admin-level and System-level, such as settings_support.php, only a single Help topic is required, and that topic should be checked in to the adminui folder.
    Tech Pubs Perforce Repository
  6. Add a topicref for Help topic to the page-level Help DITAmap
    For the topic to be included in the page-level Help output, you need to add a topic reference for it in the page-level DITAmap as follows:
    1. Check out the page-level Help DITAmap (K1000PageHelp.ditamap or K2000PageHelp.ditamap) from Perforce.
    2. Open the DITAmap in the XMetaL authoring tool.
    3. Add a topicref to the new Help topic in the DITAmap. Be sure to add the topicref to the bottom of the list.
    4. Save the DITAmap and check it back in to Perforce.
    XMetaL DITAmap
  7. Generate the page-level Help output
    Open the WebWorks ePublisher page-level Help project and generate the DHTML output. When the WebWorks project is generated, the output includes the new page-level Help topic.
    WebWorks ePublisher Project
  8. Check the output in to the Perforce Development repository
    Delete the existing output from the Development repository and check in the new output.
    Development Perforce Repository
    For setups that are connected to the Perforce Development repository, the Help button appears on the UI page, and the new page-level Help topic is available, when the source is refreshed. For setups that are not connected to the repository, the new Help topic is available when a build containing the latest Help files is applied to the setup.
  9. Help Button Available
    New Page-level Help Topic