Article standards and practices - Revision history

DaVince: Added some more instructions

2017-06-20T18:33:53Z

Added some more instructions

DaVince: DaVince moved page API:Article standards and practices to Article standards and practices: Not part of the API but part of wiki guidelines

2017-06-19T15:17:45Z

DaVince moved page API:Article standards and practices to Article standards and practices: Not part of the API but part of wiki guidelines

DaVince: Created page, copied from guidelines on forums

2017-06-19T15:15:46Z

Created page, copied from guidelines on forums

New page

To those who would like to contribute to the wiki and/or edit existing articles, the following is a list of finalized standards and practices for formatting an article for inclusion on the wiki. The list is subject to change (expansion, most likely) at any time as deemed necessary.

== Articles documenting Sphere functions ==

# Visit the [[API:Functions|Functions list]] and find the function you want to create/update the article for if you don't already have the link to it.
# If the article exists, simply edit the appropriate section as necessary. Follow existing editing guidelines as applicable.
# If the article does NOT exist, create it. For legacy functions, ideally the article existed previously so the [http://web.archive.org/web/*/http://www.spheredev.org/wiki/* Wayback Machine] might have the old copy; use the data from that if possible.

There is a template functemp you can use to create the function article. Enter the following at the top of the article, replacing each REPLACEME as needed:

<pre><nowiki>{{subst:functemp|preamble=REPLACEME|function=REPLACEME|object=REPLACEME|returns=REPLACEME|params=REPLACEME}}</nowiki></pre>

As a wiki template, functemp can take parameters; some are optional:

* '''preamble''' - the introductory text that will appear before the table of contents block; use this to provide a small description of what the function is used for.
* '''function''' - the name of the function being described; if this is a method of an object you will need to use the object parameter.
* '''object''' (OPTIONAL) - the name of the Sphere object to which the function is attached; must be a Sphere-specific object such as Color, Font, Image, Animation, etc; if the function is not attached to an object remove it from the generated text after the page has been saved.
* '''returns''' (OPTIONAL) - the return type of the function; if the function doesn't return an object remove it from the generated text after the page has been saved.
* '''params''' (OPTIONAL) - the parameters the function expects; if the function doesn't take parameters remove it from the generated text after the page has been saved.

There are also various "navboxes" that are meant to be transcluded in the footer of function articles. Find the navbox for the function in question and transclude it at the bottom of the article.

@@ Line 18: / Line 18: @@
 * '''returns''' (OPTIONAL) - the return type of the function; if the function doesn't return an object remove it from the generated text after the page has been saved.
 * '''params''' (OPTIONAL) - the parameters the function expects; if the function doesn't take parameters remove it from the generated text after the page has been saved.
 There are also various "navboxes" that are meant to be transcluded in the footer of function articles. Find the navbox for the function in question and transclude it at the bottom of the article.

← Older revision	Revision as of 15:17, 19 June 2017
(No difference)