Contribution convention - Revision history

SarahK at 20:53, 14 October 2021

2021-10-14T20:53:59Z

SarahK at 20:52, 14 October 2021

2021-10-14T20:52:55Z

EcwNick at 18:26, 13 March 2008

2008-03-13T18:26:10Z

EcwNick at 18:21, 13 March 2008

2008-03-13T18:21:30Z

EcwNick: /* After creation */

2008-03-13T18:20:25Z

‎After creation

EcwNick: /* Optional parameters */

2008-03-13T13:52:19Z

‎Optional parameters

EcwNick: /* Optional parameters */

2008-03-13T13:51:53Z

‎Optional parameters

EcwNick: /* Optional parameters */

2008-03-13T13:50:20Z

‎Optional parameters

EcwNick at 13:47, 13 March 2008

2008-03-13T13:47:04Z

EcwNick: /* Page content */

2008-03-13T13:40:50Z

‎Page content

@@ Line 61: / Line 61: @@
   | nofeatures = yes
-:Add this if you don't want to display a list of features. ''E.G. [[User:Matt|Matt]]'s [[Contribution:Banned Emails|Banned Emails]] addon.''
+:Add this if you don't want to display a list of features. <nowiki>''E.G. [[User:Matt|Matt]]'s [[Contribution:Banned Emails|Banned Emails]] addon.''</nowiki>
   | nochangelog = yes
-:Add this if you don't want to maintain a project changelog. ''E.G. [[User:Matt|Matt]]'s [[Contribution:Banned Emails|Banned Emails]] addon.''
+:Add this if you don't want to maintain a project changelog. <nowiki>''E.G. [[User:Matt|Matt]]'s [[Contribution:Banned Emails|Banned Emails]] addon.''</nowiki>

@@ Line 7: / Line 7: @@
 Contribution:ModificationName
-I.E. If you're the creator of 'MyAwesomeModule', head along: [[Contribution:MyAwesomeModule]]!
+I.E. If you're the creator of 'MyAwesomeModule', head along: <nowiki>[[Contribution:MyAwesomeModule]]</nowiki>!
 == Page content ==

@@ Line 1: / Line 1: @@
 So, you want to release and document your WHMCS module/modification/enhancement/template on the wiki? Follow these guidelines to get up and running and ''thank you'' for sharing!
 __TOC__
 == Naming your page ==

@@ Line 1: / Line 1: @@
-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 and ''thank you'' for sharing!
 __TOC__
 == Naming your page ==
 Your new page should be named accordingly:

@@ Line 81: / Line 81: @@
 * Contribution:MyAwesomeModule/Changelog
 * Contribution:MyAwesomeModule/Code
 {{contribs}}

@@ Line 70: / Line 70: @@
   | code = yes
 :Add this to display the necessary code changes to make to install this contribution instead of showing download links. Code changes are stored in sub-pages (see below).
-:Note: If you supply download links they will be squashed by this option)
+:Note: If you supply download links they will be squashed by this option
 == After creation ==

@@ Line 1: / Line 1: @@
 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 ==
@@ Line 53: / Line 54: @@
   | zip = <nowiki>http://mydomain/link/to/download.zip</nowiki>
   | targz = <nowiki>http://mydomain/link/to/download.tar.gz</nowiki>
-:Specify the URL to download your modification from as either a .tar.gz or .zip file. You may use both formats, or either (See below if you don't want to use downloads). If your download is neither format or you want to link to a different page, use 'link' and 'linkname' instead:
+:Specify the URL to download your modification from as either a .tar.gz or .zip file. You may use both formats, or either (See [[#Optional parameters|Optional parameters]] below if you don't want to use downloads). If your download is neither format or you want to link to a different page, use 'link' and 'linkname' instead:
   | link = <nowiki>http://link/to/another/site/</nowiki>
   | linkname = Download here
   | code = yes
-:This will instead allow you to insert code changes onto the page. (More information below)
+:Add this to display the necessary code changes to make to install this contribution instead of showing download links. Code changes are stored in sub-pages (see below).
 == After creation ==

@@ Line 22: / Line 22: @@
   <nowiki>}}</nowiki>
-Your new page will be automatically formatted and added to the appropriate categories. Step-by-step:
+This calls the [[Template:Contribution|contribution template]] with various options, meaning your new page will be automatically formatted and added to the appropriate categories.
   <nowiki>{{Contribution|</nowiki>
-This line should be left as it is
+:This line should be left as it is - this is the name of the template being called.
   | name = MyAwesomeModule
-Your module's name
+:Your module's name
   | author = Your name / wiki username
-Take credit for your work!
+:Take credit for your work! If you are registered on the wiki use your username - it will then automatically link to your userpage. Contributions will be automatically added to the category ''Category:Contributions/Authorname'' (which will also be linked to on the contribution's page).
@@ Line 38: / Line 40: @@
   | 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.
+: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.
+:Let people know exactly what your modification does. Don't go mad, you can add a features section later, this should just be a short intro.
   | version = Current version number
-.0 is a good starting place.
+:1.0 is always a good starting place.
   | zip = <nowiki>http://mydomain/link/to/download.zip</nowiki>
   | targz = <nowiki>http://mydomain/link/to/download.tar.gz</nowiki>
-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:
+:Specify the URL to download your modification from as either a .tar.gz or .zip file. You may use both formats, or either (See below if you don't want to use downloads). If your download is neither format or you want to link to a different page, use 'link' and 'linkname' instead:
   | link = <nowiki>http://link/to/another/site/</nowiki>
   | linkname = Download here
@@ Line 58: / Line 60: @@
 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.
+:This will instead allow you to insert code changes onto the page. (More information below)
 == After creation ==