Import Ditaval files

You can import Ditaval files in the DITA CMS.

These files must follow the standard Ditaval format defined in the Oasis standard. See the following link for more information:

http://docs.oasis-open.org/dita/v1.2/os/spec/common/about-ditaval.html

When you import a Ditaval file, its file name is added to the object's metadata in the originalFileName index and the path relative to its containing map is added to the object's metadata in the OriginalRelativePath index.

Note: Any document you import is automatically assigned to you.

Specifying a Ditaval title and description

You can specify the Ditaval title and description inside processing instructions before importing the Ditaval file. This ensures that a meaningful title and description are associated with this Ditaval file.

To specify the title and description, add the following processing instructions to your Ditaval file before importing it:
  • ixiasoft.ditaval.title
  • ixiasoft.ditaval.description
For example:
<?xml version="1.0" encoding="UTF-8"?>
<?ixiasoft.ditaval.title Internal User Guide for Linux ?>
<?ixiasoft.ditaval.description Conditions for publishing the User Guide for Linux to an internal audience ?><val>
	<prop action="include" att="product"/>
	<prop action="include" att="audience"/>
	<prop action="include" att="rev"/>
	<prop action="include" att="platform"/>
	<prop action="exclude" att="audience" val="External"/>
	<prop action="include" att="audience" val="Internal"/>
	<prop action="include" att="platform" val="Linux"/>
</val>

Import options

You can specify the following options when importing Ditaval files:
Option Description
Update existing documents When it imports a document, the DITA CMS determines if this document already exists by checking:
  1. That a document exists in the repository with the same name as the original file name of the imported document.
  2. If a document with the same name exists, and the Use relative path along with file name to match documents to update option is selected, the DITA CMS also checks that the base path of the imported document also matches the base path of the document in the repository.

If a document already exists and the Update existing documents option is selected, the existing document is updated with the contents of the imported document. If this option is not selected, a new document is created, with a new file name.

Note that, to be updated, the document:
  • Must be in a lockable state (for example Authoring:Draft)
  • Must not be already locked by another user
Import options
  Import Base Path: Specifies the base path to use when replacing existing documents.

To import one ore more Ditaval files:

  1. Select File > Import...
    The Import dialog appears.
  2. Open the DITA CMS folder and select Import Ditaval.
  3. Click Next.
    The Import Ditaval(s) dialog appears.
    Import Ditavals
  4. Click Browse.
    The Open dialog appears.
  5. Navigate to the folder that contains the Ditaval file(s), select the file(s), and click Open.
    The selected Ditaval file(s) appear in the Ditavals to import list.
  6. To replace existing documents with the contents of the imported documents, select Update existing documents. To also use the relative path to match the documents to update, select Use relative path along with file name to match documents to update.
  7. Click Next.
    The Import Options dialog appears. Enter the Import Base Path if applicable.
  8. Click Finish.
The Ditaval file is imported is imported.