ADAM Publisher

Retaining the original case of warnings and cautions in 1000BR publications

Available from ADAM PUBLISHER_PDF version 3.2.4 onwards

As part of the ongoing improvement of ADAM Publisher, a change has been made to the handling of ‘warning’ and ‘caution’ elements in publications compliant with the 1000BR specification.

From now on, the case of the text entered in the XML data is retained when the PDF is generated, without being automatically converted to upper case.

This change ensures that technical information remains accurate and complies with the presentation rules of the 1000BR specification.

Why has this change taken place?

Until now, the ADAM Publisher style sheet systematically converted the content of warning and caution elements to uppercase.

Consequently, even when an editor entered text containing lower-case letters, it appeared entirely in uppercase in the generated PDF document.

This conversion could lead to misinterpretations, particularly for units of measurement, technical references or product names where case is significant.

Example:

Before: DO NOT APPLY MORE THAN 25 MA TO THE TEST CONNECTOR.

After: Do not apply more than 25 mA to the test connector.

In this example, the conversion of ‘mA’ (milliamps) to ‘MA’ (megaamps) significantly alters the meaning of the information.

In the context of technical documentation and safety instructions, preserving this information is essential.

A development in line with the 1000BR specification

The 1000BR specification does not require the content of warnings and cautions to be systematically capitalised.

It stipulates a specific layout in which:

  • The headings ‘WARNING’ and ‘CAUTION’ remain in capital letters and underlined.
  • The content of the messages retains its bold and centred formatting.
  • The case of the text corresponds to that defined in the XML data.

The new ADAM Publisher system therefore adheres to these principles whilst preserving the information entered by the author.

Réunions com 4D (5)

In particular, it includes warningAndCautionPara in its original mixed-case form, which would be impossible if the standard required the content to be in capital letters.

What exactly is changing?

From version ADAM PUBLISHER_PDF 3.2.4 onwards, the only change is to the way case sensitivity is handled in the content of warnings and cautions.

Item

Before

Now

Headings WARNING / CAUTION

Capital letters and underlining

Unchanged

Messages content

Forced capital letters

XML formatting retained

Content formatting

Bold and centred

Unchanged

Please note: if text is entered in upper case in the XML, it will remain in upper case in the PDF. If the text contains lower-case letters, these will now be retained.

What impact will this have on existing publications?

This change may affect publications where the data was written taking into account the previous automatic capitalisation.

When a new PDF is generated, this content will now appear with the case defined in the XML files.

For users wishing to retain certain messages entirely in upper case, the recommended solution is to amend the relevant XML data directly.

It remains technically possible to restore the previous behaviour by overriding the style sheet via the properties.xml file in the publication configuration (see screenshot below).

This option allows you to force warnings and cautions to be converted to uppercase, independently of one another.

Please note: this method is not recommended, as it reintroduces the risk of altering units of measurement, references and other case-sensitive information.

Updating the XML data therefore remains the preferred solution.

In summary

This update to ADAM Publisher ensures greater consistency between the XML data created and its rendering in 1000BR PDF publications.

In particular, it enables you to:

  • Preserve the meaning of units of measurement and technical references.
  • Avoid errors caused by automatic capitalisation.
  • Maintain the case defined during the drafting and validation of content.
  • Ensure that the presentation complies with the principles of the 1000BR specification.

Affected version: ADAM PUBLISHER_PDF 3.2.4 and later versions.