Understanding the PeopleSoft Online Help Website Folders
Before adding new PeopleSoft Online Help to an existing website or changing how users access the help, you should understand the hierarchical folder structure of the website and how it corresponds to the organizational levels of the documentation on the site. The PeopleSoft Online Help site contains the following folder levels:
Global
Language
Product line
Subject
Global Folder Level
The top folder of the website (docroot) is the global level of the online help.
Image: Global Level of the PeopleSoft Online Help
This example illustrates the files and subfolders in the global level of the help system. In this example, the docroot is named “help-PB.” The contents of the global folder are described later in this section.
Files
The global level contains the following HTML files:
Folders
The global level includes the following folders:
| language |
Contains all help content for a specific language. The only delivered language folder is eng (English). See Language Folder Level. |
| html |
Contains common HTML files that are used in the PeopleSoft Online Help user interface for all languages. |
| images |
Contains graphic files that are used in the user interface for all languages. |
| js |
Contains JavaScript files for all languages. |
| styles |
Contains cascading style sheet (CSS) files for all languages. |
Language Folder Level
Below the docroot folder are folders representing each installed documentation language. These folders represent the language level of the website.
Image: Language Level of the PeopleSoft Online Help
This example illustrates the files and subfolders in the language level of the help system. In this example, the docroot is named “help-PB.” The contents of the language folder are described later in this section.
The language level is the top of the PeopleSoft Online Help site as far as users are concerned. When a user navigates to docroot/index.htm, that user is redirected to the appropriate language folder, based on his or her browser language. The files at and below the language level are all language specific.
Files
The language level contains the following HTML files:
Folders
The language level includes the following folders:
| product line |
Contains all help content for a specific product line. For example, the hcm folder contains the Human Capital Management online help. |
| js |
Contains JavaScript files with language-specific information, such as text strings that appear within the help user interface. |
| styles |
Contains Cascading Style Sheet (CSS) files for language-specific user interface formatting. This is also where your organization can modify the user interface formatting, if required. See Modifying Online Help Style Sheets. |
Product Line Folder Level
Within the language folders are one or more product line folders, depending on which product lines you have installed. These folders represent the product line level of the website.
Image: Product Line Level of the PeopleSoft Online Help
This example illustrates the files and subfolders in the product line level of the help system. In this example, the docroot is named “help-PB.” The contents of the product line folder are described later in this section.
The product line folder contains several files, including the index.html file, which represents the product line navigation page containing links to all subject navigation pages within the product line. In addition, the product line folder contains one folder for each product or subject that has online help. Online help for subjects includes information that applies to the product line as a whole, such as application fundamentals help, or to a set of multiple, related products within the product line, such as call center applications. See Subject Folder Level. Common boilerplate files are stored in the _bp_common or bp_common folder.
The product line folder may contain a bpms folder, which contains files and folders for the business process map (BPM) diagrams and text-only BPMs. This folder is not available for all product lines.
Subject Folder Level
Within the product line folders are one or more subject folders, which contain the actual online help for each product or subject in the product line. These folders represent the subject level of the website.
Image: Subject Level of the PeopleSoft Online Help
This example illustrates the files and subfolders in the subject level of the help system. In this example, the docroot is named “help-PB.” The contents of the subject folder are described later in this section.
The subject folder contains several files, including the index.html file, which represents the subject navigation page containing links to all help pages for the subject. The prefix of each help page file name indicates the type of content that the page contains, such as concept or task information. All images for the subject are stored in the img subfolder.