Help system - Revision history

Wilsonge: Remove 1.6 and 1.7 instances

2013-04-29T17:56:23Z

Remove 1.6 and 1.7 instances

Wilsonge: Update 3.0 to 3.1 and 3.x

2013-04-29T09:48:44Z

Update 3.0 to 3.1 and 3.x

Chris Davenport: Added link to Joomla 3.0 help screens.

2012-11-06T01:09:25Z

Added link to Joomla 3.0 help screens.

Hutchy68: /* Introduction to the Joomla help system */ setting tags for page transclusion

2012-10-26T16:27:06Z

‎Introduction to the Joomla help system: setting <onlyinclude> tags for page transclusion

JoomlaWikiBot: /* See also */adding category

2012-10-26T16:24:05Z

‎See also: adding category

Hutchy68: adding category

2012-08-09T01:34:23Z

adding category

Dextercowley: add link for chunk article

2012-06-23T03:33:31Z

add link for chunk article

Chris Davenport: Added link to Joomla 1.7 help screens control page

2011-09-24T10:30:28Z

Added link to Joomla 1.7 help screens control page

Chris Davenport: Added link to helpsites.xml format page.

2011-02-20T21:26:57Z

Added link to helpsites.xml format page.

Chris Davenport: 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...

2011-02-20T19:55:13Z

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

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

[[Image:Help16-Global.Config Toolbar.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.

* Read more about [[Help system/How the help system works|how the help system works]].
* Read more about [[Help system/Help servers|setting up your own help server]].
* Read more about [[Help system/Local help files|using local help files]].
* Read more about [[Help system/Translation and localisation|translating and localising help screens]].
* Read more about [[Help system/Administrator help area|how the administrator help area works]].
* 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]]

@@ 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.
+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.
@@ Line 26: / Line 26: @@
 * [[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}}
 * [[Help25:Help screens|Table of help screens for Joomla 2.5]] {{JVer|2.5}}
 * [[Help31:Help screens|Table of help screens for Joomla 3.x]] {{JVer|3.x}}

@@ Line 29: / Line 29: @@
 * [[Help17:Help screens|Table of help screens for Joomla 1.7]] {{JVer|1.7}}
 * [[Help25:Help screens|Table of help screens for Joomla 2.5]] {{JVer|2.5}}
-* [[Help30:Help screens|Table of help screens for Joomla 3.0]] {{JVer|3.0}}
+* [[Help31:Help screens|Table of help screens for Joomla 3.x]] {{JVer|3.x}}
 * [[Using_chunks_in_Joomla_help_screens|Using chunks in Joomla help screens]] {{JVer|2.5}}

@@ Line 29: / Line 29: @@
 * [[Help17:Help screens|Table of help screens for Joomla 1.7]] {{JVer|1.7}}
 * [[Help25:Help screens|Table of help screens for Joomla 2.5]] {{JVer|2.5}}
 * [[Using_chunks_in_Joomla_help_screens|Using chunks in Joomla help screens]] {{JVer|2.5}}

← Older revision		Revision as of 16:24, 26 October 2012
Line 33:		Line 33:
	[[Category:Tutorials]]		[[Category:Tutorials]]
	[[Category:Joomla! Website Management]]		[[Category:Joomla! Website Management]]
		+
		+	<noinclude>[[Category:Joomla! Help System]]</noinclude>

← Older revision		Revision as of 01:34, 9 August 2012
Line 32:		Line 32:

	[[Category:Tutorials]]		[[Category:Tutorials]]
		+	[[Category:Joomla! Website Management]]

@@ Line 4: / Line 4: @@
 ==Introduction to the Joomla help system==
+<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.
 A typical toolbar with a help button looks like this:
-[[Image:Help16-Global.Config Toolbar.png]]
+[[Image:Help16-Global.Config Toolbar.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.

@@ Line 28: / Line 28: @@
 * [[Help16:Help screens|Table of help screens for Joomla 1.6]] {{JVer|1.6}}
 * [[Help17:Help screens|Table of help screens for Joomla 1.7]] {{JVer|1.7}}
 [[Category:Tutorials]]