Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 22:36:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs.

Browse source
This commit is contained in:
Evennia docbuilder action 2023-01-06 17:19:13 +00:00
parent 21cbd1bbfb
commit ee1df69707
372 changed files with 5063 additions and 5060 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/1.0/Components/Help-System.html
View file

@ -120,33 +120,33 @@
<section class="tex2jax_ignore mathjax_ignore" id="help-system">
<h1>Help System<a class="headerlink" href="#help-system" title="Permalink to this headline"></a></h1>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt; <span class="nb">help</span> theatre
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span><span class="nb">help</span><span class="w"> </span>theatre
</pre></div>
</div>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>------------------------------------------------------------------------------
Help <span class="k">for</span> The theatre <span class="o">(</span>aliases: the hub, curtains<span class="o">)</span>
Help<span class="w"> </span><span class="k">for</span><span class="w"> </span>The<span class="w"> </span>theatre<span class="w"> </span><span class="o">(</span>aliases:<span class="w"> </span>the<span class="w"> </span>hub,<span class="w"> </span>curtains<span class="o">)</span>
The theatre is at the centre of the city, both literally and figuratively ...
<span class="o">(</span>A lot more text about it follows ...<span class="o">)</span>
The<span class="w"> </span>theatre<span class="w"> </span>is<span class="w"> </span>at<span class="w"> </span>the<span class="w"> </span>centre<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>city,<span class="w"> </span>both<span class="w"> </span>literally<span class="w"> </span>and<span class="w"> </span>figuratively<span class="w"> </span>...
<span class="o">(</span>A<span class="w"> </span>lot<span class="w"> </span>more<span class="w"> </span>text<span class="w"> </span>about<span class="w"> </span>it<span class="w"> </span>follows<span class="w"> </span>...<span class="o">)</span>
Subtopics:
theatre/lore
theatre/layout
theatre/dramatis personae
<span class="w"> </span>theatre/lore
<span class="w"> </span>theatre/layout
<span class="w"> </span>theatre/dramatis<span class="w"> </span>personae
------------------------------------------------------------------------------
</pre></div>
</div>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt; <span class="nb">help</span> evennia
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span><span class="nb">help</span><span class="w"> </span>evennia
</pre></div>
</div>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>------------------------------------------------------------------------------
No <span class="nb">help</span> found
No<span class="w"> </span><span class="nb">help</span><span class="w"> </span>found
There is no <span class="nb">help</span> topic matching <span class="s1">&#39;evennia&#39;</span>.
... But matches where found within the <span class="nb">help</span> texts of the suggestions below.
There<span class="w"> </span>is<span class="w"> </span>no<span class="w"> </span><span class="nb">help</span><span class="w"> </span>topic<span class="w"> </span>matching<span class="w"> </span><span class="s1">&#39;evennia&#39;</span>.
...<span class="w"> </span>But<span class="w"> </span>matches<span class="w"> </span>where<span class="w"> </span>found<span class="w"> </span>within<span class="w"> </span>the<span class="w"> </span><span class="nb">help</span><span class="w"> </span>texts<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>suggestions<span class="w"> </span>below.
Suggestions:
grapevine2chan, about, irc2chan
<span class="w"> </span>grapevine2chan,<span class="w"> </span>about,<span class="w"> </span>irc2chan
-----------------------------------------------------------------------------
</pre></div>
</div>
@ -250,7 +250,7 @@ server and the file-based help entries will be available to view.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia</span> <span class="kn">import</span> <span class="n">Command</span>
<span class="k">class</span> <span class="nc">MyCommand</span><span class="p">(</span><span class="n">Command</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; </span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot; </span>
<span class="sd"> This command is great! </span>
<span class="sd"> Usage: </span>
@ -290,7 +290,7 @@ everyone can read the help entry.</p></li>
</ul>
<p>For Commands you set the help-related locks the same way you would any lock:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyCommand</span><span class="p">(</span><span class="n">Command</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> &lt;docstring for command&gt;</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="s2">&quot;mycommand&quot;</span>