From b4ac74c41911ee7771e88da91208c1eb16c4b752 Mon Sep 17 00:00:00 2001 From: "Y. Wang" Date: Thu, 11 Aug 2022 19:07:42 +0200 Subject: Reformat manual pages --- assets/manual/man/man7advtrains/node_definition.7advtrains.md | 11 ++++++----- assets/manual/man/man7advtrains/rwt.7advtrains.md | 7 ++++--- assets/manual/man/man7advtrains/signal_aspects.7advtrains.md | 7 ++++--- assets/manual/man/man7advtrains/speed.7advtrains.md | 9 +++++---- 4 files changed, 19 insertions(+), 15 deletions(-) (limited to 'assets/manual/man/man7advtrains') diff --git a/assets/manual/man/man7advtrains/node_definition.7advtrains.md b/assets/manual/man/man7advtrains/node_definition.7advtrains.md index c662614..8b6407a 100644 --- a/assets/manual/man/man7advtrains/node_definition.7advtrains.md +++ b/assets/manual/man/man7advtrains/node_definition.7advtrains.md @@ -1,23 +1,24 @@ --- -title: 'NODE_DEFINITION(7ADVTRAINS) | Advtrains Developer''s Manual' +title: 'node_definition(7advtrains)' +manual: 'Advtrains Developer''s Manual' seealso: - signal_aspects(7advtrains) --- -# NAME +# Name `node_definition` - Advtrains-specific node definition entries -# DESCRIPTION +# Description This page describes various fields in node definition tables that are used by Advtrains. -# NODE GROUPS +# Node Groups Advtrains uses node groups to identify certain properties of a node. The following node groups are currently read by Advtrains: * `advtrains_signal`: When set, this property defines the type of signal this node belongs to. `1` indicates that this node is a static signal, and `2` indicates that this node is a signal with a variable aspect. * `not_blocking_trains`: When set to 1, trains can move through this node. * `save_in_at_nodedb`: When set to 1, this node should be saved in the internal node database used by Advtrains. -# THE `advtrains` FIELD +# The `advtrains` Field The `advtrains` field in the node definition may contain the following fields: * `get_aspect(pos, node)`: This function should return the signal aspect of the node at the given position. diff --git a/assets/manual/man/man7advtrains/rwt.7advtrains.md b/assets/manual/man/man7advtrains/rwt.7advtrains.md index 5e15406..3c1690a 100644 --- a/assets/manual/man/man7advtrains/rwt.7advtrains.md +++ b/assets/manual/man/man7advtrains/rwt.7advtrains.md @@ -1,5 +1,6 @@ --- -title: 'RWT(7ADVTRAINS) | Advtrains Developer''s Manual' +title: 'rwt(7advtrains)' +manual: 'Advtrains Developer''s Manual' seealso: - rwt_add(3advtrains) - rwt_copy(3advtrains) @@ -7,10 +8,10 @@ seealso: - rwt_now(3advtrains) --- -# NAME +# Name `rwt` - Advtrains railway time -# DESCRIPTION +# Description Advtrains depends on Minetest's "dtime" for most operations, and may slow itself down when necessary to prevent unexpected behavior, such as in a situation with a significant amount of lag. As a result, the internal time used by Advtrains is not synchronized to real-life time due to lag and server restarts. Railway time was therefore introduced as a method of accurately measuring internal time and, with this information, implementing a scheduling system. It can, however, also be set up to keep in sync with real-life time. Railway time is counted in cycles, minutes, and seconds, roughly corresponding to their real-life counterparts, with cycles roughly corresponding to hours. For a valid railway time object, it is expected that diff --git a/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md b/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md index 0066f7f..110d642 100644 --- a/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md +++ b/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md @@ -1,13 +1,14 @@ --- -title: 'SIGNAL_ASPECTS(7ADVTRAINS) | Advtrains Developer''s Manual' +title: 'signal_aspects(7advtrains)' +manual: 'Advtrains Developer''s Manual' seealso: - speed(7advtrains) --- -# NAME +# Name `signal_aspects` - Signal aspect tables for Advtrains -# DESCRIPTION +# Description A signal aspect table describes the status of a signal in relation to a train following it. A signal aspect table may contain the following fields: diff --git a/assets/manual/man/man7advtrains/speed.7advtrains.md b/assets/manual/man/man7advtrains/speed.7advtrains.md index eefd764..b963686 100644 --- a/assets/manual/man/man7advtrains/speed.7advtrains.md +++ b/assets/manual/man/man7advtrains/speed.7advtrains.md @@ -1,15 +1,16 @@ --- -title: 'SPEED(7ADVTRAINS) | Advtrains Developer''s Manual' +title: 'speed(7advtrains)' +manual: 'Advtrains Developer''s Manual' seealso: - speed_lessp(3advtrains) - speed_set_restriction(3advtrains) - signal_aspects(7advtrains) --- -# NAME +# Name `speed` - Advtrains speed limit library -# DESCRIPTION +# Description The speed library allows the manipulation of speed limits, which can be represented with * A non-negative number, which stands for a regular speed limit in m/s, or @@ -19,6 +20,6 @@ The use of other values (in particular, nan and infinity) may result in undefine This library is available as `advtrains.speed`. -# NOTES +# Notes The meaning of `nil` for the speed limit library differs from its meaning in signal aspect tables, where `nil` keeps the current speed limit. -- cgit v1.2.3