Documentation Center

New features and enhancements in SDL Contenta S1000D 5.1

Contenta S1000D 5.1 provides support of the S1000D Issue 4.1 specification and includes modification of tools and functionality to recognize and handle Issue 4.1 modules and markup (XML tagging). Contenta S1000D 5.1 also continues to support earlier S1000D issues (2.2, 2.3, 3.0, 3.0.1, 4.0, 4.0.1).

Key new features in Contenta S1000D 5.1

  • Support for Issue 4.1 modules throughout the Contenta S1000D tool set, from Upload to Publish, notably the following:
    • Support for the four data module types that were added in Issue 4.1: Added during Contenta S1000D 5.1 database upgrades.
      • comrep
      • frontmatter
      • sb
      • scocontent
    • New template XML files for all twenty Issue 4.1 data module types: Added during Contenta S1000D 5.1 database upgrades.
    • Support for Issue 4.1 modules: Available in Upload, the Define and Manage tools, Arbortext edit (Checkout/Checkin), LiveContent Preview, DDN Export, Validate (References and BREX), PM Builder, and Publish.
  • Support for Issue 4.1 internalRefTargetType attribute values in:
    • Arbortext Editor styles.
    • Validate from within Arbortext Editor (Internal References pane).
    • XPP XSLs and styles.
  • Support for Issue 4.1 <brexDmRef> tags in PMs and SCPMs:
    • Validate BREX is available for Issue 4.1 PMs and SCPMs.
    • PM Builder adds a BREX DM reference to new Issue 4.1 PMs and preserves the BREX DM reference in existing Issue 4.1 PMs.
  • Support for Issue 4.1 <brexDmRef> tags in DDNs: DDN Export adds a BREX DM reference to Issue 4.1 DDN XML files.
  • Support for Issue 4.1 CIR (Common Information Repository) warnings and cautions in the Publish tool.
  • Support for internal (local) warning and caution repositories in the Publish tool. (This functionality was added in S1000D Issue 4.0 but was not supported in earlier versions of Contenta S1000D.)
  • Support for Issue 4.1 CIR applicability in the Assign Applicability, Manage Applicability, and Publish tools.
  • Support for optional Issue 4.1 applicability markup (primary product identifiers, prompts, enumeration labels) in the LiveContent Preview and Publish applicability UIs.
  • Support for Issue 4.1 IPD markup in XPP XSLs.
  • Support for graphics and multimedia display in LiveContent Preview.
  • Contenta S1000D Web Services API - early adopter program available.

    A RESTful Web Services API is now available for Contenta S1000D as the next step in evolving the API using current industry standards. Additional methods available with Contenta S1000D Web Services include Get list of PMs, List references inside DM, Get the Propertysheet data of DM, amongst others. All of the methods used for the ADL SCORM Bridge project are now available with this Web Services API.

    Customers who develop custom tools for their implementation and those who are interested in integrating Contenta with other applications and enterprise systems (e.g., LSAR, LMS), may be interested in participating in the early adopter program which is available with this version release. If you would like to be considered for this program, please contact Technical Support requesting further information on this program.

New feature details

The following sections contain detailed descriptions of new functionality in Contenta S1000D 5.1.

Contenta S1000D Database Upgrade changes for Issue 4.1
The Contenta S1000D 5.1 database upgrade adds twenty Issue 4.1 templates to the CSDB under S1000D/Templates/4.1, and adds required AppData keys and values under {Global}/Document Types for the four data module types that were added in Issue 4.1.
S1000D Upload tool enhancements
The Upload tool displays the specific version of each module being uploaded, for example: 4.1, 4.0.1, 4.0, 3.0.1, 3.0, 2.3. The version is obtained from the xsi:noNamespaceSchemaLocation attribute on the <dmodule>, <pm>, or <scormContentPackage> tag. (Formerly Upload displayed an S1000D Version of either 4.0 or Pre 4.0.) If Upload cannot determine the specific version, it initially displays S1000D Version: ?? and, after the well-formed check, displays the following error message and prevents the module from being uploaded into the CSDB:

Version not found

Missing or invalid xsi:noNamespaceSchemaLocation attribute

The Upload tool recognizes the four data module types that were added in Issue 4.1 (comrep, frontmatter, sb, scocontent) and displays a description for each type as follows:
  • For comrep: Common Information Repository
  • For frontmatter: Front Matter
  • For sb: Service Bulletin
  • For scocontent: SCO content

The Upload tool recognizes Issue 4.1 data module types when uploading DMRL (CSV) files. Contenta S1000D delivers a sample 4.1 CSV file that includes the four new data module types: Contenta_home/S1000D_samples/data/DMRL-sample_S1000D_41.csv

