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 | ||
+ | |none | ||
+ | |||
+ | <sub> | ||
+ | Notes to table:\\ | ||
+ | - This isn't a module so there are no commands. :) | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Related commands ==== | ||
+ | |||
+ | * **!document module** - Nah. Just kidding. No related commands either. | ||
+ | |||
+ | |||
+ | ===== Module settings ===== | ||
+ | |||
+ | ^Setting | ||
+ | |Show template |Enabled | ||
+ | |||
+ | <sub> | ||
+ | Notes to table:\\ | ||
+ | - Jabbadijab jab | ||
+ | </ | ||
+ | |||
+ | |||
+ | ===== Module colors ===== | ||
+ | |||
+ | ^Scheme name | ||
+ | |name_of_scheme|colorname | | ||
+ | |||
+ | |||
+ | ===== Notes ===== | ||
+ | |||
+ | * 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 | ||
+ | |!command1| | ||
+ | |!command1|keyword | ||
+ | ^Command | ||
+ | |!command2| | ||
+ | |||
+ | <sub> | ||
+ | Notes to table:\\ | ||
+ | - Things to observe when reading the table | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Related commands ==== | ||
+ | |||
+ | * **!related command** - How is this command related? | ||
+ | |||
+ | |||
+ | ===== Module settings ===== | ||
+ | |||
+ | ^Setting | ||
+ | |Setting_one | ||
+ | |||
+ | <sub> | ||
+ | Notes to table:\\ | ||
+ | - Things to observe when reading the table | ||
+ | </ | ||
+ | |||
+ | ===== Module colors ===== | ||
+ | |||
+ | ^Scheme name | ||
+ | |name_of_scheme|colorname | | ||
+ | |||
+ | |||
+ | ===== Notes ===== | ||
+ | |||
+ | * Notes to the module | ||
+ | </ |