Go to file
Martin Scheidt e640fae427 Merge branch 'master' of https://github.com/railtoolkit/tikz-trackschematic 2021-12-01 11:47:48 +01:00
doc Merge branch 'master' of https://github.com/railtoolkit/tikz-trackschematic 2021-12-01 11:47:48 +01:00
src updated version 2021-10-15 11:10:08 +02:00
test removed local tikz-trackschematic-dev.sty call with [dev]-call provided by ctan tikz-trackschematic package 2021-01-02 19:47:14 +01:00
.gitignore arrange files for CTAN 2020-01-16 21:49:53 +01:00
CITATION.cff updated citation information 2021-10-15 11:25:07 +02:00
CODE_OF_CONDUCT.md remove package requirement lmodern, minor corrections, added citing information 2021-09-30 12:37:31 +02:00
CONTRIBUTING.md included versioning process 2021-10-15 13:18:15 +02:00
LICENSE Added symbols for "direction control", "track marking", "pylons" and 2021-01-02 14:04:05 +01:00
README.md updated version 2021-10-15 11:10:08 +02:00
create_ctan-package.sh included symbology.code.tex zu CTAN creation 2021-09-30 12:40:26 +02:00
dev-install.sh remove package requirement lmodern, minor corrections, added citing information 2021-09-30 12:37:31 +02: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.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.


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 for further information regarding meaning of the symbols.


History

Version 0.6.2

bug fixing

Version 0.6.1

  • removed package requirement lmodern
  • minor correction in manual
  • added citation information

Version 0.6

  • created an encapsulating package for future flexibility
  • added symbols for direction control, track marking, pylons and electric wiring
  • change symbol for friction bufferstop;
  • changed load command to \usepackage{tikz-trackschematic}

Version 0.5.1

  • modified symbol "end of movement authority"
  • added symbols "braking point" and "danger point"

Version 0.5

  • new improved syntax for topology
  • documentation

Version 0.4

  • added document for symbology
  • renamed overview to snippets
  • reworked library for common tikz library layout

Version 0.3

  • moved snippet folder to root folder
  • added shunting movements
  • added points to turnouts
  • added moving trains
  • defined and used color foreground and background

Version 0.2

  • added transmitters
  • reorganized src library
  • minor improvements

Version 0.1

Basic concept of a library with railway topology symbols and some examples.


Roadmap

  • rethink syntax
  • provide option for internationalziation (i18n)
  • replace "\gettikzxy" with "\path let" syntax
  • rewrite library with better coding skills
  • include support for glossaries package

Acknowledgement

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


License

Open Source Initiative Approved License logo

Copyright (c) 2018 - 2021, 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.