S1000D Define and Manage Programs tool enhancements
S1000D Manage DMRL and IRL tool enhancements
These two Contenta S1000D tools recognize Issue 4.1 data module types and export valid 4.1 CSV files.
Arbortext Editor tool enhancements
Contenta S1000D provides updated styles for Arbortext Editor that recognize the Issue 4.1 attribute values for internalRefTargetType and circuitBreakerType attributes.
The Contenta S1000D Arbortext, Arbortext Check Out, and Arbortext Check In tools distinguish 4.0 DMs/PMs/SCPMs from 4.1 DMs/PMs/SCPMs, recognize the data module types that were added in Issue 4.1, and handle 4.1 DMs, PMs, and SCPMs.
The following menu items on the Contenta dropdown in Arbortext Editor have also been modified to handle 4.1 modules:
  • Insert Reference...
  • Validate (see details below)
  • Manage Applicability (see details below)
  • Assign Applicability (see details below)
  • Preview (see details below, in the LiveContent Preview section)
Manage Applicability tool enhancements
If an author wishes to modify an applicability notation in a CIR DM, they must edit the CIR DM directly and run Manage Applicability from there; Contenta S1000D does not support updating a CIR DM while editing a different DM.
If an author wants to add a DM-level applicability annotation to an Issue 4.1 DM, Manage Applicability checks for an <applicRef> tag. If found, the tool displays a message indicating that an <applic> tag cannot be inserted because an <applicRef> tag was found.
If an author wants to add a content-level applicability annotation to an Issue 4.1 DM, Manage Applicability checks for an <referencedApplicGroupRef> tag. If found, the tool displays a message indicating that a <referencedApplicGroup> tag cannot be inserted because a <referencedApplicGroupRef> tag was found.
In Issue 4.1 DMs only, Manage Applicability inserts <referencedApplicGroup> tags in the <content> section, in the correct order with respect to <refs>, <warningsAndCautions>, and/or <warningsAndCautionsRef> tags. (This is a change from Issue 4.0, where <referencedApplicGroup> tags are located in the <identAndStatusSection>.)
Assign Applicability tool enhancements
The Assign Applicability UI displays the following label: Implicit applicability references are not supported in this release.
Assign Applicability recognizes Issue 4.1 <applicRef> tags in the <identAndStatusSection> and <referencedApplicGroupRef>/<applicRef> tags in the <content> section, extracts referenced applicability annotations from the CIR DM, and displays applicability as follows:
  • For DM-level applicability, the <simplePara> text from the referenced CIR DM applicability notation is displayed in the "DM:" field of the Assign Applicability UI.
  • For content-level applicability, one CIR applicability annotation record is displayed in the Reference pane of the Apply Applicability UI for each <applicRef> found in <referencedApplicGroupRef>.
  • For both types of applicability, conditions from the <evaluate> and <assert> elements are extracted for possible display in the Expression pane of the Assign Applicability UI.
Error handling: If missing or incorrect attribute values invalidate a CIR reference, Assign Applicability displays the following message in the Arbortext Editor status bar and provides detailed error messages in the log file itself:
Some CIR applicability references could not be resolved. See latest log file under <Contenta>\logs\XyArbortextPlugin.
When an author selects a CIR applicability notation in the Assign Applicability UI:
  • The Modify button is deactivated since Contenta S1000D does not support updating the CIR DM while editing a different DM. The CIR DM must be edited directly in order to update it.
  • The New button is deactivated since Issue 4.1 does not permit <applic> or <referencedApplicGroup> tags to be added to a DM that contains <applicRef> or <referencedApplicGroupRef> tags respectively.
  • The Apply button is activated. If the author clicks Apply, Assign Applicability inserts an applicRefId attribute as it already does in Issue 4.0; this markup is the same for both CIR and non-CIR applicability references.
S1000D Clip Reference tool enhancements
The title of one of the code blocks has been changed from S1000D 4.0 Code Block to S1000D 4.0 or higher Code Block.
The wording of the "Click here" instructions has been improved as follows:
  • Old wording: Click here to get the structure used in PubModules before S1000D 4.0
  • New wording: Click here to get the structure used in PubModules before S1000D 4.0 (i.e., with the <dmc> tag)
  • Old wording: Click here to get the structure used in PubModules in S1000D 4.0 or higher
  • New wording: Click here to get the structure used in PubModules as of S1000D 4.0 (i.e., without the <dmc> tag)
