Actions

Difference between revisions of "Help system"

From Joomla! Documentation

m (Added link to Joomla 3.0 help screens.)
(Marked this version for translation)
 
(8 intermediate revisions by 2 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>
 +
<noinclude>{{review||Needs to be updated for 3.x series}}</noinclude>
  
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 installationsIt 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 extensionsFinally, a more detailed description of how to add help support to Joomla extensions is aimed at developers.
+
<translate><!--T:1-->
 +
This document describes the help system as implemented in Joomla 2.5 onwardsThe help system in previous versions of Joomla was not the same and was considerably less versatileIn particular, help servers were restricted to being Joomla instances.  The help system in Joomla 1.5 and earlier versions is documented elsewhere.</translate>
  
==Introduction to the Joomla help system==
+
<translate><!--T:2-->
 +
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>
 +
 
 +
<translate>
 +
==Introduction to the Joomla help system== <!--T:3-->
 +
</translate>
 
<onlyinclude>
 
<onlyinclude>
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.
+
<translate><!--T:4-->
 +
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.</translate>
  
A typical toolbar with a help button looks like this:
+
<translate><!--T:5-->
 +
A typical toolbar with a help button looks like this:</translate>
  
[[Image:Help16-Global.Config Toolbar.png]]</onlyinclude>
+
[[Image:Help16-Global.Config Toolbar-<translate><!--T:22-->
 +
en</translate>.png]]</onlyinclude>
  
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><!--T:6-->
 +
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>
  
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><!--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 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>
  
* Read more about [[Help system/How the help system works|how the help system works]].
+
<translate><!--T:8-->
* Read more about [[Help system/Help servers|setting up your own help server]].
+
* Read more about [[S:MyLanguage/Help system/How the help system works|how the help system works]].</translate>
* Read more about [[Help system/Local help files|using local help files]].
+
<translate><!--T:9-->
* Read more about [[Help system/Translation and localisation|translating and localising help screens]].
+
* Read more about [[S:MyLanguage/Help system/Help servers|setting up your own help server]].</translate>
* Read more about [[Help system/Administrator help area|how the administrator help area works]].
+
<translate><!--T:10-->
* Read more about [[Help system/Adding a help button to the toolbar|adding help support to Joomla extensions]].
+
* Read more about [[S:MyLanguage/Help system/Local help files|using local help files]].</translate>
 +
<translate><!--T:11-->
 +
* Read more about [[S:MyLanguage/Help system/Translation and localisation|translating and localising help screens]].</translate>
 +
<translate><!--T:12-->
 +
* Read more about [[S:MyLanguage/Help system/Administrator help area|how the administrator help area works]].</translate>
 +
<translate><!--T:13-->
 +
* Read more about [[S:MyLanguage/Help system/Adding a help button to the toolbar|adding help support to Joomla extensions]].</translate>
  
==See also==
+
<translate>
* [[Help system/Helpsites XML format|Format of the helpsites XML file]].
+
==See also== <!--T:14-->
* [[Help system/Substitution codes|Substitution codes]] for use in help screen URLs.
+
</translate>
* [[Help15:Help screens|Table of help screens for Joomla 1.5]] {{JVer|1.5}}
+
<translate><!--T:15-->
* [[Help16:Help screens|Table of help screens for Joomla 1.6]] {{JVer|1.6}}
+
* [[S:MyLanguage/Help system/Helpsites XML format|Format of the helpsites XML file]].</translate>
* [[Help17:Help screens|Table of help screens for Joomla 1.7]] {{JVer|1.7}}
+
<translate><!--T:16-->
* [[Help25:Help screens|Table of help screens for Joomla 2.5]] {{JVer|2.5}}
+
* [[S:MyLanguage/Help system/Substitution codes|Substitution codes]] for use in help screen URLs.</translate>
* [[Help30:Help screens|Table of help screens for Joomla 3.0]] {{JVer|3.0}}
+
<translate><!--T:17-->
* [[Using_chunks_in_Joomla_help_screens|Using chunks in Joomla help screens]] {{JVer|2.5}}
+
* [[S:MyLanguage/Help15:Help screens|Table of help screens for Joomla 1.5]] {{JVer|1.5}}</translate>
 +
<translate><!--T:18-->
 +
* [[S:MyLanguage/Help25:Help screens|Table of help screens for Joomla 2.5]] {{JVer|2.5}}</translate>
 +
<translate><!--T:19-->
 +
* [[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|2.5}}</translate>
  
 +
<noinclude>
 +
<translate>
 +
<!--T:21-->
 
[[Category:Tutorials]]
 
[[Category:Tutorials]]
 
[[Category:Joomla! Website Management]]
 
[[Category:Joomla! Website Management]]
 
+
[[Category:Joomla! Help System]]
<noinclude>[[Category:Joomla! Help System]]</noinclude>
+
</translate>
 +
</noinclude>

Latest revision as of 07:59, 16 November 2015

Other languages:
English • ‎español • ‎français • ‎Nederlands
Copyedit.png
This Article Needs Your Help

This article is tagged because it NEEDS REVIEW. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.

Reason: Needs to be updated for 3.x series


This document describes the help system as implemented in Joomla 2.5 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.

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.

Introduction to the Joomla help system

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.

A typical toolbar with a help button looks like this:

Help16-Global.Config Toolbar-en.png

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

See also