Difference between revisions of "Documentation Working Group/Websites"
From Joomla! Documentation
< Documentation Working Group
m (Marked for translation) |
|||
| Line 1: | Line 1: | ||
| + | <noinclude><languages /></noinclude> | ||
| + | |||
| + | <translate> | ||
The Documentation Working Group currently maintains the following websites: | The Documentation Working Group currently maintains the following websites: | ||
| + | </translate> | ||
| + | |||
===[http://api.joomla.org api.joomla.org]=== | ===[http://api.joomla.org 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. | 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> | ||
| + | |||
===[http://docs.joomla.org docs.joomla.org]=== | ===[http://docs.joomla.org 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 [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. | 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. | ||
| + | </translate> | ||
| + | |||
| + | <translate> | ||
| + | Those interested in the techniques will find more information [[S:MyLanguage/JDOC:Modular documentation|here]]. | ||
| + | </translate> | ||
| − | |||
===[http://help.joomla.org help.joomla.org]=== | ===[http://help.joomla.org 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. | 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. | ||
* [[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] | * [[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] | ||
| Line 12: | Line 29: | ||
* [[Creating a Joomla! 1.5 help screens SQL dump]] | * [[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. | * [http://joomlacode.org/gf/project/joomla/docman/?subdir=6 Help screens SQL dump files] for Joomla! versions up to 1.5.x. | ||
| + | </translate> | ||
| − | + | <translate> | |
[[Category:Documentation Working Group]] | [[Category:Documentation Working Group]] | ||
| + | </translate> | ||
Revision as of 09:43, 14 January 2015
The Documentation Working Group currently maintains the following websites:
api.joomla.org[edit]
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[edit]
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[edit]
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.
- Joomla! 1.5.x help screens are created on this wiki before being moved to help.joomla.org
- Joomla! 1.0.x help screens Note: These are no longer being maintained.
- Creating a Joomla! 1.5 help screens SQL dump
- Help screens SQL dump files for Joomla! versions up to 1.5.x.