Differences

This shows you the differences between two versions of the page.

--- template.php [2013/09/12 22:49]
+++ template.php [2020/09/12 01:30] (current)
@@ Line 1: / Line 1: @@
+====== ModuleName ======
+==== Description ====
+This is a template for how to document modules in the wiki
+==== Features ====
+  * Provides wiki codes. Just fill in the blanks
+===== Commands provided =====
+^Command  ^ Keyword  ^Argument(s)   ^Description                          ^Tell      ^Guild     ^Priv      ^
+|none     |          |              |There are no command here.           |Disabled *|Disabled *|Disabled *|
+<sub>
+Notes to table:\\
+ - This isn't a module so there are no commands. :)
+</sub>
+==== Related commands ====
+  * **!document module** - Nah. Just kidding. No related commands either.
+===== Module settings =====
+^Setting       ^Default   ^Description                                              ^
+|Show template |Enabled   |This setting is just made up. Just go with it, OK?       |
+<sub>
+Notes to table:\\
+ - Jabbadijab jab
+</sub>
+===== Module colors =====
+^Scheme name   ^Default   ^
+|name_of_scheme|colorname |
+===== Notes =====
+  * The code for the template is below with more comprehencive values filled in.
+<code>
+====== 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>
+===== Module colors =====
+^Scheme name   ^Default   ^
+|name_of_scheme|colorname |
+===== Notes =====
+  * Notes to the module
+</code>