diff options
author | Y. Wang <yw05@forksworld.de> | 2021-11-25 19:59:49 +0100 |
---|---|---|
committer | Y. Wang <yw05@forksworld.de> | 2021-11-25 19:59:49 +0100 |
commit | f4a1c40e0c698b95dd02f1553587dd630192cc74 (patch) | |
tree | f3ba96d6e9a92576a91bf584214bf43e8edadfd0 /assets | |
parent | 21075bcf97b2838dc623d36ea25c1ef47d2f5fa3 (diff) | |
download | advtrains-f4a1c40e0c698b95dd02f1553587dd630192cc74.tar.gz advtrains-f4a1c40e0c698b95dd02f1553587dd630192cc74.tar.bz2 advtrains-f4a1c40e0c698b95dd02f1553587dd630192cc74.zip |
Replace description environment with apidoc
Diffstat (limited to 'assets')
-rw-r--r-- | assets/manual2/manual.tex | 47 |
1 files changed, 25 insertions, 22 deletions
diff --git a/assets/manual2/manual.tex b/assets/manual2/manual.tex index 878e817..c6f5bba 100644 --- a/assets/manual2/manual.tex +++ b/assets/manual2/manual.tex @@ -63,6 +63,9 @@ \newcommand{\apifunc}[1]{\api{##1}{function}} \newcommand{\apilex}[1]{\api{##1}{lexical syntax}} \newcommand{\apipat}[1]{\api{##1}{pattern}} +\newcommand{\apiterm}[1]{\apient{##1}{term}} +\newcommand{\apitrainmode}[1]{\apient{##1}{train mode}} +\newcommand{\apiui}[1]{\apient{##1}{UI element}} }{\end{list}} \tikzset{ @@ -302,22 +305,22 @@ The ``lever'' field in the table above is described as follows: \subsection{Train formspec}\label{s:trainformspec} If you have access to the driver stand of the wagon, right-clicking the train will open up a formspec will a few buttons, depending on the status of the train: -\begin{description} -\item[Passenger area] Move to the passenger area. -\item[Driver stand] Move to the driver stand. -\item[Onboard computer] Open the onboard computer. -\item[Wagon properties] Allow setting wagon properties. -\item[Get off] Get off the train. -\item[(Doors closed)] Get off the train by right-clicking the train while holding the Sneak key. -\end{description} +\begin{apidoc} +\item \apiui{Passenger area} Move to the passenger area. +\item \apiui{Driver stand} Move to the driver stand. +\item \apiui{Onboard computer} Open the onboard computer. +\item \apiui{Wagon properties} Allow setting wagon properties. +\item \apiui{Get off} Get off the train. +\item \apiui{(Doors closed)} Get off the train by right-clicking the train while holding the Sneak key. +\end{apidoc} \subsection{Onboard computer}\label{s:bordcom} The onboard computer allow setting certain properties of the train. Feel free to explore it yourself. A few fields are explained here in detail: -\begin{description} -\item[Line number] The line name of the train. Despite the label, you can set this to anything. This field is mainly used for interlocking. -\item[Routing code] The routing code of the train, separated by space characters. This field is mainly used for interlocking. -\item[Train overview] This section is only shown when the train is not moving. It allows you to couple and decouple wagons from the train. -\end{description} +\begin{apidoc} +\item \apiui{Line number} The line name of the train. Despite the label, you can set this to anything. This field is mainly used for interlocking. +\item \apiui{Routing code} The routing code of the train, separated by space characters. This field is mainly used for interlocking. +\item \apiui{Train overview} This section is only shown when the train is not moving. It allows you to couple and decouple wagons from the train. +\end{apidoc} \subsection{HUD}\label{s:trainhud} @@ -492,10 +495,10 @@ LZB speed targets are temporary and associated to a specific point - it only mak \subsection{Minor modes}\label{s:trainminormodes} The modes described here do not override any of the modes described above, but rather coexist with these. -\begin{description} -\item[ARS] If enabled, signals using ARS will select the appropriate route for the train. If ARS is disabled for the train, signals using ARS will not select any route for the train. This mode is enabled by default. -\item[Autocouple mode] If enabled, the train will automatically couple with any train it collides with. This mode is disabled by default. -\end{description} +\begin{apidoc} +\item \apitrainmode{ARS} If enabled, signals using ARS will select the appropriate route for the train. If ARS is disabled for the train, signals using ARS will not select any route for the train. This mode is enabled by default. +\item \apitrainmode{Autocouple mode} If enabled, the train will automatically couple with any train it collides with. This mode is disabled by default. +\end{apidoc} % TODO: Add documentation on shunt mode \section{Interlocking and line automation}\label{s:interlocking} @@ -799,11 +802,11 @@ There are a few types of speed restrictions that a signal can give. These speed The following types of speed restrictions are used by signals in \advtrains{}: -\begin{description} -\item[Permanent (``main'') speed restriction (\texttt{main})] The default type of speed restriction. This one is most commonly given by signal lights. -\item[Temporary speed restriction (\texttt{temp})] Speed restrictions that are temporarily set up, such as near construction sites. -\item[Line speed restriction (\texttt{line})] Speed restriction that applies to the entire rail line. -\end{description} +\begin{apidoc} +\item \apiterm{Permanent (``main'') speed restriction (\texttt{main})} The default type of speed restriction. This one is most commonly given by signal lights. +\item \apiterm{Temporary speed restriction (\texttt{temp})} Speed restrictions that are temporarily set up, such as near construction sites. +\item \apiterm{Line speed restriction (\texttt{line})} Speed restriction that applies to the entire rail line. +\end{apidoc} The following is an example of a train running with speed restrictions. You may want to read the section on German signal signs first. \begin{itemize} |