Create a published version of a map

Publish creates an official copy of the document deliverable that can then be generated in any of the available formats.

Before you begin

To publish a document, the map and all its referenced files – including those referenced by conrefs or related-links – must have reached their final state.

About this task

Use Publish when you are ready to create a final, official version of a document: the one you intend to use for publishing in various formats and to send to localization.

Files must be assigned a version label every time they are published. The version identifies completed files for a specific release. The version label that you assign to the map is assigned, in turn, to all the files in the project. If a file is published in more than one document, it will have a label for each publication. If you want to see a file's version labels, look in the file's Properties.

Tip: You can use the version label in your search criteria to find published topics, maps, and images.

Procedure

  1. Do one of the following:
    • In the DITA Map view, right-click the map and select Publish.
    • In the Todo List, right-click the map and select Publish.
    • In Project Management view, select the deliverable(s) you want to publish, then right-click and select Publish.

      You can select one map, select several maps by holding down CTRL or SHIFT and clicking the maps, or right-click on the Deliverables node to select all the maps within a project.

    The Publishing Tags dialog appears.
  2. Enter the required tag Value(s).
    The specific tags that appear vary with system configuration. Typical tags may include Version, Scope, etc, and may or may not be mandatory according to your system's configuration.
  3. Click Create Label(s).
    A new version label is recorded in the map and all its topics. Topics that are published in more than one document will have a label for each map in which they have been published.
    The Publish… dialog tells you that publication was successful.
  4. Click OK.
    A Progress Information dialog appears as your local file (or files) is copied to the server.
  5. Click Run in Background if you want to hide the Progress Information dialog and continue working in Eclipse.
    The Progress Information dialog will be minimized into the trim at the bottom of the workspace.

    You can click the Results icon to restore the Progress Information dialog or to view the results of the operation. Results icon

Results

A copy of the map and its contents is created in the published area.