S1000D LiveContent Preview tool enhancements
An Ilustrations control has been added that, when clicked, displays graphics and multimedia objects referenced in the data module. Authors may navigate through the graphics and multimedia objects and click a Tear Off button to view an object at full size in a separate window.
The LiveContent Preview tool supports optional Issue 4.1 applicability markup for primary product identifiers and user-friendly prompts and enumeration labels. When present, this markup is displayed in the window that opens when an author clicks Current Applicability Shown. Specifically, the applicability UI supports the following:
  • Prompts: The LiveContent Preview tool detects the optional <prompt> tag in each <productAttribute> tag in the ACT DM, and in each <cond> tag in the CCT DM. If found, when applicability is selected by either Product or Condition in LiveContent Preview, the <prompt> tag contents are displayed in the left-hand columns of the Product Attributes and Technical Conditions tables. Otherwise, the name is displayed.

  • Enumeration labels: The LiveContent Preview tool detects the optional enumerationLabel attribute in each <enumeration> tag in both ACT and CCT DMs.

    When applicability is selected by either Product or Condition, the enumerationLabel attribute value is displayed in the right-hand column pick lists in the Product Attributes table.

    When applicability is selected by Condition, the enumerationLabel attribute value is displayed in the right-hand column pick lists in the Technical Conditions table.

    When there are no enumerationLabel attributes, or when an enumerationLabel has been incorrectly added to a list or range of applicPropertyValues such as Mk1|Mk9 or 1~3, the applicPropertyValues themselves are displayed.

  • Primary product identifiers: The LiveContent Preview tool detects the optional productIdentifier attribute in each <productAttribute> tag.

    If found and set to primary, when applicability by Product in LiveContent Preview is selected, only these <product> id values are used to populate the Product Identifier pick list (that is, products that contain a primary product identifier as the <assign> tag's applicPropertyIdent attribute value).

S1000D DDN Export tool enhancements
Version 4.1 has been added to the list of S1000D Version options.
The Issue 4.1 DDN schema includes a mandatory <brexDmRef> tag that must reference a BREX DM. The DDN Export tool adds a <brexDmRef> tag to reference the project BREX when possible, as follows:
  • If an Issue 4.1 DDN package contains one BREX DM, DDN Export adds a reference to that DM.
  • If an Issue 4.1 DDN package contains multiple BREX DMs, DDN Export adds a reference to the first BREX DM that is found.
  • If an Issue 4.1 DDN package doesn't contain a BREX DM, DDN Export adds a reference to the Issue 4.1 default BREX DM.

The exported DDN file can be manually edited to reference a different BREX DM as needed.

S1000D Validate tool enhancements - Validate References
When Validate is run from within Arbortext Editor on an Issue 4.1 DM, the resulting Internal References pane displays Issue 4.1 internalRefTargetType attribute values, for example: irtt01 rather than figure.
Since, in Issue 4.1, internal references may point to either non-"Alts" tags (such as <figure> or <multimedia>) or "Alts" tags (such as <figureAlts> or <multimediaAlts>), the Internal References pane displays both types of tags.
The following table lists internal reference target tags, their "Alts" equivalents, and the corresponding internalRefTargetType attribute values:
Internal reference target elementRelated "Alts" elementinternalRefTargetType
figurefigureAltsirtt01
multimediamultimediaAltsirtt03
commonInfoDescrParacommonInfoDescrParaAltsirtt07
levelledParalevelledAltsirtt07
proceduralStepproceduralStepAltsirtt08
S1000D Validate tool enhancements - Validate BREX
Validate BREX has been enhanced to run on Issue 4.1 PM and SCPM objects, which contain a mandatory <brexDmRef> tag. The BREX Compliance pane will be also be displayed for Issue 4.1 PMs and SCPMs when Validate is run from within Arbortext Editor.
Since other types of modules, not just data modules (DMs), may be validated for BREX compliance, the wording in all BREX reports has been changed from "DM" or "data module" to "module."
When checking for a version mismatch between the module being validated and the BREX DM, Validate BREX additionally checks for version mismatches between Issues 4.0 and 4.1. (Formerly this tool only checked for version mismatches between Issues 3.0 and 4.0.)
BREX syntax errors have been made more visible so that they are not missed when the module being validated is BREX compliant. In this case, a green More... link is additionally displayed that, when clicked, informs the author of any BREX rules that could not be validated.
S1000D PM Builder tool enhancements
PM Builder has been enhanced to run on Issue 4.1 PMs.
PM Builder recognizes Issue 4.1 markup changes in the identificationAndStatusSection and content section of PMs and handles this markup in the same way that it handles Issue 3.0 and 4.0 markup, as follows:
  • PM Builder supports mandatory Issue 4.1 markup in the <identificationAndStatusSection>, specifically the <brexDmRef> tag.
    • When building a new Issue 4.1 PM, PM Builder adds a <brexDmRef> tag along with the required child <dmRef> and <dmRefIdent> tags to reference the default 4.1 BREX DM, preceded by a comment indicating that the author may change this reference to point to a different BREX DM as needed.
    • When modifying an existing Issue 4.1 PM, PM Builder preserves the existing BREX DM reference.
  • PM Builder preserves optional Issue 4.1 markup in the <identificationAndStatusSection>, specifically <externalPubCode> and <applicRef> tags.
  • PM Builder searches for unsupported Issue 4.1 markup in the <content> section, and displays an error if any is found. In Issue 4.1, nine optional attributes are available on the <pmEntry> tag: applicRefId, changeMark, changeType, reasonForUpdateRefIds, securityClassification, commercialClassification, caveat, authorityName, authorityDocument
Contenta S1000D sample data
Contenta S1000D sample data consists of three small publications, one each for Issues 3.0, 4.0, and 4.1. The 4.1 sample publication is new with Contenta S1000D 5.1. The sample publications contain subsets of S1000DBIKE data (PMs, DMs, and ICNs) and do not include every DM type.

The purpose of these publications is to provide content that can be used to step through the functionality from Upload through Publish, including publishing from a single source to produce both a PDF and an IETM.

The 4.1 sample publication also provides examples of the following Issue 4.1 features:
  • CIR warnings and cautions
  • CIR applicability
  • Optional applicability markup:
    • <prompt> element
    • enumerationLabel attribute
    • primary product identifiers
  • IPD markup changes
In Contenta S1000D 5.1, the model identification code used for the sample data is SAMPLEBIKE. The Contenta S1000D 3.0 and 4.0 sample data modules have been renamed so that they do not conflict with S1000DBIKE sample data module names or with different versions of the same data module. The following system difference codes have been assigned:
  • AAA for 3.0 data modules
  • BBB for 4.0 data modules
  • CCC for 4.1 data modules
The Contenta S1000D 3.0 and 4.0 sample publication modules have also been renamed for the same reasons. The PMs are are named as follows:
  • 3.0 PM: SAMPLEBIKE-XYENT-00030-01
  • 4.0 PM: SAMPLEBIKE-XYENT-00040-01
  • 4.1 PM: SAMPLEBIKE-XYENT-00041-01

Contenta S1000D delivers three sample output PDF files, one for each publication. Contenta S1000D no longer delivers sample IETMs since LiveContent S1000D delivers its own sample IETMs.

XPP style enhancements
To support publishing Issue 4.1 data to XPP to create PDFs, XSLs and XPP styles have been modified to handle Issue 4.1 markup. The existing s1000d40 XPP style bundle has been enhanced to include Issue 4.1 tags and attributes where needed. Specifically:
  • The XSL that builds IPD tables additionally builds Issue 4.1 IPD tables.
  • XSL and XPP styles additionally handle Issue 4.1 internalRefTargetType attribute values, for example: irtt01 rather than figure.
  • Various XPath expressions in the XPP styles were modified to support Issue 4.1 markup.
  • Various other formatting enhancements were made in the XPP styles.
S1000D Publish tool enhancements
The Publish tool resolves Issue 4.1 CIR warning and caution references when publishing to XPP to create a PDF or to LiveContent S1000D to create an IETM. Note the following:
  • The <dmRef> of the CIR DM must be provided (explicit reference). The Contenta Insert Reference menu item in Arbortext Editor may be used to add this markup. Implicit CIR references are not supported in this release.
  • The Publish tool adds <repositorySourceDmIdent> tags to each referencing DM, in order to list each warning or caution CIR DM that was referenced by that particular referencing DM.
  • The Publish tool also supports internal (local) warning and caution repositories by resolving references to those warnings and cautions. (This functionality was added in S1000D Issue 4.0 but was not supported prior to Contenta S1000D 5.1.)
The Publish tool resolves Issue 4.1 CIR applicability references when publishing to XPP to create a PDF or to LiveContent S1000D to create an IETM. Note the following:
  • The <dmRef> of the CIR DM must be provided (explicit reference). The Contenta Insert Reference menu item in Arbortext Editor may be used to add this markup. Implicit CIR references are not supported in this release.
  • The Publish tool adds <repositorySourceDmIdent> tags to each referencing DM, in order to list each applicability CIR DM that was referenced by that particular referencing DM.
The Publish tool supports optional Issue 4.1 applicability markup for primary product identifiers and user-friendly prompts and enumeration labels. When present, this markup is displayed in the window that opens when the author clicks Set Applicability and selects a PM. The applicability UI changes are the same as described above for LiveContent Preview; the only difference is that the tables in which these UI changes are displayed have different names in the publish applicability UI: BY ACT, BY CCT, and BY PRODUCT.