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

Revision 16172, 4.9 KB checked in by mistic100, 7 years ago (diff)

-help buttons added with a prefilter, update for 2.4
-update fr and en help files (only)

Line 
1<div style="text-align:left;">
2<h2>Extended Description</h2>
3
4<h3>Multilanguage descriptions</h3>
5
6<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>
7
8<ul>
9  <li><b>Example</b>:<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>&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>&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>&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 an album or a photo</h3>
51
52<ul>
53  <li><b>[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>[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- <code>xx</code> the photo identifier; you can add the album identifier next to the photo identifier: <code>xx.ccc</code>.<br>
62- <code>yyyy</code> (optional) : can take any value among <i>{left, right}</i>.<br>
63- <code>name</code> (optional) : can take any value among <i>{name, titleName}</i>. 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>
64
65<ul>
66  <li><b>[photo id=xx album=yy size=M html=yes link=yes]</b></li>
67</ul>
68<p>This tag allows to insert one picture at any size you want, with:<br><br>
69- <code>id</code> the photo identifier<br>
70- <code>album</code> (optional) the parent album identifier<br>
71- <code>size</code> (optional) the size of the photo, among <i>{SQ, TH, XXS, S, M, L, XL, XXL}</i><br>
72- <code>html</code> (optional) if set to <i>no</i> the tag only returns the URL of the photo, without HTML<br>
73- <code>link</code> (optional) if set to <i>yes</i> the photo is wrapped into a link to the picture page</p>
74
75<ul>
76  <li><b>[random album=yy size=M html=yes link=yes]</b></li>
77</ul>
78<p>Same thin as above, except that the photo is choosed randomly into <code>album</code></p>
79
80
81<h3>Hide an album</h3>
82
83<p>Use tag <b>&lt;!--hidden--&gt;</b> in the album name:<br>
84<br>
85- it won't be displayed in the parent album<br>
86- it remains visible in the album menu</p>
87
88<h3>Hide an album from the menu</h3>
89
90<p>Use tag <b>&lt;!--mb-hidden--&gt;</b> in the album name:<br>
91<br>
92- it won't be displayed in the album menu<br>
93- it remains visible in the parent album</p>
94
95<h3>Hide a photo</h3>
96
97<p>Use tag <b>&lt;!--hidden--&gt;</b> in the photo name:<br>
98<br>
99- it won't be displayed on the thumbnails page<br>
100- it remains visible inside the album</p>
101
102<h3>Redirected album</h3>
103
104<ul>
105  <li><b>[redirect http://piwigo.org]</b></li>
106</ul>
107<p>Insert this tag into a album description to redirect it to the URL of your choice.</p>
108
109<ul>
110  <li><b>[redirect img=xx]</b></li>
111</ul>
112<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>
113
114<ul>
115  <li><b>[redirect cat=xx]</b></li>
116</ul>
117<p>Redirect to a album of your gallery where xx the album identifier.</p>
118
119<ul>
120  <li><b>[redirect search=xx]</b></li>
121</ul>
122<p>Redirect to a search page of your gallery where xx is the search identifier.</p>
123</div>
Note: See TracBrowser for help on using the repository browser.