Publishing Document Maps

You can generate a PDF file from the document map structure. You cannot publish an individual topic.

This task shows you how to:

Request Publication
Monitor Publish Requests
Cancel Publish Requests
View Published Documents

Request Publication

You can request publication of an open document map to generate a PDF file. You can request publication of up to 10 document maps at any time.

Open the required document map.
If any topic in the map is used as a resource for other topics but must not itself be part of the published document, verify that the topic is specified as excluded from rendering. Right-click and select  Exclude from rendering.
If the context menu shows an  Include in rendering action, that topic is excluded.
In the map pane, select Publish > To PDF. All formatting defined in the topics is used when rendering the PDF file.

You must have read access to all topics and referenced content included in the document map. Any topic that you cannot access, such as a topic in the Private state owned by another user, is empty in the published PDF file. Structured Document Editor defines the styles used to generate the PDF file and they cannot be customized.

The app schedules the document map for processing to generate the PDF file and save it in the active repository. The resulting PDF file includes a title page using the title of the first topic as the published document's title and a table of contents based on the structure of the document map.

When processing of the document map to generate a PDF document completes, a 3DNotification reports the outcome. You can access the Published Document in the home page or in the Publish Requests list.

The PDF includes a header on all pages except the first. All content references are included in the published document. The PDF also includes hyperlinks for all cross-references and footnotes.

If the PDF could not be generated, the Status column reports that it failed. You can find more details about the failure in the Publish Request Information dialog box.

Monitor Publish Requests

You can monitor the progress and view detailed information for publish requests.

From the home page, click  Publish Requests.
A list displays information for all publish requests. The Status column reports whether the document map publication is pending, running, succeeded, failed, cancel pending, or canceled. The table also displays the date and time when the publish request was submitted and complete, as well as the time taken to generate the PDF document.
For the publish request of interest, click  and select  Information.
The Publish Request Information dialog box displays detailed information for the publish request. If the publication process failed, a message reports the reason.
Click Close when you have reviewed the information.

Cancel Publish Requests

You can cancel your own publish requests. Repository Managers can cancel any publish requests. Leaders can cancel any publish requests in their repositories.

From the home page, click  Publish Requests.
A list displays information for all publish requests.
For the publish request of interest, click  and select  Cancel Publish Request.
Confirm that you want to cancel, click Yes.
A message reports successful cancellation and the status changes to Cancel pending.

When the cancellation completes, the status of the publish request is Canceled. You can no longer access detailed information for the publish request.

View Published Documents

You can open the published PDF documents to review their contents.

Do one of the following:

From the Publish Requests view, click the name of the document in the Published Document column.
From the Publish Requests view, for the document you want to view click  and select  Open Published Document.
In a content list, click the name of a document with a value of Published Document in the Content Type column.

The PDF file opens in 3DPlay. You can browse the document, download it, or print it.