martin
/
tikz-trackschematic
1
0
Fork 0
Code Issues Pull Requests Releases Activity
187 Commits
1 Branch
12 Tags
9.6 MiB
TeX 87.7%
Shell 12.3%
 
 
Go to file
Martin Scheidt f46d7a7770 Fixed label test 2022-03-22 18:39:57 +01:00
.github added automatic documentation compilation before release 2022-03-22 18:33:21 +01:00
doc integrated documentation compilation in build.sh script 2022-03-22 18:27:29 +01:00
src Fixed label coordinate calculation for vehicles in manual or automatic mode 2022-03-22 18:20:08 +01:00
test Fixed label test 2022-03-22 18:39:57 +01:00
.gitignore added cleanup routine and modified other routines, respectively 2022-03-09 13:09:03 +01:00
CHANGELOG.md revised symbol and syntax for balises 2022-03-22 17:07:19 +01:00
CITATION.cff tidying up the citation 2022-02-23 15:43:57 +01:00
CODE_OF_CONDUCT.md remove package requirement lmodern, minor corrections, added citing information 2021-09-30 12:37:31 +02:00
CONTRIBUTING.md moved history from README.md to CHANGELOG.md for automated release note 2022-02-15 16:17:24 +01:00
LICENSE updated copyright 2022-01-06 20:17:51 +01:00
README.md updated symbology table URL 2022-02-25 22:46:56 +01:00
build.sh integrated documentation compilation in build.sh script 2022-03-22 18:27:29 +01:00

README.md

TikZ-trackschematic

Installation

The tikz library is contained in the files:

  • tikz-trackschematic.sty
  • tikzlibrarytrackschematic.code.tex,
  • tikzlibrarytrackschematic.topology.code.tex,
  • tikzlibrarytrackschematic.trafficcontrol.code.tex,
  • tikzlibrarytrackschematic.vehicles.code.tex,
  • tikzlibrarytrackschematic.constructions.code.tex,
  • tikzlibrarytrackschematic.symbology.code.tex,
  • tikzlibrarytrackschematic.electrics.code.tex, and
  • tikzlibrarytrackschematic.measures.code.tex.

These files should be copied wherever TeX can find it, for example in your $TEXMF folder.

Alternatively, the tikz library is provided by CTAN as "tikz-trackschematic" and is thus part of the TeX Live distribution or can be installed via MiKTeX.

The library can then be loaded through the command

\usepackage{tikz-trackschematic}

in any LaTeX file.

The library can also be used in Overleaf.

Minimal working example

\documentclass{standalone} % LaTeX
\usepackage{tikz-trackschematic} % loading the library

\begin{document}
  \begin{tikzpicture}

    % TikZ command: specify coordinates
    \coordinate (A)   at (0,0);
    \coordinate (B)   at (6,0);
    \coordinate (T)   at (5,0);

    % draw a track
    \maintrack (A) -- (B);

    % place a train on the track
    \train[forward] at (T) label ();

  \end{tikzpicture}
\end{document}

results in:

train on a track

Symbology and meaning

Please consult the symbology table for further information regarding meaning of the symbols.

Roadmap

  • rethink syntax
  • provide option for internationalziation (i18n)
  • rewrite library with better coding skills
  • include support for glossaries package

Acknowledgement

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No. 826347.

License

Open Source Initiative Approved License logo

Copyright (c) 2018 - 2022, Martin Scheidt <m.scheidt@tu-bs.de> (ISC License)

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.