source: branches/2.4/language/hr_HR/help/extend_for_templates.html @ 16299

Last change on this file since 16299 was 5316, checked in by plg, 15 years ago

copy all languages (exceptions are en_UK and fr_FR) from branch 2.0 to trunk,
then convert the *.lang.php files with tools/convert_language_to_2.1.pl

Next step is to play with tools/translation_analysis.php to find which
language keys need translation for each language.

  • Property svn:eol-style set to LF
File size: 4.5 KB
Line 
1<h2>Extend for templates configuration</h2>
2
3<h3>Goal</h3>
4<p>Define replacement conditions for each template from template-extension
5(template called "replacer").</p>
6
7<p>"original template" from ./template/yoga (or any other than yoga)
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>
10
11<p>"Optional URL keywords" are those you can find after the module name in URLs.</p>
12
13<p>Therefore "Optional URL keywords" can be an active "permalink"
14(see permalinks in our documentation for further explanation).</p>
15
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.
21By 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>
26<ul>
27  <li><span class="filename">index.tpl</span></li>
28  <li><span class="filename">mainpage_categories.tpl</span> and/or <span class="filename">thumbnails.tpl</span></li>
29  <li><span class="filename">menubar.tpl</span></li>
30  <li><span class="filename">header.tpl</span> and/or <span class="filename">footer.tpl</span></li>
31  <li><span class="filename">picture_content.tpl</span> and/or <span class="filename">picture.tpl</span></li>
32  <!-- <li><span class="filename">slideshow.tpl</span></li> -->
33  <li><span class="filename">profile.tpl</span> and/or <span class="filename">profile_content.tpl</span></li>
34  <li><span class="filename">tags.tpl</span></li>
35  <li><span class="filename">upload.tpl</span></li>
36  <li><span class="filename">about.tpl</span></li>
37  <li><span class="filename">popuphelp.tpl</span></li>
38  <li><span class="filename">search.tpl</span> and/or <span class="filename">search_rules.tpl</span></li>
39  <li><span class="filename">nbm.tpl</span> and/or <span class="filename">notification.tpl</span></li>
40  <li><span class="filename">identification.tpl</span> and/or <span class="filename">register.tpl</span></li>
41  <li><span class="filename">redirect.tpl</span></li>
42</ul>
43
44<h3>Where can I find "original templates"?</h3>
45
46<p>Distributed original templates are in template/yoga/
47(don't edit them in place for upgrade perspectives). So with "original templates",
48any 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
53template-extension folder (or its subfolders).
54Replacers can have any filename with the .tpl extension. For example: <span
55class="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
64will 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>
76<a name="warnings"></a>
77<h3>Warnings</h3>
78<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:
92Subfolders are ignored but they are usefull to change current order.<br />
93distributed-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
100</ul>
Note: See TracBrowser for help on using the repository browser.