Help system: Difference between revisions

From Joomla! Documentation

Chris Davenport (talk | contribs)
Email Confirmed
4,043 edits
New page: This document describes the help system as implemented in Joomla 1.6 onwards. The help system in previous versions of Joomla was not the same and was considerably less versatile. In part...
 
Cmb (talk | contribs)
956 edits
Several markup and capitalization changes.
 
(23 intermediate revisions by 10 users not shown)
Line 1: Line 1:
This document describes the help system as implemented in Joomla 1.6 onwards.  The help system in previous versions of Joomla was not the same and was considerably less versatile. In particular, help servers were restricted to being Joomla instances.  The help system in Joomla 1.5 and earlier versions is documented elsewhere.
<noinclude><languages /></noinclude>
<translate><!--T:2-->
After a brief introduction to the Joomla Help system, this document describes how the Help system works, which is something of general interest although written primarily for the benefit of site integrators who must customise Joomla installations. It then proceeds to describe how to set up your own Help server, which is something that will be of interest to translators wanting to localise Help screens and to third-party developers wanting to provide integrated Help for their extensions. Finally, a more detailed description of how to add Help support to Joomla extensions is aimed at developers.</translate>


After a brief introduction to the Joomla help system, this document begins by describing how the help system works, which is something of general interest although written primarily for the benefit of site integrators who must customise Joomla installations. It then proceeds to describe how to set up your own help server, which is something that will be of interest to translators wanting to localise help screens and to third-party developers wanting to provide integrated help from their extensions.  Finally, a more detailed description of how to add help support to Joomla extensions is aimed at developers.
<translate>
==Introduction to the Joomla Help System== <!--T:3-->
</translate>
<onlyinclude>
<translate><!--T:4-->
The Joomla Help system provides context-sensitive information to users logged into the Joomla Administrator. Generally Help information is accessed by clicking on the ''Help'' toolbar button located at the top right of almost all screens (Note that the toolbar button may be located elsewhere if you are not using one of the Administrator templates shipped with Joomla). Clicking on this toolbar button will open a new browser window with information relevant to the screen on which it was clicked.</translate>


==Introduction to the Joomla help system==
<translate><!--T:5-->
A typical toolbar with a Help button looks like:</translate>


The Joomla help system provides context-sensitive information to users logged in to the Joomla Administrator. Generally help information is accessed by clicking on the help toolbar button located at the top right of almost all screens (Note that the toolbar button may be located elsewhere if you are not using one of the administrator templates shipped with Joomla).  Clicking on this toolbar button will open a new browser window with information relevant to the screen on which it was clicked.
[[Image:Help16-Global.Config Toolbar-<translate><!--T:22-->
en</translate>.png]]</onlyinclude>


A typical toolbar with a help button looks like this:
<translate><!--T:6-->
In addition, by clicking on the {{rarr|Help,Joomla Help,''<menu item>''}}, a list of Help topics will be displayed. Clicking on any of these topic titles will bring up relevant information on the same page.</translate>


[[Image:Help16-Global.Config Toolbar.png]]
<translate><!--T:7-->
The Help system can access information stored locally as part of the Joomla installation, or from a remote Help server. It is fully multilingual and can be localised using one of the official translations, or by providing your own Help information using a separately hosted Help server. Third-party extension developers can integrate Help information for components that they supply, either from the local component file structure, or from a remote Help server. Furthermore, site integrators can override any or all Help screens to fully customise a particular Joomla installation.</translate>


In addition, by clicking on the Help -> Joomla Help menu item, a list of help topics will be displayed.  Clicking on any of these topic titles will bring up relevant information on the same page.
<translate>=== Read More About === <!--T:8-->
* [[S:MyLanguage/Help system/How the help system works|how the Help system works]].</translate>
<translate><!--T:9-->
* [[S:MyLanguage/Help system/Help servers|setting up your own Help server]].</translate>
<translate><!--T:10-->
* [[S:MyLanguage/Help system/Local help files|using local Help files]].</translate>
<translate><!--T:11-->
* [[S:MyLanguage/Help system/Translation and localisation|translating and localising Help screens]].</translate>
<translate><!--T:12-->
* [[S:MyLanguage/Help system/Administrator help area|how the administrator Help area works]].</translate>
<translate><!--T:13-->
* [[S:MyLanguage/Help system/Adding a help button to the toolbar|adding Help support to Joomla extensions]].</translate>


