Examples/Parameter: format (example 4): Difference between revisions

From DynamicPageList3 Manual
Content added Content deleted
imported>FrozenPlum
m (Update to parser function syntax because again, it contains a complication that needs to be well understood in order to be used successfully. The general use and syntax page only describes escaping being necessary for "extensions", it is also required for gallery syntax.)
imported>FrozenPlum
m (I see soooo many fixes to my wording and examples that need doing)
Line 1: Line 1:
<noinclude>{{noedit}}</noinclude><!--
<noinclude>{{note|Please '''do not edit''' this page unless you're wanting to edit the manual itself, it is an example included in the manual.|error}}</noinclude><!--
This is the example preloaded for testing, press "Show Preview" to see
This is the example preloaded for testing, press "Show Preview" to see
the example working (at the bottom of the page). If you save this page,
the example working (at the bottom of the page). If you save this page,
Line 6: Line 6:
==Example==
==Example==


This would list items in the ''File'' namespace, limited to a count of 3, formatted as a gallery using the <code>''Startall''</code> and <code>''Endall''</code> positions of the {{DPL|format}} syntax to specify gallery start and end. Note that when DPL3 parser function syntax is used to create a gallery, which uses tag syntax, the <code><</code> and <code>></code> characters must be escaped, so each is replaced by <code>«</code> and <code>»</code> respectively. The <code>''Start''</code> position in the syntax specifies the <code>%PAGE%</code> (in this case the file page) followed by a line break <code><nowiki>\n</nowiki></code> to populate the MediaWiki gallery syntax needed. The <code>''Start''</code> and <code>''End''</code> (empty, not required) parts of the syntax are applied to each result in the list, so the file page name is fetched for each image and put on a new line to complete the gallery statement. See [[mw:Help:Images#Gallery syntax|gallery syntax]] on MediaWiki Wiki for more information on gallery syntax.
This would list items in the ''File'' namespace, formatted as a gallery using the <code>''Startall''</code> and <code>''Endall''</code> arguments of the {{DPL|format}} syntax to specify gallery start and end. The <code>''Start''</code> and <code>''End''</code> arguments are then applied to each result, so the file page names are fetched for each image, and put on a new line to complete the gallery statement.


'''Note:''' When DPL3 parser function syntax is used to create a gallery, the <code><</code> and <code>></code> characters must be replaced by <code>«</code> and <code>»</code> respectively (to escape them).


<pre>
<pre>
{{#dpl:
{{#dpl:
|namespace = File
|namespace = File
⚫
|count = 3
|format = «gallery mode="packed" widths="80px" heights="80px"»,%PAGE%\n,,«/gallery»
|format = «gallery mode="packed" widths="80px" heights="80px"»,%PAGE%\n,,«/gallery»
⚫
|count = 3
}}
}}
</pre>
</pre>
Line 20: Line 23:
{{#dpl:
{{#dpl:
|namespace = File
|namespace = File
⚫
|count = 3
|format = «gallery mode="packed" widths="80px" heights="80px"»,%PAGE%\n,,«/gallery»
|format = «gallery mode="packed" widths="80px" heights="80px"»,%PAGE%\n,,«/gallery»
⚫
|count = 3
}}
}}
<noinclude>
<noinclude>

Revision as of 21:53, 25 April 2022

Please do not edit this page unless you're wanting to edit the manual itself, it is an example included in the manual.

Example

This would list items in the File namespace, formatted as a gallery using the Startall and Endall arguments of the format syntax to specify gallery start and end. The Start and End arguments are then applied to each result, so the file page names are fetched for each image, and put on a new line to complete the gallery statement.


Note: When DPL3 parser function syntax is used to create a gallery, the < and > characters must be replaced by « and » respectively (to escape them). 

{{#dpl:
|namespace = File
|format    = «gallery mode="packed" widths="80px" heights="80px"»,%PAGE%\n,,«/gallery»
|count	    = 3
}}

Result

{{#dpl: |namespace = File |format = «gallery mode="packed" widths="80px" heights="80px"»,%PAGE%\n,,«/gallery» |count = 3 }}

Retrieved from "https://dpl3.wikitide.org/wiki/Examples/Parameter:_format_(example_4)?oldid=2067"