You can override the default end user help that is provided
with IBM® Content
Navigator, you can
override the end user help in several ways.
About this task
You can override the end user help at the desktop level.
Select the appropriate method for customizing the end user help for
your environment:
| Method |
When to use this method |
Considerations |
|---|
| Replace the content in the deployed instance of IBM Knowledge
Center |
You want to use the help framework that is deployed when
you install IBM Content
Navigator. |
To enable the Learn more links
in the interface, use the same file names as the IBM Content
Navigator integrated help file
names for the names of your help system files. The files are in the KnowledgeCenter/usr/content/com.ibm.usingeuc.doc directory
of the IBM Content
Navigator installation
directory. |
| Specify the URL of a custom help system |
You have an existing help framework that you want to use. |
If you specify the URL of your custom help system, the web
client appends the following information to the end of the URL that
you specified: - index.jsp?content=/com.ibm.usingeuc.doc/
- A file name
You should adhere to the following practices when you provide
custom end user help for IBM Content
Navigator:
- Use the existing IBM Content
Navigator integrated
help index.jsp file.
Restriction: In
previous releases, IBM Content
Navigator included
an index.jsp file. However, this file is not
included in IBM Content
Navigator,
Version 2.0.3. Unless you have a previous version of IBM Content
Navigator installed, you cannot
use the IBM Content
Navigator index.jsp file.
- Use the same directory name as the IBM Content
Navigator integrated help directory
name, com.ibm.usingeuc.doc, for the directory
name of your help system files.
- To enable the Learn more links
in the interface, use the same file names as the IBM Content
Navigator integrated help file
names for the names of your help system files. The files are in the KnowledgeCenter/usr/content/com.ibm.usingeuc.doc directory
of the IBM Content
Navigator installation
directory.
|
You can provide different customized help files for
each desktop in your environment.
Procedure
To provide custom end user help for IBM Content
Navigator:
- Open the administration tool in the web client.
- Click Desktops and open the desktop
for which you want to provide custom end user help.
- Click the Appearance tab.
- In the End user help URL specify
the custom help method that you want to use:
- Select URL and enter the URL of your
custom help system.
- Select Use custom help in IBM Knowledge Center
Customer Installed and specify the following information
about your help system:
- Specify the taxonomy code for your custom help.
The taxonomy
code for IBM Content
Navigator is
SSEUEX. If you want to display your help under a different product
name in IBM Knowledge
Center,
you must add a unique taxonomy code to the KC_taxonomy.ditamap file
in the KnowledgeCenter/usr/taxonomy directory
of the IBM Content
Navigator installation
directory.
- Specify the context for your custom help.
The help for IBM Content
Navigator is
in the KnowledgeCenter/usr/content/com.ibm.usingeuc.doc directory
of the IBM Content
Navigator installation
directory.
The context of the default help is com.ibm.usingeuc.doc.
If you want to provide custom help, add the content to a new subdirectory
in the KnowledgeCenter/usr/content/ directory.
- Specify the name of the topic that you want to use as the landing
page when users access the help.
You must create a properties file
that specifies the location of the landing page and add the properties
file to the KnowledgeCenter/usr/conf directory
of the IBM Content
Navigator installation
directory.
- Save your changes to the desktop.
IBM Content Navigator, Version 2.0.3
Supports:
Content Manager, FileNet P8, OnDemand, OASIS CMIS