PDFs, Wikis and Implementations Guides

This is documentation for ART-DECOR Release 2 and tends to be out-dated. Please visit our new documentation site at docs.art-decor.org

Output

The ART-DECOR Expert Group has decided to support the following output methods:

  • HTML,
  • PDF and
  • Wiki (Mediawiki).

HTML

The ART-DECOR Release and Archiving Manager (ADRAM) allows to publish an ART-DECOR live project, convert it to a set of HTML pages, publish them at a dedicated web location and by that "freeze" the specification. This is called a release and goes typically along release notes, a release label such as "v1.0" or "1.0.1" or "2nd draft" and an automatically assigned publisher (a project author) and date/time.

For further information see the documentation about creation of a new version / release / publication request and the DECOR publication format.

PDF

ART-DECOR has two methods to create PDFs out of the artefacts defined in a project.

The first method is to create a PDF with the collection of selected artefacts as part of the normal HTML publication process (see above).

If the conversion process should create PDF based documentation by default

  • datasets,
  • scenarios,
  • identifiers,
  • terminologies and
  • rules
  • issues

are included. The single sections can be deselected at publication request time.

Information.svg At this point in time there is no dialog part when submitting the publication request to select / deselect the artefacts to be included in the automatically generated PDF. Instead the switchCreateDocPDF1 switch for the publication in decor-parameters (see DECOR publication) need to be set and populated with the desired options d, s, n, t, r, and/or i for datasets, scenarios, identifiers, terminologies, rules, issues.

The second method is through the Wiki approach. An ART-DECOR server can be configured to export Templates and Value Sets through the ADAWIB service to a Wiki (Mediawiki). The artefacts can be simply transcluded into the normal set-up of a wiki-based implementation guide with text and graphics etc. With that a complete implementation guide can be created and then converted to PDF.

This method uses Prince as the conversion mechanism as DECOR makes use of some special CSS features that are not correctly transformed by some CSS parsers.

Wiki

DECOR value sets and templates can be exported into a wiki (Mediawiki) format and directly used in the respective wiki by transclusion. With that writing of implementation guides that incorporates ART-DECOR rendering of value sets and templates is easily possible.

The export is managed on an ART-DECOR server with an ADAWIB service.