Customizing Help Files for the Classic UI
This page is specific to Primo's classic UI. For customization information that is specific to the new Primo UI and Primo VE, see the following documents, respectively:
-
Log on to the Back Office server.
-
Enter the following commands to access the help directory:fe_webcd help
-
Enter the following command to edit the help file:vi search.html
-
Modify the file.
-
Exit and save your changes to the file.
-
Create a backup of the file.
-
Log on to the Back Office server.
-
Enter the following commands to access the help directory, where <lng/> indicates language and region:fe_webcd locale/<lng>/help
-
Enter the following command to edit the help file:vi search.html
-
Modify the file.
-
Exit and save your changes to the file.
-
Create a backup of the file.
-
Create a custom help file on your local server.
-
Remove the out-of-the-box help link that appears at the top of the page in the Front End UI by adding the following line to your customized CSS file stored on your local server:#exlidMainMenuRibbon li.EXLLastItem {display: none;}}
-
Add a link to the new help file from the Main menu in the FE:
-
On the Primo Home > Ongoing Configuration Wizards > Views Wizard > Tile Configuration page, select Home Page from the Page drop-down list.
-
In the All tiles list, click Edit in the row containing the Main Menu tile.
-
On the Edit Main Menu Attributes page, select the language in the Interface Language drop-down list.Edit Main Menu Attributes PageWhen users select a language in the Front End, the system displays the code name if you do not define a label for the English interface or do not configure a label for the selected language.
-
In the new Label section, specify the display label and the URL of the help file that is stored on your local Web server.Create New Label SectionThe system uses the Label field to generate the code, replacing spaces with underscores and changing uppercase characters to lowercase. After the code has been created, you cannot change its name. For example, the generated code for label Help EN is help_en.
-
Click Add.The system adds the new code to the list of menu items.Because this step creates a new menu item in the Front End for all languages (not just the one you selected), you must hide the non-relevant menu items in the CSS per locale. For more information, see Hiding Menu Items in the Front End.
-
For each language that is supported in the FE, modify the label for the new menu item.
-
Return to step c if you want to link to a different help page per locale.
-
Click Save & Continue.
-
On the Tiles Configuration page, click Continue.
-
Click Deploy Now.
-
Hiding Menu Items in the Front End
Using CSS to Hide Links
Using JavaScript to Hide Links
$('body[class*=EXLCurrentLang_<locale>] a.EXLMainMenuITEM<code>').parents('li.EXLMainMenuItem').hide();
.
.
.
</script>
<script type="text/javascript">
$('body[class*=EXLCurrentLang_en_US] a.EXLMainMenuITEMhelp_fr').parents('li.EXLMainMenuItem').hide();
$('body[class*=EXLCurrentLang_en_US] a.EXLMainMenuITEMhelp_de').parents('li.EXLMainMenuItem').hide();
$('body[class*=EXLCurrentLang_fr_FR] a.EXLMainMenuITEMhelp_en').parents('li.EXLMainMenuItem').hide();
$('body[class*=EXLCurrentLang_fr_FR] a.EXLMainMenuITEMhelp_de').parents('li.EXLMainMenuItem').hide();
$('body[class*=EXLCurrentLang_de_DE] a.EXLMainMenuITEMhelp_fr').parents('li.EXLMainMenuItem').hide();
$('body[class*=EXLCurrentLang_de_DE] a.EXLMainMenuITEMhelp_en').parents('li.EXLMainMenuItem').hide();
</script>