Creating a publication module
Use the Contenta S1000D PM Builder tool to create and populate a new publication module.
Before you begin
Tip: If referencing a 3.0 DM from a 4.x (4.0 or higher) PM, edit the DM and ensure that the issno tag's inwork attribute has been added. This ensures that the markup is valid in the 4.x PM, where inwork is a required attribute.
Procedure
- Navigate to the desired location in the Publication Modules section of the CSDB hierarchy.
Tip: When creating the PM object manually, the module must reside in the hierarchy as described in the section How Content is Organized in Contenta S1000D. If the hierarchy does not exist, you must first create it. If you are working in a CSDB that supports multiple languages, any PM not in the source language must reside in a folder corresponding to the correct LanguageCountry. Creating the PM in the wrong location in the hierarchy will prevent the PM Builder tool from running.
- In Contenta Web, click Tools, New Object, PModule to create a new PM.
- In Contenta Explorer, click File > New Object > PModule to create a new PM.
- Enter any working name for the PM.
The PM name is modified to comply with S1000D naming conventions according to the information you enter into the PMBuilder form. The name is changed according to the information you entered, and is added to the PM's property sheet when you click Save.
- Enter the S1000D Version number in the new PModule object's property sheet (for example, 3.0, 4.0, 4.1, 4.2, or 5.0).
Note:
- PM Builder is only available for S1000D versions 3.0 or higher.
- Since PM Builder adds version-specific markup to the PM, it is important to enter the version that you want PM Builder to build. (For example, PM markup is different between versions 4.0 and 4.1.)
- If you are working in a CSDB that supports multiple languages, enter the applicable values in the Language ISO Code and Country ISO Code property sheet fields.
- Click OK to create the PModule object.
- Select the PModule object you created, click Tools, then click S1000D PM Builder.
The PM Properties tab is selected by default.PM Builder displays the PMBuilder form and places an edit lock on the object. (You must refresh the view to see the edit lock.)
- On the PM Properties tab, enter data in the required data fields, which are marked with an asterisk (*). Enter other data as needed.
The information you enter is added to the PM's property sheet when you click Save.Note: If the Contenta S1000D property sheet field Quality Assurance Verification is set to
Second Verification(related to the XMLsecondVerificationtag):- for 3.0 PMs, the Verification Type property contains the value in the attribute
typefor the<secver>tag. - for 4.0 and higher PMs, the Verification Type property contains the value in the attribute
verificationTypefor the<secondVerification>tag.
- for 3.0 PMs, the Verification Type property contains the value in the attribute
- Click the Build PM tab.
The PM is listed in the right pane by a name consistent with S1000D naming conventions using the data provided in the PM Properties fields.
- To add a
pmEntry, in the right pane of the window, right-click on the Publication Module name.- A menu appears with the option to Create pmEntry.
- The Rename and Delete options are not active at this time.
- Click Create pmEntry and enter a name for the folder.
The folder name corresponds to the tag for the
pmentryTitle.Note: Perform one of the following two steps. - To add a DM to the PM by filtering on SNS:
- With the new folder selected, in the Select field (left pane), click DMs.
- From the Select Model drop-down list, click a model.
- From the Select SDC field, click a specific code or click All.
- Click Direct SNS.
- Click a specific code, or click All
- In the Select Information Code field, click a specific code, or click All.
- Click Search.
Note: In a CSDB that supports multiple languages:
- When you search for DMs or nested PMs to add to the PM, search results include only objects in the same language as the PM being built.
- When you run PM Builder on a PM in the source language, if the CSDB is configured to omit language and country codes from the names of source objects, DM or PM names in the search results will likewise not include language or country codes.
- In the Select From Available DMs field, click a DM (or CTRL-click to select multiple DMs).
- Optionally, click Preview DM if you want to ensure that you have selected the correct DM. You can preview only one DM at a time.
- Click Add to PM. A read-only copy of the PM opens in a LiveContent Preview window.
- To add a DM to the PM by filtering on the SNS parts breakdown:
- With the new folder selected, in the Select field (left pane), click DMs.
- From the Select Model drop-down list, click a model.
- From the Select SDC field, click a specific code or click All.
- Click System, Subsystem, SubSubsystem, Unit or Assembly. You do not have to select all SNS parts.
- In the System field, click a code or click All.
- In the Subsystem field, click a code or click All.
- In the SubSubsystem field, click a code or click All.
- In the Unit or Assembly field, click a code or click All.
- In the Select Information Code field, click a code or click All.
- Click Search.
- In the Select From Available DMs field, click a DM (or CTRL-click to select multiple DMs). If defined in the property sheet, the Technical Name and the Information Name appear as you hover over the DM.
- Optionally, click Preview DM if you want to ensure that you have selected the correct DM. You can preview only one DM at a time.
- Click Add to PM.
- To add a nested PM to the PM:
- With the new folder selected, in the Select field click Nested PMs.
- In the Select Model drop-down list, click a model.
- In the Select Issuer field, click a specific issuer, or click All.
- In the Select PM Number field, click a number, or click All.
- Click Search.
- In the Select From Available PMs field, click a PM (or CTRL-click to select multiple PMs).
Tip: If defined in the property sheet, the Publication Module Title appears when you hover over the PM.
- Optionally, click Preview PM if you want to ensure that you have selected the correct Nested PM.
Note: You can preview only one PM at a time.A read-only copy of the PM opens in a LiveContent Preview window. Exit the preview window.
- Click Add to PM.
If no DMs or nested PMs are added, PMBuilder adds an empty module so that when the PM is opened the next time, it parses without error.
- To modify the PM hierarchy, do any of the following:
- To reorder the references, drag and drop them into the desired order in the right pane of the window under your PM.
- To delete a DM or PM reference, right-click in the DM or PM, and then click Delete.
- To rename or delete a pmEntry (folder name), right-click on the folder, and then select Rename or Delete.
- Click Save.
- Click OK to dismiss the PM updated successfully window.