<spanid="evennia-help-package"></span><h1>evennia.help package<aclass="headerlink"href="#module-evennia.help"title="Permalink to this headline">¶</a></h1>
<p>This sub-package defines the help system of Evennia. It is pretty
simple, mainly consisting of a database model to hold help entries.
The auto-cmd-help is rather handled by the default ‘help’ command
itself.</p>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<divclass="toctree-wrapper compound">
</div>
</div>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="evennia-help-admin-module"></span><h2>evennia.help.admin module<aclass="headerlink"href="#module-evennia.help.admin"title="Permalink to this headline">¶</a></h2>
<p>This defines how to edit help entries in Admin.</p>
<dlclass="class">
<dtid="evennia.help.admin.HelpEntryAdmin">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.help.admin.</code><codeclass="sig-name descname">HelpEntryAdmin</code><spanclass="sig-paren">(</span><emclass="sig-param">model</em>, <emclass="sig-param">admin_site</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/admin.html#HelpEntryAdmin"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">fieldsets</code><emclass="property"> = ((None, {'fields': (('db_key', 'db_help_category'), 'db_entrytext', 'db_lock_storage'), 'description': 'Sets a Help entry. Set lock to <i>view:all()</I> unless you want to restrict it.'}),)</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.fieldsets"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="evennia.help.admin.HelpEntryAdmin.form">
<codeclass="sig-name descname">form</code><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.form"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="#evennia.help.admin.HelpEntryForm"title="evennia.help.admin.HelpEntryForm"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HelpEntryForm</span></code></a></p>
<codeclass="sig-name descname">inlines</code><emclass="property"> = [<class 'evennia.help.admin.HelpTagInline'>]</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.inlines"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list_display</code><emclass="property"> = ('id', 'db_key', 'db_help_category', 'db_lock_storage')</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.list_display"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list_display_links</code><emclass="property"> = ('id', 'db_key')</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.list_display_links"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list_select_related</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.list_select_related"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="evennia.help.admin.HelpEntryAdmin.media">
<emclass="property">property </em><codeclass="sig-name descname">media</code><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.media"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">ordering</code><emclass="property"> = ['db_help_category', 'db_key']</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.ordering"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">save_as</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.save_as"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">save_on_top</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.save_on_top"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_fields</code><emclass="property"> = ['^db_key', 'db_entrytext']</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryAdmin.search_fields"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.help.admin.HelpEntryForm">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.help.admin.</code><codeclass="sig-name descname">HelpEntryForm</code><spanclass="sig-paren">(</span><emclass="sig-param">data=None</em>, <emclass="sig-param">files=None</em>, <emclass="sig-param">auto_id='id_%s'</em>, <emclass="sig-param">prefix=None</em>, <emclass="sig-param">initial=None</em>, <emclass="sig-param">error_class=<class 'django.forms.utils.ErrorList'></em>, <emclass="sig-param">label_suffix=None</em>, <emclass="sig-param">empty_permitted=False</em>, <emclass="sig-param">instance=None</em>, <emclass="sig-param">use_required_attribute=None</em>, <emclass="sig-param">renderer=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/admin.html#HelpEntryForm"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.admin.HelpEntryForm"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-name descname">Meta</code><aclass="reference internal"href="../_modules/evennia/help/admin.html#HelpEntryForm.Meta"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.admin.HelpEntryForm.Meta"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">fields</code><emclass="property"> = '__all__'</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryForm.Meta.fields"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">model</code><aclass="headerlink"href="#evennia.help.admin.HelpEntryForm.Meta.model"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="#evennia.help.models.HelpEntry"title="evennia.help.models.HelpEntry"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">evennia.help.models.HelpEntry</span></code></a></p>
</dd></dl>
</dd></dl>
<dlclass="attribute">
<dtid="evennia.help.admin.HelpEntryForm._meta">
<codeclass="sig-name descname">_meta</code><emclass="property"> = <django.forms.models.ModelFormOptions object></em><aclass="headerlink"href="#evennia.help.admin.HelpEntryForm._meta"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">declared_fields</code><emclass="property"> = {'db_help_category': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>}</em><aclass="headerlink"href="#evennia.help.admin.HelpEntryForm.declared_fields"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="evennia.help.admin.HelpEntryForm.media">
<emclass="property">property </em><codeclass="sig-name descname">media</code><aclass="headerlink"href="#evennia.help.admin.HelpEntryForm.media"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.help.admin.HelpTagInline">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.help.admin.</code><codeclass="sig-name descname">HelpTagInline</code><spanclass="sig-paren">(</span><emclass="sig-param">parent_model</em>, <emclass="sig-param">admin_site</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/admin.html#HelpTagInline"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.admin.HelpTagInline"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">media</code><aclass="headerlink"href="#evennia.help.admin.HelpTagInline.media"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="evennia.help.admin.HelpTagInline.model">
<codeclass="sig-name descname">model</code><aclass="headerlink"href="#evennia.help.admin.HelpTagInline.model"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">evennia.help.models.HelpEntry_db_tags</span></code></p>
<codeclass="sig-name descname">related_field</code><emclass="property"> = 'helpentry'</em><aclass="headerlink"href="#evennia.help.admin.HelpTagInline.related_field"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-help-manager-module"></span><h2>evennia.help.manager module<aclass="headerlink"href="#module-evennia.help.manager"title="Permalink to this headline">¶</a></h2>
<p>Custom manager for HelpEntry objects.</p>
<dlclass="class">
<dtid="evennia.help.manager.HelpEntryManager">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.help.manager.</code><codeclass="sig-name descname">HelpEntryManager</code><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">all_to_category</code><spanclass="sig-paren">(</span><emclass="sig-param">default_category</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">find_apropos</code><spanclass="sig-paren">(</span><emclass="sig-param">topicstr</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_topicmatch</code><spanclass="sig-paren">(</span><emclass="sig-param">topicstr</em>, <emclass="sig-param">exact=False</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 <cite>False</cite> (default), match
<codeclass="sig-name descname">find_topics_with_category</code><spanclass="sig-paren">(</span><emclass="sig-param">help_category</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">find_topicsuggestions</code><spanclass="sig-paren">(</span><emclass="sig-param">topicstr</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">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
them.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><dlclass="simple">
<dt>Unique list of category names across all</dt><dd><p>topics.</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>
<codeclass="sig-name descname">search_help</code><spanclass="sig-paren">(</span><emclass="sig-param">ostring</em>, <emclass="sig-param">help_category=None</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>
<spanid="evennia-help-models-module"></span><h2>evennia.help.models module<aclass="headerlink"href="#module-evennia.help.models"title="Permalink to this headline">¶</a></h2>
<p>Models for the help system.</p>
<p>The database-tied help system is only half of Evennia’s help
functionality, the other one being the auto-generated command help
that is created on the fly from each command’s <cite>__doc__</cite> string. The
persistent database system defined here is intended for all other
forms of help that do not concern commands, like information about the
game world, policy info, rules and similar.</p>
<dlclass="class">
<dtid="evennia.help.models.HelpEntry">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.help.models.</code><codeclass="sig-name descname">HelpEntry</code><spanclass="sig-paren">(</span><emclass="sig-param">*args</em>, <emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_is_deleted</code><emclass="property"> = False</em><aclass="headerlink"href="#evennia.help.models.HelpEntry._is_deleted"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="evennia.help.models.HelpEntry._meta">
<codeclass="sig-name descname">_meta</code><emclass="property"> = <Options for HelpEntry></em><aclass="headerlink"href="#evennia.help.models.HelpEntry._meta"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="evennia.help.models.HelpEntry.access">
<codeclass="sig-name descname">access</code><spanclass="sig-paren">(</span><emclass="sig-param">accessing_obj</em>, <emclass="sig-param">access_type='read'</em>, <emclass="sig-param">default=False</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.access"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.access"title="Permalink to this definition">¶</a></dt>
<dd><p>Determines if another object has permission to access.
accessing_obj - object trying to access this one
access_type - type of access sought
default - what to return if no lock of access_type was found</p>
</dd></dl>
<dlclass="attribute">
<dtid="evennia.help.models.HelpEntry.aliases">
<codeclass="sig-name descname">aliases</code><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.aliases"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">db_entrytext</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_entrytext"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<codeclass="sig-name descname">db_help_category</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_help_category"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dlclass="attribute">
<dtid="evennia.help.models.HelpEntry.db_key">
<codeclass="sig-name descname">db_key</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_key"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<codeclass="sig-name descname">db_lock_storage</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_lock_storage"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<codeclass="sig-name descname">db_staff_only</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_staff_only"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dlclass="attribute">
<dtid="evennia.help.models.HelpEntry.db_tags">
<codeclass="sig-name descname">db_tags</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.db_tags"title="Permalink to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<p><codeclass="docutils literal notranslate"><spanclass="pre">Pizza.toppings</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">Topping.pizzas</span></code> are <codeclass="docutils literal notranslate"><spanclass="pre">ManyToManyDescriptor</span></code>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <codeclass="docutils literal notranslate"><spanclass="pre">create_forward_many_to_many_manager()</span></code> defined below.</p>
</dd></dl>
<dlclass="method">
<dtid="evennia.help.models.HelpEntry.entrytext">
<emclass="property">property </em><codeclass="sig-name descname">entrytext</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.entrytext"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for getting database field <cite>db_entrytext</cite>.</p>
<codeclass="sig-name descname">get_absolute_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.help.models.HelpEntry.get_absolute_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to view details for
this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘character-detail’ would be referenced by this method.</p>
<emclass="property">property </em><codeclass="sig-name descname">help_category</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.help_category"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for getting database field <cite>db_help_category</cite>.</p>
</dd></dl>
<dlclass="attribute">
<dtid="evennia.help.models.HelpEntry.id">
<codeclass="sig-name descname">id</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.id"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dlclass="method">
<dtid="evennia.help.models.HelpEntry.key">
<emclass="property">property </em><codeclass="sig-name descname">key</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.key"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for getting database field <cite>db_key</cite>.</p>
<emclass="property">property </em><codeclass="sig-name descname">lock_storage</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.lock_storage"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for getting database field <cite>db_lock_storage</cite>.</p>
</dd></dl>
<dlclass="attribute">
<dtid="evennia.help.models.HelpEntry.locks">
<codeclass="sig-name descname">locks</code><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.locks"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.locks"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="evennia.help.models.HelpEntry.objects">
<codeclass="sig-name descname">objects</code><emclass="property"> = <evennia.help.manager.HelpEntryManager object></em><aclass="headerlink"href="#evennia.help.models.HelpEntry.objects"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="evennia.help.models.HelpEntry.path">
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.help.models.HelpEntry'</em><aclass="headerlink"href="#evennia.help.models.HelpEntry.path"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">search_index_entry</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd><p>Property for easily retaining a search index entry for this object.</p>
</dd></dl>
<dlclass="method">
<dtid="evennia.help.models.HelpEntry.staff_only">
<emclass="property">property </em><codeclass="sig-name descname">staff_only</code><aclass="headerlink"href="#evennia.help.models.HelpEntry.staff_only"title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for getting database field <cite>db_staff_only</cite>.</p>
</dd></dl>
<dlclass="attribute">
<dtid="evennia.help.models.HelpEntry.tags">
<codeclass="sig-name descname">tags</code><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.tags"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.tags"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="evennia.help.models.HelpEntry.typename">
<codeclass="sig-name descname">typename</code><emclass="property"> = 'SharedMemoryModelBase'</em><aclass="headerlink"href="#evennia.help.models.HelpEntry.typename"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">web_get_admin_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.web_get_admin_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.web_get_admin_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for the Django Admin page for this object.</p>
<emclass="property">classmethod </em><codeclass="sig-name descname">web_get_create_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.web_get_create_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.web_get_create_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to create new
instances of this object.</p>
<p>ex. Chargen = ‘/characters/create/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘character-create’ would be referenced by this method.</p>
<codeclass="sig-name descname">web_get_delete_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.web_get_delete_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.web_get_delete_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to delete this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/delete/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘character-detail’ would be referenced by this method.</p>
<codeclass="sig-name descname">web_get_detail_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.web_get_detail_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.web_get_detail_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to view details for
this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘character-detail’ would be referenced by this method.</p>
<codeclass="sig-name descname">web_get_update_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/help/models.html#HelpEntry.web_get_update_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.help.models.HelpEntry.web_get_update_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to update this
object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/change/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘character-update’ would be referenced by this method.</p>
