1 Introduction

This is a sample document for Wortsammler

2 Anforderung an Dokumentenaufbereiter

• [RS_Comp_003] Steuerung Dokumentenzusammenstellung {Dokumentenzusammenstellungen soll über ein manifest [RS_Comp_007] gesteuert werden.

  • Die Manifeste sollen als Laufzeitparameter übergeben werden
  • Das Manifest enthält auch die Ausgabedatei

  }(RS_DM_014, RS_DM_010, RS_DM_005)

• [RS_Comp_004] Prozessierung Einzeldokument {Soll Dokumente verschiedenen Umfangs erzeugen können:

  • einzelnes Files
  • zu Prüfzwecken

  Steuerung soll über Konfiguration (Manifest) erfolgen [RS_Comp_007].

  }()

• [RS_Comp_005] Erstellung Loseblattsammlung {Soll Dokumente verschiedenen Umfangs erzeugen können:

  • kann aus dem Manifest errechnet werden [RS_Comp_007]

  }()

• [RS_Comp_006] Inkrementelle Verarbeitung {Soll nur auf geänderte Dokumente reagieren können:

  • ähnlich wie make/rake

  }()

• [RS_Comp_007] Anforderungen an Manifest {Folgende Anforderungen gelten für das Manifest
  • einfach bearbeiten - nur liste der Files
  • Markdown-lite
  • Yaml

  Inhalte im Manifest sind

  • Name der Konfiguration
  • Ausgabeverzeichnis
  • Ausgabeformat
  • Name des generierten Dokumentes
  • Formate in denen das Dokument generiert wird. Werte hierfür ergeben sich aus den Anforderungen an die Aufbereitet
  • zu verarbeitende Eingabedateien. Diese werden in der Reihenfolge verarbeitet wie sie aufgeführt sind.
  • Optionen für die jeweiligen Formate.
  • zu bearbeitende Zielgruppen [RS_Comp_008]

  Beispiel für ein manifest

   -
     :name:  komplett
     :outdir: ../ZGEN_Documents
     :outname: RS_Requirements-Ngopm
     :format:
       - pdf
       - html
       - rtf
       - docx
       - latex
  
     :lang: german  
  
     :vars:
         :lang: german
  
     :editions:
       :intern: 
           :title: Interne Ausgabe
           :filepart: _intern 
       :extern: 
           :title: Externe Ausgabe
           :filepart: _extern
       :mieter: 
           :title: Ausgabe für Mieter
           :filepart: _mieter
       :ea: 
           :title: Ausgabe für ehrenamtliche Mitarbeiter
           :filepart: _ma-ehrenamtlich
       :ha: 
           :title: Ausgabe für hauptamtliche Mitarbeiter
           :filepart: _ma-hauptamtlich
       :1: 
           :title: Ausgabe für erste hauptamtliche Mitarbeiter
           :filepart: _ma-hauptamtlich-1
  
     :input: 
       - ../RS_Process/RS_Process.md 
       - ../RS_Tooling/RS_Tooling.md 
       - ../RS_Tooling/RS_MarkdownCleaner.md 
       - ../RS_Tooling/RS_MarkdownEditor.md 
       - ../RS_Tooling/RS_DocumentComposer.md  
       - ../TPL_DirectoryStructure/TPL_DirectoryStructure.md
       - ../TR_Installation/TR_Installation.md
       - ../TR_Installation/TR_Proo-Handbuch.md
       - ../ZGEN_RequirementsTracing/ZGEN_Reqtrace.md
  
     :snippets:
       - ../TS_Markdown/TS_Snippets.yaml
       - ../TS_Markdown/TS_MoreSnippets.yaml

  }(RS_Comp_003)

2.1 Zielgruppenspezifische Ausgaben

Dieser Abschnitt behandelt speziell die Anforderungen an flexible Dokumentenausgabe

• [RS_Comp_001] Flexibler Dokumentumfang {Soll Dokumente verschiedenen Umfangs erzeugen können:

  • einzelnes Files
  • Zusammengestelltes Dokument

  }(RS_Comp_003)

• [RS_Comp_002] Flexible Dokumentendarstellung {Sollte Dokumente in verschiedener Darstellung erzeugen können:
  • Seitenlayout
  • Detaillierungsgrad (z.B. RequirementsMarken ausblenden) } (RS_Comp_003)

• [RS_Comp_008] Zielgruppenspezifische Ausgaben (Editionen) { Es soll möglich sein Zielgruppenspezifische Ausgaben zu erstellen.

  • Dabei wird die Zielgruppe durch eine spezifische Zeichenkette umgeschaltet (Durchstreichung), die auch in standard Markdown Programmen eine sinnvolle Ausgabe liefert: