Setting up a local help server - Revision history

Hutchy68: adding categories

2012-10-18T22:13:27Z

adding categories

Chris Davenport: Updated for latest help screens release.

2008-07-12T17:52:48Z

Updated for latest help screens release.

Chris Davenport: /* Step 5: Amend the database scripts */

2008-07-08T08:28:09Z

‎Step 5: Amend the database scripts

Chris Davenport: Amended to match reality.

2008-07-08T08:07:00Z

Amended to match reality.

Infograf768: /* Step 5: Amend the database scripts */

2008-07-08T07:54:28Z

‎Step 5: Amend the database scripts

Chris Davenport at 15:12, 7 July 2008

2008-07-07T15:12:04Z

Chris Davenport at 12:16, 7 July 2008

2008-07-07T12:16:35Z

Chris Davenport: New page: {{inuse}}

2008-07-07T08:47:00Z

New page: {{inuse}}

New page

← Older revision		Revision as of 22:13, 18 October 2012
Line 132:		Line 132:
	----		----
	<noinclude>This page was adapted from an [http://help.joomla.org/ghop/feb2008/task102 original document] produced during the [http://docs.joomla.org/Google_Highly_Open_Participation_Contest GHOP Contest] by igeoffi.</noinclude>		<noinclude>This page was adapted from an [http://help.joomla.org/ghop/feb2008/task102 original document] produced during the [http://docs.joomla.org/Google_Highly_Open_Participation_Contest GHOP Contest] by igeoffi.</noinclude>
		+	[[Category:Server configurations]][[Category:Server setup local]]

@@ Line 66: / Line 66: @@
   +- images
       +- stories
-          +- 1_5_help_screens
+          +- help_screens_1.5
               +- buttons
               +- headers
@@ Line 95: / Line 95: @@
 Joomla! 1.5.x Help Screens: Content Menu
 Joomla! 1.5.x Help Screens: Components Menu
-Joomla! 1.5 Help Screens: Extensions Menu
+Joomla! 1.5.x Help Screens: Extensions Menu
-Joomla! 1.5 Help Screens: Tools Menu
+Joomla! 1.5.x Help Screens: Tools Menu
 </pre>
 Try clicking on some of these items and make sure that the help screens are displaying correctly.  In particular, check that the screenshots and other images are being shown.  If they are not then check the directory structure in the <tt><joomla-root>/images/stories</tt> directory as it is important that this is set up correctly.

@@ Line 75: / Line 75: @@
 </pre>
 ===Step 5: Amend the database scripts===
-The five <tt>.txt.sql</tt> files '''must''' be amended before they can be used.  Open each file in turn using a text editor.  Do not use a word processing program.  Using the Find and Replace or similar function, replace all instances of <tt>#_</tt> with your MySQL Table Prefix (which you noted in Step 1).  The default MySQL Table Prefix for a Joomla! 1.0 installation is <tt>jos_</tt>.  Repeat this for all five files.
+The default MySQL Table Prefix for a Joomla! 1.0 installation is <tt>jos_</tt>.  If your MySQL Table Prefix (which you noted in Step 1) is '''not''' <tt>jos_</tt> then you will need to amend all five of the <tt>.txt.sql</tt> files before they can be used.  To amend the files, open each one in turn using a text editor.  Do not use a word processing program.  Using the Find and Replace or similar function, replace all instances of <tt>jos_</tt> with your MySQL Table Prefix.  Repeat this for all five files.
 ===Step 6: Start phpMyAdmin===

@@ Line 75: / Line 75: @@
 </pre>
 ===Step 5: Amend the database scripts===
-The five <tt>.txt.sql</tt> files '''may have to be amended''' before they can be used.  Open each file in turn using a text editor.  Do not use a word processing program.  Using the Find and Replace or similar function, replace all instances of <tt>jos_</tt> with your MySQL Table Prefix (which you noted in Step 1).  The default MySQL Table Prefix for a Joomla! 1.0 installation is <tt>jos_</tt>.  Repeat this for all five files.
+The five <tt>.txt.sql</tt> files '''must''' be amended before they can be used.  Open each file in turn using a text editor.  Do not use a word processing program.  Using the Find and Replace or similar function, replace all instances of <tt>#_</tt> with your MySQL Table Prefix (which you noted in Step 1).  The default MySQL Table Prefix for a Joomla! 1.0 installation is <tt>jos_</tt>.  Repeat this for all five files.
 ===Step 6: Start phpMyAdmin===

@@ Line 75: / Line 75: @@
 </pre>
 ===Step 5: Amend the database scripts===
-The five <tt>.txt.sql</tt> files '''must''' be amended before they can be used.  Open each file in turn using a text editor.  Do not use a word processing program.  Using the Find and Replace or similar function, replace all instances of <tt>#_</tt> with your MySQL Table Prefix (which you noted in Step 1).  The default MySQL Table Prefix for a Joomla! 1.0 installation is <tt>mos_</tt>.  Repeat this for all five files.
+The five <tt>.txt.sql</tt> files '''may have to be amended''' before they can be used.  Open each file in turn using a text editor.  Do not use a word processing program.  Using the Find and Replace or similar function, replace all instances of <tt>jos_</tt> with your MySQL Table Prefix (which you noted in Step 1).  The default MySQL Table Prefix for a Joomla! 1.0 installation is <tt>jos_</tt>.  Repeat this for all five files.
 ===Step 6: Start phpMyAdmin===

@@ Line 1: / Line 1: @@
-{{inuse}}
+==What are help screens?==
 {{:What are help screens?}}
 {{:What is a local help server?}}
 ==Setting up a local help server==

← Older revision		Revision as of 12:16, 7 July 2008
Line 1:		Line 1:
	{{inuse}}		{{inuse}}
		+	{{:What are help screens?}}
		+	{{:What is a local help server?}}
		+	==Setting up a local help server==
		+	[[Image:CreatingLocalHelpServerNoSampleData.png\|right]]
		+	===Step 1: Installing Joomla! 1.0 to use as a local help server===
		+	'''Important note:''' The following instructions show how to set up a local help server to serve help screens for Joomla! 1.5 installations. Please note that the local help server itself is a Joomla! 1.0 installation. It is possible to run the local help server under Joomla! 1.5 but the help screens are not yet available in the required format.
		+
		+	Setting up a local help server is similar to installing Joomla! on your site. There is one major difference in the installation process though. In a normal Joomla! installation you would normally check the box “Install Sample Data” but when setting up a help server, do not be check this box off.
		+
		+	'''Important:''' Note the MySQL Table Prefix and the MySQL Database Name used when installing the Joomla! local help server. You will need to know these later.
		+
		+	Complete the installation process as normal. When you have finished the installation process you will need to delete the <joomla-root>/installation directory.
		+
		+
		+
		+
		+
		+	===Step 2: Download the latest help screens===
		+	Download the latest copy of the help screens SQL dump from JoomlaCode: [http://joomlacode.org/gf/project/joomla/docman/?subdir=6]
		+
		+	Note that the date forms part of the filename so ensure that you download the latest version.
		+
		+
		+
		+
		+
		+	===Step 3: Extract files into a local directory===
		+	Extract the contents of the ZIP file downloaded from JoomlaCode into a directory on your local computer. You should see the following files:
		+	{\| class="wikitable"
		+	\|-
		+	!Filename
		+	!Description
		+	\|-
		+	\|category.txt.sql
		+	\|contains the SQL dump for the Joomla! Categories (mos_categories)
		+	\|-
		+	\|content.txt.sql
		+	\|contains the SQL dump for the Joomla! Content Items (mos_content)
		+	\|-
		+	\|menu.txt.sql
		+	\|contains the SQL dump for the Joomla! Menu (mos_menus)
		+	\|-
		+	\|modules.txt.sql
		+	\|contains the SQL dump for the Joomla! Modules (mos_modules)
		+	\|-
		+	\|readme.txt
		+	\|contains a brief description of the help screens package
		+	\|-
		+	\|section.txt.sql
		+	\|ontains the SQL dump for the Joomla! Sections (mos_sections)
		+	\|-
		+	\|images.zip
		+	\|contains all the screenshots, tool bar images, and icons used in the help screens
		+	\|}
		+	===Step 4: Extract the help screen images===
		+	One of the files you just extracted was <tt>images.zip</tt>. This contains all the screenshots, tool bar images and icons used in the help screens.
		+	Either:
		+	* Extract it to a directory on your local computer, then upload all the files into the <tt><joomla-root>/images/stories</tt> directory of your help server.
		+	* Or upload the <tt>images.zip</tt> to your help server and extract it into the <tt><joomla-root>/images/stories</tt> directory using the server control panel or a command-line instruction in an SSH session. '''This method requires appropriate access to your help server.'''
		+
		+	Once the upload is complete you should have the following directory structure:
		+	<pre>
		+	<joomla-root>
		+	+- images
		+	+- stories
		+	+- 1_5_help_screens
		+	+- buttons
		+	+- headers
		+	+- icons
		+	+- screenshots
		+	+- toolbars
		+	+- userlevels
		+	</pre>
		+	===Step 5: Amend the database scripts===
		+	The five <tt>.txt.sql</tt> files '''must''' be amended before they can be used. Open each file in turn using a text editor. Do not use a word processing program. Using the Find and Replace or similar function, replace all instances of <tt>#_</tt> with your MySQL Table Prefix (which you noted in Step 1). The default MySQL Table Prefix for a Joomla! 1.0 installation is <tt>mos_</tt>. Repeat this for all five files.
		+
		+	===Step 6: Start phpMyAdmin===
		+	[[Image:CreatingLocalHelpServerPHPMyAdminImport.png\|right]]
		+	Open [http://www.phpmyadmin.net phpMyAdmin] or a similar MySQL database management tool. Navigate to the database used by your Joomla! local help server. Go to the Import page.
		+	===Step 7: Import the data===
		+	Browse to each of the <tt>.txt.sql</tt> files and click the '''Go''' button. Repeat this process for each file in turn. The order in which you import them does not matter.
		+
		+	[[Image:CreatingLocalHelpServerPHPMyAdminFileToImport.png]]
		+
		+	This completes the process of setting up your local help server.
		+
		+	===Step 8: Test===
		+	Go to the front-end of your local help site. You should see a new menu item called '''Help Screens'''. If you click on it the menu should open up and you should see the following sub-menus:
		+	<pre>
		+	Joomla! 1.5.x Help Screens: General
		+	Joomla! 1.5.x Help Screens: Site
		+	Joomla! 1.5.x Help Screens: Menus Menu
		+	Joomla! 1.5.x Help Screens: Content Menu
		+	Joomla! 1.5.x Help Screens: Components Menu
		+	Joomla! 1.5 Help Screens: Extensions Menu
		+	Joomla! 1.5 Help Screens: Tools Menu
		+	</pre>
		+	Try clicking on some of these items and make sure that the help screens are displaying correctly. In particular, check that the screenshots and other images are being shown. If they are not then check the directory structure in the <tt><joomla-root>/images/stories</tt> directory as it is important that this is set up correctly.
		+
		+	==Configuring Joomla! 1.5 to use your local help server==
		+	===Step 1: Edit the help server list===
		+	The list of available help servers is stored in XML format in the file <tt><joomla-root>/administrator/help/helpsites-15.xml</tt>. Open this file in a text editor and add the following line in the <tt><sites></tt> segment (replacing the ''url'' attribute with the URL of your local help server):
		+	<source lang="xml">
		+	<site tag="en-GB" url="http://localhost/joomlahelp">Local Help</site>
		+	</source>
		+	For example, when this line is added to the standard <tt>helpsites-15.xml</tt> file distributed with Joomla! 1.5 it will look like this:
		+	<source lang="xml">
		+	<?xml version="1.0" encoding="iso-8859-1"?>
		+	<joshelp>
		+	<sites>
		+	<site tag="en-GB" url="http://help.joomla.org">English (GB) - help.joomla.org</site>
		+	<site tag="en-GB" url="http://localhost/joomlahelp">Local Help</site>
		+	</sites>
		+	</joshelp>
		+	</source>
		+	Save the file.
		+	===Step 2: Change Global Configuration===
		+	[[Image:CreatingLocalHelpServerSelectServer.png\|right]]
		+	Log into the Joomla! Back End of your Joomla! 1.5 site, ''not the local help server''.
		+
		+	Go to <tt>Site -> Global Configuration</tt>. Click on the <tt>System</tt> tab. Find the <tt>System Settings</tt> group and within that the <tt>Help Server</tt> field. This is a drop-down selection list. Click on it and select your new local help server from the list.
		+
		+	Save your changes to Global Configuration.
		+
		+	===Step 3: Test===
		+	Go to any screen in the Joomla! Back End and click on the '''Help''' toolbar button. You should see the appropriate help screen in a popup window, served from your local help server.
		+
		+	As multiple Joomla! 1.5 sites can share the same local help server, you will need to repeat these steps for each Joomla! 1.5 site.
		+
		+	----
		+	<noinclude>This page was adapted from an [http://help.joomla.org/ghop/feb2008/task102 original document] produced during the [http://docs.joomla.org/Google_Highly_Open_Participation_Contest GHOP Contest] by igeoffi.</noinclude>