source: trunk/language/en_UK/help/extend_for_templates.html @ 12286

Revision 12286, 4.2 KB checked in by ddtddt, 8 years ago (diff)

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

  • Property svn:eol-style set to LF
Line 
1<h2>Template Extension Configuration</h2>
2
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>
6
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>
9
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>
12
13<h3>Bound Theme</h3>
14<p>The bound theme is the theme from which the template files are being replaced.</p>
15
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>
19<ul>
20  <li><span class="filename">index.tpl</span></li>
21  <li><span class="filename">mainpage_categories.tpl</span> and/or <span class="filename">thumbnails.tpl</span></li>
22  <li><span class="filename">menubar.tpl</span></li>
23  <li><span class="filename">header.tpl</span> and/or <span class="filename">footer.tpl</span></li>
24  <li><span class="filename">picture_content.tpl</span> and/or <span class="filename">picture.tpl</span></li>
25  <!-- <li><span class="filename">slideshow.tpl</span></li> -->
26  <li><span class="filename">profile.tpl</span> and/or <span class="filename">profile_content.tpl</span></li>
27  <li><span class="filename">tags.tpl</span></li>
28  <li><span class="filename">upload.tpl</span></li>
29  <li><span class="filename">about.tpl</span></li>
30  <li><span class="filename">popuphelp.tpl</span></li>
31  <li><span class="filename">search.tpl</span> and/or <span class="filename">search_rules.tpl</span></li>
32  <li><span class="filename">nbm.tpl</span> and/or <span class="filename">notification.tpl</span></li>
33  <li><span class="filename">identification.tpl</span> and/or <span class="filename">register.tpl</span></li>
34  <li><span class="filename">redirect.tpl</span></li>
35</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>
43
44<a name="warnings"></a>
45<h3>Warnings</h3>
46<ul>
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>
51</ul>
Note: See TracBrowser for help on using the repository browser.