The help system can access information stored locally as part of the Joomla installation, or from a remote help server. It is fully multi-lingual and can be localised using one of the official translations, or by providing your own help information using a separately hosted help server. Third-party extension developers can integrate help information for components that they supply, either from the local component file structure, or from a remote help server. Furthermore, site integrators can override any or all help screens to fully customise a particular Joomla installation.
<translate>
==See Also== <!--T:14-->
</translate>
<translate><!--T:15-->
* [[S:MyLanguage/Help system/Helpsites XML format|Format of the Helpsites XML file]].</translate>
<translate><!--T:16-->
* [[S:MyLanguage/Help system/Substitution codes|Substitution codes]] for use in Help screen URLs.</translate>
<translate>
<!--T:23-->
* [[S:MyLanguage/Help4.x:Help_screens|Table of Help screens for Joomla 4.x]] {{JVer|4.x}}</translate>
<translate><!--T:17-->
* [[S:MyLanguage/Help31:Help screens|Table of Help screens for Joomla 3.x]] {{JVer|3.x}}</translate>
<translate><!--T:20-->
* [[S:MyLanguage/Using_chunks_in_Joomla_help_screens|Using chunks in Joomla Help screens]] {{JVer|3.x}}</translate>


* Read more about [[Help system/How the help system works|how the help system works]].
<noinclude>
* Read more about [[Help system/Help servers|setting up your own help server]].
[[Category:Tutorials{{#translation:}}]]
* Read more about [[Help system/Local help files|using local help files]].
[[Category:Joomla! Website Management{{#translation:}}]]
* Read more about [[Help system/Translation and localisation|translating and localising help screens]].
[[Category:Joomla! Help System{{#translation:}}]]
* Read more about [[Help system/Administrator help area|how the administrator help area works]].
</noinclude>
* Read more about [[Help system/Adding a help button to the toolbar|adding help support to Joomla extensions]].
 
==See also==
* [[Help system/Substitution codes|Substitution codes]] for use in help screen URLs.
* [[Help15:Help screens|Table of help screens for Joomla 1.5]] {{JVer|1.5}}
* [[Help16:Help screens|Table of help screens for Joomla 1.6]] {{JVer|1.6}}
 
[[Category:Tutorials]]

Latest revision as of 21:56, 25 November 2022

Other languages:

After a brief introduction to the Joomla Help system, this document describes how the Help system works, which is something of general interest although written primarily for the benefit of site integrators who must customise Joomla installations. It then proceeds to describe how to set up your own Help server, which is something that will be of interest to translators wanting to localise Help screens and to third-party developers wanting to provide integrated Help for their extensions. Finally, a more detailed description of how to add Help support to Joomla extensions is aimed at developers.

Introduction to the Joomla Help System

The Joomla Help system provides context-sensitive information to users logged into the Joomla Administrator. Generally Help information is accessed by clicking on the Help toolbar button located at the top right of almost all screens (Note that the toolbar button may be located elsewhere if you are not using one of the Administrator templates shipped with Joomla). Clicking on this toolbar button will open a new browser window with information relevant to the screen on which it was clicked.

A typical toolbar with a Help button looks like:

In addition, by clicking on the Help → Joomla Help → <menu item>, a list of Help topics will be displayed. Clicking on any of these topic titles will bring up relevant information on the same page.

The Help system can access information stored locally as part of the Joomla installation, or from a remote Help server. It is fully multilingual and can be localised using one of the official translations, or by providing your own Help information using a separately hosted Help server. Third-party extension developers can integrate Help information for components that they supply, either from the local component file structure, or from a remote Help server. Furthermore, site integrators can override any or all Help screens to fully customise a particular Joomla installation.

Read More About

See Also

Retrieved from "https://docs.sandbox.joomla.org/index.php?title=Help_system&oldid=995403"