wortsammler 0.0.2

data/resources/default.latex

@@ -0,0 +1,225 @@
+\documentclass[$if(fontsize)$$fontsize$,$endif$$if(lang)$$lang$,$endif$]{$documentclass$}
+%list environment by rj
+% {\catcode`\@=11\relax%
+% \gdef\itemize{%
+%   \ifnum \@itemdepth >\thr@@\@toodeep\else
+%     \advance\@itemdepth\@ne
+%     \edef\@itemitem{labelitem\romannumeral\the\@itemdepth}%
+%     \expandafter
+%     \list
+%       \csname\@itemitem\endcsname
+%       {\def\makelabel##1{\hss\llap{##1}}%
+%        \addtolength{\leftmargin}{-10pt}% 29.37pt
+%        \addtolength{\rightmargin}{0.0pt}% 0.0pt
+%        \addtolength{\labelsep}{0pt}% 23.50pt
+%        \addtolength{\itemsep}{-3.0pt}% 5.0pt
+%        \addtolength{\parsep}{0pt}% 5.0pt
+%        \addtolength{\topsep}{-5pt}% 10.0pt
+%        \addtolength{\partopsep}{0pt}% 3.0pt
+%       }%
+%   \fi}
+% }%
+%end list environment by Reinhard Jahraus
+\usepackage[T1]{fontenc}
+\usepackage{lmodern}
+\usepackage{amssymb,amsmath}
+\usepackage{ifxetex,ifluatex}
+\usepackage{fixltx2e} % provides \textsubscript
+% use microtype if available
+\IfFileExists{microtype.sty}{\usepackage{microtype}}{}
+\ifnum 0\ifxetex 1\fi\ifluatex 1\fi=0 % if pdftex
+  \usepackage[utf8]{inputenc}
+$if(euro)$
+  \usepackage{eurosym}
+$endif$
+\else % if luatex or xelatex
+  \usepackage{fontspec}
+  \ifxetex
+    \usepackage{xltxtra,xunicode}
+  \fi
+  \defaultfontfeatures{Mapping=tex-text,Scale=MatchLowercase}
+  \newcommand{\euro}{€}
+$if(mainfont)$
+    \setmainfont{$mainfont$}
+$endif$
+$if(sansfont)$
+    \setsansfont{$sansfont$}
+$endif$
+$if(monofont)$
+    \setmonofont{$monofont$}
+$endif$
+$if(mathfont)$
+    \setmathfont{$mathfont$}
+$endif$
+\fi
+$if(geometry)$
+\usepackage[$for(geometry)$$geometry$$sep$,$endfor$]{geometry}
+$endif$
+$if(natbib)$
+\usepackage{natbib}
+\bibliographystyle{plainnat}
+$endif$
+$if(biblatex)$
+\usepackage{biblatex}
+$if(biblio-files)$
+\bibliography{$biblio-files$}
+$endif$
+$endif$
+$if(listings)$
+\usepackage{listings}
+$endif$
+$if(lhs)$
+\lstnewenvironment{code}{\lstset{language=Haskell,basicstyle=\small\ttfamily}}{}
+$endif$
+$if(highlighting-macros)$
+$highlighting-macros$
+$endif$
+$if(verbatim-in-note)$
+\usepackage{fancyvrb}
+$endif$
+$if(fancy-enums)$
+% Redefine labelwidth for lists; otherwise, the enumerate package will cause
+% markers to extend beyond the left margin.
+\makeatletter\AtBeginDocument{%
+  \renewcommand{\@listi}
+    {\setlength{\labelwidth}{4em}}
+}\makeatother
+\usepackage{enumerate}
+$endif$
+$if(tables)$
+\usepackage{ctable}
+\usepackage{float} % provides the H option for float placement
+$endif$
+
+\usepackage{graphicx}
+% We will generate all images so they have a width \maxwidth. This means
+% that they will get their normal width if they fit onto the page, but
+% are scaled down if they would overflow the margins.
+\makeatletter
+\def\maxwidth{\ifdim\Gin@nat@width>\linewidth\linewidth
+\else\Gin@nat@width\fi}
+\makeatother
+\let\Oldincludegraphics\includegraphics
+\renewcommand{\includegraphics}[1]{\Oldincludegraphics[width=\maxwidth]{#1}}
+
+\ifxetex
+  \usepackage[setpagesize=false, % page size defined by xetex
+              unicode=false, % unicode breaks when used with xetex
+              xetex]{hyperref}
+\else
+  \usepackage[unicode=true]{hyperref}
+\fi
+\hypersetup{breaklinks=true,
+            bookmarks=true,
+            pdfauthor={$author-meta$},
+            pdftitle={$title-meta$},
+            colorlinks=true,
+            urlcolor=$if(urlcolor)$$urlcolor$$else$blue$endif$,
+            linkcolor=$if(linkcolor)$$linkcolor$$else$magenta$endif$,
+            pdfborder={0 0 0}}
+$if(links-as-notes)$
+% Make links footnotes instead of hotlinks:
+\renewcommand{\href}[2]{#2\footnote{\url{#1}}}
+$endif$
+$if(strikeout)$
+\usepackage[normalem]{ulem}
+% avoid problems with \sout in headers with hyperref:
+\pdfstringdefDisableCommands{\renewcommand{\sout}{}}
+$endif$
+\setlength{\parindent}{0pt}
+\setlength{\parskip}{6pt plus 2pt minus 1pt}
+\setlength{\emergencystretch}{3em}  % prevent overfull lines
+$if(numbersections)$
+$else$
+\setcounter{secnumdepth}{0}
+$endif$
+$if(verbatim-in-note)$
+\VerbatimFootnotes % allows verbatim text in footnotes
+$endif$
+$if(lang)$
+\ifxetex
+  \usepackage{polyglossia}
+  \setmainlanguage{$mainlang$}
+\else
+  \usepackage[$lang$]{babel}
+\fi
+$endif$
+$for(header-includes)$
+$header-includes$
+$endfor$
+
+$if(title)$
+\title{$title$}
+$endif$
+\author{$for(author)$$author$$sep$ \and $endfor$}
+\date{$date$}
+
+\setlength{\oddsidemargin}{0cm}
+\setlength{\evensidemargin}{0cm}
+\setlength{\textwidth}{16cm}
+\setlength{\topmargin}{-2cm}
+\setlength{\headheight}{1cm}
+\setlength{\headsep}{1cm}
+\setlength{\textheight}{23cm}
+\setlength{\footskip}{1cm}
+
+% adjust the toc layout
+\makeatletter
+% \renewcommand*\l@section{\@dottedtocline{2}{1.8em}{4em}}
+ \renewcommand*\l@subsection{\@dottedtocline{2}{1.5em}{4em}}
+ \renewcommand*\l@subsubsection{\@dottedtocline{2}{5.5em}{4em}}
+\makeatother
+
+\usepackage{fancyhdr}
+\pagestyle{fancy}
+\chead{\begin{center}\textbf{$title$}\end{center}}
+%\lhead{\includegraphics{logo.jpg}}
+\rhead{\leftmark}
+\lfoot{www.weichel21.de}
+\rfoot{\today}
+\renewcommand{\footrulewidth}{0.4pt}
+%
+\renewcommand{\familydefault}{\sfdefault}
+%
+%
+\begin{document}
+$if(title)$
+\maketitle
+\clearpage
+$endif$
+
+$for(include-before)$
+$include-before$
+
+$endfor$
+$if(toc)$
+{
+\hypersetup{linkcolor=black}
+\tableofcontents
+\newpage
+}
+$endif$
+$body$
+
+$if(natbib)$
+$if(biblio-files)$
+$if(biblio-title)$
+$if(book-class)$
+\renewcommand\bibname{$biblio-title$}
+$else$
+\renewcommand\refname{$biblio-title$}
+$endif$
+$endif$
+\bibliography{$biblio-files$}
+
+$endif$
+$endif$
+$if(biblatex)$
+\printbibliography$if(biblio-title)$[title=$biblio-title$]$endif$
+
+$endif$
+$for(include-after)$
+$include-after$
+
+$endfor$
+\end{document}

data/resources/main.md

@@ -0,0 +1,268 @@
+% Wortsammler sample document
+% Bernhard Weichel; and others
+% date
+
+# Introduction
+
+This is a sample document for Wortsammler
+
+# 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)
+
+## 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:
+
+        `~~ED intern extern~~` ab hier gilt: Text erscheint in Ausgabe
+        `intern` als auch in `extern`
+
+        Es handelt sich also um ein durchgestrichenes Muster als
+        regulärer Ausdruck
+
+            ~~ED((\s* \S+)*)~~
+
+    -   Die Umschaltung wirkt ab einschliesslich der Zeile, die die
+        Umschaltung enthält, bis zum Aufruf einer neuen Umschaltung.
+
+    -   Die möglichen Zielgruppen werden im Manifest festgelegt
+        ->[RS_Comp_007] daselbst Eintrag `:editions:`
+
+    -   Eine vorgegebene Zielgruppe `all` erzeugt keine spezifische
+        Ausgabe. Sie kennzeichnet vielmehr Inhalte, die in **allen**
+        Ausgaben gleichermassen enthalten sind.
+
+    -   Bei einer Aufteilung auf mehrere Dateien wird empfohlen am Ende
+        einer jeden Datei auf `all` zu schalten. Dadurch wird das System
+        einfache wartbar.
+
+    }(RS_Comp_003)
+
+    Alternativen für die Umschaltung sind:
+
+    \marginpar{intern}
+
+    -   ~~ED intern extern~~ und so geht es weiter
+
+    -   ^ZG intern extern^ und nun kommt der text der nur extern ist
+
+    \marginpar{extern}
+
+    -   ~ZG intern extern~ und hier ist der text der nur intern ist
+
+    -   <!-- ZG intern extern --> und nun geht es weiter
+
+    \marginpar{intern}
+
+    -   und nun geht es intern weiter Gelaber und weiter
+
+-   [RS_Comp_009] **Gesamtausgabe mit allen Texten zur Prüfung**
+    {Sollte Dokumente Eine Gesamtausgabe mit allen Texten zur
+    Überprüfung soll erstellt werden. In diesem Fall werden die Ausgaben
+    am Rand notiert. }(RS_Comp_003)
+
+-   [RS_Comp_010] **Erstellung aller Ausgaben mit einem Befehl** {Es
+    sollen immer alle Ausgaben gleichermassen generiert werden. Dabei
+    gilt:
+
+    -   Der Dateiname für die generierten Dokumente bildet sich nach
+
+        `{:outname:}_{:edition:.:filepart:}.{format}`
+
+    -   In der Kopfzeile des Dokumentes wird `:edition:.:title:`
+        eingefügt, so dass die Ausgabe auf jeder Seite identifiziert
+        werden kann.
+
+    Ohne Angabe einer Zielgruppe bzw. mit der Angabe `all` soll
+    wortsammler alle Ausgaben erstellen.
+
+    Die Angabe einer einzelnen Zielgruppe erstellt dann auch nur die
+    gewählte Ausgabe.
+
+    }(RS_Comp_003)
+
+## Processing TODO - open issues
+
+Paragraphs like starting with
+
+    TODO: #13 do something are used to manage the open issues   
+
+## Processing the traceables
+
+## Including Files
+
+-   [RS_Comp_011] **including Plain pdf-Pages**{ PDF pages can be
+    included by
+
+    `~~PDF "lib/01234_particularPdf.pdf" "Das ist der Eintrag im Inhaltsverzeichnis" 1 2-4~~`
+
+    It is done in a markdown verbatim section. By this, Pandoc does not
+    add linebreaks in the command such that it can be processed with
+    regular expressions.
+
+    }(RS_Comp_003)
+
+-   [RS_Comp_014] **Including markdown files** {
+
+    `~~MD "lib/01234/xxxx/yyyy.md"~~`
+
+    will be replaced by the content of the argument. It shold even work
+    inline.
+
+    }(RS_Comp_003)
+
+## Handling Text Snippets
+
+-   [RS_Comp_012] **Including text Snippets**{ Text Snippts can be
+    included by
+
+        `~~SN {symbol}~~`
+
+    The snippets are taken from one of the snippet databases declared in
+    the manifest ->[RS_Comp_007] according to the format in
+    ->[RS_Comp_013]. }()
+
+-   [RS_Conp_013] **Defining text Snippets** {
+
+    Text snippets are defined as a yaml file in the following format:
+
+        :Snippet1: Das ist Snippet 1
+
+        :Snippet2: |- Das ist snippet 2. Es enthält sogar eine Liste
+
+                *   Das ist item 1 in Snippet 2
+
+                *   Das ist item 2 in Snippet 2
+
+    }(RS_Comp_003)
+

data/resources/rakefile.rb

@@ -0,0 +1,5 @@
+
+require 'wortsammler/rake_helper'
+
+
+

data/resources/requirementsSynopsis.graphml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<graphml xmlns="http://graphml.graphdrawing.org/xmlns"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:y="http://www.yworks.com/xml/graphml" xmlns:yed="http://www.yworks.com/xml/yed/3" xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns http://www.yworks.com/xml/schema/graphml/1.1/ygraphml.xsd">
+  <!--Created by yFiles for Java 2.9-->
+  <key for="graphml" id="d0" yfiles.type="resources"/>
+  <key for="port" id="d1" yfiles.type="portgraphics"/>
+  <key for="port" id="d2" yfiles.type="portgeometry"/>
+  <key for="port" id="d3" yfiles.type="portuserdata"/>
+  <key attr.name="url" attr.type="string" for="node" id="d4"/>
+  <key attr.name="description" attr.type="string" for="node" id="d5"/>
+  <key for="node" id="d6" yfiles.type="nodegraphics"/>
+  <key attr.name="Beschreibung" attr.type="string" for="graph" id="d7"/>
+  <key attr.name="url" attr.type="string" for="edge" id="d8"/>
+  <key attr.name="description" attr.type="string" for="edge" id="d9"/>
+  <key for="edge" id="d10" yfiles.type="edgegraphics"/>
+  <graph edgedefault="directed" id="G">
+  </graph>
+</graphml>

data/resources/sample_the-sample-document.yaml

@@ -0,0 +1,51 @@
+-
+    :name:  komplett
+    :outdir: ../ZGEN_Documents
+    :outname: RS_Main
+    :format:
+        - latex
+        - docx
+        - html
+
+    :vars: 
+        :lang: german
+        :fontsize: 12pt
+        :mainfont: Calibri
+        :sansfont: Calibri
+        :geometry: a4paper 
+
+    :stylefiles:
+      :latex: ../ZSUPP_Styles/default.latex
+      :docx:  ../ZSUPP_Styles/default.docx
+      :html:  ../ZSUPP_Styles/default.css
+
+    :input: 
+        - ../001_main/main.md
+
+    :downstream_tracefile: ../ZGEN_RequirementsTracing/RS_Main.traces.md
+
+    :reqtracefile_base: ../ZGEN_RequirementsTracing/ZGEN_Reqtrace
+
+    :traceSortOrder:
+        - RS_MG
+        - RS_TEC
+
+
+    :editions:
+
+        :review:
+            :title: Main requirements (review)
+            :filepart: review
+            :debug: true
+
+        :compact:
+            :title: Main requirements (compact)
+            :filepart: compact
+
+        :extended:
+            :title: Main requirements (extended)
+            :filepart: mieter
+
+    :snippets:
+        - ../900_snippets/snippets.xlsx
+

data/spec/test.graphml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<graphml xmlns="http://graphml.graphdrawing.org/xmlns" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:y="http://www.yworks.com/xml/graphml" xmlns:yed="http://www.yworks.com/xml/yed/3" xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns http://www.yworks.com/xml/schema/graphml/1.1/ygraphml.xsd">
+  <!--Created by yFiles for Java 2.9-->
+  <key for="graphml" id="d0" yfiles.type="resources"/>
+  <key for="port" id="d1" yfiles.type="portgraphics"/>
+  <key for="port" id="d2" yfiles.type="portgeometry"/>
+  <key for="port" id="d3" yfiles.type="portuserdata"/>
+  <key attr.name="url" attr.type="string" for="node" id="d4"/>
+  <key attr.name="description" attr.type="string" for="node" id="d5"/>
+  <key for="node" id="d6" yfiles.type="nodegraphics"/>
+  <key attr.name="Beschreibung" attr.type="string" for="graph" id="d7"/>
+  <key attr.name="url" attr.type="string" for="edge" id="d8"/>
+  <key attr.name="description" attr.type="string" for="edge" id="d9"/>
+  <key for="edge" id="d10" yfiles.type="edgegraphics"/>
+  <graph edgedefault="directed" id="G">
+    <node id="t0">
+      <data key="d6">
+        <y:ShapeNode>
+          <y:NodeLabel>[t0] </y:NodeLabel>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <node id="t1">
+      <data key="d6">
+        <y:ShapeNode>
+          <y:NodeLabel>[t1] </y:NodeLabel>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <edge source="t1" target="t0" id="t0_t1"/>
+    <node id="t10">
+      <data key="d6">
+        <y:ShapeNode>
+          <y:NodeLabel>[t10] </y:NodeLabel>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <edge source="t10" target="t1" id="t1_t10"/>
+    <edge source="t10" target="t2" id="t2_t10"/>
+    <node id="t100">
+      <data key="d6">
+        <y:ShapeNode>
+          <y:NodeLabel>[t100] </y:NodeLabel>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <edge source="t100" target="t10" id="t10_t100"/>
+    <node id="t2">
+      <data key="d6">
+        <y:ShapeNode>
+          <y:NodeLabel>[t2] </y:NodeLabel>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <edge source="t2" target="t0" id="t0_t2"/>
+    <node id="t20">
+      <data key="d6">
+        <y:ShapeNode>
+          <y:NodeLabel>[t20] </y:NodeLabel>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <edge source="t20" target="t2" id="t2_t20"/>
+    <edge source="t20" target="t1" id="t1_t20"/>
+    <node id="t200">
+      <data key="d6">
+        <y:ShapeNode>
+          <y:NodeLabel>[t200] </y:NodeLabel>
+        </y:ShapeNode>
+      </data>
+    </node>
+    <edge source="t200" target="t20" id="t20_t200"/>
+  </graph>
+</graphml>