Before configuring thePeopleSoft Online Help or changing how users access the help, youshould understand the hierarchical folder structure of the websiteand how it corresponds to the organizational levels of the documentationon the site. The PeopleSoft Online Help site contains the followingfolder levels:
Global
Language
Product family
Subject
The top folder of thewebsite (docroot) is the global level of the online help.
This example illustratesthe files and subfolders in the global level of the help system. Inthis example, the docroot is named “help-PB.” The contents of the globalfolder are described later in this section.
Files
The global level containsthe following HTML files:
Term | Definition |
|---|---|
help.html | Contains JavaScriptto support context-sensitive help. |
helptest.html | Contains a web pagewith fields for testing and troubleshooting the context-sensitivehelp. |
Folders
The global level includesthe following folders:
Term | Definition |
|---|---|
language | Contains all help contentfor a specific language. The only delivered language folder is eng(English). See Language Folder Level. |
idx | Contains data to supportcontext-sensitive help. See Understanding Context-Sensitive Help Processing formore information about the files in this folder. |
images | Contains graphic filesthat are used in the user interface for all languages. |
js | Contains JavaScriptfiles for all languages. |
styles | Contains cascading stylesheet (CSS) files for all languages. |
Below the docroot folderare folders representing each installed documentation language. Thesefolders represent the language levelof the website.
This example illustratesthe files and subfolders in the language level of the help system.In this example, the docroot is named “help-PB.” The language folder is named“eng.” The contents of the language folder are described later inthis section.
The language level isthe top of the PeopleSoft Online Help site as far as users are concerned.When a user navigates to the PeopleSoft Online Help website, thatuser is redirected to the appropriate language folder, based on hisor her browser language. The files at and below the language levelare all language specific.
Files
The language level containsthe following HTML files:
Term | Definition |
|---|---|
copyright.html | Contains the Oraclecopyright statements and legal notices. |
helpNotFound.xml | Contains a templatefor the context-sensitive help processor to display a message whenno help is found for an application page. See Customizing the “No Help Found” Messages for more information. |
pcHelpNotFound.xml | Contains a templatefor the context-sensitive help processor to display a message whenno help is found for a PeopleCode page. See Customizing the “No Help Found” Messages for more information. |
Folders
The language level includesthe following folders:
Term | Definition |
|---|---|
product family | Contains all help contentfor a specific product family. For example, the hcm folder containsthe Human Capital Management online help. See Product Family Folder Level. |
js | Contains JavaScriptfiles with language-specific information, such as text strings thatappear within the help user interface. |
styles | Contains Cascading StyleSheet (CSS) files for language-specific user interface formatting.This is also where your organization can modify the user interfaceformatting, if required. See Modifying Online Help Style Sheets. |
images | This folder is deliveredempty. You use it to store custom images for your organization, suchas a background image for the homepage. See Modifying Online Help Style Sheets for more informationabout this folder. |
Within the languagefolders are one or more product family folders, depending on whichproduct families you have installed. These folders represent the product family level of the website.
This example illustratesthe files and subfolders in the product family level of the help system.In this example, the docroot is named “help-PB.” The language folder is named“eng,” and the product family folder is named “pt.” The contents ofthe product family folder are described later in this section.
Files
The product family levelcontains the following HTML files:
Term | Definition |
|---|---|
index.html | This is the homepagefor the site. |
subject code.html | This is the subjecttable of contents (TOC) file. It contains data used to generate sectionsin the Contents sidebar. |
helpid.txt | Contains all contextIDs that are specified in all help pages within the product familyfolder. |
info.xml | Contains informationabout links that should appear in the More section of the Contentssidebar and in the footer. |
pchelp.dat | Contains all PeopleCodecontext IDs that are specified in all help pages within the productfamily folder. |
Folders
The product family levelcontains the following folders:
Term | Definition |
|---|---|
subject code | Contains all help contentfor a subject within the product family. This is where the actualhelp pages reside. A subject might correspond to a single PeopleSoftproduct, a group of products, or a high-level concept or businessprocess. See Subject Folder Level. |
bp_common, _bp_common,and _ec_bp_common | Contain boilerplateand common files for the product family. |
bpms | Contains files and foldersfor the business process map (BPM) diagrams and text-only BPMs. Thisfolder is not available for all product families. |
Within the product familyfolders are one or more subject folders, which contain the actualonline help for each subject in the product family. These foldersrepresent the subject level of the website.
This example illustratesthe files and subfolders in the subject level of the help system.In this example, the docroot is named “help-PB.” The language folder is named“eng,” and the product family folder is named “pt.” The subject folderis named “tace.” The contents of the subject folder are describedlater in this section.
The subject folder containsall help pages for the subject. Each folder is named with a four-lettersubject code. For example, the tupa subject folder corresponds tothe PeopleSoftApplications User’s Guide.
To determine which folderapplies to which subject, open a help page in the browser and openthe Contents sidebar or the You Are Here path to see the full nameof the subject corresponding to the folder. See Using the Contents Sidebar and Using the You Are Here Path.
The prefix of each helppage file name indicates the type of content that the page contains,such as concept or task information. All images for the subject arestored in the img subfolder. Any report sample PDF files also residein the subject folder.
