Setting up your Reference Implementation home page

In the Reference Implementation home page, publications are grouped by product family name, with one category per product family. This task explains how to ensure your publication is categorized on the home page as you intend.

Before you begin

In advance, you need to ensure the values you plan to use for Product family name and Product release name exist in your Knowledge Center system settings. This is done by adding values to the appropriate Lists of Values or LOVs in the Settings tab of the Web Client.

Users can set the Product family name and Product release name values for each publication version they wish to publish to the Reference Implementation. If you don't specify one or both values, then the publication appears as on the home page as either an Unknown Release Version and/or Unknown Product.

About this task

This task explains how to use the Publication Manager to specify two publication properties, Product family name and Product release name for one version of a publication.

Alternatively using the Web Client, you can search for publications in the repository, and set these properties in each publication and version. These values determine how the publication will be categorized on your home page.

In the examples for this task, we've assumed that the system is using the default name (DITA Delivery) for the output format to publish to the Reference Implementation.

Procedure

  1. Decide on the name for the different product categories to appear on the Reference Implementation home page. Each category corresponds to a value in the Product family name list of values in your Knowledge Center system. For example Telephone directories and URL listings could be two product family names. Each has three release versions 2016, 2017 and 2018.
    In this example I want my telephone directory versions for 2016 and 2017 to appear on the home page.
  2. For each category or product family that should appear on the home page, open the first version of a publication in that product family with the Publication Manager.
  3. From the Publication menu, select the Publication Properties.
    The Properties dialog for this publication appears.
  4. On the General tab, select the desired value from the Product family name field.
    In this example, choose Telephone Directory from the drop down list.
  5. On the Version tab, select the desired Product release name from the options available.
    In this example, for the older publication version that contains changes for the 2016 release, choose 2016.
  6. Repeat these steps for each publication and publication version that should appear on your home page.
    In this example, I'll open the same publication in the newer version for the next year's telephone directory, and select 2017 for Product release name.
  7. Publish each categorized publication version to your Reference Implementation by selecting the DITA Delivery output format. On your home page you will find a separate publication object for each different Publication/Version/Language combination. Language versions that are available in languages other than English are visible in the Reference Implementation when a visitor switches the Reference Implementation UI language to the other non-English language.

What to do next

When something changes or if you made a mistake you can change how this publication is deployed in the Reference Implementation in two ways:
  • You can re-categorize publications by make a change to one or both of the two metadata fields for this publication. Change Product family name and Product release name as desired and republish the publication to effect the change.
  • You can remove this publication altogether by opening the publication in the Publication Manager, and on the Output tab select the Properties for the DITA Delivery output format. In the Publishing Options tab change the DITA Delivery Remote Statusfrom Online to Offline. Then republish the publication to effect the change.