Actions

Difference between revisions of "Documentation Working Group"

From Joomla! Documentation

(Other public resources)
m (new page format and layout, tying working groups together)
Line 1: Line 1:
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.
+
<div style="background-color:#f9f9ff  ; margin:0; padding:8px; border:1px solid #aaccff">
 +
<!-- This portal was created using subst:box portal skeleton -->
 +
{{browsebar|working}}__NOTOC__
 +
<div style="clear:both; width:100%">
  
The official documentation language is British/Australian.  Translations of the official documentation into other languages are the responsibility of the [[Translations Working Group]].
+
{{/box-header|<big>About the {{FULLPAGENAME}}</big>|{{FULLPAGENAME}}/Intro|}}
 +
{{:{{FULLPAGENAME}}/Intro}}
 +
{{/box-footer|}}
  
==Websites==
+
<div class="portal-column-left"> <!-- Switch to one column on narrow screens -->
The Documentation Working Group currently maintains the following websites:
+
===[http://api.joomla.org 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.
+
===[http://docs.joomla.org 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 [http://help.joomla.org help.joomla.org] and [http://developer.joomla.org 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 [[JDOC:Modular documentation|here]].
+
{{/box-header|Websites|{{FULLPAGENAME}}/Websites|}}
===[http://help.joomla.org help.joomla.org]===
+
{{:{{FULLPAGENAME}}/Websites}}
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.
+
{{/box-footer|}}
* [[Help screens|Joomla! 1.5.x help screens]] are created on this wiki before being moved to [http://help.joomla.org/content/section/42/278/ help.joomla.org]
+
</div>
* [http://help.joomla.org/content/section/16/276/ Joomla! 1.0.x help screens]  Note: These are no longer being maintained.
+
* [[Creating a Joomla! 1.5 help screens SQL dump]]
+
* [http://joomlacode.org/gf/project/joomla/docman/?subdir=6 Help screens SQL dump files] for Joomla! versions up to 1.5.x.
+
  
==Documentation wiki==
+
<div class="portal-column-right">
{{:Documentation wiki}}
+
{{/box-header|Documentation Wiki|Documentation wiki|}}
==Other public resources==
+
{{:{{FULLPAGENAME}}/Documentation Wiki}}
* [http://community.joomla.org/contributors/documentors.html Documentation Working Group blog]
+
{{/box-footer|}}
* [[jforum:303|Public discussion forum]]
+
</div>
* [http://dev.joomla.org/component/option,com_jd-wiki/Itemid,32/ Developer wiki] Note: All useful material has now been moved from this wiki to here.
+
<div style="clear:both; width:100%">
* [http://groups.google.com/group/joomla-docs Documentation Working Group mailing list]
+
{{/box-header|Other Public Resources|{{FULLPAGENAME}}/Other Resources|}}
* [http://groups.google.com/group/joomla-devel-docs Developer documentation mailing list]
+
{{:{{FULLPAGENAME}}/Other Resources}}
* [[Project:MediaWiki setup notes|MediaWiki setup notes]]
+
{{/box-footer|}}
* [http://forum.joomla.org/viewtopic.php?f=502&t=268156 Help screens white paper proposal] for Joomla! 1.6 onwards
+
</div>
* [[Documentors]] profile in this wiki.
+
__NOTOC__ __NOEDITSECTION__
* [[Translations]] Unofficial translations of the official documentation, in hope of easing the review process.
+
</div>
 
[[Category:Documentation Working Group]]
 
[[Category:Documentation Working Group]]
 
[[Category:Working Groups]]
 
[[Category:Working Groups]]

Revision as of 20:50, 20 September 2012

All Production Working Groups - Documentation · Bug Squad · JavaScript · Search · Translations

About the Documentation Working Group


Documentation all together large.jpg

<translate> 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. </translate>

<translate> The official documentation language is British English. Translations of the official documentation into other languages are the responsibility of the Documentation Translation Team (JDT). </translate>

<translate> </translate>

Websites


<translate> The Documentation Working Group currently maintains the following websites: </translate>

api.joomla.org

<translate> 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. </translate>

docs.joomla.org

<translate> 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. </translate>

<translate> Those interested in the techniques will find more information here. </translate>

help.joomla.org

<translate> 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.

</translate>

<translate> </translate>

Documentation Wiki


{{:Documentation wiki/<translate> en</translate>}}

<translate></translate>

Other Public Resources


<translate>

</translate>

<translate> </translate>