y5nw
/
advtrains-doc-integration
Mirror von https://codeberg.org/y5nw/advtrains-doc-integration/wiki


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474
							<!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="#Functions">Functions</a></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><strong>advtrains_doc_integration.hypertext</strong></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>
<h2>Topics</h2>
<ul class="">
  <li><a href="../topics/README.md.html">README</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>advtrains_doc_integration.hypertext</code></h1>
<p>Utilities for hypertext used in Minetest formspecs.</p>
<p>

</p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#plain">plain (str[, noescape])</a></td>
	<td class="summary">Create a plain text hypertext element.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#mono">mono (str[, noescape])</a></td>
	<td class="summary">Create a hypertext element with monospace text.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#bold">bold (str[, noescape])</a></td>
	<td class="summary">Create a hypertext element with bold text.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#italic">italic (str[, noescape])</a></td>
	<td class="summary">Create a hypertext element with italic text.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#header">header (str[, noescape])</a></td>
	<td class="summary">Create a hypertext element with text formatted as header.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#listitem">listitem (str[, noescape])</a></td>
	<td class="summary">Create a hypertext element with text formatted as an item in a list.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#action">action (action, str[, noescape])</a></td>
	<td class="summary">Create a hypertext element with an action.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#describe_sound">describe_sound ([action], soundspec)</a></td>
	<td class="summary">Describe a soundspec.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#describe_coupler">describe_coupler (coupler)</a></td>
	<td class="summary">Describe a coupler type.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#describe_item">describe_item (item)</a></td>
	<td class="summary">Describe an item.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#describe_function">describe_function (f)</a></td>
	<td class="summary">Describe a function.</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "plain"></a>
    <strong>plain (str[, noescape])</strong>
    </dt>
    <dd>
    Create a plain text hypertext element.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">str</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
         The content of the element.
        </li>
        <li><span class="parameter">noescape</span>
            <span class="types"><span class="type">boolean</span></span>
         Whether to avoid escaping the content.
         (<em>optional</em>)
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The hypertext element containing the text.
    </ol>


</dd>
    <dt>
    <a name = "mono"></a>
    <strong>mono (str[, noescape])</strong>
    </dt>
    <dd>
    Create a hypertext element with monospace text.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">str</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
         The content of the element.
        </li>
        <li><span class="parameter">noescape</span>
            <span class="types"><span class="type">boolean</span></span>
         Whether to avoid escaping the content.
         (<em>optional</em>)
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The hypertext element containing the text.
    </ol>


</dd>
    <dt>
    <a name = "bold"></a>
    <strong>bold (str[, noescape])</strong>
    </dt>
    <dd>
    Create a hypertext element with bold text.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">str</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
         The content of the element.
        </li>
        <li><span class="parameter">noescape</span>
            <span class="types"><span class="type">boolean</span></span>
         Whether to avoid escaping the content.
         (<em>optional</em>)
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The hypertext element containing the text.
    </ol>


</dd>
    <dt>
    <a name = "italic"></a>
    <strong>italic (str[, noescape])</strong>
    </dt>
    <dd>
    Create a hypertext element with italic text.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">str</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
         The content of the element.
        </li>
        <li><span class="parameter">noescape</span>
            <span class="types"><span class="type">boolean</span></span>
         Whether to avoid escaping the content.
         (<em>optional</em>)
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The hypertext element containing the text.
    </ol>


</dd>
    <dt>
    <a name = "header"></a>
    <strong>header (str[, noescape])</strong>
    </dt>
    <dd>
    Create a hypertext element with text formatted as header.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">str</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
         The content of the element.
        </li>
        <li><span class="parameter">noescape</span>
            <span class="types"><span class="type">boolean</span></span>
         Whether to avoid escaping the content.
         (<em>optional</em>)
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The hypertext element containing the text.
    </ol>


</dd>
    <dt>
    <a name = "listitem"></a>
    <strong>listitem (str[, noescape])</strong>
    </dt>
    <dd>
    Create a hypertext element with text formatted as an item in a list.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">str</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
         The content of the element.
        </li>
        <li><span class="parameter">noescape</span>
            <span class="types"><span class="type">boolean</span></span>
         Whether to avoid escaping the content.
         (<em>optional</em>)
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The hypertext element containing the text.
    </ol>


</dd>
    <dt>
    <a name = "action"></a>
    <strong>action (action, str[, noescape])</strong>
    </dt>
    <dd>
    Create a hypertext element with an action.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">action</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
         The name of the action.
        </li>
        <li><span class="parameter">str</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
         The content of the element.
        </li>
        <li><span class="parameter">noescape</span>
            <span class="types"><span class="type">boolean</span></span>
         Whether to avoid escaping the content.
         (<em>optional</em>)
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The hypertext element containing the text.
    </ol>


</dd>
    <dt>
    <a name = "describe_sound"></a>
    <strong>describe_sound ([action], soundspec)</strong>
    </dt>
    <dd>
    Describe a soundspec.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">action</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
         The name of the action.
         (<em>optional</em>)
        </li>
        <li><span class="parameter">soundspec</span>
            <span class="types"><a class="type" href="https://api.minetest.net/sounds/#simplesoundspec">SimpleSoundSpec</a></span>
         The soundspec to describe.
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The hypertext element describing the soundspec.
    </ol>


</dd>
    <dt>
    <a name = "describe_coupler"></a>
    <strong>describe_coupler (coupler)</strong>
    </dt>
    <dd>
    Describe a coupler type.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">coupler</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
         The name of the coupler.
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The hypertext element describing the coupler.
    </ol>


</dd>
    <dt>
    <a name = "describe_item"></a>
    <strong>describe_item (item)</strong>
    </dt>
    <dd>
    Describe an item.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">item</span>
            <span class="types"><a class="type" href="https://api.minetest.net/class-reference/#itemstack">ItemStack</a></span>
         The item to describe
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
        The hypertext element describing the item.
    </ol>


</dd>
    <dt>
    <a name = "describe_function"></a>
    <strong>describe_function (f)</strong>
    </dt>
    <dd>
    Describe a function.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">f</span>
            <span class="types"><span class="type">function</span></span>
         The function to describe.
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a> or <span class="type">nil</span></span>
        The hypertext element describing the function if a sufficiently informative description is available.
    </ol>


</dd>
</dl>


</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>