summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/tikz-trackschematic/tikz-trackschematic.tex
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/tikz-trackschematic/tikz-trackschematic.tex')
-rw-r--r--graphics/pgf/contrib/tikz-trackschematic/tikz-trackschematic.tex130
1 files changed, 50 insertions, 80 deletions
diff --git a/graphics/pgf/contrib/tikz-trackschematic/tikz-trackschematic.tex b/graphics/pgf/contrib/tikz-trackschematic/tikz-trackschematic.tex
index 9c85bc7c3f..dfea410fc8 100644
--- a/graphics/pgf/contrib/tikz-trackschematic/tikz-trackschematic.tex
+++ b/graphics/pgf/contrib/tikz-trackschematic/tikz-trackschematic.tex
@@ -4,15 +4,7 @@
% Permission to use, copy, modify, and/or distribute this file for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
-\documentclass[
- paper=a4,
- % version=3.25,
- pagesize=pdftex,
- twoside=false,
- toc=listof,
- BCOR=0pt,
- DIV=15,
-]{scrartcl}
+\documentclass{scrartcl}
\usepackage{tikz-trackschematic-documentation}
@@ -21,7 +13,7 @@
%\newcommand{\initials}{fullname}
\newcommand{\MS}{Martin Scheidt}
\newcommand{\GW}{Gregor Wehrle}
-\newcommand{\authorlist}{\MS, \GW}
+\newcommand{\authorlist}{by the project contributors}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -35,7 +27,7 @@
\begin{document}
-\title{\tikz\node[scale=1.2]{\color{gray}\Huge\sffamily \{\textcolor{black}{Ti\textcolor{orange}{\emph{k}}Z}-\textcolor{blue}{trackschematic}\}};}
+\title{\color{gray}\Huge\sffamily \{\textcolor{black}{Ti\textcolor{orange}{\emph{k}}Z}-\textcolor{blue}{trackschematic}\}}
\subtitle{A Ti\emph{k}Z library for track schematics}
\author{\authorlist}
\date{Version \vhCurrentVersion~ from \vhCurrentDate}
@@ -49,19 +41,20 @@
\section{Introduction}\label{sec:intro}
- \subsection[About]{About tikz-trackschematic}
+ \subsection{About tikz-trackschematic}
The Ti\emph{k}Z-\emph{trackschematic} library is a toolbox of symbols geared primarily towards creating track schematic for either research or educational purposes.
It provides a Ti\emph{k}Z frontend to some of the symbols which maybe needed to describe situations and layouts in railway operation.
- The library is divided into four sublibraries:
- \begin{itemize*}[label={}]
+ The library is divided into the following sublibraries:
+ \begin{itemize}
\item \texttt{topology},
\item \texttt{trafficcontrol},
\item \texttt{vehicles},
\item \texttt{constructions},
+ \item \texttt{symbology},
\item \texttt{electrics}, and
\item \texttt{measures}.
- \end{itemize*}
+ \end{itemize}
\subsection{Acknowledgement}
@@ -72,19 +65,19 @@
\subsection{Requirements}\label{sec:require}
The library uses Ti\emph{k}Z and it is based the following packages:
- \begin{itemize*}[label={}]
+ \begin{itemize}
\item \texttt{tikz},
- \item \texttt{lmodern},
\item \texttt{xcolor}, and
\item \texttt{etoolbox}.
- \end{itemize*}
+ \end{itemize}
+
Further more it uses the following Ti\emph{k}Z libraries:
- \begin{itemize*}[label={}]
+ \begin{itemize}
\item \texttt{calc},
\item \texttt{intersections},
\item \texttt{patterns}, and
\item \texttt{arrows.meta}.
- \end{itemize*}
+ \end{itemize}
\subsection{License}
@@ -94,7 +87,7 @@
\subsection{Alternatives}
- Apart from this library, there is also a \href{https://tu-dresden.de/bu/verkehr/ibv/vst/die-professur/mitarb/ulrich-maschek/signalschablone} with german (Deutsche Bahn) symbols for MS Visio.
+ Apart from this library, there is also the \href{https://tu-dresden.de/bu/verkehr/ibv/vst/die-professur/mitarb/ulrich-maschek/signalschablone}{Signalschablone} with german (Deutsche Bahn) symbols for MS Visio.
% \newpage
@@ -105,24 +98,7 @@
Here is a complete working minimal example which will produce a single PDF file with the figure on the right:\\
\begin{minipage}[c]{0.51\textwidth}
\centering
- \begin{lstlisting}[gobble=8]
- \documentclass{standalone}
-
- % loading the library
- \usepackage{tikz-trackschematic}
-
- \begin{document}
- \begin{tikzpicture}
-
- % draw a track
- \maintrack (0,0) -- (6,0);
-
- % place a train on the track
- \train[forward] at (5,0) label ();
-
- \end{tikzpicture}
- \end{document}
- \end{lstlisting}
+ \lstinputlisting{examples/minimal_working_example.tex}
\end{minipage}
\hfil
\begin{minipage}[c]{0.45\textwidth}
@@ -167,7 +143,7 @@
\begin{minipage}[c]{0.68\textwidth}
\begin{lstlisting}[gobble=6]
- \train[face=forward ] at (coordinate) label ();
+ \train[face=forward] at (coordinate) label ();
\end{lstlisting}
\end{minipage}
@@ -207,7 +183,7 @@
\begin{minipage}[c]{0.68\textwidth}
\begin{lstlisting}[gobble=6]
- \turnout[forward ,branch=right] at (coordinate) label ();
+ \turnout[forward,branch=right] at (coordinate) label ();
\end{lstlisting}
\end{minipage}
@@ -218,7 +194,7 @@
\begin{minipage}[c]{0.68\textwidth}
\begin{lstlisting}[gobble=6]
- \turnout[backward,branch=left ] at (coordinate) label ();
+ \turnout[backward,branch=left] at (coordinate) label ();
\end{lstlisting}
\end{minipage}
@@ -245,6 +221,7 @@
The default traffic practice for this library ist right-hand traffic.
You can change it either globally or locally with the key \texttt{traffic practice=left}.
There is also the alias \texttt{position} for single local entries.
+
\begin{minipage}[c]{0.65\textwidth}
\begin{lstlisting}[gobble=8]
\documentclass{standalone}
@@ -550,7 +527,7 @@
values for \texttt{options} (comma seperated):
\begin{itemize}[label={}]
\item \texttt{length=\textit{length unit}} (optional, default 4cm)
- \item \texttt{label at=\{\textit{(label-coord)}\}} (optional, default: \textit{center})
+ \item \texttt{shift label=\{\textit{(label-coord)}\}} (optional, default: (0,0))
\item \texttt{label align=left} or \texttt{label align=right} (optional, default: center)
\item \texttt{foreground=\textit{color}} (optional, default: \texttt{black})
\item \texttt{background=\textit{color}} (optional, default: \texttt{white})
@@ -578,7 +555,7 @@
\item \texttt{operation=manual} or \texttt{operation=automatic} (optional) % \texttt{operation=undefined} (default)
\item \texttt{bend left at=\{\textit{(bend-coord)}\}} (optional, default: \textit{none})
\item \texttt{bend right at=\{\textit{(bend-coord)}\}} (optional, default: \textit{none})
- \item \texttt{label at=\{\textit{(label-coord)}\}} (optional, default: \textit{center})
+ \item \texttt{shift label=\{\textit{(label-coord)}\}} (optional, default: (0,0))
\item \texttt{label align=left} or \texttt{label align=right} (optional, default: center)
\item \texttt{foreground=\textit{color}} (optional, default: \texttt{black})
\item \texttt{background=\textit{color}} (optional, default: \texttt{white})
@@ -1049,46 +1026,40 @@
\subsubsection{Transmitters}\label{sec:transmitters}
- \symboldescription{Generic transmitter command}\label{sym:generictransmitter}
- \begin{lstlisting}[gobble=10]
- \transmitter[options] at (coord) label (name);
- \end{lstlisting}
- values for \texttt{options} (comma seperated):
- \begin{itemize}[label={}]
- \item \texttt{type=balise} or \texttt{type=loop} (mandatory)
- \item \texttt{forward}, \texttt{backward} or \texttt{bidirectional} (optional)
- \item \texttt{position=left} or \texttt{position=right} (optional, default: \textit{traffic practice})
- \item \texttt{shift label=\{\textit{(label-coord)}\}} (optional, default: (0,0))
- \item \texttt{foreground=\textit{color}} (optional, default: \texttt{black})
- \end{itemize}
-
-
\symboldescription{Balise}\label{sym:balise}
- \tsSymbol{transmitter_forward}
+ \tsSymbol{balise_group}
+ \tsSymbol{balise_individual}
\begin{lstlisting}[gobble=10]
\balise[options] at (coord) label (name);
\end{lstlisting}
values for \texttt{options} (comma seperated):
\begin{itemize}[label={}]
- \item \texttt{forward}, \texttt{backward} or \texttt{bidirectional} (optional)
+ \item \texttt{forward}, or \texttt{backward} (mandatory)
\item \texttt{position=left} or \texttt{position=right} (optional, default: \textit{traffic practice})
+ \item \texttt{switched} (optional)
\item \texttt{shift label=\{\textit{(label-coord)}\}} (optional, default: (0,0))
\item \texttt{foreground=\textit{color}} (optional, default: \texttt{black})
\end{itemize}
- This command is equivalent to:
- \begin{lstlisting}[gobble=10]
- \transmitter[type=balise,options] at (coord) label (name);
- \end{lstlisting}
+ The basic state is one in which the individual balises are not shown. The direction of the balises is the same as the direction of action. The direction of the balises is indicated by the orientation of the label. The \texttt{switched} option changes the symbol over the entire length.
+ \begin{itemize}[label={}]
+ \item \texttt{along=\{\textit{comma separated list of integers}\}} (optional)
+ \item \texttt{oppose=\{\textit{comma separated list of integers}\}} (optional)
+ \item \texttt{along switched=\{\textit{comma separated list of integers}\}} (optional)
+ \item \texttt{oppose switched=\{\textit{comma separated list of integers}\}} (optional)
+ \item \texttt{index} (optional)
+ \end{itemize}
+ If individual balises are to be shown, they are indicated via the \texttt{along} or \texttt{along switched} with the direction of the balise and with \texttt{oppose} or \texttt{oppose switched} against the balise. A list with integer values is passed to the parameter. The list starts with 0. For example, three individual balises are drawn with the list \{0,1,3\} and the balise at position 2 is left out. With the option \texttt{index}, the index number can also be displayed. If one of the options \texttt{along}, \texttt{along switched}, \texttt{oppose}, or \texttt{oppose switched} is set, the \texttt{switched} option is ignored.
\mbox{}\\[0.2cm]
Symbology entry as seen at top:
\begin{lstlisting}[gobble=10]
- \tsSymbol{transmitter_forward}% TeX environment
+ \tsSymbol{balise_group}% TeX environment
+ \tsSymbol{balise_individual}% TeX environment
\end{lstlisting}
\symboldescription{Loop}\label{sym:loop}
- \tsSymbol{loop_transmitter}
+ \tsSymbol{trackloop}
\begin{lstlisting}[gobble=10]
\trackloop[options] at (coord) label (name);
\end{lstlisting}
@@ -1098,15 +1069,11 @@
\item \texttt{shift label=\{\textit{(label-coord)}\}} (optional, default: (0,0))
\item \texttt{foreground=\textit{color}} (optional, default: \texttt{black})
\end{itemize}
- This command is equivalent to:
- \begin{lstlisting}[gobble=10]
- \transmitter[type=loop,options] at (coord) label (name);
- \end{lstlisting}
\mbox{}\\[0.2cm]
Symbology entry as seen at top:
\begin{lstlisting}[gobble=10]
- \tsSymbol{loop_transmitter}% TeX environment
+ \tsSymbol{trackloop}% TeX environment
\end{lstlisting}
@@ -1402,7 +1369,7 @@
\end{lstlisting}
- \subsection{Messures}\label{sec:measures}
+ \subsection{Measures}\label{sec:measures}
\symboldescription{Track distance}\label{sym:trackdistance}
\tsSymbol[2.0]{track_distance}
@@ -1446,8 +1413,13 @@
\end{lstlisting}
No \texttt{options} available.\\
This command is equivalent to:
- \begin{lstlisting}[gobble=10]
- \path[draw=foreground!50!background,dashed,shorten <=0.75cm,shorten >=0.75cm] (coord1) -- (coord2);
+ \begin{lstlisting}[gobble=8]
+ \path[
+ draw=foreground!50!background,
+ dashed,
+ shorten <=0.75cm,
+ shorten >=0.75cm
+ ] (coord1) -- (coord2);
\end{lstlisting}
\mbox{}\\[0.2cm]
@@ -1483,7 +1455,7 @@
\symboldescription{Track Marking}\label{sym:trackmarking}
\tsSymbol{track_marking}
- \begin{lstlisting}[gobble=10]
+ \begin{lstlisting}[gobble=8]
\trackmarking[color] (coord1) -- (coord2);
\end{lstlisting}
\begin{itemize}[label={}]
@@ -1614,13 +1586,11 @@
\hline
\No & direction control & \tsSymbol{direction_control} & \ref{sec:routes} \\
\hline
- \No & transmitter & \tsSymbol{transmitter} & \ref{sec:transmitters} \\
- \hline
- \No & transmitter effective forward & \tsSymbol{transmitter_forward} & \ref{sec:transmitters} \\
+ \No & balise group & \tsSymbol{balise_group} & \ref{sec:transmitters} \\
\hline
- \No & transmitter bidirectional & \tsSymbol{transmitter_bidirectional} & \ref{sec:transmitters} \\
+ \No & balise individual & \tsSymbol{balise_individual} & \ref{sec:transmitters} \\
\hline
- \No & loop transmitter & \tsSymbol{loop_transmitter} & \ref{sec:transmitters} \\
+ \No & track loop & \tsSymbol{trackloop} & \ref{sec:transmitters} \\
\hline
\No & platform & \tsSymbol[1.4]{platform} & \ref{sec:constructions} \\
\hline