Changeset 12286


Ignore:
Timestamp:
Oct 1, 2011, 9:44:49 AM (13 years ago)
Author:
ddtddt
Message:

[trunk] - language - update en_UK - English - Thanks to mixedbredie - step 3 - feature:2320

Location:
trunk/language/en_UK/help
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/language/en_UK/help/extend_for_templates.html

    r8749 r12286  
    1 <h2>Extend for templates configuration</h2>
     1<h2>Template Extension Configuration</h2>
    22
    3 <h3>Goal</h3>
    4 <p>Define replacement conditions for each template from template-extension
    5 (template called "replacer").</p>
     3<h3>About</h3>
     4<p>Your Piwigo gallery can be customised by replacing existing template files with customised versions.  For example, the default header template (header.tpl) can be replaced by a customised header template (my-header.tpl).  After submitting the changes to the database the gallery will display the customised header instead of the original header.<br>
     5Template extensions are a powerful way to create customised themes for both new and advanced users.  Used together with the LocalFiles Editor you can create your own child themes.</p>
    66
    7 <p>"original template" from ./themes/default/template (or any other theme)
    8  will be replaced by a "replacer" if the replacer is linked to this "original template"
    9  (and optionally, when the requested URL contains an "optional URL keyword").</p>
     7<h3>Original Template</h3>
     8<p>A theme contains a number of template files that make up the gallery pages.  These are the original templates.</p>
    109
    11 <p>"Optional URL keywords" are those you can find after the module name in URLs.</p>
     10<h3>Optional URL Keyword</h3>
     11<p>These are words found in the gallery URL after the module name.  They can also be active permalinks  (See the permalink documentation for more information).  <a href="#warnings">WARNING:</a> if the same original template and same keyword is used on more than one customised template only the last one is active.</p>
    1212
    13 <p>Therefore "Optional URL keywords" can be an active "permalink"
    14 (see permalinks in our documentation for further explanation).</p>
     13<h3>Bound Theme</h3>
     14<p>The bound theme is the theme from which the template files are being replaced.</p>
    1515
    16 <p>Read: `<a href="#warnings">Warning</a>` usage conditions.</p>
    17 
    18 <h3>What are template extensions?</h3>
    19 
    20 <p>This configuration tool is powerfull for beginners and advanced users.
    21 By FTP, in the template-extension folder, the Webmaster can duplicate a lot of
    22  the distributed .tpl files ("original template") with a different name
    23  ("replacer").
    24  
    25  "Original templates", current original supported templates are:</p>
     16<h3>Where are the original templates?</h3>
     17<p>Original templates are the template files shipped with each theme.  These are saved in <em>/themes/default/template</em> (or <em>themes/<theme name>/template</em>).  These template files should not be edited in place as changes will be lost with theme upgrades.<br>
     18Supported original templates include:</p>
    2619<ul>
    2720  <li><span class="filename">index.tpl</span></li>
    … …  
    4134  <li><span class="filename">redirect.tpl</span></li>
    4235</ul>
     36<h3>Saving customised templates</h3>
     37<p>Customised templates should be saved in the template-extension folder or subfolders.  For example, <em>/template-extension/my-default/header.tpl</em> (or <em>/template-extension/<my-theme-name>/header.tpl</em>)  Template files can have any name with a .tpl extension.  The template files in subfolders appear in the Template configuration screen as available custom templates.</p>
     38<h3>Activating customised templates</h3>
     39<p>Select the original template to replace.  Optionally choose a URL keyword to ensure that the customised template is only shown on pages with that keyword.  Select a bound theme and the changes will be effective on that theme.  Submit the changes to the database.</p>
     40<h3>Deactivating customised templates</h3>
     41<p>Unselect the original template and submit the changes to the database.<br>
     42Delete the customised template files from the template-extension folder.</p>
    4343
    44 <h3>Where can I find "original templates"?</h3>
    45 
    46 <p>Distributed original templates are in /themes/default/template/
    47 (don't edit them in place for upgrade perspectives). So with "original templates",
    48 any webmaster can create his "replacers (customized templates)".</p>
    49 
    50 <h3>Where should I save "replacers"?</h3>
    51 
    52 <p><strong>Replacers (customized templates)</strong> must be placed in the
    53 template-extension folder (or its subfolders).
    54 Replacers can have any filename with the .tpl extension. For example: <span
    55 class="filename">template-extension/my-extension/video.tpl</span>.</p>
    56 
    57 
    58 <h3>How can I activate my "replacers"?</h3>
    59 <p>An <strong>original template</strong> should be assigned to each
    60  <strong>replacer (customized templates)</strong> to activate the related replacements.
    61  This is the goal of "Extend for templates" in the Configuration Administration menu.</p>
    62 
    63 <p>If you select an <strong>optional URL keyword</strong> then replacements
    64 will be operate only on pages with this keyword. For example: <span
    65   class="pwgScreen">index.php?/<strong>most_visited</strong></span></p>
    66  
    67 <p>Advanced users will use permalinks as <strong>optional URL keyword</strong>. </p>
    68 
    69 <p>If you select a <strong>Bound template</strong> then replacements will be operate only on this template.</p>
    70 
    71 <h3>How can I deactivate my "replacers"?</h3>
    72 <ul>
    73 <li>Unselect related "Original templates".</li>
    74 <li>By FTP delete of "replacers".</li>
    75 </ul>
    7644<a name="warnings"></a>
    7745<h3>Warnings</h3>
    7846<ul>
    79 
    80   <li><strong>Original template</strong> must be the "original" template
    81   otherwise you could have unpredictable results!</li>
    82 
    83   <li>On several <strong>replacers (customized templates)</strong> with the
    84   same<strong>Original template</strong> and the same <strong>optional URL
    85   keyword</strong> only the last replacer is active.</li>
    86 
    87   <li>Unselected <strong>optional URL keyword</strong> will active the replacer
    88   on any template usage. As previous point, order can override previous
    89   selected replacers.</li>
    90 
    91   <li>Subfolders:
    92 Subfolders are ignored but they are usefull to change current order.<br>
    93 distributed-samples: for test purpose are distributed!
    94 <strong>Don't edit them</strong> create your own ones.
    95 </li>
    96 
    97   <li>On delete of a replacer the <strong>Original template</strong> is
    98   immediately reactivated.</li>
    99 
     47  <li><strong>The original template</strong> must be the original template otherwise you may have unpredictable results.</li>
     48  <li>If the same original template and same URL keyword is used on more than one customised template only the last one is active.</li>
     49  <li>Distributed sample template files are for test purposes only.  Do not edit them.  Create your own ones or copy existing theme template files into <em>/template-extension/<my-theme>/</em></li>
     50  <li>When the customised template is deleted the original template file is immediately reactivated.</li>
    10051</ul>

  • trunk/language/en_UK/help/maintenance.html

    r8880 r12286  
    11<h2>Maintenance</h2>
    22
    3 <p>To optimize page generation time, Piwigo uses cached
    4 information. For example, instead of counting the number of photos
    5 contained in each album at each page reload, this information is stored
    6 in the database. In theory, this information should always be correct, but
    7 sometimes an error can occur and cached information becomes wrong.</p>
     3<p>To optimise page generation time Piwigo uses cached information. For example, instead of counting the number of photos contained in each album at each page reload this information is stored in the database. In theory this information should always be correct but sometimes an error can occur and cached information becomes out of date.</p>
    84
    9 <p>Some information become useless with time going by. Deleting this useless
    10 information from database make you save disk space.</p>
     5<p>Some information becomes less useful as time goes by.  Deleting this useless information from the database will save you some disk space.</p>
    116
    127<ul>
    13 
    14   <li>
    15     <strong>Unlinked photos:</strong>
    16     Display photos which are not associated to any virtual album.
    17   </li>
    18   <li>
    19     <strong>Files with the same name in more than one physical album:</strong>
    20     Display photos or files which are found with the same filename in several albums.
    21   </li>
    22 
     8        <li><strong>Delete orphan tags</strong></li>
     9</ul>
     10<ul>
     11  <li><strong>Update albums informations:</strong> For each album, the following information is checked, and updated if necessary : list of parent albums, number of photos, last photo date, position among brother albums, position among all albums. This action also checks the representative photos consistency.</li>
     12  <li><strong>Update photos information:</strong> For each photo, information updated is : full path to file, average rate. <em>Warning</em>, do not mix up: metadata information must be synchronised from <span class="pwgScreen">Administration &raquo; Tools &raquo; synchronise</span>, or on the modification screen of a single photo (through <span class="pwgScreen">Photo</span> for example).</li>
     13</ul>
     14<ul>
     15  <li><strong>Repair and optimise the database:</strong>Perform re-order, repair and optimise operations on each table of the database.</li>
     16  <li><strong>Reinitialize integrity check</strong></li>
    2317</ul>
    2418
    2519<ul>
    26 
    27   <li><strong>Update albums informations:</strong> For each album,
    28   the following information is checked, and updated if necessary : list of parent
    29   albums, number of photos, last photo date, position among
    30   brother albums, position among all albums. This action also checks
    31   the representative photos consistency.</li>
    32 
    33   <li><strong>Update photos information:</strong> For each photo,
    34   information updated is : full path to file, average
    35   rate. <em>Warning</em>, do not mix up: metadata information
    36   must be synchronized from <span class="pwgScreen">Administration &raquo;
    37   Tools &raquo; Synchronize</span>, or on the modification screen of a
    38   single photo (through <span class="pwgScreen">Photo</span> for
    39   example).</li>
    40 
    41   <li><strong>Repair and optimize the database:</strong>
    42   Perform re-order, repair and optimize operations on each table of the database.
    43   </li>
    44 </ul>
    45 
    46 <ul>
    47   <li><strong>Purge history details:</strong> Delete all lines from the
    48   <code>history</code> table. Screen <span class="pwgScreen">Administration &raquo;
    49   Tools &raquo; History</span> will not longer show information for the past
    50   history. <em>Warning</em>: all data will be lost, without any way to
    51   get them back.</li>
    52 
     20  <li><strong>Purge history details:</strong> Delete all lines from the history table. Screen <span class="pwgScreen">Administration &raquo; Tools &raquo; History</span> will not longer show information for the past history. <em>Warning:</em> all data will be lost, without any way to get them back.</li>
    5321  <li><strong>Purge history summary:</strong> Delete all the summary information about visit history. This summary is calculated from the history details.</li>
    54 
    5522  <li><strong>Purge sessions:</strong> Delete expired user sessions.</li>
    56 
    5723  <li><strong>Purge never used notification feeds</strong></li>
    58 
    5924  <li><strong>Purge searches history</strong></li>
    60  
    6125  <li><strong>Purge compiled templates</strong></li> 
    6226</ul>

  • trunk/language/en_UK/help/site_manager.html

    r8705 r12286  
    11<h2>Remote sites</h2>
    22
    3 <p>Piwigo offers the possibility to use several servers to store the
    4 photos which will compose your gallery. It can be useful if your gallery is
    5 installed on a limited space and you have a huge quantity of images to
    6 show.</p>
     3<p>Piwigo offers the possibility to use several servers to store the photos which will fill your gallery. It can be useful if your gallery is installed on a server with limited space and you have a huge number of images to display.</p>
    74
    85<ol>
    9 
    10   <li>edit file <span class="filename">tools/create_listing_file_local.inc.php</span>,
    11   by modifying parameters section such as
    12   <code>$conf['prefix_thumbnail']</code> or
    13   <code>$conf['use_exif']</code>.</li>
    14 
    15   <li>using ftp, place the files <span class="filename">tools/create_listing_file.php</span>
    16   and <span class="filename">tools/create_listing_file_local.inc.php</span> (modified)
    17   on your distant website, in the same directory as your album
    18   directories (as the directory <span class="filename">galleries</span> of
    19   this website). For example, let's say that you can access <span
    20   class="filename">http://example.com/galleries/create_listing_file.php</span>.</li>
    21 
    22   <li>go to <span class="pwgScreen">administration panel &raquo; Tools &raquo; Site
    23   manager</span>. Ask to create a new site, for example <span
    24   class="filename">http://example.com/galleries</span>.</li>
    25 
    26   <li>a new remote site is registered. You can perform 4 actions :
    27 
     6  <li>Edit the file <span class="filename">tools/create_listing_file_local.inc.php</span>, by modifying the parameters section such as <code>$conf['prefix_thumbnail']</code> or <code>$conf['use_exif']</code>.</li>
     7  <li>Using FTP, place the files <span class="filename">tools/create_listing_file.php</span> and <span class="filename">tools/create_listing_file_local.inc.php</span> (modified) on your remote website, in the same directory as your album directories (as the directory <span class="filename">galleries</span> of this website). For example, let's say that you can access <span class="filename">http://example.com/galleries/create_listing_file.php</span>.</li>
     8  <li>Go to Administration &raquo; Tools &raquo; Site manager. Create a new site, for example <span class="filename">http://example.com/galleries</span>.</li>
     9  <li>A new remote site is registered. You can perform 4 actions:
    2810    <ol>
    29 
    30       <li><strong>generate listing</strong> : launches a distant request to
    31       generate a distant file listing</li>
    32 
    33       <li><strong>synchronize</strong> : reads the distant <span
    34       class="filename">listing.xml</span> file and synchronizes with
    35       database information</li>
    36 
    37       <li><strong>clean</strong> : removes distant <span
    38       class="filename">listing.xml</span> file</li>
    39 
    40       <li><strong>delete</strong> : deletes the site (and all related
    41       albums and photos) in the database</li>
    42 
     11      <li><strong>Generate listing:</strong> launches a remote request to generate a remote file listing</li>
     12      <li><strong>Synchronise:</strong> reads the remote <span class="filename">listing.xml</span> file and synchronises with database information</li>
     13      <li><strong>Clean:</strong>removes remote <span class="filename">listing.xml</span> file</li>
     14      <li><strong>Delete:</strong> deletes the site (and all related albums and photos) in the databas</li>
    4315    </ol>
    4416  </li>
    4517</ol>
    46 

  • trunk/language/en_UK/help/synchronize.html

    r8707 r12286  
    1 <h2>Synchronize</h2>
     1<h2>Synchronise</h2>
    22
    3 <p>There are 2 different synchronizations types : directories/files and file
    4 metadata. Directories/files is about synchronizing your directories tree
    5 with the album tree in the database. Metadata is about updating photos
    6 informations such as filesize, dimensions in pixels, EXIF or IPTC
    7 informations.</p>
     3<p>There are two different types of synchronisation:</p>
     4<ul>
     5        <li>directories/files</li>
     6        <li>file metadata</li>
     7</ul>
    88
    9 <p>The first synchronization must be the directories/files one.</p>
     9<p>Synchronising directories and files is about updating your directories tree with the album tree in the database.
     10Synchronising file metadata is about updating photo information, such as filesize, dimensions in pixels, EXIF or IPTC information, in the database.</p>
    1011
    11 <p>Synchronization process may take long (depending on your server load and the
    12 quantity of elements to manage) so it is possible to do it album by album.</p>
     12<p>When synchronising your uploads with your gallery you must first synchronise directories and files.</p>
     13
     14<p>The synchronisation process may take a long time (depending on server load and the number of elements to manage) so it is possible to do it album by album.</p>

  • trunk/language/en_UK/help/thumbnail.html

    r8706 r12286  
    1 <h2>Thumbnails creation</h2>
     1<h2>Thumbnails Creation</h2>
    22
    3 <p>This page let you create missing thumbnails. It is advised not to use this functionality if your gallery is hosted on a shared server.</p>
     3<p>This page let you create missing thumbnails.  It is advised not to use this functionality if your gallery is hosted on a shared server.  To regenerate thumbnails use the Batch Manager.</p>
    44
    55<dl>
    … …  
    77  <dt>GD version</dt>
    88
    9   <dd>GD is the picture manipulating library for PHP. Choose the version
    10   installed on your server. You will be warned by an error message, should you choose the wrong one; just come back to the previous page with your browser and choose the other version. If no
    11   version works, then  your server does not support GD.</dd>
     9  <dd>GD is the image manipulation library for PHP. Choose the version installed on your server. You will be warned by an error message should you choose the wrong one; just come back to the previous page with your browser and choose another version. If no version works, then your server does not support GD.  PHP will need to be compiled with GD image library functions for this to work.</dd>
    1210
    1311  <dt>Width and height</dt>
    1412
    15   <dd>Maximum thumbnails dimensions. Original aspect ratio is
    16   preserved. Default values can be modified using configuration settings <code>tn_width</code> and
    17 <code>tn_height</code> (see <span
    18 class="filename">include/config_default.inc.php</span> file).</dd>
     13  <dd>Maximum thumbnail dimensions. Original aspect ratio is preserved. Default values can be modified using configuration settings <code>tn_width</code> and <code>tn_height</code> (see <span class="filename">include/config_default.inc.php</span> file).</dd>
    1914
    2015  <dt>Number of thumbnails to create</dt>
    2116
    22   <dd>Do not try to miniaturize too many photos at once. The miniaturization process does use a lot of CPU. If your Piwigo gallery is hosted by a free provider, too high CPU a load might lead to the withdrawal of your website.</dd>
     17  <dd>Do not try to process too many photos at once. The thumbnail creation process does use a lot of CPU. If your Piwigo gallery is hosted by a free provider, too high a load on the CPU might lead to the withdrawal of your website.</dd>
    2318
    2419  <dt>File format</dt>
    2520
    26   <dd>Thumbnails are created in JPEG file format. They
    27   can be created from PNG and JPEG photos only.</dd>
     21  <dd>Thumbnails are created in JPEG file format. They can be created from PNG and JPEG photos only.</dd>
    2822
    2923</dl>
Note: See TracChangeset for help on using the changeset viewer.