Changeset 3020 for trunk/language


Ignore:
Timestamp:
Dec 23, 2008, 8:56:14 PM (15 years ago)
Author:
vdigital
Message:
  • Adding <span> to obtain the expected result
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/language/en_UK/help.html

    r2495 r3020  
    22<h2>Help</h2>
    33
    4 <h3>Quick start</h3>
     4<div id="instructionPLoader" class="instructionBlock">
     5  <div
     6    id="pLoader_header"
     7    class="instructionBlockHeaderCollapsed"
     8    onclick="blockToggleDisplay('pLoader_header', 'pLoader_content')"
     9  ><span>
     10    Add photos, the pLoader way
     11  </span></div>
     12  <div
     13    id="pLoader_content"
     14    class="instructionBlockContent"
     15    style="display:none"
     16  >
     17    <ol>
     18      <li>Create a directory "upload" next to directory "galleries" in your Piwigo installation, with write access.</li>
     19      <li>Install pLoader on your computer, start it and fill the connection settings : your gallery URL, your username and password.</li>
     20      <li>Drag'n drop photos from your directory browser into pLoader photo selection.</li>
     21      <li>Create a category and select it.</li>
     22      <li>Select some photos.</li>
     23      <li>Click on the green arrow to transfer photos in your gallery</li>
     24    </ol>
     25Congratulations! You have successfuly created the first category of your photo gallery.
     26  </div> <!-- pLoader_content -->
     27</div> <!-- instructionPLoader -->
     28
     29<div id="instructionFTP" class="instructionBlock">
     30  <div
     31    id="FTP_header"
     32    class="instructionBlockHeaderCollapsed"
     33    onclick="blockToggleDisplay('FTP_header', 'FTP_content')"
     34  ><span>
     35    Add photos, the FTP way
     36  </span></div>
     37  <div
     38    id="FTP_content"
     39    class="instructionBlockContent"
     40    style="display:none"
     41  >
     42
     43<h3>Quick Start</h3>
    544
    645<ol>
    7  
    8   <li>Create a local directory "test_category".</li>
    9 
    10   <li>Copy pictures in "test_category".</li>
    11 
    12   <li>Open an FTP connection to this remote gallery.</li>
    13 
    14   <li>Upload local directory "test_category" into your remote directory
    15   names "galleries". Set authorizations to 777 on directory
    16   "galleries/test_category".</li>
    17 
    18   <li>Connect to your Piwigo as an admin.</li>
    19 
    20   <li>Go to <span class="pwgScreen">Administration, Pictures,
    21   Thumbnails</span>. Piwigo find the picture from "test_category"
    22   without thumbnails. Ask to create thumbnails.</li>
    23 
    24   <li>Go to <span class="pwgScreen">Administration, Categories,
    25   Synchronize</span>. Check "directories + files" option, uncheck "only
    26   perform a simulation" and submit the synchronization.</li>
    27 
    28   <li>Job's done. You've created a category "test_category" at the root of
    29 your gallery.</li>
    30  
     46  <li>Create a directory on your computer.</li> 
     47
     48  <li>Copy some photos inside this directory, resize them for web display. <em>Warning</em>: the name of directories and files must contain only letters, figures, "-", "_" or ".". No blank space, no accentuated characters.</li>
     49
     50  <li>With a FTP client, copy your directory in the "galleries" directory of your Piwigo installation.</li>
     51
     52  <li>Logon your gallery and go to <span class="pwgScreen">Administration &raquo; Pictures &raquo; Thumbnails</span> to create missing thumbnails.</li>
     53
     54  <li>Go to <span class="pwgScreen">Administration</span> and click on the big Synchronization button.</li>
    3155</ol>
    3256
    33 <h3>Adding elements</h3>
    34 
     57Congratulations! You have successfuly created the first category of your photo gallery.
     58
     59<h3>Directories and files organization</h3>
    3560<ul>
    3661
    … …  
    3863
    3964    <p>Category directories are in the Piwigo directory
    40     "galleries". Here follow the directory tree of a very small gallery (but
     65    "galleries". Here follows the directory tree of a very small gallery (but
    4166    using many features) :</p>
    4267
    … …  
    77102  </li>
    78103 
    79   <li>Basically, a category is represented by a directory at any level in
    80   Piwigo directory "galleries". Each category can contain as many
    81   sub-level as you wish. In the example above, category-1.1.1.1 is at level
    82   4 of deepness.</li>
     104  <li>Each directory under "galleries" produces a category. There is no limit on deepness.</li>
    83105
    84106  <li>Basically, an element is represented by a file. A file can be a
    … …  
    93115
    94116  <li>Picture elements can have a high quality file associated. As for
    95   wedding.jpgin the example above. No prefix on the high quality picture is
    96   required.</li>
     117  wedding.jpg in the example above. No prefix on the high quality picture.</li>
    97118
    98119  <li>Non picture elements (video, sounds, file texts, what you want...) are
    … …  
    101122  file (see video.avi in the example above).</li>
    102123
    103   <li><em>Warning</em> : the name of directories and files must be composed
    104 of letters, figures, "-", "_" or ".". No blank space, no accentuated
    105 characters</li>
    106 
    107   <li><em>Advise</em> : a category can contain elements and sub-categories
    108 in the same time. Nerverthless, you are strongly advised for each category
    109 to choose between category containing elements <strong>or</strong> category
    110 containing sub-categories.</li>
     124  <li><em>Warning</em>: the name of directories and files must contain only letters, figures, "-", "_" or ".". No blank space, no accentuated characters.</li>
    111125
    112126  <li>Once files, thumbnails and representatives are correctly placed in the
    113   directories, go to : <span class="pwgScreen">Administration, Categories,
     127  directories, go to : <span class="pwgScreen">Administration &raquo; Categories &raquo;
    114128  Synchronize</span></li>
    115129
    … …  
    117131
    118132<h3>Thumbnails</h3>
    119 
    120 <ul>
    121 
    122   <li>As said earlier, each element of picture type must be associated with
    123   a thumbnail.</li>
     133<ul>
     134
     135  <li>Each photo must have its thumbnail.</li>
    124136
    125137  <li>Thumbnails are stored in the sub-directory "thumbnail" of the category
    126   directory. The thumbnail is a picture (same filename extensions possible
    127   than picture files) which filename is prefixed by the configured
    128   "Thumbnail prefix" (see admin panel, Configuration, General).</li>
    129 
    130   <li>Thumbnails don't need to have the same extension as their associated
    131   picture (a picture with .jpg extension can have a thumbnail in .GIF
    132   extention for instance).</li>
    133 
    134   <li>Advise: use an external module for thumbnails creation.</li>
    135 
    136   <li>You can also use the thumbnail creation page (<span
    137   class="pwgScreen">Administration, Pictures, Thumbnails</span>), but it is
    138   not recommended. Indeed, thumbnail quality may be poor and it uses a high
    139   CPU load which can be a problem if you use free web hosting.</li>
    140 
    141   <li>If you choose to use your hosting provider to create thumbnails, you
    142   must give write rights on all category directories and sub-directories
    143   "thumbnail" for ugo (user, group, other).</li>
    144 
    145 </ul>
    146 
    147 <h3>Access authorization</h3>
    148 
    149 <ul>
    150 
    151   <li>You can forbid access to categories. Categories can be "public" or
    152   "private". Permissions (for groups and users) can be set only if the
    153   category is private.</li>
     138  directory. The thumbnail has the same filename as the corresponding photo, with <em>TN-</em> as prefix.</li>
     139
     140  <li><em>Advise</em>: use an external module for thumbnails creation.</li>
     141
     142  <li>Even if it is not recommended (image quality, web server resource load), you can use <span
     143  class="pwgScreen">Administration &raquo; Pictures &raquo; Thumbnails</span> page to create thumbnails.</li>
     144
     145  <li>Give write access on all category directories.</li>
     146
     147</ul>
     148
     149  </div> <!-- FTP_content -->
     150</div> <!-- instructionFTP -->
     151
     152<div id="instructionPermissions" class="instructionBlock">
     153  <div
     154    id="permissions_header"
     155    class="instructionBlockHeaderCollapsed"
     156    onclick="blockToggleDisplay('permissions_header', 'permissions_content')"
     157  ><span>
     158    Permissions
     159  </span></div>
     160  <div
     161    id="permissions_content"
     162    class="instructionBlockContent"
     163    style="display:none"
     164  >
     165<ul>
     166
     167  <li>You can forbid access to categories. Switch the category access type to "private" if you want to manage permissions.</li>
    154168
    155169  <li>You can set a category to private by editing a single category (<span
    156   class="pwgScreen">Administration, Categories, Manage, edit</span>) or by
     170  class="pwgScreen">Administration &raquo; Categories &raquo; Manage &raquo; edit</span>) or by
    157171  setting options to your whole category tree (<span
    158   class="pwgScreen">Administration, Categories, Properties, Public / Private</span>).</li>
     172  class="pwgScreen">Administration &raquo; Categories &raquo; Properties &raquo; Public / Private</span>).</li>
    159173
    160174  <li>
    161175
    162176    <p>Once the category is private, you can manage permissions for groups
    163     and users through 3 screens :</p>
     177    and users with 3 screens:</p>
    164178
    165179    <ul>
    166180
    167       <li><span class="pwgScreen">Administration, Identification, Users,
    168       permissions action (one link per user)</span></li>
    169 
    170       <li><span class="pwgScreen">Administration, Identification, Groups,
    171       permissions action (one link per group)</span></li>
    172 
    173       <li><span class="pwgScreen">Administration, Categories, Manage, edit
    174       category permissions action (one link per category)</span></li>
     181      <li><span class="pwgScreen">Administration &raquo; Identification &raquo; Users &raquo;
     182      permissions action</span> (one link per user)</li>
     183
     184      <li><span class="pwgScreen">Administration &raquo; Identification &raquo; Groups &raquo;
     185      permissions action</span> (one link per group)</li>
     186
     187      <li><span class="pwgScreen">Administration &raquo; Categories &raquo; Manage &raquo; edit
     188      category permissions action</span> (one link per category)</li>
    175189
    176190    </ul>
    … …  
    179193
    180194</ul>
    181 
    182 <h3>Users Groups</h3>
    183 
    184 <ul>
    185 
    186   <li>Piwigo is able to manage groups of users. It can be very useful
    187   to have common permission access for private categories.</li>
    188 
    189   <li>You can create groups in <span class="pwgScreen">Administration,
    190   Identification, Groups</span> and associate users to this group in <span
    191   class="pwgScreen">Administration, Identication, Users</span>.</li>
    192 
    193   <li>A user can belong to several groups. The authorization is stronger
    194   than prohibition : if user "jack" belongs to groups "family" and
    195   "friends", and that only group "family" can see category "Christmas 2003",
     195  </div> <!-- permissions_content -->
     196</div> <!-- instructionPermissions -->
     197
     198<div id="instructionGroups" class="instructionBlock">
     199  <div
     200    id="groups_header"
     201    class="instructionBlockHeaderCollapsed"
     202    onclick="blockToggleDisplay('groups_header', 'groups_content')"
     203  ><span>
     204    Groups
     205  </span></div>
     206  <div
     207    id="groups_content"
     208    class="instructionBlockContent"
     209    style="display:none"
     210  >
     211<ul>
     212
     213  <li>Groups is a convenient way to set permissions for a list of users.</li>
     214
     215  <li>Create groups in <span class="pwgScreen">Administration &raquo;
     216  Identification &raquo; Groups</span> and associate users to this group in <span
     217  class="pwgScreen">Administration &raquo; Identication &raquo; Users</span>.</li>
     218
     219  <li>A user can belong to several groups. Authorization is stronger
     220  than forbiddance : if user "jack" belongs to groups "family" and
     221  "friends", and that only group "family" can see category "Christmas 2003" category then
    196222  "jack" will be able to see "Christmas 2003".</li>
    197223
    198224</ul>
    199 
    200 <h3>Files upload by users</h3>
    201 
    202 <p>Piwigo offers the possibility for users to upload images. in
    203 order to do it:</p>
     225  </div> <!-- groups_content -->
     226</div> <!-- instructionGroups -->
     227
     228<div id="instructionUpload" class="instructionBlock">
     229  <div
     230    id="upload_header"
     231    class="instructionBlockHeaderCollapsed"
     232    onclick="blockToggleDisplay('upload_header', 'upload_content')"
     233  ><span>
     234    Upload by users
     235  </span></div>
     236  <div
     237    id="upload_content"
     238    class="instructionBlockContent"
     239    style="display:none"
     240  >
     241<p>Users can upload their photos too.</p>
    204242
    205243<ol>
    206244
    207   <li>authorize upload on any categories (<span
    208   class="pwgScreen">Administration, Categories, Manage, edit</span> or <span
    209   class="pwgScreen">Administration panel, Categories, Properties, Upload</span>)</li>
    210 
    211   <li>give write rights on directories for ugo (user, group, other)</li>
     245  <li>Authorize upload on any physical categories (<span
     246  class="pwgScreen">Administration &raquo; Categories &raquo; Manage &raquo; edit</span> or <span
     247  class="pwgScreen">Administration &raquo; Categories &raquo; Properties &raquo; Upload</span>). Virtual categories can't receive any upload.</li>
     248
     249  <li>Give write access on corresponding directories.</li>
    212250
    213251</ol>
    214252
    215 <p>Files uploaded by users are not directly visible on the website, they
    216 must be validated by an administrator. For that purpose, an administrator
    217 must go in <span class="pwgScreen">Administration, Pictures, Waiting</span>
    218 in order to validate or to refuse the files proposed, then to synchronize
    219 filesystem with database.</p>
    220 
    221 
    222 <h3>Links between elements and categories, virtual categories</h3>
    223 
    224 <ul>
    225 
    226   <li>Piwigo dissociates categories where elements are stored and
    227   categories where they are shown.</li>
    228 
    229   <li>By default, elements are shown only in their real categories : the
    230   ones corresponding to directories on the web server.</li>
    231 
    232   <li>To link an element to a category, you just have to make the
    233   association on the page of element edition (link to this screen on
    234   picture.php logged as an administrator) or on the informations of all
    235   elements of a category.</li>
    236 
    237   <li>Using this principle, it is possible to create virtual categories : no
    238   directory coresponds to this category. You can create virtual categories
    239   in <span class="pwgScreen">Administration, Categories, Manage</span>.</li>
    240 
    241 </ul>
    242 
    243 <h3>Miscellanous informations</h3>
    244 
     253<p>Photos uploaded by users are not directly visible on the website. An administrator
     254must validate uploaded photos in <span class="pwgScreen">Administration &raquo; Pictures &raquo; Waiting</span>.</p>
     255  </div> <!-- upload_content -->
     256</div> <!-- instructionUpload -->
     257
     258<div id="instructionCategoryLinks" class="instructionBlock">
     259  <div
     260    id="categoryLinks_header"
     261    class="instructionBlockHeaderCollapsed"
     262    onclick="blockToggleDisplay('categoryLinks_header', 'categoryLinks_content')"
     263  ><span>
     264    Links between elements and categories, virtual categories
     265  </span></div>
     266  <div
     267    id="categoryLinks_content"
     268    class="instructionBlockContent"
     269    style="display:none"
     270  >
     271<ul>
     272
     273  <li>Photos are displayed in the category corresponding to the file directory.</li>
     274
     275  <li>You can also display a picture in several categories, without duplicating the file on your web server. Associate the photo to any category from the photo editing screen (that any administrator can reach from the photo page on the gallery side).</li>
     276
     277  <li>Virtual categories are based on this concept: they have no corresponding directory. Create virtual categories from <span class="pwgScreen">Administration &raquo; Categories &raquo; Manage</span>.</li>
     278
     279</ul>
     280  </div> <!-- categoryLinks_content -->
     281</div> <!-- instructionCategoryLinks -->
     282
     283<div id="instructionMisc" class="instructionBlock">
     284  <div
     285    id="misc_header"
     286    class="instructionBlockHeaderCollapsed"
     287    onclick="blockToggleDisplay('misc_header', 'misc_content')"
     288  ><span>
     289    Miscellanous informations
     290  </span></div>
     291  <div
     292    id="misc_content"
     293    class="instructionBlockContent"
     294    style="display:none"
     295  >
    245296<ul>
    246297
    247298  <li>As soon as you created your gallery, modify default display properties
    248   in <span class="pwgScreen">Administration panel, Configuration,
    249   Default</span>. Indeed, every new registered user will have by default the
    250   same display properties.</li>
    251 
    252   <li>If you have any question, do not hesitate to take a look at the forum
    253   or ask a question there. The <a
    254   href="http://forum.phpwebgallery.net">forum</a> (message board) is
    255   available on the presentation site of Piwigo. Check the <a
    256   href="http://phpwebgallery.net/doc/">official Piwigo
    257   documentation</a> for further reading.</li>
    258 
    259 </ul>
     299  in <span class="pwgScreen">Administration &raquo; Configuration &raquo;
     300  Default</span>. Every new registered user will use these default configuration settings.</li>
     301
     302  <li>If you have any question, Piwigo community will welcome you on <a
     303  href="http://forum.phpwebgallery.net">its forum</a>.</li>
     304
     305</ul>
     306  </div> <!-- misc_content -->
     307</div> <!-- instructionMisc -->
     308
    260309</div>
Note: See TracChangeset for help on using the changeset viewer.