<spanid="evennia-help-manager"></span><h1>evennia.help.manager<aclass="headerlink"href="#module-evennia.help.manager"title="Permalink to this headline">¶</a></h1>
<p>Custom manager for HelpEntry objects.</p>
<dlclass="py class">
<dtid="evennia.help.manager.HelpEntryManager">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.help.manager.</code><codeclass="sig-name descname">HelpEntryManager</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/manager.html#HelpEntryManager"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.manager.HelpEntryManager"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">find_topicmatch</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">topicstr</span></em>, <emclass="sig-param"><spanclass="n">exact</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/manager.html#HelpEntryManager.find_topicmatch"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.manager.HelpEntryManager.find_topicmatch"title="Permalink to this definition">¶</a></dt>
<dd><p>Searches for matching topics or aliases based on player’s
input.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>topcistr</strong> (<em>str</em>) – Help topic to search for.</p></li>
<li><p><strong>exact</strong> (<em>bool</em><em>, </em><em>optional</em>) – Require exact match
(non-case-sensitive). If <strong>False</strong> (default), match
<codeclass="sig-name descname">find_apropos</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">topicstr</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/manager.html#HelpEntryManager.find_apropos"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.manager.HelpEntryManager.find_apropos"title="Permalink to this definition">¶</a></dt>
<dd><p>Do a very loose search, returning all help entries containing
<codeclass="sig-name descname">find_topicsuggestions</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">topicstr</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/manager.html#HelpEntryManager.find_topicsuggestions"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.manager.HelpEntryManager.find_topicsuggestions"title="Permalink to this definition">¶</a></dt>
<dd><p>Do a fuzzy match, preferably within the category of the
<codeclass="sig-name descname">find_topics_with_category</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">help_category</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/manager.html#HelpEntryManager.find_topics_with_category"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.manager.HelpEntryManager.find_topics_with_category"title="Permalink to this definition">¶</a></dt>
<dd><p>Search topics having a particular category.</p>
<codeclass="sig-name descname">get_all_topics</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/manager.html#HelpEntryManager.get_all_topics"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.manager.HelpEntryManager.get_all_topics"title="Permalink to this definition">¶</a></dt>
<dd><p>Get all topics.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><em>all (HelpEntries)</em>– All topics.</p>
<codeclass="sig-name descname">get_all_categories</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/manager.html#HelpEntryManager.get_all_categories"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.manager.HelpEntryManager.get_all_categories"title="Permalink to this definition">¶</a></dt>
<dd><p>Return all defined category names with at least one topic in
<codeclass="sig-name descname">all_to_category</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">default_category</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/manager.html#HelpEntryManager.all_to_category"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.manager.HelpEntryManager.all_to_category"title="Permalink to this definition">¶</a></dt>
<dd><p>Shifts all help entries in database to default_category. This
action cannot be reverted. It is used primarily by the engine
when importing a default help database, making sure this ends
up in one easily separated category.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>default_category</strong> (<em>str</em>) – Category to move entries to.</p>
<codeclass="sig-name descname">search_help</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">ostring</span></em>, <emclass="sig-param"><spanclass="n">help_category</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/manager.html#HelpEntryManager.search_help"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.manager.HelpEntryManager.search_help"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve a search entry object.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ostring</strong> (<em>str</em>) – The help topic to look for.</p></li>
<li><p><strong>category</strong> (<em>str</em>) – Limit the search to a particular help topic</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>Queryset</em>– An iterable with 0, 1 or more matches.</p>
