<spanid="evennia-web-website-views-help"></span><h1>evennia.web.website.views.help<aclass="headerlink"href="#module-evennia.web.website.views.help"title="Permalink to this headline">¶</a></h1>
<p>Views to manipulate help entries.</p>
<dlclass="simple">
<dt>Multi entry object type supported added by DaveWithTheNiceHat 2021</dt><dd><p>Pull Request #2429</p>
<codeclass="sig-prename descclassname">evennia.web.website.views.help.</code><codeclass="sig-name descname">get_help_category</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">help_entry</span></em>, <emclass="sig-param"><spanclass="n">slugify_cat</span><spanclass="o">=</span><spanclass="default_value">True</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/website/views/help.html#get_help_category"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.website.views.help.get_help_category"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns help category.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>help_entry</strong> (<aclass="reference internal"href="evennia.help.models.html#evennia.help.models.HelpEntry"title="evennia.help.models.HelpEntry"><em>HelpEntry</em></a><em>, </em><aclass="reference internal"href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry"title="evennia.help.filehelp.FileHelpEntry"><em>FileHelpEntry</em></a><em> or </em><aclass="reference internal"href="evennia.commands.command.html#evennia.commands.command.Command"title="evennia.commands.command.Command"><em>Command</em></a>) – Help entry instance.</p></li>
<li><p><strong>slugify_cat</strong> (<em>bool</em>) – If true the return string is slugified. Default is True.</p></li>
</ul>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>If an entry does not have a <strong>help_category</strong> attribute, DEFAULT_HELP_CATEGORY from the
settings file is used.
If the entry does not have attribute ‘web_help_entries’. One is created with a slugified
copy of the attribute help_category. This attribute is used for sorting the entries for the
help index (ListView) page.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><em>help_category (str)</em>– The category for the help entry.</p>
<codeclass="sig-prename descclassname">evennia.web.website.views.help.</code><codeclass="sig-name descname">get_help_topic</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">help_entry</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/website/views/help.html#get_help_topic"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.website.views.help.get_help_topic"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the topic of the help entry.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>help_entry</strong> (<aclass="reference internal"href="evennia.help.models.html#evennia.help.models.HelpEntry"title="evennia.help.models.HelpEntry"><em>HelpEntry</em></a><em>, </em><aclass="reference internal"href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry"title="evennia.help.filehelp.FileHelpEntry"><em>FileHelpEntry</em></a><em> or </em><aclass="reference internal"href="evennia.commands.command.html#evennia.commands.command.Command"title="evennia.commands.command.Command"><em>Command</em></a>) – Help entry instance.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>help_topic (str)</em>– The topic of the help entry. Default is ‘unknown_topic’.</p>
<codeclass="sig-prename descclassname">evennia.web.website.views.help.</code><codeclass="sig-name descname">can_read_topic</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmd_or_topic</span></em>, <emclass="sig-param"><spanclass="n">account</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/website/views/help.html#can_read_topic"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.website.views.help.can_read_topic"title="Permalink to this definition">¶</a></dt>
<dd><p>Check if an account or puppet has read access to a help entry.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cmd_or_topic</strong> (<aclass="reference internal"href="evennia.commands.command.html#evennia.commands.command.Command"title="evennia.commands.command.Command"><em>Command</em></a><em>, </em><aclass="reference internal"href="evennia.help.models.html#evennia.help.models.HelpEntry"title="evennia.help.models.HelpEntry"><em>HelpEntry</em></a><em> or </em><aclass="reference internal"href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry"title="evennia.help.filehelp.FileHelpEntry"><em>FileHelpEntry</em></a>) – The topic/command to test.</p></li>
<li><p><strong>account</strong>– the account or puppet checking for access.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>bool</em>– If command can be viewed or not.</p>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>This uses the ‘read’ lock. If no ‘read’ lock is defined, the topic is assumed readable
by all.
Even if this returns False, the entry will still be visible in the help index unless
<strong>can_list_topic</strong> is also returning False.</p>
<codeclass="sig-prename descclassname">evennia.web.website.views.help.</code><codeclass="sig-name descname">collect_topics</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">account</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/website/views/help.html#collect_topics"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.website.views.help.collect_topics"title="Permalink to this definition">¶</a></dt>
<dd><p>Collect help topics from all sources (cmd/db/file).</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>account</strong> (<em>Character</em><em> or </em><em>Account</em>) – Account or Character to collect help topics from.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.web.website.views.help.</code><codeclass="sig-name descname">HelpMixin</code><aclass="reference internal"href="../_modules/evennia/web/website/views/help.html#HelpMixin"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.website.views.help.HelpMixin"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">page_title</code><emclass="property"> = 'Help'</em><aclass="headerlink"href="#evennia.web.website.views.help.HelpMixin.page_title"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get_queryset</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/website/views/help.html#HelpMixin.get_queryset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.website.views.help.HelpMixin.get_queryset"title="Permalink to this definition">¶</a></dt>
<dd><p>Django hook; here we want to return a list of only those HelpEntries
and other documentation that the current user is allowed to see.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><em>queryset (list)</em>– List of Help entries available to the user.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.web.website.views.help.</code><codeclass="sig-name descname">HelpListView</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/website/views/help.html#HelpListView"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.website.views.help.HelpListView"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">paginate_by</code><emclass="property"> = 500</em><aclass="headerlink"href="#evennia.web.website.views.help.HelpListView.paginate_by"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">template_name</code><emclass="property"> = 'website/help_list.html'</em><aclass="headerlink"href="#evennia.web.website.views.help.HelpListView.template_name"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">page_title</code><emclass="property"> = 'Help Index'</em><aclass="headerlink"href="#evennia.web.website.views.help.HelpListView.page_title"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.web.website.views.help.</code><codeclass="sig-name descname">HelpDetailView</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/website/views/help.html#HelpDetailView"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.website.views.help.HelpDetailView"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">template_name</code><emclass="property"> = 'website/help_detail.html'</em><aclass="headerlink"href="#evennia.web.website.views.help.HelpDetailView.template_name"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">page_title</code><aclass="headerlink"href="#evennia.web.website.views.help.HelpDetailView.page_title"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get_context_data</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/website/views/help.html#HelpDetailView.get_context_data"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.website.views.help.HelpDetailView.get_context_data"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds navigational data to the template to let browsers go to the next
<codeclass="sig-name descname">get_object</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">queryset</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/website/views/help.html#HelpDetailView.get_object"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.website.views.help.HelpDetailView.get_object"title="Permalink to this definition">¶</a></dt>
<dd><p>Override of Django hook that retrieves an object by category and topic
instead of pk and slug.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>queryset</strong> (<em>list</em>) – A list of help entry objects.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>entry (HelpEntry, FileHelpEntry or Command)</em>– HelpEntry requested in the URL.</p>