PDF/UA

Diese CIAbkürzung für „Continuous Integration“ – eine Entwicklungspraxis, bei der Codeänderungen automatisch gebaut, getestet und häufig in ein zentrales Repository integriert werden, um Integrationsprobleme frühzeitig zu erkennen und eine hohe Codequalität sicherzustellen. Komponente können Sie verwenden, um ein Markdown-Dokument in eine PDFPortable Document Format/UAUniversal Accessibility-konforme PDFPortable Document Format-Datei umzuwandeln.

Damit Sie dem PDFPortable Document Format/UAUniversal Accessibility-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 CIAbkürzung für „Continuous Integration“ – eine Entwicklungspraxis, bei der Codeänderungen automatisch gebaut, getestet und häufig in ein zentrales Repository integriert werden, um Integrationsprobleme frühzeitig zu erkennen und eine hohe Codequalität sicherzustellen.-Komponente ausgeführt wird.
  Standardwert: build

Quell-Dateien

• md-path: Pfad zum Markdown-Dokument (Ordner im RepositoryEin zentraler, versionskontrollierter Speicherort für Quellcode und zugehörige Dateien, der die gemeinsame Entwicklung und Änderungsverfolgung erleichtert., ausgehend vom Stammverzeichnis), das in eine PDFPortable Document Format/UAUniversal Accessibility-konforme PDFPortable Document Format-Datei umgewandelt werden soll.
  Standardwert: document

• template-path: Pfad zum Ordner, der die Template-Dateien (z. B. LaTeX-Vorlage oder Schriftarten) für die PDFPortable Document Format-Datei enthält.
  Standardwert: template

PDF-Datei

• outputfile-name: Name der PDFPortable Document Format-Datei (ohne Dateiendung .pdf).
  Standardwert: output

• document-title: Titel des Dokuments, der in der PDFPortable Document Format-Datei angezeigt wird.
  Standardwert: Document

• primary-color: Primärfarbe für die PDFPortable Document Format-Datei (RGB-1-Wert).
  Standardwert: 0.12,0.28,0.49

Feature

• table-of-contents: Aktiviert bzw. deaktiviert das Inhaltsverzeichnis in der PDFPortable Document Format-Datei. Wird nur im PDFPortable Document Format-Modus full unterstützt.
  Standardwert: true

• display-watermark: Aktiviert bzw. deaktiviert das Wasserzeichen “Vorabfassung - wird durch lektorierte Fassung ersetzt” in der PDFPortable Document Format-Datei. Wird nur im PDFPortable Document Format-Modus full unterstützt.
  Standardwert: false

IT-Architekturrichtlinien spezifisch

• mode: Modus der PDFPortable Document Format-Generierung. Kann die Werte full, compact oder core annehmen. Die Modi compact und core beschränken die PDFPortable Document Format auf die Vorgaben.
  Standardwert: full

• additional-controls-highlighting: Aktiviert die Hervorhebung von Ergänzungen in der PDFPortable Document Format-Datei. Mehr zu dieser Funktion finden Sie hier.
  Standardwert: false
  Status: PoC