Template.php

From Bebot Wiki 2
Revision as of 22:17, 16 September 2020 by B3b0tUzR (talk | contribs) (Created page with '====== ModuleName ====== ==== Description ==== This is a template for how to document modules in the wiki ==== Features ==== * Provides wiki codes. Just fill in the blanks…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
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 *|

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 ^Default ^Description ^ |Show template |Enabled |This setting is just made up. Just go with it, OK? |

Notes to table:\\

- Jabbadijab jab


Module colors

^Scheme name ^Default ^ |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 ^ 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 |

Notes to table:\\

- Things to observe when reading the table


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? |

Notes to table:\\

- Things to observe when reading the table

Module colors

^Scheme name ^Default ^ |name_of_scheme|colorname |


Notes
 * Notes to the module