<prolog>: How do you use the <prolog> element to include additional information, such as copyright notices or abstracts, at the beginning of a DITA topic?

November 10, 2023
|By Bryan Tipper

The <prolog> element in DITA XML is used to include additional information at the beginning of a DITA topic. This information typically consists of metadata, copyright notices, abstracts, or any content that provides context or supplementary details about the topic. The <prolog> element allows you to enhance the topic’s content and provide valuable information to readers.

Adding Copyright Notices

One common use of the <prolog> element is to include copyright notices. This helps ensure that the intellectual property rights of the content are acknowledged and protected. Here’s an example:


<topic>
  <prolog>
    <copyright>
      <copyright-year>2023</copyright-year>
      <copyright-holder>XYZ Corporation</copyright-holder>
    </copyright>
  </prolog>
  <title>Product User Manual</title>
  <body>
    <p>This manual provides instructions for using our product.</p>
    <!-- Content goes here -->
  </body>

In this example, the <prolog> element includes a copyright notice with the copyright year and holder’s name.

Providing Abstracts

Another use of the <prolog> element is to include an abstract that summarizes the topic’s content. This abstract offers readers a brief overview before diving into the details. Here’s an example:


<topic>
  <prolog>
    <abstract>
      <p>This topic discusses the benefits of using DITA XML for structured authoring and content reuse.</p>
    </abstract>
  </prolog>
  <title>Introduction to DITA XML</title>
  <body>
    <p>DITA XML is a markup language designed for structured authoring...</p>
    <!-- Content goes here -->
  </body>

In this case, the <prolog> element contains an abstract that provides a concise summary of the topic’s content, helping readers understand its purpose.