Difference between revisions of "Documentation wiki"

From Joomla! Documentation

(New page: The bulk of the documentation effort now revolves around this wiki. * If you are new to MediaWiki then you should consult the '''[http://meta.wikimedia.org/wiki/Help:Contents User's Guide]...)
 
m (noinclude tags)
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
The bulk of the documentation effort now revolves around this wiki.
 
The bulk of the documentation effort now revolves around this wiki.
 
* If you are new to MediaWiki then you should consult the '''[http://meta.wikimedia.org/wiki/Help:Contents User's Guide]''' for information on using the wiki software.
 
* If you are new to MediaWiki then you should consult the '''[http://meta.wikimedia.org/wiki/Help:Contents User's Guide]''' for information on using the wiki software.
* List of '''[[local wiki templates]]''' that can be used in your wiki pages.  Templates reduce repetition and are the basis of modular documentation.
+
{{JDOC:Local wiki references}}
* List of '''[[local wiki extensions]]''' that have been installed on this wiki.  Extensions provide additionally functionality to the wiki such as '''syntax highlighting''' and conditional expressions.
+
* There are some conventions for making sure the Wiki remains organized.
* List of '''[[local interwiki links]]''' that are available on this wiki.  These provide useful shortcuts to creating URLs to other websites including the Joomla! forum, help screens and issue tracker; as well as links to the [http://php.net/manual PHP documentation] or [[wikipedia:Main_Page|Wikipedia]].
+
** Try to use the [[JDOC:Image naming convention|Image naming convention]].
* requested but yet [[Special:Wantedpages|empty pages]]
+
** Try to observe the [[JDOC:Joomla! versions|convention for labelling pages with Joomla! version numbers]].
* the [[Cookie jar]] contains pages that have been categorised as being small, well-defined tasks that require minimal commitment to complete.
+
* You might want to take a look at
* [[:Category:Articles that require a review]] also awaiting a copy editor
+
** the requested but yet [[Special:Wantedpages|empty pages]]
* [[:Category:Landing Pages|Landing pages]] are pages that match important keywords used by people using search engines to find documentation.
+
** the [[JDOC:Cookie jar|Cookie jar]]: a list of pages that have been categorised as being small, well-defined tasks that require minimal commitment to complete
* Pages that define terms can be added to the [[:Category:Glossary|Glossary]] category by adding <nowiki>[[Category:Glossary]]</nowiki> at the end of the page.
+
** [[:Category:Articles that require a review]] (also awaiting a copy editor)
 +
** [[:Category:Articles for which information is required]]: you may be the one that knows certain details
 +
** [[:Category:Articles that could be improved]]: these are not ''quite'' as good as they could be
 +
** [[:Category:Landing Pages|Landing pages]]: pages that match important keywords used by people using search engines to find documentation.
 +
* Pages that define terms can be added to the [[:Category:Glossary|Glossary]], but '''not''' by adding <nowiki>[[Category:Glossary]]</nowiki> to the page. Please see [[Talk:Glossary]] for more information.
 +
<noinclude>[[Category:Documentation Working Group]]</noinclude>

Revision as of 09:04, 22 September 2012

The bulk of the documentation effort now revolves around this wiki.

  • If you are new to MediaWiki then you should consult the User's Guide for information on using the wiki software.

<translate>

  • List of <tvar name=1>local wiki templates</tvar> that can be used in your wiki pages. Templates reduce repetition and are the basis of modular documentation.

</translate> <translate>

  • List of <tvar name=1>local wiki extensions</tvar> that have been installed on this Wiki. Extensions provide additionally functionality to the Wiki such as <tvar name=2>syntax highlighting</tvar> and <tvar name=3>link search</tvar>.

</translate> <translate>

  • List of <tvar name=1>local interwiki links</tvar> that are available on this Wiki. These provide useful shortcuts to creating URLs to other websites including the Joomla forum, help screens and issue tracker, as well as links to the PHP documentation and Wikipedia.

</translate>