Changeset 669


Ignore:
Timestamp:
Dec 31, 2004, 8:58:41 AM (19 years ago)
Author:
plg
Message:
  • administration instructions rewritten (english only), no more picture needed to represent directories tree, space added between list items
Location:
trunk
Files:
1 deleted
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/admin/help.php

    r593 r669  
    3030
    3131//----------------------------------------------------- help categories display
    32 $categories = array( 'images','thumbnails','database','remote','upload',
    33                      'virtual','groups','access','infos' );
    34 foreach ( $categories as $category ) {
    35   $template->assign_block_vars('cat', array('NAME'=>$lang['help_'.$category.'_title']));
    36   if ( $category == 'images' )
     32$categories = array('images','thumbnails','database','access','groups',
     33                    'remote','upload','virtual','infos');
     34foreach ($categories as $category)
     35{
     36  $template->assign_block_vars(
     37    'cat',
     38    array('NAME'=>$lang['help_'.$category.'_title']));
     39 
     40  foreach ($lang['help_'.$category] as $item)
    3741  {
    38     $template->assign_block_vars('cat.illustration', array(
    39           'SRC_IMG'=>PHPWG_ROOT_PATH.'admin/images/admin.png',
    40           'CAPTION'=>$lang['help_images_intro']
    41           ));
    42   }
    43   foreach ( $lang['help_'.$category] as $item ) {
    4442    $template->assign_block_vars('cat.item', array('CONTENT'=>$item));
    4543  }

  • trunk/language/en_UK.iso-8859-1/faq.lang.php

    r593 r669  
    2727
    2828// Admin FAQ
    29 $lang['help_images_title'] = 'Adding pictures';
    30 $lang['help_images_intro'] = 'How to place pictures in your directories';
    31 $lang['help_images'][0] = 'in the directory "galleries", create directories that will represent your categories';
    32 $lang['help_images'][1] = 'in each directory, you can create as many sub-level directories as you wish.';
    33 $lang['help_images'][2] = 'you can create as many categories and sub-categories for each category as you wish';
    34 $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).';
    35 $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';
     29$lang['help_images_title'] = 'Adding elements';
     30$lang['help_images'] =
     31array(
     32  'Category directories are in the PhpWebGallery directory "galleries". Here
     33follow the directory tree of a very small gallery (but using many features)
     34: <br />
     35<pre>
     36.
     37|-- admin
     38|-- doc
     39|-- galleries
     40|   |-- category-1
     41|   |   |-- category-1.1
     42|   |   |   |-- category-1.1.1
     43|   |   |   |   |-- category-1.1.1.1
     44|   |   |   |   |   |-- pwg_high
     45|   |   |   |   |   |   +-- wedding.jpg
     46|   |   |   |   |   |-- thumbnail
     47|   |   |   |   |   |   +-- TN-wedding.jpg
     48|   |   |   |   |   +-- wedding.jpg
     49|   |   |   |   +-- category-1.1.1.2
     50|   |   |   +-- category-1.1.2
     51|   |   |-- category-1.2
     52|   |   |   |-- pookie.jpg
     53|   |   |   +-- thumbnail
     54|   |   |       +-- TN-pookie.jpg
     55|   |   +-- category-1.3
     56|   +-- category-2
     57|       |-- piglet.gif
     58|       |-- pwg_representative
     59|       |   +-- video.avi
     60|       |-- thumbnail
     61|       |   +-- TN-piglet.jpg
     62|       +-- video.avi
     63|-- include
     64|-- install
     65|-- language
     66|-- template
     67+-- tool
     68</pre>',
     69 
     70  'Basically, a category is represented by a directory at any level in
     71PhpWebGallery directory "galleries". Each category can contain as many
     72sub-level as you wish. In the example above, category-1.1.1.1 is at level 4
     73of deepness.',
     74 
     75  'Basically, an element is represented by a file. A file can be a
     76PhpWebGallery element if its extenstion is among $conf[\'file_ext\']
     77possibilities (see include/config.inc.php file). A file can be a picture if
     78its extension is among $conf[\'picture_ext\'] (see include/config.inc.php
     79file).',
     80 
     81  'Picture elements must have an associated thumbnail (see section below about
     82thumbnails)',
     83
     84  'Picture elements can have a high quality file associated. As for wedding.jpg
     85in the example above. No prefix on the high quality picture is required.',
     86
     87  'Non picture elements (video, sounds, file texts, what you want...) are by
     88default represented by an icon corresponding to the filename
     89extension. Optionaly, you can associate a thumbnail and a representative
     90file (see video.avi in the example above).',
     91 
     92  'Warning : the name of directories and files must be composed of letters,
     93figures, "-", "_" or ".". No blank space, no accentuated characters',
     94 
     95  'Advise : a category can contain elements and sub-categories in the same
     96time. Nerverthless, you are strongly advised for each category to choose
     97between category containing elements OR category containing sub-categories.'
     98  );
     99
    36100$lang['help_thumbnails_title'] = 'Thumbnails';
    37 $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.';
    38 $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).';
    39 $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).';
    40 $lang['help_thumbnails'][3] = 'I advise you to use the module for windows downloadable on the presentation site of PhpWebGallery for thumbnails management.';
    41 $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.';
    42 $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.';
    43 $lang['help_database_title'] = 'Updating database';
    44 $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.';
     101$lang['help_thumbnails'] =
     102array(
     103  'As said earlier, each element of picture type must be associated with a
     104thumbnail.',
     105
     106  'Thumbnails are stored in the sub-directory "thumbnail" of the category
     107directory. The thumbnail is a picture (same filename extensions possible
     108than picture files) which filename is prefixed by the configured "Thumbnail
     109prefix" (see admin panel, Configuration, General).',
     110
     111  'Thumbnails don\'t need to have the same extension as their associated
     112picture (a picture with .jpg extension can have a thumbnail in .GIF
     113extention for instance).',
     114
     115  'I advise you to use an external module for thumbnails creation (such as
     116ThumbClic available on the presentation site of PhpWebGallery).',
     117
     118  'You can also use the thumbnail creation page integrated in PhpWebGallery,
     119but I don\'t advise you so, because thumbnail quality may be poor and it
     120uses a high CPU load which can be a problem if you use free web hosting.',
     121
     122  'If you choose to use your hosting provider to create thumbnails, you must
     123give write rights on all category directories and sub-directories
     124"thumbnail" for ugo (user, group, other).'
     125 
     126  );
     127
     128$lang['help_database_title'] = 'Synchronize filesystem and database';
     129$lang['help_database'] =
     130array(
     131  'Once files, thumbnails and representatives are correctly placed in the
     132directories, go to : administration panel, General, Synchronize',
     133
     134  'There are 2 synchronizations possible : directories/files and file
     135metadata. directories/files is about synchronizing your directories tree
     136with the category tree in the database. metadata is about updating elements
     137informations such as filesize, dimensions in pixels, EXIF or IPTC
     138informations.',
     139
     140  'The first synchronization must be the directories/files one.',
     141
     142  'Synchronization process may take long (depending on your server load and
     143quantity of elements to manage) so it is possible to progress by step :
     144category by category.'
     145 
     146  );
     147
     148$lang['help_access_title'] = 'Access authorization';
     149$lang['help_access'] =
     150array(
     151  'You can forbid access to categories. Categories can be "public" or
     152"private". Permissions (for groups and users) can be set only if the
     153category is private.',
     154
     155  'You can set a category to private by editing a single category
     156(administration panel, Categories, Manage, edit) or by setting options to
     157your whole category tree (administration panel, Categories, Public/Private)',
     158
     159  'Once the category is private, you can manage permissions for groups and
     160users (administration panel, Permissions).'
     161 
     162  );
     163
     164$lang['help_groups_title'] = 'Users Groups';
     165$lang['help_groups'] =
     166array(
     167 
     168  'PhpWebGallery is able to manage groups of users. It can be very useful to
     169have common permission access for private categories.',
     170
     171  'You can create groups and add users to a group in administration panel,
     172Identification, Groups.',
     173
     174  'A user can belong to several groups. The authorization is stronger than
     175prohibition : if user "jack" belongs to groups "family" and "friends", and
     176that only group "family" can see category "Christmas 2003", "jack" will be
     177able to see "Christmas 2003".'
     178 
     179  );
     180
     181$lang['help_remote_title'] = 'Remote site';
     182$lang['help_remote'] =
     183array(
     184
     185  'PhpWebGallery offers the possibility to use several servers to store the
     186images which will compose your gallery. It can be useful if your gallery is
     187installed on one limited space and that you have a big quantity of images to
     188be shown.',
     189
     190  '1. edit file tools/create_listing_file.php, by modifying parameters section
     191such as $conf[\'prefix_thumbnail\'] or $conf[\'use_exif\'].',
     192
     193  '2. place file "tools/create_listing_file.php" modified on your distant
     194website, in the same directory than your category directories (as the
     195directory "galleries" of this website) by ftp. For the example, let\'s say
     196that you can access http://example.com/galleries/create_listing_file.php.',
     197
     198  '3. go to administration panel, General, Remote sites. Ask to create a new
     199site, for example http://example.com/galleries',
     200
     201  '4. a new remote site is registered. You can perform 4 actions :
     202<ol>
     203
     204  <li>generate listing : launches a distant request to generate a distant
     205  file listing</li>
     206
     207  <li>update : reads the distant listing.xml file and synchronizes with
     208  database informations</li>
     209
     210  <li>clean : removes distant listing.xml file</li>
     211
     212  <li>delete : deletes the site (and all related categories and elements) in
     213  the database</li>
     214
     215</ol>',
     216
     217  'You can do all this by hand by generating yourself the listing.xml file,
     218moving it from your distant server to you local PhpWebGallery "admin"
     219directory and opening the remote site management screen : PhpWebGallery will
     220propose you to use the found listing.xml file.'
     221 
     222  );
     223
     224$lang['help_upload_title'] = 'Files upload by users';
     225$lang['help_upload'] =
     226array(
     227  'PhpWebGallery offers the possibility for users to upload images. in order to
     228do it :',
     229 
     230  '1. authorize upload on any categories (administration panel, Categories,
     231Manage, edit or administration panel, Categories, Upload)',
     232
     233  '2. give write rights on directories for ugo (user, group, other)',
     234 
     235  'Files uploaded by users are not directly visible on the website, they must
     236be validated by an administrator. For that purpose, an administrator must go
     237on administration panel, Pictures, Waiting in order to validate or to refuse
     238the files proposed, then to synchronize filesystem with database.'
     239  );
     240
     241$lang['help_virtual_title'] = 'Links between elements and categories, virtual categories';
     242$lang['help_virtual'] =
     243array(
     244  'PhpWebGallery dissociates categories where elements are stored and
     245categories where they are shown.',
     246 
     247  'By default, elements are shown only in their real categories : the ones
     248corresponding to directories on the web server.',
     249
     250  'To link an element to a category, you just have to make the association on
     251the page of element edition (link to this screen on picture.php logged as an
     252administrator) or on the informations of all elements of a category.',
     253 
     254  'Using this principle, it is possible to create virtual categories : no
     255directory coresponds to this category. You can create virtual categories in
     256administration panel, Categories, Manage.'
     257  );
     258
    45259$lang['help_infos_title'] = 'Miscellanous informations';
    46 $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.';
    47 $lang['help_remote_title'] = 'Remote site';
    48 $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 : ';
    49 $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-".';
    50 $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.';
    51 $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.';
    52 $lang['help_remote'][4] = '4. get back file listing.xml from your distant website to place it in directory "admin" of this website.';
    53 $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".';
    54 $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.';
    55 $lang['help_upload_title'] = 'Added images by users';
    56 $lang['help_upload'][0] = 'PhpWebGallery offers the possibility for users to upload images. in order to do it :';
    57 $lang['help_upload'][1] = '1. authorize the option in the configuration zone of the administration panel';
    58 $lang['help_upload'][2] = '2. authorize the rights in writing in the images directories';
    59 $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"';
    60 $lang['help_upload'][3] = 'The category must have upload available itself for upload.';
    61 $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.';
    62 $lang['help_virtual_title'] = 'Links between pictures and categories and virtual categories';
    63 $lang['help_virtual'][0] = 'PhpWebGallery is able to dissociate categories where pictures are stored and categories where pictures are shown.';
    64 $lang['help_virtual'][1] = 'By default, pictures are shown only in their real categories : the ones corresponding to directories on the web server.';
    65 $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.';
    66 $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.';
    67 $lang['help_groups_title'] = 'Users Groups';
    68 $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.';
    69 $lang['help_groups'][1] = '1. Create the group "family" on the section "Groups" of admin panel.';
    70 $lang['help_groups'][2] = '2. On the section "Users", edit on of them and associate him to the group "family".';
    71 $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.';
    72 $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".';
    73 $lang['help_access_title'] = 'Access authorization';
    74 $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 :';
    75 $lang['help_access'][1] = '1. Modify category informations (from the "categories" section in tha admin panel) and make it "private".';
    76 $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.';
    77 $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.';
    78 
    79  ?>
     260$lang['help_infos'] =
     261array(
     262  'As soon as you created your gallery, go in the user list and modify
     263permissions for user "guest". Indeed, every new registered user will have by
     264default the same permissions as "guest" user.',
     265 
     266  'If you have any question, do not hesitate to take a look at the forum or ask
     267a question there. The <a href="http://forum.phpwebgallery.net"
     268style="text-decoration:underline">forum</a> (message board) is available on
     269the presentation site of PhpWebGallery. Check the <a
     270href="http://doc.phpwebgallery.net"
     271style="text-decoration:underline">official PhpWebGallery documentation</a> for
     272further reading.'
     273  );
     274?>

  • trunk/template/default/admin/help.tpl

    r394 r669  
    1515      <ul style="text-align:left; margin-right:10px;">
    1616        <!-- BEGIN item -->
    17         <li>{cat.item.CONTENT}</li>
     17        <li style="margin-bottom:5px;">{cat.item.CONTENT}</li>
    1818        <!-- END item -->
    1919      </ul>
Note: See TracChangeset for help on using the changeset viewer.