aboutsummaryrefslogtreecommitdiffstats
path: root/language/en_UK.iso-8859-1/help
diff options
context:
space:
mode:
authorplegall <plg@piwigo.org>2005-09-14 21:57:05 +0000
committerplegall <plg@piwigo.org>2005-09-14 21:57:05 +0000
commit3371c757424cef291be02a946e528983dece9543 (patch)
tree2ede9c21e065d766d8a3226309635c46b596d77d /language/en_UK.iso-8859-1/help
parenteac1724ee5e20967d989916b76fc9076411be758 (diff)
- improvement: long localized messages are in HTML files instead of $lang
array. This is the case of admin/help and about pages. - deletion: of unused functions (ts_to_mysqldt, is_image, TN_exists, check_date_format, date_convert, get_category_directories, get_used_metadata_list, array_remove, pwg_write_debug, get_group_restrictions, get_all_group_restrictions, is_group_allowed, style_select, deprecated_getAttribute). - new: many new contextual help pages to replace descriptions previously included in pages. - modification: reorganisation of language files. Deletion of unused language keys, alphabetical sort. No faq.lang.php anymore (replaced by help.html). Only done for en_UK.iso-8859-1. git-svn-id: http://piwigo.org/svn/trunk@862 68402e56-0260-453c-a942-63ccdbb3a9ee
Diffstat (limited to '')
-rw-r--r--language/en_UK.iso-8859-1/help.html230
-rw-r--r--language/en_UK.iso-8859-1/help/cat_modify.html95
-rw-r--r--language/en_UK.iso-8859-1/help/cat_options.html36
-rw-r--r--language/en_UK.iso-8859-1/help/cat_perm.html15
-rw-r--r--language/en_UK.iso-8859-1/help/search.html24
-rw-r--r--language/en_UK.iso-8859-1/help/synchronize.html12
-rw-r--r--language/en_UK.iso-8859-1/help/thumbnail.html28
-rw-r--r--language/en_UK.iso-8859-1/help/user_list.html32
8 files changed, 472 insertions, 0 deletions
diff --git a/language/en_UK.iso-8859-1/help.html b/language/en_UK.iso-8859-1/help.html
new file mode 100644
index 000000000..4f1e5634f
--- /dev/null
+++ b/language/en_UK.iso-8859-1/help.html
@@ -0,0 +1,230 @@
+<h2>Help</h2>
+
+<h3>Adding elements</h3>
+
+<ul>
+
+ <li>
+
+ <p>Category directories are in the PhpWebGallery directory
+ "galleries". Here follow the directory tree of a very small gallery (but
+ using many features) :</p>
+
+ <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.jpg
+| |-- thumbnail
+| | +-- TN-piglet.jpg
+| +-- video.avi
+|-- include
+|-- install
+|-- language
+|-- template
++-- tool</pre>
+
+ </li>
+
+ <li>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.</li>
+
+ <li>Basically, an element is represented by a file. A file can be a
+ PhpWebGallery element if its extenstion is among <code>file_ext</code>
+ configuration parameter possibilities (see <span
+ class="filename">include/config_default.inc.php</span> file). A file can
+ be a picture if its extension is among <code>picture_ext</code>
+ configuration parameter possibilities.</li>
+
+ <li>Picture elements must have an associated thumbnail (see section below
+ about thumbnails)</li>
+
+ <li>Picture elements can have a high quality file associated. As for
+ wedding.jpgin the example above. No prefix on the high quality picture is
+ required.</li>
+
+ <li>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).</li>
+
+ <li>Warning : the name of directories and files must be composed of
+ letters, figures, "-", "_" or ".". No blank space, no accentuated
+ characters</li>
+
+ <li>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.</li>
+
+ <li>Once files, thumbnails and representatives are correctly placed in the
+ directories, go to : <span class="pwgScreen">Administration, General,
+ Synchronize</span></li>
+
+</ul>
+
+<h3>Thumbnails</h3>
+
+<ul>
+
+ <li>As said earlier, each element of picture type must be associated with
+ a thumbnail.</li>
+
+ <li>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).</li>
+
+ <li>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).</li>
+
+ <li>Advise: use an external module for thumbnails creation.</li>
+
+ <li>You can also use the thumbnail creation page (<span
+ class="pwgScreen">Administration, Pictures, Thumbnails</span>), but it is
+ not recommended. Indeed, thumbnail quality may be poor and it uses a high
+ CPU load which can be a problem if you use free web hosting.</li>
+
+ <li>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).</li>
+
+</ul>
+
+<h3>Access authorization</h3>
+
+<ul>
+
+ <li>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.</li>
+
+ <li>You can set a category to private by editing a single category (<span
+ class="pwgScreen">Administration, Categories, Manage, edit</span>) or by
+ setting options to your whole category tree (<span
+ class="pwgScreen">Administration, Categories, Public/Private</span>).</li>
+
+ <li>
+
+ <p>Once the category is private, you can manage permissions for groups
+ and users through 3 screens :(administration panel, Permissions).</p>
+
+ <ul>
+
+ <li><span class="pwgScreen">Administration, Identification, Users,
+ permissions action (one link per user)</span></li>
+
+ <li><span class="pwgScreen">Administration, Identification, Groups,
+ permissions action (one link per group)</span></li>
+
+ <li><span class="pwgScreen">Administration, Categories, Manage, edit
+ category permissions action (one link per category)</span></li>
+
+ </ul>
+
+ </li>
+
+</ul>
+
+<h3>Users Groups</h3>
+
+<ul>
+
+ <li>PhpWebGallery is able to manage groups of users. It can be very useful
+ to have common permission access for private categories.</li>
+
+ <li>You can create groups in <span class="pwgScreen">Administration,
+ Identification, Groups</span> and associate users to this group in <span
+ class="pwgScreen">Administration, Identication, Users</span>.</li>
+
+ <li>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".</li>
+
+</ul>
+
+<h3>Files upload by users</h3>
+
+<p>PhpWebGallery offers the possibility for users to upload images. in
+order to do it:</p>
+
+<ol>
+
+ <li>authorize upload on any categories (<span
+ class="pwgScreen">Administration, Categories, Manage, edit</span> or <span
+ class="pwgScreen">Administration panel, Categories, Upload</span>)</li>
+
+ <li>give write rights on directories for ugo (user, group, other)</li>
+
+</ol>
+
+<p>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 in <span class="pwgScreen">Administration, Pictures, Waiting</span>
+in order to validate or to refuse the files proposed, then to synchronize
+filesystem with database.</p>
+
+
+<h3>Links between elements and categories, virtual categories</h3>
+
+<ul>
+
+ <li>PhpWebGallery dissociates categories where elements are stored and
+ categories where they are shown.</li>
+
+ <li>By default, elements are shown only in their real categories : the
+ ones corresponding to directories on the web server.</li>
+
+ <li>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.</li>
+
+ <li>Using this principle, it is possible to create virtual categories : no
+ directory coresponds to this category. You can create virtual categories
+ in <span class="pwgScreen">Administration, Categories, Manage</span>.</li>
+
+</ul>
+
+<h3>Miscellanous informations</h3>
+
+<ul>
+
+ <li>As soon as you created your gallery, modify default display properties
+ in <span class="pwgScreen">Administration panel, Configuration,
+ Default</span>. Indeed, every new registered user will have by default the
+ same display properties.</li>
+
+ <li>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">forum</a> (message board) is
+ available on the presentation site of PhpWebGallery. Check the <a
+ href="http://doc.phpwebgallery.net">official PhpWebGallery
+ documentation</a> for further reading.</li>
+
+</ul>
+
diff --git a/language/en_UK.iso-8859-1/help/cat_modify.html b/language/en_UK.iso-8859-1/help/cat_modify.html
new file mode 100644
index 000000000..52d0d17e0
--- /dev/null
+++ b/language/en_UK.iso-8859-1/help/cat_modify.html
@@ -0,0 +1,95 @@
+<h2>Edit a category</h2>
+
+<p>Modify informations and options of a single category.</p>
+
+<h3>Action links</h3>
+
+<p>This page offers you link to modification page of parent categories and
+action links :</p>
+
+<ul>
+ <li>jump to category</li>
+ <li>manage category elements (if category contains elements)</li>
+ <li>manage sub-categories</li>
+ <li>manage permissions (if category is private)</li>
+ <li>delete category (if category is virtual).</li>
+</ul>
+
+<h3>Move</h3>
+
+<p>If the category is virtual, you can move it. Moving a category means
+changing its parent category.</p>
+
+<h3>Options</h3>
+
+<ul>
+
+ <li><strong>Access type</strong>: Permission management. If you make a
+ category private, all its child categories becomes private. If you make a
+ category public, all its parent categories becomes public.</li>
+
+ <li><strong>Lock</strong>: The category and its sub-categories will
+ temporary been disabled for maintenance.</li>
+
+ <li><strong>Comments</strong>: Authorize users to comment elements of this
+ category.</li>
+
+ <li><strong>Authorize upload</strong>: Authorize users to upload
+ files. This option is available only if category is physical (not
+ virtual).</li>
+
+</ul>
+
+<p>You can also manage these options with multi-categories options
+management screen (screens <span class="pwgScreen">Upload</span>, <span
+class="pwgScreen">Comments</span>, <span class="pwgScreen">Lock</span>,
+<span class="pwgScreen">Public/Private</span>, <span
+class="pwgScreen">Representative</span> in <span
+class="pwgScreen">Administration, Categories</span>).</p>
+
+<h3>Representation</h3>
+
+<p>The representant of the category is the thumbnail displayed to represent
+the category on main page (<span class="pwgScreen">category.php</span>) when
+a category contains only sub-categories (just as the root category).</p>
+
+<p>There are 4 ways to set the representative picture of a category :</p>
+
+<ul>
+
+ <li><span class="pwgScreen">picture.php</span>: in the action buttons bar,
+ one of them let you set the displayed picture as representative for the
+ displayed category. This button is available only for administrators.</li>
+
+ <li><span class="pwgScreen">Modify informations about a picture</span> in
+ administration. This screen can be reach from <span
+ class="pwgScreen">picture.php</span> or <span class="pwgScreen">Batch
+ management</span> in <em>unit mode</em>. See the help of this screen for
+ details.</li>
+
+ <li><span class="pwgScreen">Administration, Categories,
+ Representative</span>. See the help of this screen for details.</li>
+
+ <li><span class="pwgScreen">Edit a category</span> (this screen).</li>
+
+</ul>
+
+<p>The representation depends on configuration parameter
+<code>allow_random_representative</code> (see <span
+class="filename">include/config_default.inc.php</span>).</p>
+
+<p>In default mode (<code>allow_random_representative</code> set to false)
+each category containing at least one element is represented by a fixed
+element. Once set (at category creation), the representative changes only
+when an administrator ask for it. If the representant is not appropriate,
+you can ask to <strong>Find a new representant by random</strong>.</p>
+
+<p>If configuration parameter <code>allow_random_representative</code> is
+set to true, a category containing elements can have no fixed
+representant. Just use <strong>Delete representant</strong> button.</p>
+
+<p>If the category contains no element (but only sub-categories) it can be
+represented by any element thanks to screen <span class="pwgScreen">Modify
+informations about a picture</span>. The only option on the current screen
+is to <strong>Delete representant</strong> button, after using this button,
+no representant option to set anymore.</p>
diff --git a/language/en_UK.iso-8859-1/help/cat_options.html b/language/en_UK.iso-8859-1/help/cat_options.html
new file mode 100644
index 000000000..2db75ed0a
--- /dev/null
+++ b/language/en_UK.iso-8859-1/help/cat_options.html
@@ -0,0 +1,36 @@
+<h2>Category options</h2>
+
+<p>This screen lets the administrator manage categories option for many
+categories at once.</p>
+
+<dl>
+
+ <dt>Upload</dt>
+ <dd>Make categories uploadable for gallery visitors. Only non virtual and
+ non remote categories are shown.</dd>
+
+ <dt>Comments</dt>
+ <dd>Authorize users to add comments on selected categories. By
+ inheritance, an element is commentable if it belongs at least to one
+ commentable category.</dd>
+
+ <dt>Lock</dt>
+ <dd>Selected categories will temporary been disabled for maintenance. If
+ you lock a category, all its child categories become locked. If you unlock
+ a category, all its parent categories become unlocked.</dd>
+
+ <dt>Public / private</dt>
+ <dd>Manage authorizations for selected categories. Selected categories are
+ private : you will need to authorize users and/or groups to access to
+ them. If you make a category private, all its child categories becomes
+ private. If you make a category public, all its parent categories becomes
+ public</dd>
+
+ <dt>Representative</dt>
+ <dd>This option can be managed only if you set configuration parameter
+ <code>allow_random_representative</code> (see <span
+ class="filename">include/config_defaults.inc.php</span>) to
+ <em>true</em>. Each category can be randomly represented or singly
+ represented (by a unique picture).</dd>
+
+</dl>
diff --git a/language/en_UK.iso-8859-1/help/cat_perm.html b/language/en_UK.iso-8859-1/help/cat_perm.html
new file mode 100644
index 000000000..3b3471fb9
--- /dev/null
+++ b/language/en_UK.iso-8859-1/help/cat_perm.html
@@ -0,0 +1,15 @@
+<h2>Manage permissions for a category</h2>
+
+<p>This screen is available only for a private category. Here you can select
+users and groups authorized for this category.</p>
+
+<h3>Groups</h3>
+
+<p>You can deny or grant groups for the current category. By modifying
+groups authorizations, you'll probably modify the list of users granted to
+the category thanks to group belongings.</p>
+
+<h3>Users</h3>
+
+<p>You can deny or grant individual users. Users granted thanks to group
+belongings can be denied or granted specifically.</p>
diff --git a/language/en_UK.iso-8859-1/help/search.html b/language/en_UK.iso-8859-1/help/search.html
new file mode 100644
index 000000000..c98038b2b
--- /dev/null
+++ b/language/en_UK.iso-8859-1/help/search.html
@@ -0,0 +1,24 @@
+<h2>Search</h2>
+
+<p>This page let you search pictures among the whole gallery.</p>
+
+<dl>
+
+ <dt>Search for words</dt>
+ <dd>Search for entered words in all the attributes related to the pictures
+ displayed in the gallery. Use * as a wildcard for partial matches.</dd>
+
+ <dt>Search for Author</dt>
+ <dd>Use * as a wildcard for partial matches.</dd>
+
+ <dt>Search by Date</dt>
+ <dd>Select a date and/or an ending date for your query. Leave date empty
+ if you want to make a "before" query. The year must be entered in the last
+ field in the following format : 0000 (i.e. 2004)</dd>
+
+ <dt>Search in Categories</dt>
+ <dd>Select the category or categories you wish to search in. For speed all
+ subcategories can be searched by selecting the parent and setting enable
+ search subcategories below.</dd>
+
+</dl>
diff --git a/language/en_UK.iso-8859-1/help/synchronize.html b/language/en_UK.iso-8859-1/help/synchronize.html
index 835e0c52e..c1ae424f8 100644
--- a/language/en_UK.iso-8859-1/help/synchronize.html
+++ b/language/en_UK.iso-8859-1/help/synchronize.html
@@ -1 +1,13 @@
<h2>Synchronize</h2>
+
+<p>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.</p>
+
+<p>The first synchronization must be the directories/files one.</p>
+
+<p>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.</p>
diff --git a/language/en_UK.iso-8859-1/help/thumbnail.html b/language/en_UK.iso-8859-1/help/thumbnail.html
new file mode 100644
index 000000000..857a266ca
--- /dev/null
+++ b/language/en_UK.iso-8859-1/help/thumbnail.html
@@ -0,0 +1,28 @@
+<h2>Thumbnails creation</h2>
+
+<p>This page let you create missing thumbnails.</p>
+
+<dl>
+
+ <dt>GD version</dt>
+
+ <dd>GD is the picture manipulating library for PHP. Choose the version
+ installed on your server. If you choose the wrong, you'll just have errors
+ messages, come back with your browser and choose the other version. If no
+ version works, it means your server doesn't support GD.</dd>
+
+ <dt>Width and height</dt>
+
+ <dd>Maximum dimensions that thumbnails can take. Aspect ratio is
+ maintained.</dd>
+
+ <dt>Number of thumbnails to create</dt>
+
+ <dd>Do not try to miniaturize too many pictures in the same time. Indeed, miniaturization uses a lot of CPU. If you installed PhpWebGallery on a free provider, a too high CPU load can sometime lead to the deletion of your website.</dd>
+
+ <dt>File format</dt>
+
+ <dd>Only JPEG file format is supported for thumbnail creation. Thumbnails
+ can be created only from PNG and JPEG pictures.</dd>
+
+</dl>
diff --git a/language/en_UK.iso-8859-1/help/user_list.html b/language/en_UK.iso-8859-1/help/user_list.html
new file mode 100644
index 000000000..4bc00081b
--- /dev/null
+++ b/language/en_UK.iso-8859-1/help/user_list.html
@@ -0,0 +1,32 @@
+<h2>Users list</h2>
+
+<p>This is the place where you can manage registered users. Only permissions
+are managed in different several screens.</p>
+
+<h3>Add a user</h3>
+
+<p>Administrator can manually add users.</p>
+
+<h3>Users list</h3>
+
+<p>The list can be filtered on username (use * as wildcard), group or
+status. The list can be order by registration date or username, in ascending
+or descending order.</p>
+
+<p>This screen works be managing several users at once on different actions
+:</p>
+
+<ul>
+
+ <li>delete users (require a confirmation checkbox)</li>
+
+ <li>change status</li>
+
+ <li>associate or dissociate from groups</li>
+
+ <li>modify display properties</li>
+
+</ul>
+
+<p>The target is the set users selected (by default) or all users is
+asked.</p>