source: extensions/ExtendedDescription/language/en_UK/help.html @ 11384

Revision 11384, 4.1 KB checked in by ddtddt, 8 years ago (diff)

[extensions] - ExtendedDescription - update rename to album/photo

Line 
1<h2>Extended Description</h2>
2
3<h3>Multilanguage descriptions</h3>
4
5<p>Multilanguage descriptions are placed between [lang=xx] and [/lang] tags, where xx is the language code (for example en, es, fr). There is also 2 special languages : [lang=default] and [lang=all]</p>
6
7<ul>
8  <li><b>Example</b>:<br>
9  <br>
10<code>[lang=default] default description [/lang]<br>
11[lang=en] description in english [/lang]<br>
12[lang=de] deutsche Beschreibung [/lang]</code>
13</li>
14</ul>
15
16<p>The default description will be used if the description is not available in the connected user selected language.
17If [lang=default] does not exists, anything outside the [lang] tags will be considered as the default description.</p>
18
19<p><u>Special language <i>all</i></u>: anything inside [lang=all] will be included in the description, anywhat the connected user defined language is.
20This is mainly useful to include HTML/JavaScript code inside a description.</p>
21
22<h3>Extended descriptions</h3>
23
24<p>Extended description tags make it possible to have a short description for the album outside the album,
25a longer description for the album inside the album page,
26or even 2 distinct descriptions inside the album page.</p>
27
28<p>tag &lt;!--more--&gt; adds text to the short description.<br>
29tag &lt;!--complete--&gt; let the user have 2 distinct descriptions.<br>
30tag &lt;!--up-down--&gt; let the user have a top and a bottom description.</p>
31
32<ul>
33  <li><b>tag &lt;!--more--&gt;</b></li>
34</ul>
35<code>short description &lt;!--more--&gt; long description</code>
36<p>Only the short description is displayed outside the album. On the album page, you will see short description + long description.</p>
37
38<ul>
39  <li><b>tag &lt;!--complete--&gt;</b></li>
40</ul>
41<code>short description &lt;!--complete--&gt; long description</code>
42<p>Only the short description is displayed outside the album. On the album page, you will only see the long description, so you have 2 distinct descriptions.</p>
43
44<ul>
45  <li><b>tag &lt;!--up-down--&gt;</b></li>
46</ul>
47<code>top description &lt;!--up-down--&gt; bottom description</code>
48<p>Only the top description is displayed outside the album.  On the album page, the top description is displayed above the thumbnails, the bottom description is displayed below the thumbnails.</p>
49
50<h3>Insert a album or a photo</h3>
51
52<ul>
53  <li><b>tag [cat=xx]</b></li>
54</ul>
55<p>This tag inserts a album in the description, where xx is the album identifier.</p>
56
57<ul>
58  <li><b>tag [img=xx1 xx2 xxN;yyyy;name]</b></li>
59</ul>
60<p>This tag allows to insert one or more thumbnail in the description, with:<br><br>
61- xx the photo identifier; you can add the album identifier next to the photo identifier: <code>xx.ccc</code>.
62<br>
63- yyyy (optional) : can take any value among {left, right}.</p>
64- name (optional) : can take any value among {name, titleName}. If tagged, with <i>name</i> the name of the picture is diplayed under the thumbnail, with <i>titleName</i> the photo markup &lt;title&gt; is fill with the name.</p>
65
66
67<h3>Hide a album</h3>
68
69<p>Use tag <b>&lt;!--hidden--&gt;</b> in the album name:<br>
70<br>
71- it won't be displayed in the parent album<br>
72- it remains visible in the album menu</p>
73
74<h3>Hide a album in menu</h3>
75
76<p>Use tag <b>&lt;!--mb-hidden--&gt;</b> in the album name:<br>
77<br>
78- it won't be displayed in the album menu<br>
79- it remains visible in the parent album</p>
80
81<h3>Hide a photo</h3>
82
83<p>Use tag <b>&lt;!--hidden--&gt;</b> in the photo name:<br>
84<br>
85- it won't be displayed on the thumbnails page<br>
86- it remains visible inside the album</p>
87
88<h3>Redirected album</h3>
89
90<ul>
91  <li><b>[redirect http://piwigo.org]</b></li>
92</ul>
93<p>Insert this tag into a album description to redirect it to the URL of your choice.</p>
94
95<ul>
96  <li><b>[redirect img=xx]</b></li>
97</ul>
98<p>Redirect to a photo of your gallery where xx is the photo identifier; you can add the album identifier next to the photo identifier: <code>xx.ccc</code>.</p>
99
100<ul>
101  <li><b>[redirect cat=xx]</b></li>
102</ul>
103<p>Redirect to a album of your gallery where xx the album identifier.</p>
104
105<ul>
106  <li><b>[redirect search=xx]</b></li>
107</ul>
108<p>Redirect to a search page of your gallery where xx is the search identifier.</p>
Note: See TracBrowser for help on using the repository browser.