- administration instructions rewritten (english only), no more picture

  needed to represent directories tree, space added between list items


git-svn-id: http://piwigo.org/svn/trunk@669 68402e56-0260-453c-a942-63ccdbb3a9ee

4 files changed, 254 insertions, 61 deletions

diff --git a/admin/help.php b/admin/help.php
index aea90c74b..18e1f295f 100644
--- a/admin/help.php
+++ b/admin/help.php
@@ -29,18 +29,16 @@ include_once( PHPWG_ROOT_PATH.'admin/include/isadmin.inc.php' );
 $template->set_filenames( array('help'=>'admin/help.tpl') );
 
 //----------------------------------------------------- help categories display
-$categories = array( 'images','thumbnails','database','remote','upload',
-                     'virtual','groups','access','infos' );
-foreach ( $categories as $category ) {
-  $template->assign_block_vars('cat', array('NAME'=>$lang['help_'.$category.'_title']));
-  if ( $category == 'images' )
+$categories = array('images','thumbnails','database','access','groups',
+                    'remote','upload','virtual','infos');
+foreach ($categories as $category)
+{
+  $template->assign_block_vars(
+    'cat',
+    array('NAME'=>$lang['help_'.$category.'_title']));
+  
+  foreach ($lang['help_'.$category] as $item)
   {
-    $template->assign_block_vars('cat.illustration', array(
-	  'SRC_IMG'=>PHPWG_ROOT_PATH.'admin/images/admin.png',
-	  'CAPTION'=>$lang['help_images_intro']
-	  ));
-  }
-  foreach ( $lang['help_'.$category] as $item ) {
     $template->assign_block_vars('cat.item', array('CONTENT'=>$item));
   }
 }
diff --git a/admin/images/admin.png b/admin/images/admin.png
deleted file mode 100644
index ff8dc0160..000000000
--- a/admin/images/admin.png
+++ /dev/null
diff --git a/language/en_UK.iso-8859-1/faq.lang.php b/language/en_UK.iso-8859-1/faq.lang.php
index 8509bbdfc..3fcb5e49a 100644
--- a/language/en_UK.iso-8859-1/faq.lang.php
+++ b/language/en_UK.iso-8859-1/faq.lang.php
@@ -26,54 +26,249 @@
 // +-----------------------------------------------------------------------+
 
 // Admin FAQ
-$lang['help_images_title'] = 'Adding pictures';
-$lang['help_images_intro'] = 'How to place pictures in your directories';
-$lang['help_images'][0] = 'in the directory "galleries", create directories that will represent your categories';
-$lang['help_images'][1] = 'in each directory, you can create as many sub-level directories as you wish.';
-$lang['help_images'][2] = 'you can create as many categories and sub-categories for each category as you wish';
-$lang['help_images'][3] = 'picture files must have jpeg format (extension jpg or JPG), gif format (extension gif or GIF) or png format (extension png or PNG).';
-$lang['help_images'][4] = 'try not to use blank space " " or hyphen "-" in picture files, I advise you to use underscore "_" character which is managed by PhpWebGallery and will provide better results';
+$lang['help_images_title'] = 'Adding elements';
+$lang['help_images'] =
+array(
+  'Category directories are in the PhpWebGallery directory "galleries". Here
+follow the directory tree of a very small gallery (but using many features)
+: <br />
+<pre>
+.
+|-- admin
+|-- doc
+|-- galleries
+|   |-- category-1
+|   |   |-- category-1.1
+|   |   |   |-- category-1.1.1
+|   |   |   |   |-- category-1.1.1.1
+|   |   |   |   |   |-- pwg_high
+|   |   |   |   |   |   +-- wedding.jpg
+|   |   |   |   |   |-- thumbnail
+|   |   |   |   |   |   +-- TN-wedding.jpg
+|   |   |   |   |   +-- wedding.jpg
+|   |   |   |   +-- category-1.1.1.2
+|   |   |   +-- category-1.1.2
+|   |   |-- category-1.2
+|   |   |   |-- pookie.jpg
+|   |   |   +-- thumbnail
+|   |   |       +-- TN-pookie.jpg
+|   |   +-- category-1.3
+|   +-- category-2
+|       |-- piglet.gif
+|       |-- pwg_representative
+|       |   +-- video.avi
+|       |-- thumbnail
+|       |   +-- TN-piglet.jpg
+|       +-- video.avi
+|-- include
+|-- install
+|-- language
+|-- template
++-- tool
+</pre>',
+  
+  'Basically, a category is represented by a directory at any level in
+PhpWebGallery directory "galleries". Each category can contain as many
+sub-level as you wish. In the example above, category-1.1.1.1 is at level 4
+of deepness.',
+  
+  'Basically, an element is represented by a file. A file can be a
+PhpWebGallery element if its extenstion is among $conf[\'file_ext\']
+possibilities (see include/config.inc.php file). A file can be a picture if
+its extension is among $conf[\'picture_ext\'] (see include/config.inc.php
+file).',
+  
+  'Picture elements must have an associated thumbnail (see section below about
+thumbnails)',
+
+  'Picture elements can have a high quality file associated. As for wedding.jpg
+in the example above. No prefix on the high quality picture is required.',
+
+  'Non picture elements (video, sounds, file texts, what you want...) are by
+default represented by an icon corresponding to the filename
+extension. Optionaly, you can associate a thumbnail and a representative
+file (see video.avi in the example above).',
+  
+  'Warning : the name of directories and files must be composed of letters,
+figures, "-", "_" or ".". No blank space, no accentuated characters',
+  
+  'Advise : a category can contain elements and sub-categories in the same
+time. Nerverthless, you are strongly advised for each category to choose
+between category containing elements OR category containing sub-categories.'
+  );
+
 $lang['help_thumbnails_title'] = 'Thumbnails';
-$lang['help_thumbnails'][0] = 'in each directory containing picture to display on your site, there is a sub-directory nammed "thumbnail", if it doesn\'t exist, create it to place your thumbnails into it.';
-$lang['help_thumbnails'][1] = 'thumbnails don\'t need to have the same extension as their associated picture (a picture with .jpg extension can have a thumbnail in .GIF extention for instance).';
-$lang['help_thumbnails'][2] = 'the thumbnail associated to a picture must be prefixed with the prefix given on the configuration page(image.jpg -> TN_image.GIF for instance).';
-$lang['help_thumbnails'][3] = 'I advise you to use the module for windows downloadable on the presentation site of PhpWebGallery for thumbnails management.';
-$lang['help_thumbnails'][4] = 'you can use the thumbnail creation page integrated in PhpWebGallery, but I don\'t advice you so, because thumbnail quality may be poor and it uses a high CPU load which can be a problem if you use free web hosting.';
-$lang['help_thumbnails'][5] = 'if you choose to use your hosting provider to create thumbnails, you must give 775 rights on "galleries" folder and all its sub-folders.';
-$lang['help_database_title'] = 'Updating database';
-$lang['help_database'][0] = 'once pictures files and thumbnails correctly placed in the directories, clic on "database update" in the menu of the administration panel.';
-$lang['help_infos_title'] = 'Miscellanous informations';
-$lang['help_infos'][1] = 'As soon as you created your gallery, go in the user list and modify permissions for user "visiteur". Indeed, every new registered users will have by default the same permissions as "visiteur" user.';
-$lang['help_remote_title'] = 'Remote site';
-$lang['help_remote'][0] = 'PhpWebGallery offers the possibility to use several servers to store the images which will compose your gallery. It can be useful if your gallery is installed on one limited space and that you have a big quantity of images to be shown. Please , follow this procedure : ';
-$lang['help_remote'][1] = '1. edit file "create_listing_file.php" (you will find it in the directory "admin"), by modifying the line "$prefix_thumbnail = "TN-";" if the prefix for your thumbnails is not "TN-".';
-$lang['help_remote'][2] = '2. place file "create_listing_file.php" modified on your distant website, in the root directory of your directories of images  (as the directory "galleries" of this website) by ftp.';
-$lang['help_remote'][3] = '3. launch script using the url http://domaineDistant/repGalerie/create_listing_file.php, a file listing.xml has just been created.';
-$lang['help_remote'][4] = '4. get back file listing.xml from your distant website to place it in directory "admin" of this website.';
-$lang['help_remote'][5] = '5. please , launch an update of the data of images by the interface of administration, once the listing.xml used file, kill it from the directory "admin".';
-$lang['help_remote'][6] = 'You can update the contents of a distant website by redoing the described manipulation. You can also kill a distant website by choosing the option in the configuration section of the administration panel.';
-$lang['help_upload_title'] = 'Added images by users';
-$lang['help_upload'][0] = 'PhpWebGallery offers the possibility for users to upload images. in order to do it :';
-$lang['help_upload'][1] = '1. authorize the option in the configuration zone of the administration panel';
-$lang['help_upload'][2] = '2. authorize the rights in writing in the images directories';
-$lang['help_database'][1] = 'In order to avoid the update of too many pictures in a single update, I advise to start by updating only categories, then on the categories section of the administration panel, update each category thanks to the link "update"';
-$lang['help_upload'][3] = 'The category must have upload available itself for upload.';
-$lang['help_upload'][4] = 'Uploaded images by the users are not directly visible on the website, they must be validated by an administrator.  For that purpose, an administrator must go on the page "en attente" of the administration panel, to validate or to refuse the images proposed, then launch an update of the images data.';
-$lang['help_virtual_title'] = 'Links between pictures and categories and virtual categories';
-$lang['help_virtual'][0] = 'PhpWebGallery is able to dissociate categories where pictures are stored and categories where pictures are shown.';
-$lang['help_virtual'][1] = 'By default, pictures are shown only in their real categories : the ones corresponding to directories on the web server.';
-$lang['help_virtual'][2] = 'To link a picture to a category, you just have to make the association on the page of picture informations or on the informations of all pictures of a category.';
-$lang['help_virtual'][3] = 'Using this principle, it is possible to create virtual categories in PhpWebGallery : no real directory coresponds to this category. You just have to create this category on the section "categories" of the admin panel.';
-$lang['help_groups_title'] = 'Users Groups';
-$lang['help_groups'][0] = 'PhpWebGallery is able to manage groups of users. It can be very useful to have common permission access for private categories.';
-$lang['help_groups'][1] = '1. Create the group "family" on the section "Groups" of admin panel.';
-$lang['help_groups'][2] = '2. On the section "Users", edit on of them and associate him to the group "family".';
-$lang['help_groups'][3] = '3. By modifying the permissions for a category or for a group, you\'ll see that all categories accessible for a group are accessible for its members.';
-$lang['help_groups'][4] = 'A user can belong to several groups. The authorization is stronger than prohibition : if a user "jack" belongs to the group "family" and "friends", and that only group "family" can see category "Christmas 2003", "jack" will be able to see "Christmas 2003".';
+$lang['help_thumbnails'] =
+array(
+  'As said earlier, each element of picture type must be associated with a
+thumbnail.',
+
+  'Thumbnails are stored in the sub-directory "thumbnail" of the category
+directory. The thumbnail is a picture (same filename extensions possible
+than picture files) which filename is prefixed by the configured "Thumbnail
+prefix" (see admin panel, Configuration, General).',
+
+  'Thumbnails don\'t need to have the same extension as their associated
+picture (a picture with .jpg extension can have a thumbnail in .GIF
+extention for instance).',
+
+  'I advise you to use an external module for thumbnails creation (such as
+ThumbClic available on the presentation site of PhpWebGallery).',
+
+  'You can also use the thumbnail creation page integrated in PhpWebGallery,
+but I don\'t advise you so, because thumbnail quality may be poor and it
+uses a high CPU load which can be a problem if you use free web hosting.',
+
+  'If you choose to use your hosting provider to create thumbnails, you must
+give write rights on all category directories and sub-directories
+"thumbnail" for ugo (user, group, other).'
+  
+  );
+
+$lang['help_database_title'] = 'Synchronize filesystem and database';
+$lang['help_database'] =
+array(
+  'Once files, thumbnails and representatives are correctly placed in the
+directories, go to : administration panel, General, Synchronize',
+
+  'There are 2 synchronizations possible : directories/files and file
+metadata. directories/files is about synchronizing your directories tree
+with the category tree in the database. metadata is about updating elements
+informations such as filesize, dimensions in pixels, EXIF or IPTC
+informations.',
+
+  'The first synchronization must be the directories/files one.',
+
+  'Synchronization process may take long (depending on your server load and
+quantity of elements to manage) so it is possible to progress by step :
+category by category.'
+  
+  );
+
 $lang['help_access_title'] = 'Access authorization';
