Publishing an IETP
You can publish an IETP for use with Contenta S1000D or your own IETP viewer.
Before you begin
RWS LiveContent must be installed and configured if publishing to LiveContent S1000D . If publishing to the file system, you must perform additional setup (see "Configuring third-party output formats").
About this task
Procedure
- In Contenta S1000D, select the desired Configuration, Project, or PModule object.
Note: If you select a Project, you will be able to publish only PMs in that project; if you select a PModule, you will be able to publish only that PM.Remember: To publish from a project, the configuration must be on the user's desktop.
- Select Tools, then select S1000D Publish.
- Select one or more PMs to publish.
Note: If publishing an incremental update, select only one PM.
- If any of the selected PMs has applicability, and you want to filter by applicability during publish rather than while viewing the IETP, perform the following steps:
- Select Set Applicability.
The Publication Module Applicability window opens.Note: When using an ACT Catalog DM, the Publication Module Applicability window will take longer to open.
- Select a PM.
- Indicate the content that you want to be rendered.
Unless a check box is selected or a text field contains a valid value, the content with that applicability will not be included in the IETP.
- Select Apply Applicability.
The applicability that you select here applies until you close the browser.
Note: The information that is displayed in the Applicability window is based on the contents of the ACT DM that is referenced by the PM being published. If that ACT DM in turn references a PCT and a CCT, the content of those DMs will also be displayed. - Select Set Applicability.
- To publish an incremental update to an existing IETP:
- Select Select Change Package. If one or more change packages exist for the PM, the Select Change Package window appears.
- In the Select Change Package window, complete the fields as described in the following table.
Field Entry Optimize publish for Select either the Size or Speed radio button to optimize the publish for size or speed. Select a change package to publish Select a change package from the drop-down list. - Select Apply. Your selections are saved and the system displays a confirmation message showing your selections.
Note: You can cancel your selections by closing the window without selecting Apply. To cancel your selections after you have selected Apply, select -NONE- from the change package list, and then select Apply.
- Select Close to close the Select Change Package window.
- In the Formats field, select LiveContent or select Contenta to name-of-your-IETP-viewer.
Note: If your site is configured to publish to PDF, you can publish to both LiveContent and PDF if desired, by selecting multiple formats.
- Select the Resolve Explicit CIR References check box to resolve explicit references to CIR items, which are available in S1000D Issue 4.1 and later. Clear this check box (which is selected by default) if your publication does not include CIRs or if you don't need to resolve CIRs during this publish.
Resolving CIR references in a larger publication can slow down the publish process.Note: The
LiveContent_PublishTool_ContentRefResolveflag in the publishing configuration file must be set totrueto resolve CIR references when publishing to LiveContent S1000D. - Select Resolve Implicit CIR References to resolve implicit references to CIR items.
This option becomes available only if Resolve Explicit CIR References has been selected.
- Select the Get Latest Content check box to obtain the latest versions of reusable components (warnings, cautions, support equipment, supplies, spares) from the CSDB repository. Clear this check box (which is selected by default) to output the versions of reusable components in each data module, which may not be the latest versions, or if your site is not using the Contenta S1000D reusable components functionality, that is, not storing reusable components in the CSDB repository.
- LiveContent only:
Note: If publishing to a third-party IETP viewer, select custom options as needed. If publishing to LiveContent, select the custom options described in this step.
- Enter a unique ZIP File Name.
Note: When publishing an incremental update (change package), the issue number of the change package is appended to the ZIP File Name you specify. For example, if you enter SB_00041_01 and the change package issue number is 002, the name of the change package zip file will be SB_00041_01_002.zip. Appending the change package number in this way ensures that the zip file for the full publish is not overwritten.
- Enter a Collection Name.
Note: If you are publishing an incremental update you must enter an existing collection.
- Select a Skin Name (presentation template) for the IETP.
Contenta S1000D delivers a Carbon skin by default. You may supply your own skin if preferred.
- Select ToC Title Display to specify the Table of Contents title display for the IETP to be one of three options: TechName and InfoName, InfoName Only or TechName Only.
- Select Encoding of API Results to specify the character encoding for content generated by the LiveContent S1000D API.
- Select Create Mobile Content to include content for display using LiveContent S1000D Mobile in the published output.
Note: LiveContent S1000D Mobile requires a separate license token.
- Select Encrypt Figures to to secure assets (illustrations or other media types) across all publications in the IETP
- To download the LiveContent .zip file, select the Show Link to ZIP File in Log check box.
If you do not select the check box, the .zip file is stored on the Contenta Web server.
- Select the Upload Completed ZIP to CSDB check box to upload a copy of the .zip file to the Deliverables folder in Contenta.
This option does not apply if you published from a project.
- Select the Flash Front Matter in ZIP File check box to include SWF files for the front matter in the IETP.
- To delete the collection from the server once the IETP is published, select the Delete Content from ZIP File check box.
If the collection is not cleaned, subsequent publish activities to the same collection name appends content to the collection. Users are able see each others' publications.Note: Using the Delete Content from ZIP File option only deletes the collection, it does not publish.
- Enter a unique ZIP File Name.
- Select Publish.
While publish is running, progress messages are displayed in the Publish window.
- After Publish completes, select View Log, then scroll to the bottom of the publish log.
Note: If you are publishing a full IETP, you can select the link to open or save the zip file containing the published IETP. If you are publishing an incremental update (change package), you can save the zip file to a different location if needed (Publish places this zip file in the Contenta_home/web/cw_common/custom/S1000D_Publish/temp directory on the CW server).
- If you are publishing an incremental update, open the zip file of most recent full publish, start LiveContent, select the Install Updates link, and browse to the change package zip file to install the updates.
- If Publish completed with errors or warnings, scroll through the publish log to find the errors or warnings, which are highlighted (yellow background). For example, Publish warns about missing or invalid WCN targets:
[REF RESOLVE] Referenced WCN is in Data Module: NOTEXIST-AAA-D00-00-00-00AA-041A-A
[WARNING] Missing target for referenced caution
[REF RESOLVE] Referenced WCN is in Data Module: NOTWCN-AAA-D00-00-00-00AA-042A-A
[WARNING] Invalid target for referenced caution
Example
Note: If a warning CIR DM contains multiple warnings with the same id, when references to those warnings are resolved during Publish, all warnings with that id are displayed in the output. The same is true if a caution CIR DM contains multiple cautions with the same id.