Difference between revisions of "Contribution convention"
| Line 2: | Line 2: | ||
So, you want to release and document your WHMCS module/modification/enhancement/template on the wiki? Follow these guidelines to get up and running. | So, you want to release and document your WHMCS module/modification/enhancement/template on the wiki? Follow these guidelines to get up and running. | ||
| − | + | == Naming your page == | |
Your new page should be named accordingly: | Your new page should be named accordingly: | ||
Contribution:ModificationName | Contribution:ModificationName | ||
| Line 8: | Line 8: | ||
I.E. If you're the creator of 'MyAwesomeModule', head along: [[Contribution:MyAwesomeModule]]! | I.E. If you're the creator of 'MyAwesomeModule', head along: [[Contribution:MyAwesomeModule]]! | ||
| − | + | == Page content == | |
Once you're there place the following on your new page: | Once you're there place the following on your new page: | ||
<nowiki>{{Contribution|</nowiki> | <nowiki>{{Contribution|</nowiki> | ||
| Line 54: | Line 54: | ||
| link = <nowiki>http://link/to/another/site/</nowiki> | | link = <nowiki>http://link/to/another/site/</nowiki> | ||
| linkname = Download here | | linkname = Download here | ||
| + | |||
If your modification is just a small one and doesn't require a download don't supply download links, instead use this parameter: | If your modification is just a small one and doesn't require a download don't supply download links, instead use this parameter: | ||
| code = yes | | code = yes | ||
This will instead allow you to insert code changes onto the page. | This will instead allow you to insert code changes onto the page. | ||
| + | |||
| + | == After creation == | ||
| + | After you click '''save''' you'll be presented with your contribution's page. As the description option above should only be a short introduction you can create a ''features sub-page'' for listing all that your contribution has to offer which will be automatically included in the appropriate place on the module page. A second sub-page can also be used to maintain a changelog. A link to both of these sub-pages are automatically included on your contribution's page, this link will disappear to be replaced with the page's content when the page exists. | ||
| + | |||
| + | The sub-page names take the form of: '''Contribution:MyAwesomeModule/Features''' and ''Contribution:MyAwesomeModule/Changelog''' | ||
{{contribs}} | {{contribs}} | ||
Revision as of 13:31, 13 March 2008
So, you want to release and document your WHMCS module/modification/enhancement/template on the wiki? Follow these guidelines to get up and running.
Naming your page
Your new page should be named accordingly: Contribution:ModificationName
I.E. If you're the creator of 'MyAwesomeModule', head along: Contribution:MyAwesomeModule!
Page content
Once you're there place the following on your new page:
{{Contribution|
| name = MyAwesomeModule
| author = Your name / wiki username
| admin = yes
| user = yes
| theme = yes
| desc = A short summary of your project
| version = Current version number
| zip = http://mydomain/link/to/download.zip
| targz = http://mydomain/link/to/download.tar.gz
}}
Your new page will be automatically formatted and added to the appropriate categories. Step-by-step:
{{Contribution|
This line should be left as it is
| name = MyAwesomeModule
Your module's name
| author = Your name / wiki username
Take credit for your work!
| admin = yes | user = yes | theme = yes
These specify the type of modification. Admin-side, user-side or a new theme/template. Remove all those that don't apply to your contribution. Your page will be automatically categorised based upon these lines.
| desc = A short summary of your project
Let people know exactly what your modification does.
| version = Current version number
1.0 is a good starting place.
| zip = http://mydomain/link/to/download.zip | targz = http://mydomain/link/to/download.tar.gz
Use both, or either. Specify the URL to download your modification from as either a .tar.gz or .zip file. If your download is neither format or you want to link to a different page, use 'link' and 'linkname' instead:
| link = http://link/to/another/site/ | linkname = Download here
If your modification is just a small one and doesn't require a download don't supply download links, instead use this parameter:
| code = yes
This will instead allow you to insert code changes onto the page.
After creation
After you click save you'll be presented with your contribution's page. As the description option above should only be a short introduction you can create a features sub-page for listing all that your contribution has to offer which will be automatically included in the appropriate place on the module page. A second sub-page can also be used to maintain a changelog. A link to both of these sub-pages are automatically included on your contribution's page, this link will disappear to be replaced with the page's content when the page exists.
The sub-page names take the form of: Contribution:MyAwesomeModule/Features' and Contribution:MyAwesomeModule/Changelog
Contribution convention
All documented contributions | Document your own contribution