wortsammler 1.0.3 → 2.0.1

data/testproject.xx/30_Sources/ZGEN_Documents/RS_Main_review.latex

@@ -0,0 +1,582 @@
+\documentclass[twoside,a4paper,12pt,german,]{article}
+\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}
+\else % if luatex or xelatex
+  \usepackage{fontspec}
+  \ifxetex
+    \usepackage{xltxtra,xunicode}
+  \fi
+  \defaultfontfeatures{Mapping=tex-text,Scale=MatchLowercase}
+  \newcommand{\euro}{€}
+    \setmainfont{Calibri}
+    \setsansfont{Calibri}
+\fi
+\usepackage[a4paper]{geometry}
+\usepackage{longtable}
+\usepackage{float} % provides the H option for float placement
+\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
+\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}}
+% Determine if the image is too wide for the page.
+%
+{%
+ \catcode`\@=11\relax%
+ \gdef\includegraphics{\@ifnextchar[{\Oldincludegraphics}{\Oldincludegraphics[width=\maxwidth]}}%
+}%
+%
+
+\ifxetex
+  \usepackage[setpagesize=false, % page size defined by xetex
+              unicode=false, % unicode breaks when used with xetex
+              bookmarksdepth=3, %
+              xetex]{hyperref}
+\else
+  \usepackage[unicode=true]{hyperref}
+\fi
+\hypersetup{breaklinks=true,
+            bookmarks=true,
+            pdfauthor={Bernhard Weichel; and others},
+            pdftitle={Wortsammler sample document},
+            colorlinks=true,
+            urlcolor=blue,
+            linkcolor=magenta,
+            pdfborder={0 0 0}}
+\urlstyle{same}  % don't use monospace font for urls
+\setlength{\parindent}{0pt}
+\setlength{\parskip}{6pt plus 2pt minus 1pt}
+\setlength{\emergencystretch}{3em}  % prevent overfull lines
+\setcounter{secnumdepth}{5}
+\ifxetex
+  \usepackage{polyglossia}
+  \setmainlanguage{german}
+\else
+  \usepackage[german]{babel}
+\fi
+
+\title{Main requirements (review)}
+\author{Bernhard Weichel \and and others}
+\date{2013/05}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% Wortsammler specific settings
+%
+%list environment by reinhard Jahraus
+{\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}{-1pt}% 5.0pt
+       \addtolength{\topsep}{-5pt}% 10.0pt
+       \addtolength{\partopsep}{0pt}% 3.0pt
+      }%
+  \fi}
+}%
+
+%
+% improve nesting of lists
+% %http://stackoverflow.com/questions/1935952/maximum-nesting-level-of-lists-in-latex
+%
+\usepackage{enumitem}
+\setlistdepth{9}
+\setlist[itemize,1]{label=$\bullet$}
+\setlist[itemize,2]{label=$\bullet$}
+\setlist[itemize,3]{label=$\bullet$}
+\setlist[itemize,4]{label=$\bullet$}
+\setlist[itemize,5]{label=$\bullet$}
+\setlist[itemize,6]{label=$\bullet$}
+\setlist[itemize,7]{label=$\bullet$}
+\setlist[itemize,8]{label=$\bullet$}
+\setlist[itemize,9]{label=$\bullet$}
+\renewlist{itemize}{itemize}{9}
+%
+% multicol
+%
+\usepackage{multicol}
+\newcommand{\wsbegintwocol}{}
+\newcommand{\wsendtwocol}{}
+
+%
+% embed an image in the text
+%
+% usage: \wsembedimage{file}{r|l}{width}{height}
+\usepackage{wrapfig}
+\usepackage{needspace}
+\newcommand{\wsembedimage}[4]{\needspace{#4}\begin{wrapfigure}{#2}{#3}\centering%
+\vspace{-5mm}\includegraphics{#1}\vspace{-1cm}\end{wrapfigure}}
+%
+% adjust page layout
+%
+\setlength{\oddsidemargin}{-0.5cm}
+\setlength{\evensidemargin}{-0.5cm}
+\setlength{\textwidth}{17cm}
+\setlength{\topmargin}{-2.0cm}
+\setlength{\headheight}{1cm}
+\setlength{\headsep}{1.5cm}
+\setlength{\textheight}{25cm}
+\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{pdfpages}
+\usepackage{bookmark}
+\usepackage{fancyhdr}
+\pagestyle{fancy}
+\chead{\begin{center}\textbf{Main requirements (review)} \end{center}}
+\lhead{\includegraphics{../ZSUPP_Styles/logo.jpg}}
+\rhead{\leftmark}
+\lfoot{Bernhard Weichel}
+\rfoot{\today~2013/05}
+\renewcommand{\footrulewidth}{0.4pt}
+%
+\renewcommand{\familydefault}{\sfdefault}
+%
+% Marginpars shall always be right
+\makeatletter
+   \def\marginparright{\@mparswitchfalse}
+   \def\marginparoutside{\@mparswitchtrue}
+\makeatother
+\marginparright
+%
+%
+\raggedbottom
+%
+
+\usepackage[pagewise]{lineno}
+\setlength\linenumbersep{1mm}
+\modulolinenumbers[5]
+
+\usepackage{makeidx}
+\makeindex
+
+%
+%\renewcommand{Befehl der Gliederungsebene z.B. \chapter}{\@startsection{Name z.B. chapter}{Ebene z.B. 0}{Einrückung z.B. 0pt}{Abstand zum vorigen Text z.B. 3.5ex plus 1ex minus 0pt\relax}{Abstand zum nachfolgenden Text z.B. 2.5ex plus 0.5ex minus 0pt\relax}{Schrift z.B. \normalfont\Large\bfseries}}
+%
+% \makeatletter%
+% \renewcommand{\chapter}{\@startsection{chapter}{0}{0pt}{3.5ex plus 1ex minus 0pt\relax}{2.5ex plus 0.5ex minus 0pt\relax}{\normalfont\Large\bfseries}}%
+% \makeatother%
+%
+%
+% Wortsammler extensions end here
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\begin{document}
+\maketitle
+
+\clearpage
+
+{
+\hypersetup{linkcolor=black}
+\setcounter{tocdepth}{1}
+\tableofcontents
+\newpage
+}
+\linenumbers
+
+\section{Introduction}\label{introduction}
+
+This is a sample document for Wortsammler
+
+\section{Anforderung an
+Dokumentenaufbereiter}\label{anforderung-an-dokumentenaufbereiter}
+
+\begin{itemize}
+\item
+  {[}RS\_Comp\_003{]} \textbf{\hypertarget{RS-Comp-003}{}Steuerung
+  Dokumentenzusammenstellung} \{Dokumentenzusammenstellungen soll über
+  ein manifest {[}\hyperlink{RS-Comp-007}{RS\_Comp\_007}{]} gesteuert
+  werden.
+
+  \begin{itemize}
+  \itemsep1pt\parskip0pt\parsep0pt
+  \item
+    Die Manifeste sollen als Laufzeitparameter übergeben werden
+  \item
+    Das Manifest enthält auch die Ausgabedatei
+  \end{itemize}
+
+  \}(\hyperlink{RS-DM-014}{RS\_DM\_014},
+  \hyperlink{RS-DM-010}{RS\_DM\_010},
+  \hyperlink{RS-DM-005}{RS\_DM\_005})
+\item
+  {[}RS\_Comp\_004{]} \textbf{\hypertarget{RS-Comp-004}{}Prozessierung
+  Einzeldokument} \{Soll Dokumente verschiedenen Umfangs erzeugen
+  können:
+
+  \begin{itemize}
+  \itemsep1pt\parskip0pt\parsep0pt
+  \item
+    einzelnes Files
+  \item
+    zu Prüfzwecken
+  \end{itemize}
+
+  Steuerung soll über Konfiguration (Manifest) erfolgen
+  {[}\hyperlink{RS-Comp-007}{RS\_Comp\_007}{]}.
+
+  \}()
+\item
+  {[}RS\_Comp\_005{]} \textbf{\hypertarget{RS-Comp-005}{}Erstellung
+  Loseblattsammlung} \{Soll Dokumente verschiedenen Umfangs erzeugen
+  können:
+
+  \begin{itemize}
+  \itemsep1pt\parskip0pt\parsep0pt
+  \item
+    kann aus dem Manifest errechnet werden
+    {[}\hyperlink{RS-Comp-007}{RS\_Comp\_007}{]}
+  \end{itemize}
+
+  \}()
+\item
+  {[}RS\_Comp\_006{]} \textbf{\hypertarget{RS-Comp-006}{}Inkrementelle
+  Verarbeitung} \{Soll nur auf geänderte Dokumente reagieren können:
+
+  \begin{itemize}
+  \itemsep1pt\parskip0pt\parsep0pt
+  \item
+    ähnlich wie make/rake
+  \end{itemize}
+
+  \}()
+\item
+  {[}RS\_Comp\_007{]} \textbf{\hypertarget{RS-Comp-007}{}Anforderungen
+  an Manifest} \{Folgende Anforderungen gelten für das Manifest
+
+  \begin{itemize}
+  \itemsep1pt\parskip0pt\parsep0pt
+  \item
+    einfach bearbeiten - nur liste der Files
+  \item
+    Markdown-lite
+  \item
+    Yaml
+  \end{itemize}
+
+  Inhalte im Manifest sind
+
+  \begin{itemize}
+  \itemsep1pt\parskip0pt\parsep0pt
+  \item
+    Name der Konfiguration
+  \item
+    Ausgabeverzeichnis
+  \item
+    Ausgabeformat
+  \item
+    Name des generierten Dokumentes
+  \item
+    Formate in denen das Dokument generiert wird. Werte hierfür ergeben
+    sich aus den Anforderungen an die Aufbereitet
+  \item
+    zu verarbeitende Eingabedateien. Diese werden in der Reihenfolge
+    verarbeitet wie sie aufgeführt sind.
+  \item
+    Optionen für die jeweiligen Formate.
+  \item
+    zu bearbeitende Zielgruppen
+    {[}\hyperlink{RS-Comp-008}{RS\_Comp\_008}{]}
+  \end{itemize}
+
+  Beispiel für ein manifest
+
+\begin{verbatim}
+ -
+   :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
+\end{verbatim}
+
+  \}(\hyperlink{RS-Comp-003}{RS\_Comp\_003})
+\end{itemize}
+
+\subsection{Zielgruppenspezifische
+Ausgaben}\label{zielgruppenspezifische-ausgaben}
+
+Dieser Abschnitt behandelt speziell die Anforderungen an flexible
+Dokumentenausgabe
+
+\begin{itemize}
+\item
+  {[}RS\_Comp\_001{]} \textbf{\hypertarget{RS-Comp-001}{}Flexibler
+  Dokumentumfang} \{Soll Dokumente verschiedenen Umfangs erzeugen
+  können:
+
+  \begin{itemize}
+  \itemsep1pt\parskip0pt\parsep0pt
+  \item
+    einzelnes Files
+  \item
+    Zusammengestelltes Dokument
+  \end{itemize}
+
+  \}(\hyperlink{RS-Comp-003}{RS\_Comp\_003})
+\item
+  {[}RS\_Comp\_002{]} \textbf{\hypertarget{RS-Comp-002}{}Flexible
+  Dokumentendarstellung} \{Sollte Dokumente in verschiedener Darstellung
+  erzeugen können:
+
+  \begin{itemize}
+  \itemsep1pt\parskip0pt\parsep0pt
+  \item
+    Seitenlayout
+  \item
+    Detaillierungsgrad (z.B. RequirementsMarken ausblenden) \}
+    (RS\_Comp\_003)
+  \end{itemize}
+\item
+  {[}RS\_Comp\_008{]}
+  \textbf{\hypertarget{RS-Comp-008}{}Zielgruppenspezifische Ausgaben
+  (Editionen)} \{ Es soll möglich sein Zielgruppenspezifische Ausgaben
+  zu erstellen.
+
+  \begin{itemize}
+  \item
+    Dabei wird die Zielgruppe durch eine spezifische Zeichenkette
+    umgeschaltet (Durchstreichung), die auch in standard Markdown
+    Programmen eine sinnvolle Ausgabe liefert:
+
+    \texttt{\textbackslash{}color\{red\}\textbackslash{}rule\{2cm\}\{0.5mm\}\textbackslash{}newline\textbackslash{}marginpar\{intern\ extern\}}
+    ab hier gilt: Text erscheint in Ausgabe \texttt{intern} als auch in
+    \texttt{extern}
+
+    Es handelt sich also um ein durchgestrichenes Muster als regulärer
+    Ausdruck
+
+\begin{verbatim}
+~~ED((\s* \S+)*)~~
+\end{verbatim}
+  \item
+    Die Umschaltung wirkt ab einschliesslich der Zeile, die die
+    Umschaltung enthält, bis zum Aufruf einer neuen Umschaltung.
+  \item
+    Die möglichen Zielgruppen werden im Manifest festgelegt
+    {[}\hyperlink{RS-Comp-007}{RS\_Comp\_007}{]} daselbst Eintrag
+    \texttt{:editions:}
+  \item
+    Eine vorgegebene Zielgruppe \texttt{all} erzeugt keine spezifische
+    Ausgabe. Sie kennzeichnet vielmehr Inhalte, die in \textbf{allen}
+    Ausgaben gleichermassen enthalten sind.
+  \item
+    Bei einer Aufteilung auf mehrere Dateien wird empfohlen am Ende
+    einer jeden Datei auf \texttt{all} zu schalten. Dadurch wird das
+    System einfache wartbar.
+  \end{itemize}
+
+  \}(\hyperlink{RS-Comp-003}{RS\_Comp\_003})
+
+  Alternativen für die Umschaltung sind:
+
+  \marginpar{intern}
+
+  \begin{itemize}
+  \item
+    \color{red}\rule{2cm}{0.5mm}\newline\marginpar{intern extern} und so
+    geht es weiter
+  \item
+    \textsuperscript{ZG~intern~extern} und nun kommt der text der nur
+    extern ist
+  \end{itemize}
+
+  \marginpar{extern}
+
+  \begin{itemize}
+  \item
+    \textsubscript{ZG~intern~extern} und hier ist der text der nur
+    intern ist
+  \item
+    und nun geht es weiter
+  \end{itemize}
+
+  \marginpar{intern}
+
+  \begin{itemize}
+  \itemsep1pt\parskip0pt\parsep0pt
+  \item
+    und nun geht es intern weiter Gelaber und weiter
+  \end{itemize}
+\item
+  {[}RS\_Comp\_009{]} \textbf{\hypertarget{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.
+  \}(\hyperlink{RS-Comp-003}{RS\_Comp\_003})
+\item
+  {[}RS\_Comp\_010{]} \textbf{\hypertarget{RS-Comp-010}{}Erstellung
+  aller Ausgaben mit einem Befehl} \{Es sollen immer alle Ausgaben
+  gleichermassen generiert werden. Dabei gilt:
+
+  \begin{itemize}
+  \item
+    Der Dateiname für die generierten Dokumente bildet sich nach
+
+    \texttt{\{:outname:\}\_\{:edition:.:filepart:\}.\{format\}}
+  \item
+    In der Kopfzeile des Dokumentes wird \texttt{:edition:.:title:}
+    eingefügt, so dass die Ausgabe auf jeder Seite identifiziert werden
+    kann.
+  \end{itemize}
+
+  Ohne Angabe einer Zielgruppe bzw. mit der Angabe \texttt{all} soll
+  wortsammler alle Ausgaben erstellen.
+
+  Die Angabe einer einzelnen Zielgruppe erstellt dann auch nur die
+  gewählte Ausgabe.
+
+  \}(\hyperlink{RS-Comp-003}{RS\_Comp\_003})
+\end{itemize}
+
+\subsection{Processing TODO - open
+issues}\label{processing-todo---open-issues}
+
+Paragraphs like starting with
+
+\begin{verbatim}
+TODO:\marginpar{TODO} #13 do something are used to manage the open issues   
+\end{verbatim}
+
+\subsection{Processing the traceables}\label{processing-the-traceables}
+
+\subsection{Including Files}\label{including-files}
+
+\begin{itemize}
+\item
+  {[}RS\_Comp\_011{]} \textbf{\hypertarget{RS-Comp-011}{}including Plain
+  pdf-Pages}\{ PDF pages can be included by
+
+  \texttt{\textasciitilde{}\textasciitilde{}PDF\ "lib/01234\_particularPdf.pdf"\ "Das\ ist\ der\ Eintrag\ im\ Inhaltsverzeichnis"\ 1\ 2-4\textasciitilde{}\textasciitilde{}}
+
+  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.
+
+  \}(\hyperlink{RS-Comp-003}{RS\_Comp\_003})
+\item
+  {[}RS\_Comp\_014{]} \textbf{\hypertarget{RS-Comp-014}{}Including
+  markdown files} \{
+
+  ``
+
+  will be replaced by the content of the argument. It should even work
+  inline.
+
+  \}(\hyperlink{RS-Comp-003}{RS\_Comp\_003})
+\end{itemize}
+
+\subsection{Handling Text Snippets}\label{handling-text-snippets}
+
+\begin{itemize}
+\item
+  {[}RS\_Comp\_012{]} \textbf{\hypertarget{RS-Comp-012}{}Including text
+  Snippets}\{ Text Snippts can be included by
+
+\begin{verbatim}
+`~~SN {symbol}~~`
+\end{verbatim}
+
+  The snippets are taken from one of the snippet databases declared in
+  the manifest {[}\hyperlink{RS-Comp-007}{RS\_Comp\_007}{]} according to
+  the format in {[}\hyperlink{RS-Comp-013}{RS\_Comp\_013}{]}. \}()
+\item
+  {[}RS\_Conp\_013{]} \textbf{\hypertarget{RS-Conp-013}{}Defining text
+  Snippets} \{
+
+  Text snippets are defined as a yaml file in the following format:
+
+\begin{verbatim}
+: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
+\end{verbatim}
+
+  \}(\hyperlink{RS-Comp-003}{RS\_Comp\_003})
+\end{itemize}
+
+\subsubsection{this should not show up in
+toc}\label{this-should-not-show-up-in-toc}
+
+This chapter should not show up in the toc
+
+\end{document}