Making External Documentation Available Through the PeopleSoft Online Help

You can add a custom links to the More section of the Contents sidebar. These links appear on every page in the help site.

To add the custom links:

1. Open the following file:

   docroot/language/product family/info.xml.

2. Add a <custom-links> tag for each new link. immediately after the <copyright-statement> at the end of the file.

   Use the following format: <custom-link title="link title" href="link destination"

   The following example shows two new tags in bold:

   ...
   <copyright-statement><span>Copyright © 1988-2013, Oracle and/or its affiliates. All rights reserved.</span></copyright-statement>
   <custom-links title="Example Home 1" href="https://www.example1.com" />
   <custom-links title="Example Home 2" href="https://www.example2.com" />
   ...

   Note: Do not change the parent <productLine> tag when you edit the file.

You can set up Oracle Secure Enterprise Search to create search indexes for any documentation website, including custom documentation for your organization or PeopleBook Library sites for previous releases. To do this:

1. Crawl the external documentation site to generate a full-text search index.

   See the Secure Enterprise Search documentation for instructions.

   Note: For PeopleBook Library sites for previous releases, you do not need to recrawl the site if it already has full-text searching set up on Secure Enterprise Search.

2. Modify the docroot/js/common.js file to set the following variable:

   Field or Control	Definition
   searchOpt	Add a group=SourceGroupName entry for each source group that you want to search from the PeopleSoft Online Help. SourceGroupName represents the name of the source group in Secure Enterprise Search. Separate the entries with the ampersand symbol (&).

   The following example shows the common.js file with multiple groups specified for the searchOpt variable (highlighted in bold):

   /**  
   * common.js  
   **/ 
   var searchURL = "http://example.com:7777/search/query/";          //http://host:port/search/query
   var altHelpURL = "";         //http://www.oracle.com/pls/topic/lookup?id=%CONTEXT_ID%&ctx=hcm92pbr6
                         //"http://host/path/help.html?ContextID=%CONTEXT_ID%&LangCD=%Lang%
   
   var searchOpt = "group=pt855&group=hcm92";          //group=pt853
   var queryTextParamName = "q"; //q