y5nw
/
advtrains-doc-integration
spogulis no https://codeberg.org/y5nw/advtrains-doc-integration/wiki


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Manual for advtrains_doc_integration</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>Documentation System Integration for Advtrains</h1>


<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Usage">Usage </a></li>
<li><a href="#Documentation_strings">Documentation strings </a></li>
<li><a href="#CI">CI </a></li>
</ul>


<h2>Topics</h2>
<ul class="">
  <li><strong>README</strong></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/advtrains_doc_integration.bc.html">advtrains_doc_integration.bc</a></li>
  <li><a href="../modules/advtrains_doc_integration.describe.html">advtrains_doc_integration.describe</a></li>
  <li><a href="../modules/advtrains_doc_integration.hypertext.html">advtrains_doc_integration.hypertext</a></li>
  <li><a href="../modules/advtrains_doc_integration.html">advtrains_doc_integration</a></li>
  <li><a href="../modules/advtrains_doc_integration.latex.html">advtrains_doc_integration.latex</a></li>
  <li><a href="../modules/advtrains_doc_integration.mathutils.html">advtrains_doc_integration.mathutils</a></li>
  <li><a href="../modules/advtrains_doc_integration.utils.html">advtrains_doc_integration.utils</a></li>
</ul>

</div>

<div id="content">


<h1>Documentation System Integration for Advtrains</h1>

<p>This mod integrates Advtrains with the <a href="https://content.minetest.net/packages/Wuzzy/doc/">doc</a> mod, among
other things.</p>


<p><a name="Usage"></a></p>
<h2>Usage</h2>

<p>The <code>/helpform</code> command can be used as usual.</p>

<p>This mod adds the "Wagons" category that contains information related
to the wagons. It also adds adds certain Advtrains-related properties
to certain nodes.</p>

<p>This mod also provides the <code>atdoc_write</code> command, which can be used to
export wagon datasheets.</p>

<p><strong>Please keep in mind that, while this mod attempts to provide accurate
information, its accuracy, especially for information related to
liveries, is limited by various factors. Refer the source code of the
relevant mods for authoritative information.</strong></p>

<p><a name="Documentation_strings"></a></p>
<h2>Documentation strings</h2>

<p>Wagon mods can add a description to the <code>_doc_wagon_longdesc</code> field of
the wagon prototype; adding <a href="../modules/advtrains_doc_integration.html#">advtrains_doc_integration</a> as an optional
dependency is <em>not</em> needed.</p>

<p><a name="CI"></a></p>
<h2>CI</h2>

<p>This mod also be used with <a href="https://github.com/S-S-X/mineunit">Mineunit</a> in addition to a
regular Minetest environment, such as to generate wagon datasheets.
However, please note that, due to various limitations, the datasheet
generated in such an environment does not contain certain information
that would otherwise be available from Minetest.</p>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-29 22:34:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>