mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 05:46:31 +01:00
287 lines
No EOL
18 KiB
HTML
287 lines
No EOL
18 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
<title>evennia.web.admin.help — Evennia 3.x documentation</title>
|
|
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|
<script src="../_static/jquery.js"></script>
|
|
<script src="../_static/underscore.js"></script>
|
|
<script src="../_static/doctools.js"></script>
|
|
<script src="../_static/language_data.js"></script>
|
|
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
<link rel="next" title="evennia.web.admin.objects" href="evennia.web.admin.objects.html" />
|
|
<link rel="prev" title="evennia.web.admin.frontpage" href="evennia.web.admin.frontpage.html" />
|
|
</head><body>
|
|
|
|
|
|
<div class="admonition important">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
|
|
</div>
|
|
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="evennia.web.admin.objects.html" title="evennia.web.admin.objects"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="evennia.web.admin.frontpage.html" title="evennia.web.admin.frontpage"
|
|
accesskey="P">previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 3.x</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-4"><a href="evennia.web.html" >evennia.web</a> »</li>
|
|
<li class="nav-item nav-item-5"><a href="evennia.web.admin.html" accesskey="U">evennia.web.admin</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.help</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
|
|
<div class="documentwrapper">
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<p class="logo"><a href="../index.html">
|
|
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
|
</a></p>
|
|
<div id="searchbox" style="display: none" role="search">
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="../search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>$('#searchbox').show(0);</script>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="evennia.web.admin.frontpage.html"
|
|
title="previous chapter">evennia.web.admin.frontpage</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="evennia.web.admin.objects.html"
|
|
title="next chapter">evennia.web.admin.objects</a></p>
|
|
<div role="note" aria-label="source link">
|
|
<!--h3>This Page</h3-->
|
|
<ul class="this-page-menu">
|
|
<li><a href="../_sources/api/evennia.web.admin.help.md.txt"
|
|
rel="nofollow">Show Page Source</a></li>
|
|
</ul>
|
|
</div><h3>Links</h3>
|
|
<ul>
|
|
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
|
|
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
|
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
|
|
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
|
<li>
|
|
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
|
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
|
<a href="https://evennia.blogspot.com/">Blog</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<section id="module-evennia.web.admin.help">
|
|
<span id="evennia-web-admin-help"></span><h1>evennia.web.admin.help<a class="headerlink" href="#module-evennia.web.admin.help" title="Permalink to this headline">¶</a></h1>
|
|
<p>This defines how to edit help entries in Admin.</p>
|
|
<dl class="py class">
|
|
<dt id="evennia.web.admin.help.HelpTagInline">
|
|
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.help.</code><code class="sig-name descname">HelpTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/help.html#HelpTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.help.HelpTagInline" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.tags.html#evennia.web.admin.tags.TagInline" title="evennia.web.admin.tags.TagInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.tags.TagInline</span></code></a></p>
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpTagInline.model">
|
|
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.help.HelpTagInline.model" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.help.models.HelpEntry_db_tags</span></code></p>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpTagInline.related_field">
|
|
<code class="sig-name descname">related_field</code><em class="property"> = 'helpentry'</em><a class="headerlink" href="#evennia.web.admin.help.HelpTagInline.related_field" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="evennia.web.admin.help.HelpTagInline.media">
|
|
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.help.HelpTagInline.media" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt id="evennia.web.admin.help.HelpEntryForm">
|
|
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.help.</code><code class="sig-name descname">HelpEntryForm</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">files=None</em>, <em class="sig-param">auto_id='id_%s'</em>, <em class="sig-param">prefix=None</em>, <em class="sig-param">initial=None</em>, <em class="sig-param">error_class=<class 'django.forms.utils.ErrorList'></em>, <em class="sig-param">label_suffix=None</em>, <em class="sig-param">empty_permitted=False</em>, <em class="sig-param">instance=None</em>, <em class="sig-param">use_required_attribute=None</em>, <em class="sig-param">renderer=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/help.html#HelpEntryForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.forms.models.ModelForm</span></code></p>
|
|
<p>Defines how to display the help entry</p>
|
|
<dl class="py class">
|
|
<dt id="evennia.web.admin.help.HelpEntryForm.Meta">
|
|
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/help.html#HelpEntryForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm.Meta" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryForm.Meta.model">
|
|
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm.Meta.model" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>alias of <a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry" title="evennia.help.models.HelpEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.help.models.HelpEntry</span></code></a></p>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryForm.Meta.fields">
|
|
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryForm.base_fields">
|
|
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_entrytext': <django.forms.fields.CharField object>, 'db_help_category': <django.forms.fields.CharField object>, 'db_key': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>, 'db_tags': <django.forms.models.ModelMultipleChoiceField object>}</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm.base_fields" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryForm.declared_fields">
|
|
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_help_category': <django.forms.fields.CharField object>, 'db_lock_storage': <django.forms.fields.CharField object>}</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm.declared_fields" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="evennia.web.admin.help.HelpEntryForm.media">
|
|
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.help.HelpEntryForm.media" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Return all media required to render the widgets on this form.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin">
|
|
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.help.</code><code class="sig-name descname">HelpEntryAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/help.html#HelpEntryAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.admin.options.ModelAdmin</span></code></p>
|
|
<p>Sets up the admin manaager for help entries</p>
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.inlines">
|
|
<code class="sig-name descname">inlines</code><em class="property"> = [<class 'evennia.web.admin.help.HelpTagInline'>]</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.inlines" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.list_display">
|
|
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_key', 'db_help_category', 'db_lock_storage', 'db_date_created')</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.list_display" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.list_display_links">
|
|
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'db_key')</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.search_fields">
|
|
<code class="sig-name descname">search_fields</code><em class="property"> = ['^db_key', 'db_entrytext']</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.ordering">
|
|
<code class="sig-name descname">ordering</code><em class="property"> = ['db_help_category', 'db_key']</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.ordering" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.list_filter">
|
|
<code class="sig-name descname">list_filter</code><em class="property"> = ['db_help_category']</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.list_filter" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.save_as">
|
|
<code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.save_as" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.save_on_top">
|
|
<code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.list_select_related">
|
|
<code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.view_on_site">
|
|
<code class="sig-name descname">view_on_site</code><em class="property"> = False</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.view_on_site" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.form">
|
|
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.form" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.help.HelpEntryForm" title="evennia.web.admin.help.HelpEntryForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">HelpEntryForm</span></code></a></p>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.fieldsets">
|
|
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_help_category'), 'db_entrytext', 'db_lock_storage')}),)</em><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="evennia.web.admin.help.HelpEntryAdmin.media">
|
|
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.help.HelpEntryAdmin.media" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="evennia.web.admin.objects.html" title="evennia.web.admin.objects"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="evennia.web.admin.frontpage.html" title="evennia.web.admin.frontpage"
|
|
>previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 3.x</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-4"><a href="evennia.web.html" >evennia.web</a> »</li>
|
|
<li class="nav-item nav-item-5"><a href="evennia.web.admin.html" >evennia.web.admin</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.help</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div class="admonition important">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
|
|
</div>
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2023, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
|
</div>
|
|
</body>
|
|
</html> |