source: trunk/language/en_UK.iso-8859-1/help.html @ 1087

Last change on this file since 1087 was 889, checked in by plg, 19 years ago
  • modification: localized labels in Administration>Pictures>Caddie
  • translation: bug fixed on special categories title in French
  • translation: all help pages were translated in french
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.6 KB
Line 
1<h2>Help</h2>
2
3<h3>Quick start</h3>
4
5<ol>
6 
7  <li>Create a local directory "test_category".</li>
8
9  <li>Copy pictures in "test_category".</li>
10
11  <li>Open an FTP connection to this remote gallery.</li>
12
13  <li>Upload local directory "test_category" into your remote directory
14  names "galleries". Set authorizations to 777 on directory
15  "galleries/test_category".</li>
16
17  <li>Connect to your PhpWebGallery as an admin.</li>
18
19  <li>Go to <span class="pwgScreen">Administration, Pictures,
20  Thumbnails</span>. PhpWebGallery find the picture from "test_category"
21  without thumbnails. Ask to create thumbnails.</li>
22
23  <li>Go to <span class="pwgScreen">Administration, General,
24  Synchronize</span>. Check "directories + files" option, uncheck "only
25  perform a simulation" and submit the synchronization.</li>
26
27  <li>Job's done. You've created a category "test_category" at the root of
28your gallery.</li>
29 
30</ol>
31
32<h3>Adding elements</h3>
33
34<ul>
35
36  <li>
37
38    <p>Category directories are in the PhpWebGallery directory
39    "galleries". Here follow the directory tree of a very small gallery (but
40    using many features) :</p>
41
42    <pre>
43.
44|-- admin
45|-- doc
46|-- galleries
47|   |-- category-1
48|   |   |-- category-1.1
49|   |   |   |-- category-1.1.1
50|   |   |   |   |-- category-1.1.1.1
51|   |   |   |   |   |-- pwg_high
52|   |   |   |   |   |   +-- wedding.jpg
53|   |   |   |   |   |-- thumbnail
54|   |   |   |   |   |   +-- TN-wedding.jpg
55|   |   |   |   |   +-- wedding.jpg
56|   |   |   |   +-- category-1.1.1.2
57|   |   |   +-- category-1.1.2
58|   |   |-- category-1.2
59|   |   |   |-- pookie.jpg
60|   |   |   +-- thumbnail
61|   |   |       +-- TN-pookie.jpg
62|   |   +-- category-1.3
63|   +-- category-2
64|       |-- piglet.gif
65|       |-- pwg_representative
66|       |   +-- video.jpg
67|       |-- thumbnail
68|       |   +-- TN-piglet.jpg
69|       +-- video.avi
70|-- include
71|-- install
72|-- language
73|-- template
74+-- tool</pre>
75
76  </li>
77 
78  <li>Basically, a category is represented by a directory at any level in
79  PhpWebGallery directory "galleries". Each category can contain as many
80  sub-level as you wish. In the example above, category-1.1.1.1 is at level
81  4 of deepness.</li>
82
83  <li>Basically, an element is represented by a file. A file can be a
84  PhpWebGallery element if its extenstion is among <code>file_ext</code>
85  configuration parameter possibilities (see <span
86  class="filename">include/config_default.inc.php</span> file). A file can
87  be a picture if its extension is among <code>picture_ext</code>
88  configuration parameter possibilities.</li>
89
90  <li>Picture elements must have an associated thumbnail (see section below
91  about thumbnails)</li>
92
93  <li>Picture elements can have a high quality file associated. As for
94  wedding.jpgin the example above. No prefix on the high quality picture is
95  required.</li>
96
97  <li>Non picture elements (video, sounds, file texts, what you want...) are
98  by default represented by an icon corresponding to the filename
99  extension. Optionaly, you can associate a thumbnail and a representative
100  file (see video.avi in the example above).</li>
101
102  <li><em>Warning</em> : the name of directories and files must be composed
103of letters, figures, "-", "_" or ".". No blank space, no accentuated
104characters</li>
105
106  <li><em>Advise</em> : a category can contain elements and sub-categories
107in the same time. Nerverthless, you are strongly advised for each category
108to choose between category containing elements <strong>or</strong> category
109containing sub-categories.</li>
110
111  <li>Once files, thumbnails and representatives are correctly placed in the
112  directories, go to : <span class="pwgScreen">Administration, General,
113  Synchronize</span></li>
114
115</ul>
116
117<h3>Thumbnails</h3>
118
119<ul>
120
121  <li>As said earlier, each element of picture type must be associated with
122  a thumbnail.</li>
123
124  <li>Thumbnails are stored in the sub-directory "thumbnail" of the category
125  directory. The thumbnail is a picture (same filename extensions possible
126  than picture files) which filename is prefixed by the configured
127  "Thumbnail prefix" (see admin panel, Configuration, General).</li>
128
129  <li>Thumbnails don't need to have the same extension as their associated
130  picture (a picture with .jpg extension can have a thumbnail in .GIF
131  extention for instance).</li>
132
133  <li>Advise: use an external module for thumbnails creation.</li>
134
135  <li>You can also use the thumbnail creation page (<span
136  class="pwgScreen">Administration, Pictures, Thumbnails</span>), but it is
137  not recommended. Indeed, thumbnail quality may be poor and it uses a high
138  CPU load which can be a problem if you use free web hosting.</li>
139
140  <li>If you choose to use your hosting provider to create thumbnails, you
141  must give write rights on all category directories and sub-directories
142  "thumbnail" for ugo (user, group, other).</li>
143
144</ul>
145
146<h3>Access authorization</h3>
147
148<ul>
149
150  <li>You can forbid access to categories. Categories can be "public" or
151  "private". Permissions (for groups and users) can be set only if the
152  category is private.</li>
153
154  <li>You can set a category to private by editing a single category (<span
155  class="pwgScreen">Administration, Categories, Manage, edit</span>) or by
156  setting options to your whole category tree (<span
157  class="pwgScreen">Administration, Categories, Public/Private</span>).</li>
158
159  <li>
160
161    <p>Once the category is private, you can manage permissions for groups
162    and users through 3 screens :(administration panel, Permissions).</p>
163
164    <ul>
165
166      <li><span class="pwgScreen">Administration, Identification, Users,
167      permissions action (one link per user)</span></li>
168
169      <li><span class="pwgScreen">Administration, Identification, Groups,
170      permissions action (one link per group)</span></li>
171
172      <li><span class="pwgScreen">Administration, Categories, Manage, edit
173      category permissions action (one link per category)</span></li>
174
175    </ul>
176
177  </li>
178
179</ul>
180
181<h3>Users Groups</h3>
182
183<ul>
184
185  <li>PhpWebGallery is able to manage groups of users. It can be very useful
186  to have common permission access for private categories.</li>
187
188  <li>You can create groups in <span class="pwgScreen">Administration,
189  Identification, Groups</span> and associate users to this group in <span
190  class="pwgScreen">Administration, Identication, Users</span>.</li>
191
192  <li>A user can belong to several groups. The authorization is stronger
193  than prohibition : if user "jack" belongs to groups "family" and
194  "friends", and that only group "family" can see category "Christmas 2003",
195  "jack" will be able to see "Christmas 2003".</li>
196
197</ul>
198
199<h3>Files upload by users</h3>
200
201<p>PhpWebGallery offers the possibility for users to upload images. in
202order to do it:</p>
203
204<ol>
205
206  <li>authorize upload on any categories (<span
207  class="pwgScreen">Administration, Categories, Manage, edit</span> or <span
208  class="pwgScreen">Administration panel, Categories, Upload</span>)</li>
209
210  <li>give write rights on directories for ugo (user, group, other)</li>
211
212</ol>
213
214<p>Files uploaded by users are not directly visible on the website, they
215must be validated by an administrator. For that purpose, an administrator
216must go in <span class="pwgScreen">Administration, Pictures, Waiting</span>
217in order to validate or to refuse the files proposed, then to synchronize
218filesystem with database.</p>
219
220
221<h3>Links between elements and categories, virtual categories</h3>
222
223<ul>
224
225  <li>PhpWebGallery dissociates categories where elements are stored and
226  categories where they are shown.</li>
227
228  <li>By default, elements are shown only in their real categories : the
229  ones corresponding to directories on the web server.</li>
230
231  <li>To link an element to a category, you just have to make the
232  association on the page of element edition (link to this screen on
233  picture.php logged as an administrator) or on the informations of all
234  elements of a category.</li>
235
236  <li>Using this principle, it is possible to create virtual categories : no
237  directory coresponds to this category. You can create virtual categories
238  in <span class="pwgScreen">Administration, Categories, Manage</span>.</li>
239
240</ul>
241
242<h3>Miscellanous informations</h3>
243
244<ul>
245
246  <li>As soon as you created your gallery, modify default display properties
247  in <span class="pwgScreen">Administration panel, Configuration,
248  Default</span>. Indeed, every new registered user will have by default the
249  same display properties.</li>
250
251  <li>If you have any question, do not hesitate to take a look at the forum
252  or ask a question there. The <a
253  href="http://forum.phpwebgallery.net">forum</a> (message board) is
254  available on the presentation site of PhpWebGallery. Check the <a
255  href="http://doc.phpwebgallery.net">official PhpWebGallery
256  documentation</a> for further reading.</li>
257
258</ul>
259
Note: See TracBrowser for help on using the repository browser.