Making the PDF documentation available

The PDF manuals for JustRelate's products can be made available to the users of the Content Navigators by letting the Manuals (or Documentation) menu item in the Help menu point to an overview page on which the manuals are linked. To do this, proceed as follows:

  1. Copy the manuals

    Place the manuals into a directory below the GUI web application, for example doc. Depending on the version of JustRelate CMS Fiona, the PDF files can be found in different locations in the directory hierarchy of the CMS installation or must be downloaded separately. If you have more than one instance, all of them can link to this copy of the documentation.

  2. Create documentation.html

    Please create a file named documentation.html and place it in the webapps/GUI/ directory of the instance concerned. In this file, link to the PDF documents you would like to make available to the users. The file might have the following contents, for example:

    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    <html>
      <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title>Infopark CMS Manuals</title>
      </head>
      <body>
        <div id="title"><h1>CMS Fiona Documentation</h1></div>
        <br /><br />
        <table cellpadding=5 width=600 border=0>
        <tr>
          <th align="left" bgcolor="#DDDDDD" colspan=2>Der Content Navigator</th>
        </tr>
        <tr>
         <td bgcolor="#EEEEEE"><FONT SIZE="-1"
         FACE="Helvetica,Arial,sans-serif">Describes the usage of the HTML user interface for editors</font></td>
         <td bgcolor="#EEEEEE"><a href="doc/Navigator-en.pdf">PDF</a></td>
        </tr>
        <tr><td colspan=2>&nbsp;</td></tr>
    
        <!-- More PDF files -->    
    
        </table>
      </body>
    </html>
    
  3. Adapt itemRegistry.xml

    Place the previous Manuals entry (bean id="online_help_index") inside a comment and replace it with the following lines (please adapt the URL according to your installation):

    <bean id="online_help_index" class="com.infopark.cm.htmlgui.browse.menuaction.Redirect">
    <property name="titles"><map>
    <entry key="de"><value>Handb374cher</value></entry>
    <entry key="en"><value>Manuals</value></entry>
    <entry key="fr"><value>Manuels</value></entry>
    <entry key="it"><value>Libretti di istruzioni</value></entry>
    <entry key="es"><value>Libros de instrucciones</value></entry>
    </map></property>
    <property name="uri"><value>http://<server>:8080/NPS/documentation.html</value></property>
    <property name="isExternal"><value>true</value></property>
    </bean>
    
  4. Redeploy the GUI

    Redeploy the GUI for the changes to become effektive:

    bin> ./rc.npsd deploy GUI

    Please note that deploying causes the GUI connections of the users to break. Therefore, the users will not be able to save the changes they have made to the content. For this reason, nobody should work with the GUI during the deployment procedure.