Actions

Difference between revisions of "Documentation Working Group"

From Joomla! Documentation

m (fixing transclusion onlyinclude)
m (update)
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
<div style="background-color:#f9f9ff  ; margin:0; padding:8px; border:1px solid #aaccff">
+
<onlyinclude>{{:Documentation Working Group/Intro}}</onlyinclude>
<!-- This portal was created using subst:box portal skeleton  -->
+
{{browsebar|working}}__NOTOC__
+
<div style="clear:both; width:100%">
+
  
{{/box-header|<big>About the {{FULLPAGENAME}}</big>|{{FULLPAGENAME}}/Intro|}}<onlyinclude>{{:Documentation Working Group/Intro}}</onlyinclude>
+
==Joomla! Documentation Wiki==
{{/box-footer|}}
+
{{:{{FULLPAGENAME}}/Documentation Wiki}}
  
<div class="portal-column-left"> <!-- Switch to one column on narrow screens -->
+
==All Documentation Websites==
 
+
{{/box-header|Websites|{{FULLPAGENAME}}/Websites|}}
+
 
{{:{{FULLPAGENAME}}/Websites}}
 
{{:{{FULLPAGENAME}}/Websites}}
{{/box-footer|}}
 
</div>
 
  
<div class="portal-column-right">
+
==Other Public Resources==
{{/box-header|Documentation Wiki|Documentation wiki|}}
+
{{:{{FULLPAGENAME}}/Documentation Wiki}}
+
{{/box-footer|}}
+
</div>
+
<div style="clear:both; width:100%">
+
{{/box-header|Other Public Resources|{{FULLPAGENAME}}/Other Resources|}}
+
 
{{:{{FULLPAGENAME}}/Other Resources}}
 
{{:{{FULLPAGENAME}}/Other Resources}}
{{/box-footer|}}
+
 
</div>
+
 
__NOTOC__ __NOEDITSECTION__
+
</div>
+
 
[[Category:Documentation Working Group]]
 
[[Category:Documentation Working Group]]
 +
[[Category:Permanent Working Groups]]
 
[[Category:Working Groups]]
 
[[Category:Working Groups]]

Latest revision as of 15:09, 8 February 2014

Documentation all together large.jpg

The Documentation Team is Part of the Production Working Group. It is responsible for creating and maintaining all the official Joomla! documentation including that for end-users, administrators and third-party developers. We also maintain the help screens for the Joomla! releases.

The official documentation language is British/Australian. Translations of the official documentation into other languages are the responsibility of the Translations Working Group.

Contents

Joomla! Documentation Wiki

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

  • Please refer to the Docs Wiki Roadmap for a complete overview of tasks.
  • If you are new to MediaWiki then you should consult the 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.
  • 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.
  • 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 PHP documentation or Wikipedia.

All Documentation Websites

The Documentation Working Group currently maintains the following websites:

api.joomla.org

This entire site is automatically generated by the phpDocumentor package from an analysis of the Joomla! source code and making use of specially formatted comments embedded in the source code itself. It is an invaluable tool for all Joomla! developers.

docs.joomla.org

The concept behind docs.joomla.org is that it will become the central resource for developing single-source modular documentation within the Joomla! project. The idea is that we write stuff once then re-use it in a somewhat analogous way to modern OOP software development. In the future we expect that other sites, such as help.joomla.org and developer.joomla.org will contain some, or even most, of their content derived from sources here. By building a central database of document "chunks" we gain maximum benefit from the efforts of a limited number of authors and we produce "agile" documents where a single change is rapidly propagated to all the derived documents affected.

Those interested in the techniques will find more information here.

help.joomla.org

The official help site houses much of our early documentation, including that for Joomla! 1.0.x, the help screens for all Joomla! versions and the Joomla! 1.5 Installation Guide.

Other Public Resources