Documentation Working Group/Websites/en: Difference between revisions
From Joomla! Documentation
Importing a new version from external source |
Updating to match new version of source page |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 9: | Line 9: | ||
===[http://docs.joomla.org docs.joomla.org]=== | ===[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 | 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. 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 [[S:MyLanguage/JDOC:Modular documentation|here]]. | Those interested in the techniques will find more information [[S:MyLanguage/JDOC:Modular documentation|here]]. | ||
Those of you, who are not very experienced in image editing and might want to improve the quality of their screenshots should read the tutorial [[S:MyLanguage/Taking_Screenshots_–_How_To_Enhance|Taking Screenshots – How To Enhance]]. | |||
[[S:MyLanguage/Help screens|Joomla! help screens]] are created on this wiki and are shown in the backend of any Joomla! website from here. | |||
[[Category:Documentation Working Group]] | [[Category:Documentation Working Group]] | ||
Latest revision as of 14:50, 19 July 2021
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. 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.
Those of you, who are not very experienced in image editing and might want to improve the quality of their screenshots should read the tutorial Taking Screenshots – How To Enhance.
Joomla! help screens are created on this wiki and are shown in the backend of any Joomla! website from here.