PDFs, Wikis and Implementations Guides

Revision as of 09:56, 24 May 2016 by Admin (talk | contribs) (PDF)

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.

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.

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.

Wiki