Difference between revisions of "Help:Editing Guidelines"

From POV-Wiki
Jump to navigation Jump to search
(Add initial editing guidelines page.)
 
m (Note change to using SyntaxHighlight extension (was ASHilight))
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
This page sets out guidelines for editing and contributing work to POV-Wiki.
 
This page sets out guidelines for editing and contributing work to POV-Wiki.
  
It is a work in progress and will be expanded as time allows. However, here are some simple guidelines to begin with:
+
* We have the [[mediawikiwiki:Extension:SyntaxHighlight|SyntaxHighlight extension]] installed. When placing SDL source code into articles, surround it with <code>&lt;source lang="pov"&gt;...&lt;/source&gt;</code> in order to have it displayed in highlighted form. Please refer to the [[mediawikiwiki:Extension:SyntaxHighlight#Parameters|parameter list]] for advanced formatting options.
 
 
 
* We have the [[mediawikiwiki:Extension:Cite/Cite.php#Usage|Cite extension]] installed. This allows references to be added to articles, which will appear in footnotes. We recommend its use when appropriate.
 
* We have the [[mediawikiwiki:Extension:Cite/Cite.php#Usage|Cite extension]] installed. This allows references to be added to articles, which will appear in footnotes. We recommend its use when appropriate.
* See [[Help:Mathematical_Symbols]] for information regarding the T<sub>E</sub>X markup available, and the T<sub>E</sub>X Box interactive formula editor.
+
* See [[Help:Mathematical_Symbols]] for information regarding the available markup.
 +
* When creating multi-page articles, please consider using [[Help:Subpages|sub-pages]] for subsidiary content.
 +
* Please keep in mind that export of wiki articles to other formats, particularly print, is desirable and thus try to avoid doing something in your article that may not be useful in another medium than HTML.
  
 
[[Category:Help|{{SUBPAGENAME}}]]
 
[[Category:Help|{{SUBPAGENAME}}]]

Latest revision as of 06:21, 11 April 2021

This page sets out guidelines for editing and contributing work to POV-Wiki.

  • We have the SyntaxHighlight extension installed. When placing SDL source code into articles, surround it with <source lang="pov">...</source> in order to have it displayed in highlighted form. Please refer to the parameter list for advanced formatting options.
  • We have the Cite extension installed. This allows references to be added to articles, which will appear in footnotes. We recommend its use when appropriate.
  • See Help:Mathematical_Symbols for information regarding the available markup.
  • When creating multi-page articles, please consider using sub-pages for subsidiary content.
  • Please keep in mind that export of wiki articles to other formats, particularly print, is desirable and thus try to avoid doing something in your article that may not be useful in another medium than HTML.