General usage and invocation syntax: Difference between revisions

{{DPL manual|section=General usage and invocation syntax}}

{{tocright}}

Within a DPL3 statement, you can use some symbols (called ''variables'' in this manual) which are implicitly set by DPL3. Some variables can only be used in the header or footer.

{{#lst:Controlling output format|formatvariables}}

! Variable

! Description

|-

|The page name and its included section anchor <code>''Page Name#SectionName''</code>. Corresponds to <code>include=''#SectionName''</code> (when a page section is included by name). It currently appears that <code>%SECTION%</code> can only be used in <code>{{DPL|secseparators}}</code>.

|-

|The name of the parser function, set when <code>{{DPL|include}}</code> is used to look for parser function calls in an article or result set. This variable requires a corresponding <code>include</code> statement and is not very robust, it cannot handle nested parser functions properly. <code>%PFUNC%</code> is only applicable to the template for which the parser function and its parameters are passed (under their normal names or numbers).

|-

|The name of the parser extension (tag), set when <code>{{DPL|include}}</code> is used to look for parser extension (tag) calls an article or result set. This variable requires a corresponding <code>include</code> statement and is not very robust, it cannot handle nested parser functions properly. <code>%TAG%</code> is only applicable to the template for which the parser extension information is passed.

|-

|The body content (as-is, including line breaks) of the parser extension (tag), set when <code>{{DPL|include}}</code> is used to look for parser extension calls an article or result set. This variable requires a corresponding <code>include</code> statement and is not very robust, it cannot handle nested parser functions properly. <code>%TAGBODY%</code> is only applicable to the template for which the parser extension information is passed.

|}

! Description

|-

|Limit number of pages to show, overwrites the values of the <code>{{DPL|count}}=</code> parameter.

|-

|Where to start, n^th page, overwrites the value of the <code>{{DPL|offset}}=</code> parameter.

|-

|{{note|'''Note:''' This feature was removed in DPL3 version 3.0.0.|error}}

|-

|Page name to start with, value is passed to {{DPL|titlegt}}= (previously title>= ).

|-

|Page name to end with, value is passed to {{DPL|titlegt}} (previously title>), which is needed for reverse scroll and which restricts the selection to articles with a page title less or equal to the specified value.

|-

|Page name to start after, value is passed to {{DPL|titlelt}} (previously title<), which and restricts the selection to articles with a page title greater or equal to the specified value.

|-

|direction of scroll (can be 'up' or 'down').

|}

This means that every page containing a DPL3 statement will automatically create a link to [[:Template:Extension DPL]]. You should create this Template in your wiki. We suggest that you copy the source code from [[:Template:Extension DPL|our version]]. The idea is that via this connection, you can easily find out which pages in a wiki contain DPL3 calls.

 

 

 

 

 

 

 

==References==