PDF/UA

Diese CI Komponente können Sie verwenden, um ein Markdown-Dokument in eine PDF/UA-konforme PDF-Datei umzuwandeln.

Damit Sie dem PDF/UA-Standard entsprechen, sollten Sie die Quality-Komponente einbinden. Hier wird z. B. geprüft, ob Sie Alt-Texte für Bilder hinterlegt haben.

# gitlab-ci.yml
include:
  - component: $CI_SERVER_FQDN/open-code/document-writing-tools/document-writing-ci-components/md-to-pdf-ua@v2
    inputs:
      stage: artifact-generation
      md-path: dokument/
      template-path: template/
      outputfile-name: nationale-it-architekturrichtlinie # .pdf will be appended automatically
      document-title: "Nationale IT-Architekturrichtlinie"
      primary-color: "0.004,0.361,0.271"

⚙️ Parameter

stage: Name des Stages, in dem die CI-Komponente ausgeführt wird.
Standardwert: build

Quell-Dateien

md-path: Pfad zum Markdown-Dokument (Ordner im Repository, ausgehend vom Stammverzeichnis), das in eine PDF/UA-konforme PDF-Datei umgewandelt werden soll.
Standardwert: document
template-path: Pfad zum Ordner, der die Template-Dateien (z. B. LaTeX-Vorlage oder Schriftarten) für die PDF-Datei enthält.
Standardwert: template

PDF-Datei

outputfile-name: Name der PDF-Datei (ohne Dateiendung .pdf).
Standardwert: output
document-title: Titel des Dokuments, der in der PDF-Datei angezeigt wird.
Standardwert: Document
primary-color: Primärfarbe für die PDF-Datei (RGB-1-Wert).
Standardwert: 0.12,0.28,0.49

Feature

table-of-contents: Aktiviert bzw. deaktiviert das Inhaltsverzeichnis in der PDF-Datei. Wird nur im PDF-Modus full unterstützt.
Standardwert: true
display-watermark: Aktiviert bzw. deaktiviert das Wasserzeichen “Vorabfassung - wird durch lektorierte Fassung ersetzt” in der PDF-Datei. Wird nur im PDF-Modus full unterstützt.
Standardwert: false

IT-Architekturrichtlinien spezifisch

mode: Modus der PDF-Generierung. Kann die Werte full, compact oder core annehmen. Die Modi compact und core beschränken die PDF auf die Vorgaben.
Standardwert: full
additional-controls-highlighting: Aktiviert die Hervorhebung von Ergänzungen in der PDF-Datei. Mehr zu dieser Funktion finden Sie hier.
Standardwert: false
Status: PoC