-$lang['help_access'][0] = 'PhpWebGallery is able to forbid access to categories. Categories can be "public" or "private". In order to forbid access to a category :';
-$lang['help_access'][1] = '1. Modify category informations (from the "categories" section in tha admin panel) and make it "private".';
-$lang['help_access'][2] = '2. On the page of permissions (for a group or a user) the private category will be shown and you\'ll be able to authorize access or not.';
-$lang['help_infos'][2] = 'If you have any question, do not hesitate to take a look at the forum or ask a question there. The <a href="http://forum.phpwebgallery.net" style="text-decoration:underline">forum</a> (message board) is available on the presentation site of PhpWebGallery.';
+$lang['help_access'] =
+array(
+  'You can forbid access to categories. Categories can be "public" or
+"private". Permissions (for groups and users) can be set only if the
+category is private.',
+
+  'You can set a category to private by editing a single category
+(administration panel, Categories, Manage, edit) or by setting options to
+your whole category tree (administration panel, Categories, Public/Private)',
+
+  'Once the category is private, you can manage permissions for groups and
+users (administration panel, Permissions).'
+  
+  );
+
+$lang['help_groups_title'] = 'Users Groups';
+$lang['help_groups'] =
+array(
+  
+  'PhpWebGallery is able to manage groups of users. It can be very useful to
+have common permission access for private categories.',
 
- ?>
\ No newline at end of file
+  'You can create groups and add users to a group in administration panel,
+Identification, Groups.',
+
+  'A user can belong to several groups. The authorization is stronger than
+prohibition : if user "jack" belongs to groups "family" and "friends", and
+that only group "family" can see category "Christmas 2003", "jack" will be
+able to see "Christmas 2003".'
+  
+  );
+
+$lang['help_remote_title'] = 'Remote site';
+$lang['help_remote'] =
+array(
+
+  'PhpWebGallery offers the possibility to use several servers to store the
+images which will compose your gallery. It can be useful if your gallery is
+installed on one limited space and that you have a big quantity of images to
+be shown.',
+
+  '1. edit file tools/create_listing_file.php, by modifying parameters section
+such as $conf[\'prefix_thumbnail\'] or $conf[\'use_exif\'].',
+
+  '2. place file "tools/create_listing_file.php" modified on your distant
+website, in the same directory than your category directories (as the
+directory "galleries" of this website) by ftp. For the example, let\'s say
+that you can access http://example.com/galleries/create_listing_file.php.',
+
+  '3. go to administration panel, General, Remote sites. Ask to create a new
+site, for example http://example.com/galleries',
+
+  '4. a new remote site is registered. You can perform 4 actions :
+<ol>
+
+  <li>generate listing : launches a distant request to generate a distant
+  file listing</li>
+
+  <li>update : reads the distant listing.xml file and synchronizes with
+  database informations</li>
+
+  <li>clean : removes distant listing.xml file</li>
+
+  <li>delete : deletes the site (and all related categories and elements) in
+  the database</li>
+
+</ol>',
+
+  'You can do all this by hand by generating yourself the listing.xml file,
+moving it from your distant server to you local PhpWebGallery "admin"
+directory and opening the remote site management screen : PhpWebGallery will
+propose you to use the found listing.xml file.'
+  
+  );
+
+$lang['help_upload_title'] = 'Files upload by users';
+$lang['help_upload'] =
+array(
+  'PhpWebGallery offers the possibility for users to upload images. in order to
+do it :',
+  
+  '1. authorize upload on any categories (administration panel, Categories,
+Manage, edit or administration panel, Categories, Upload)',
+
+  '2. give write rights on directories for ugo (user, group, other)',
+  
+  'Files uploaded by users are not directly visible on the website, they must
+be validated by an administrator. For that purpose, an administrator must go
+on administration panel, Pictures, Waiting in order to validate or to refuse
+the files proposed, then to synchronize filesystem with database.'
+  );
+
+$lang['help_virtual_title'] = 'Links between elements and categories, virtual categories';
+$lang['help_virtual'] =
+array(
+  'PhpWebGallery dissociates categories where elements are stored and
+categories where they are shown.',
+  
+  'By default, elements are shown only in their real categories : the ones
+corresponding to directories on the web server.',
+
+  'To link an element to a category, you just have to make the association on
+the page of element edition (link to this screen on picture.php logged as an
+administrator) or on the informations of all elements of a category.',
+  
+  'Using this principle, it is possible to create virtual categories : no
+directory coresponds to this category. You can create virtual categories in
+administration panel, Categories, Manage.'
+  );
+
+$lang['help_infos_title'] = 'Miscellanous informations';
+$lang['help_infos'] =
+array(
+  'As soon as you created your gallery, go in the user list and modify
+permissions for user "guest". Indeed, every new registered user will have by
+default the same permissions as "guest" user.',
+  
+  'If you have any question, do not hesitate to take a look at the forum or ask
+a question there. The <a href="http://forum.phpwebgallery.net"
+style="text-decoration:underline">forum</a> (message board) is available on
+the presentation site of PhpWebGallery. Check the <a
+href="http://doc.phpwebgallery.net"
+style="text-decoration:underline">official PhpWebGallery documentation</a> for
+further reading.'
+  );
+?>
\ No newline at end of file
diff --git a/template/default/admin/help.tpl b/template/default/admin/help.tpl
index c890e1fea..bcc02ce8b 100644
--- a/template/default/admin/help.tpl
+++ b/template/default/admin/help.tpl
@@ -14,7 +14,7 @@
       <!-- END illustration -->
       <ul style="text-align:left; margin-right:10px;">
         <!-- BEGIN item -->
-        <li>{cat.item.CONTENT}</li>
+        <li style="margin-bottom:5px;">{cat.item.CONTENT}</li>
         <!-- END item -->
       </ul>
     </td>
@@ -23,4 +23,4 @@
     <td>&nbsp;</td>
   </tr>
   <!-- END cat -->
-</table>
\ No newline at end of file
+</table>