News & Blogs


S1000D Print and Publish stylesheets

- Tuesday, 2nd August 2022

We understand that "todays" project teams can involve team members being spread far and wide. They could be located in a different office, on a different floor, in a different building, at a different site and sometimes even across the border in a different country.

This means an Author will often require a physical PDF file for QA review by a remote Subject Matter Expert and/or for submission to an Equipment Sponsor for final sign-off and approval.

Globe

It is therefore important to ensure the Printed output matches the FINAL Published output.

The same stylesheets for both Print and Publish

The Printed source and the Published source are the same source, so we wanted to use the same stylesheets for both outputs. We therefore spent a considerable amount of additional "testing" time during the stylesheet development phase looking at both the Printed and Published outputs to ensure they always matched.

Click image to enlarge

Docuneering - S1000D 4.1 Test Publication - Common Information Repository

S1000D 4.1 Test Publication - Common Information Repository (CIR)

This has the benefit, to our customers, of creating a consistent Printed and Published PDF output, but it also has the added advantage of creating a single S1000D stylesheet source.

S1000D CIR-dependent Data Modules

There are some items within a Data Module that are handled differently depending on whether the Data Module is being Printed or Published.

For example, within a Data Module, references to the Common Information Repository (CIR) will output the results differently. If you are Printing an individual Data Module, then there is no way to resolve a CIR-dependent reference.

If your Common Source Database (CSDB) can output a "self-contained" Data Module as opposed to CIR-dependent (see: S1000D 4.1 Chapter 1.3 Section 4 for more details) then CIR references to things like tools, supplies and spares as well as warnings and cautions can be resolved and the relevant text or description output into the PDF file.

However, if all of your Data Modules are CIR-dependent then, while much of the output is the same, there will be slight differences.

Below is an example of a CIR-dependent Data Module Printed and then Published:


Click image to enlarge

Docuneering - S1000D CIR Data Module - Printed

Printed Data Module

Docuneering - S1000D CIR Data Module - Published

Published Data Module


In the Printed output, we wanted to ensure there was no confusion between internal and external CIR-dependent references so we styled them differently. Internal CIR references are resolved and styled to look like any other link (blue text) however, external CIR references are preceded with a link icon and the target reference is coloured yellow to indicate it is an unresolved link.

The same Data Module, but this time Published, now has all of the CIR-dependent references resolved and as such, they are all styled to look like any other link.

If you would like more information...

Get in touch



Want to find out more?

Contact Us