Revision as of 13:21, 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.