DITA CMS Release 4.0 (Dynamic Release Management Module): Detailed Release Notes

Size: px

Start display at page:

Download "DITA CMS Release 4.0 (Dynamic Release Management Module): Detailed Release Notes"

Ann Johnston
8 years ago
Views:

Release Notes WWW.IXIASOFT.COM / DITACMS v. 4.

2 2 DITA CMS Release 4.0 (Dynamic Release Management Module): Detailed Release Notes Table of contents About this document Release notes Update the index definition to fix Validate links issues 4 Configure the DITA CMS to check for uniqueness of product values 5

Table of contents About this document Release notes Update the

3 About this document 3 About this document This document describes the new features and bug fixes introduced in this build of DITA CMS Release 4.0.

4 4 DITA CMS Release 4.0 (Dynamic Release Management Module): Detailed Release Notes Release notes Update the index definition to fix Validate links issues The Validate links command in the DITA Map View reported valid topics as being out-of-scope. If you are using the DRM module and you encountered this issue, you need to update an index in the Index Definition document. IXIASOFT recommends that you change the Index Definition document during off hours only. This operation will require a reindexing of the TEXTML Server, which will reduce the performance of the TEXTML Server and may impede user actions (for example, newly created topics will only be searchable using the Advanced Search). To update the Index Definition document: 1. Open the TEXTML Administration perspective. 2. Connect to your server and docbase. 3. Expand the docbase node to display the Index Definition branch. 4. Right-click Index Definition and select Check out. 5. Open the Index Definition Document in an XML editor. 6. Under <indexes> look for the keyref-contentdependencies <index> element. For example: <index CUSTOMPROPERTY="True" NAME="keyref-contentDependencies" SYNC="True">  <stringindex KEEPEXTRACTEDVALUES="True"> <elements> <element XPATH="//reference[not(contains(@class,'- map/navref ')) and not(contains(@class,'- topic/xref ')) and not(contains(@class, ' topic/link ')) DEPTH="INFINITE"/> <element XPATH="for $s in //reference[not(contains(@class,'- map/navref ')) and not(contains(@class,'- topic/xref ')) and not(contains(@class, ' topic/link '))][contains(@keyref, '/')]/@keyref return substring-before($s, '/')" DEPTH="INFINITE"/> <element XPATH="for $s in //reference/@conkeyref return substring-before($s, '/')" DEPTH="INFINITE"/> </elements> </stringindex> </index> 7. Change the first element to the following: <element XPATH="//reference[not(contains(@class,'- map/navref ')) and not(contains(@class,'- topic/xref ')) and not(contains(@class, ' topic/link ')) and not(contains(@class, ' topic/keyword ')) DEPTH="INFINITE"/> 8. Save, close, and check in the index definition document.

topics as being out-of-scope. If you are using the DRM module and you encountered this issue, you need to update an index in the Index Definition document.

5 Release notes 5 Configure the DITA CMS to check for uniqueness of product values By default, the DITA CMS checks that product names are unique within a deployment, but you can configure it so that other values in the.product file are unique as well. For example, consider the following template file for a product: <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE product PUBLIC "-//IXIA//DTD DITA CMS Product//EN" "product.dtd"> <product id="id" base=""> <name/> <productmeta> <code/> <description/> <aliases/> <productlines/> <components/> </productmeta> <relatedproducts/> <releases/> </product> The name (specified in the <name> element) must always be unique within a deployment. You can configure the DITA CMS to check the uniqueness of any other element in the.product file. You define the list of unique values in the releasemanagement.xml file, inside the <uniquekeys> element. For example, let's say that you also wanted the product code to be unique within a deployment. In this case, you add the following <key> element to the releasemanagement.xml file: <uniquekeys> <key type="product" index="index_name" xpath="xpath"/> </uniquekeys> Where: index_name xpath Is the name of the index defined for this field in the Index Definition document. Is the XPATH of the element that must be unique. For example: <uniquekeys> <key type="product" index="code" xpath="//*[contains(@class, ' product/code ')]"/> </uniquekeys> To configure a unique value: 1. Open the TEXTML Administration view.

DOCTYPE product PUBLIC "-//IXIA//DTD DITA CMS Product//EN" "product.

6 6 DITA CMS Release 4.0 (Dynamic Release Management Module): Detailed Release Notes 2. Connect to your server and Content Store. 3. In the repository's /system/conf collection, check out the releasemanagement.xml file and open it with a text editor. 4. Locate the <uniquekeys> element. In the initial configuration, this field is commented out. For example:   5. If necessary, uncomment the <uniquekeys> element. 6. Add a <key> element for each product value that must be unique within a deployment. 7. Save, close, and check in the releasemanagement.xml file. 8. Synchronize the configuration.