Help:DPL advanced editing

From Ballotpedia
Jump to: navigation, search
Ballotpedia:WikiProject Help

Dynamic Page Lists (DPLs) are wiki tools used to generate lists of material and information based on metadata attached to the pages. Simple DPLs allow you to collect a group of links to pages automatically onto one page that share a common category, template, user or other feature. The easiest way to employ DPLs is through categories. If you want to use DPLs on your project, you will need a strong category structure.

For overview information about DPLs on Judgepedia and basic formatting, see Help:DPL basics.


[edit]

DPLs allow you to add a great deal of metadata to a list. Metadata is information that is attached to each wiki page by the wiki which remains hidden. It includes things like edit history, category lists, editors, page counts, and touch dates.

This information is extremely similar to the information which can be included using Fixed wiki variables.

Metadata requires specific tags to be included in the “|format =“ of a DPL and other editing lines (as in %TITLE% and %PAGE%) for the information to appear.

The following chart highlights common metadata and how to include it in the format line.

MetadataPromptFormat tag
Edit date - The date the page was either first edited or last edited, depending on “ordermethod”. “|addeditdate = true” %DATE%
Add Category - Displays the categories each page is in.“|addcategories = true”%DATE%
Page Count - Displays the number of hits the page has received.“|addpagecounter= true”%COUNT%
Page Size - Displays the number of characters on the page.“|addpagesize = true”%SIZE%
Add Author - Adds the first person to edit the page.“|addauthor= true”%USER%
Last Editor - Adds the last person to edit the page.“|addlasteditor= true” %USER%
More Here!



Example:  Formatted metadata inclusion
Code:  
{{#dpl:
|category = Former federal judge
|ordermethod = firstedit
|addpagecounter= true
|addpagesize = true
|addauthor= true
|format = <center>This is a list of former federal judges:</center><hr>,\n#Judge [[%PAGE%{{!}}%TITLE%]],Hits=%COUNT% Pagesize=%SIZE% Author=[[User:%AUTHOR%]],<br/>List completed!
|count = 10
}}
Description:  
Complex formatting with metadata included. Count limited to ten for convenience.
Example:  

Extension:DynamicPageList (DPL), version 2.01 : Warning: No results.


See also

The “|include = “ criteria is the essential criteria for adding all substantial content from any given page. Using the include criteria, you can add sections by their location, sections by their title, and information from inclusion templates.

Multiple pieces of information from multiple sources are separated by a comma within the include criteria. Formatting the information in an understandable fashion is essential. Please see this page to see more about formatting.

From section title

There are two ways to include sections based on heading text, using the exact heading or all headings which include some string of characters.

1. Exact heading of the section, i.e.:

  • “|include = #Judicial_career”
  • Headings must match up exactly.
  • Headings cannot include punctuation.
  • DPLs will pull both headings if the page has more than one heading with the same name.

2. You can include all headings which contain a string of characters, i.e.:

  • “|include = ##.*career.*”
  • This will include the heading “Judicial career”, “Federal judicial career” or any other heading with “career” in it. The period and the asterisk together function as a blank or a wild card.
  • DPLs will pull both headings if the page has more than one heading with the same text string.
  • This is useful if the headings you are trying to pull have punctuation or are inexact.


Example:  By heading
Code:  
{{#dpl:
|title = Jeffrey R. Howard
|ordermethod = firstedit
|include = #Professional career,##.*early.*”
|format = ,[[%PAGE%]],,
}}
Description:  
Will produce a single item list including the page with the title “Jeffrey R. Howard” and incorporating the section "Professional career" and any section with the word "early" in the heading.
Example:  

Extension:DynamicPageList (DPL), version 2.01 : Warning: No results.


Limiting the size of the section

You can limit the size of a section of transcluded text by placing a filter immediately after the text. The filter code looks like:

[CHARACTERLIMIT LINKTEXT]


Example:  Limited section transclusion by heading with redirect.
Code:  
{{#dpl:
|title = Jeffrey R. Howard
|ordermethod = firstedit
|include = #Professional career[25 For the full section go here]
|format = ,[[%PAGE%]],,
}}
Description:  
Will produce a single item list including the page with the title “Jeffrey R. Howard” and incorporating the section "Professional career" and limiting the text that will appear to 25 character and providing a redirecting link.
Example:  

Extension:DynamicPageList (DPL), version 2.01 : Warning: No results.



Example:  Limited section transclusion by location without redirect.
Code:  
{{#dpl:
|title = Jeffrey R. Howard
|ordermethod = firstedit
|include = %4[25]
|format = ,[[%PAGE%]],,
}}
Description:  
Will produce a single item list including the page with the title “Jeffrey R. Howard” and incorporating the section "Professional career" and limiting the text that will appear to 25 character and allowing for the natural redirect link.
Example:  

Extension:DynamicPageList (DPL), version 2.01 : Warning: No results.



See also