template.php

This is an old revision of the document!


ModuleName

This is a template for how to document modules in the wiki

  • Provides wiki codes. Just fill in the blanks
Command Keyword Argument(s) Description Tell Guild Priv
none There are no command here. Disabled *Disabled *Disabled *

Notes to table:
- This isn't a module so there are no commands. :)

  • !document module - Nah. Just kidding. No related commands either.
Setting Default Description
Show template Enabled This setting is just made up. Just go with it, OK?

Notes to table:
- Jabbadijab jab

  • The code for the template is below with more comprehencive values filled in.
====== ModuleName ======

==== Description ====

Description of what the module does


==== Features ====

  * List of features the module provides


===== Commands provided =====

^Command  ^ Keyword  ^Argument(s)   ^Description                          ^Tell      ^Guild     ^Priv      ^
|!command1|          |              |What does this command do?           |Guest     |Member    |Admin     |
|!command1|keyword   |<arg> [optarg]|Command with arguments and keyword   |Guest     |Member    |Admin     |
^Command  ^ Keyword  ^Argument(s)   ^Description                          ^Tell      ^Guild     ^Priv      ^
|!command2|          |              |Other main command for module        |Guest     |Guest     |Guest     |

<sub>
Notes to table:\\
 - Things to observe when reading the table
</sub>


==== Related commands ====

  * **!related command** - How is this command related?


===== Module settings =====

^Setting       ^Default   ^Description                                              ^
|Setting_one   |SomeValue |Now tell me what does this setting do?                   |

<sub>
Notes to table:\\
 - Things to observe when reading the table
</sub>

===== Notes =====

  * Notes to the module
  • template.php.1175437713.txt.gz
  • Last modified: 2020/09/12 01:30
  • (external edit)