کارگروه مستندسازی

From Joomla! Documentation

This page is a translated version of the page Documentation Working Group and the translation is 33% complete.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎español • ‎français • ‎italiano • ‎português do Brasil • ‎русский • ‎فارسی • ‎日本語

Documentation Working Group/Intro/fa

ویکی مستندات جوملا!

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

Internal References

  • 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 link search.
  • 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 and 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. 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.

Other Public Resources