Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Start adding new help documentation

Browse source
This commit is contained in:
Griatch 2021-05-10 00:12:36 +02:00
parent 7e2a446bda
commit ebcff51932
7 changed files with 290 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

8
evennia/help/filehelp.py
View file

@ -13,7 +13,7 @@ Each help-entry dict is on the form
::
{'key': <str>,
'category': <str>, # optional, otherwise settings.FILE_DEFAULT_HELP_CATEGORY
'category': <str>, # optional, otherwise settings.DEFAULT_HELP_CATEGORY
'aliases': <list>, # optional
'text': <str>}``
@ -23,7 +23,7 @@ same form as other help entry-texts and contain ``# subtopics`` as normal.
New help-entry modules are added to the system by providing the python-path to
the module to `settings.FILE_HELP_ENTRY_MODULES`. Note that if same-key entries are
added, entries in latter modules will override that of earlier ones. Use
``settings.FILE_DEFAULT_HELP_CATEGORY`` to customize what category is used if
``settings.DEFAULT_HELP_CATEGORY`` to customize what category is used if
not set explicitly.
An example of the contents of a module:
@ -69,6 +69,8 @@ from evennia.utils.utils import (
variable_from_module, make_iter, all_from_module)
from evennia.utils import logger
_DEFAULT_HELP_CATEGORY = settings.DEFAULT_HELP_CATEGORY
@dataclass
class FileHelpEntry:
@ -144,7 +146,7 @@ class FileHelpStorageHandler:
for dct in loaded_help_dicts:
key = dct.get('key').lower().strip()
category = dct.get('category', settings.FILE_DEFAULT_HELP_CATEGORY).strip()
category = dct.get('category', _DEFAULT_HELP_CATEGORY).strip()
aliases = list(dct.get('aliases', []))
entrytext = dct.get('text')