Skip to main content
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    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:

    The Primo's Front End contains a single help page that describes various areas of the UI. To update this page, on-premises installations must modify the contents of the search.html file that is stored in the following directory:
    If you need customize help pages per language, update the relevant search.html files in the following directories, where <lng> indicates the language and geography of the help file (such as en_US):
    To prevent your changes from being lost during a service pack or hot fix update, save a copy of the file prior to performing the update. After the update, you may need to reapply your changes.
    To customize the content of a default help page (on-premises installations only):
    1. Log on to the Back Office server.
    2. Enter the following commands to access the help directory:
      cd help
    3. Enter the following command to edit the help file:
      vi search.html
    4. Modify the file.
    5. Exit and save your changes to the file.
    6. Create a backup of the file.
    To customize the help page for a specific language (on-premises installations):
    1. Log on to the Back Office server.
    2. Enter the following commands to access the help directory, where <lng/> indicates language and region:
      cd locale/<lng>/help
    3. Enter the following command to edit the help file:
      vi search.html
    4. Modify the file.
    5. Exit and save your changes to the file.
    6. Create a backup of the file.
    To create a custom help page (cloud installations):
    1. Create a custom help file on your local server.
    2. 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;}}
    3. Add a link to the new help file from the Main menu in the FE:
      1. On the Primo Home > Ongoing Configuration Wizards > Views Wizard > Tile Configuration page, select Home Page from the Page drop-down list.
      2. In the All tiles list, click Edit in the row containing the Main Menu tile.
      3. On the Edit Main Menu Attributes page, select the language in the Interface Language drop-down list.
        Edit Main Menu Attributes Page
        When 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.
      4. 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 Section
        The 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.
      5. 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.
      6. For each language that is supported in the FE, modify the label for the new menu item.
      7. Return to step c if you want to link to a different help page per locale.
      8. Click Save & Continue.
      9. On the Tiles Configuration page, click Continue.
      10. Click Deploy Now.

    Hiding Menu Items in the Front End

    If you use the Main Menu tile to add a custom help link and you want it to link to a locale-specific help file, you must create a separate menu item for each interface language that you support in the FE. If you do not create separate menu items, the system uses the same link for all interface languages.
    In the following example, separate menu items have been defined in the Main Menu tile for English, French, and German help links.
    Custom Help Links per Interface Language
    If the irrelevant menu items are not hidden, the system displays all menu items, as follows:
    Help Links Not Hidden in Front End
    You can use the either the CSS or JavaScript method to hide menu items per locale.

    Using CSS to Hide Links

    In order to hide items via CSS, you must specify the locale, the menu item, and the display parameter. You can hide multiple items by separating the items with a comma, using the following format:
    body.EXLCurrentLang_<locale> #exlidMainMenuItem<position>, body.EXLCurrentLang_<locale> #exlidMainMenuItem<position> {display:none;}
    In the following example, the help links are defined in positions 4, 5, and 6 in the Main Menu tile:
    Main Menu Tile Positions
    If you change the order of the menu items, you must update the CSS to reflect the change in positions.
    For example, in order to hide the unnecessary help links defined above, you must configure your CSS, as follows:
    body.EXLCurrentLang_en_US #exlidMainMenuItem5, body.EXLCurrentLang_en_US #exlidMainMenuItem6 {display:none;}
    body.EXLCurrentLang_fr_FR #exlidMainMenuItem4, body.EXLCurrentLang_fr_FR #exlidMainMenuItem6 {display:none;}
    body.EXLCurrentLang_de_DE #exlidMainMenuItem4, body.EXLCurrentLang_de_DE #exlidMainMenuItem5 {display:none;}

    Using JavaScript to Hide Links

    Although you do not need to consider the position of the item when using the JavaScript method, you must update every footer.html file that is used by your view. This allows you to execute the script after the content of the page has been loaded.
    To hide a specific menu item, specify the locale, the menu item’s code, and the hide parameter, using the following format:
    <script type="text/javascript">
       $('body[class*=EXLCurrentLang_<locale>] a.EXLMainMenuITEM<code>').parents('li.EXLMainMenuItem').hide();
    Using the example definitions provided in the previous section, add the following script to every footer.html file in order to hide the unnecessary help links:

    <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();