Memory Alpha
Memory Alpha
m (copyedit)
Tag: sourceedit
(→‎Use: Updated links to DPL manual)
Line 26: Line 26:
   
   
<big>Below are some commonly-used options and parameters. For a complete set of DynamicPageList commands, see the [http://semeb.com/dpldemo/index.php/Manual manual] on the [http://semeb.com/dpldemo/ DPL website].</big>
+
<big>Below are some commonly-used options and parameters. For a complete set of DynamicPageList commands, see the [http://followthescore.org/dpldemo/DPL:Manual manual] on the [http://followthescore.org/dpldemo/ DPL website].</big>
   
 
----
 
----

Revision as of 14:41, 13 November 2018

Help Contents → Dynamic page list

DynamicPageList is a Mediawiki extension originally developed for Wikinews. It enables Memory Alpha archivists to create a list of pages that are listed in a set of categories. For more information see Dynamic Page List on MediaWiki.

Every page on Memory Alpha that invokes DPL links to a special "Extension DPL" template automatically.

Use

DynamicPageList can be used with XML-like syntax in the wiki edit view. The parameters control the pages to list, the display order, and the display mode. See the following sections for information on each parameter. For example, the following are the oldest five pages on Memory Alpha that need one or more citations:

<dpl>
category             = Memory Alpha pages needing citation
count                = 5
order                = ascending
addfirstcategorydate = true
</dpl>


Below are some commonly-used options and parameters. For a complete set of DynamicPageList commands, see the manual on the DPL website.


Page selection

category
lists categories from which to select articles. DynamicPageList will list pages that are found in every category listed on a separate category line (i.e. an AND operation). To perform an OR operation, separate categories with the pipe character ("|") on a single category line. A minimum and maximum number of entries to list is set in the extension's source code. You may use magic words like {{CURRENTMONTHNAME}} in the category name.
The syntax is category = 1st category name | 2nd category name | ...

This example will list pages that have [[Category:TOS performers]] OR [[Category:TAS performers]], AND [[Category:ENT performers]]:

<dpl>
category = TOS performers|TAS performers
category = ENT performers
</dpl>
notcategory
restricts the list of pages to those not in a particular category. You can use magic words like {{CURRENTMONTHNAME}} in the category name.
The syntax is notcategory = category name

This example will list pages that have [[Category:TAS performers]] but NOT [[Category:TOS performers]]:

<dpl>
category    = TAS performers
notcategory = TOS performers
</dpl>
namespace
restricts the list of pages displayed to those in one of the listed namespaces, specified by name (see the List of namespaces). To select the main namespace, use a null string as the namespace parameter (i.e. namespace = ). An invalid name produces an error message.
Note that namespace ids are no longer valid as namespace arguments.
The syntax is namespace = 1st namespace name | 2nd namespace name | ...
<dpl>
category  = Memory Alpha maintenance templates
namespace = Template
</dpl>
redirects
determines whether or not to include redirect pages. The value can be exclude (default, don't list redirects), include (list redirects), or only (don't list pages that aren't redirects).
<dpl>
category  = Nicknames
redirects = only
</dpl>
count
restricts the number of results that are shown. By default, the pages added to the category most recently are shown (see order). Note that the extension will not list more results than the maximum defined in the extension source code.
<dpl>
category = Performers
count    = 3
</dpl>

Details displayed

shownamespace
displays the namespace in the page names. The value can be true (default, display in name: Help:Contents) or false (don't display in name: Contents).
<dpl>
category      = Memory Alpha maintenance templates
shownamespace = false
</dpl>
addfirstcategorydate
shows the date each article was added to category. The value can be true (display date) or false (default, don't display date). If many categories are specified, it uses the first category. The linked page names are prepended with the date formatted according to your date display preferences.
<dpl>
category             = Aquans
addfirstcategorydate = true
</dpl>
mode
determines the format of the list. The value can be unordered (default, outputs a bulleted list, HTML tag "ul"), ordered (outputs numbered list, HTML tag "ol"), none (outputs plain text with line breaks), or inline (outputs an inline list separated by the character(s) specified in the 'inlinetext' parameter).
unordered:
<dpl>
category      = Constellations
mode          = unordered
</dpl>

ordered:
<dpl>
category      = Constellations
mode          = ordered
</dpl>

plain text:
<dpl>
category      = Constellations
mode          = none
</dpl>

inline:
<dpl>
category      = Constellations
mode          = inline
</dpl>

unordered:

ordered:

  1. Orion (constellation)
  2. Leo (constellation)
  3. Eridanus
  4. Cygnus
  5. Auriga
  6. Gemini (constellation)
  7. Andromeda
  8. Cancer (constellation)
  9. Puppis
  10. Aries
  11. Canis Major
  12. Canis Minor
  13. Cetus
  14. Fornax
  15. Columba
  16. Lepus
  17. Monoceros
  18. Sculptor (constellation)
  19. Pisces
  20. Taurus
  21. Lynx
  22. Hercules (constellation)
  23. Virgo
  24. Scorpius
  25. Great Horn
  26. Eastern lights
  27. Perseus
  28. Gezid
  29. Paedos
  30. The Runners

plain text:

inline:

inlinetext
defines the inline text separator to be used when mode = inline is specified. The default is &nbsp;-&nbsp;.
<dpl>
category      = Asteroids
mode          = inline
shownamespace = false
inlinetext    = &nbsp;&bull;&nbsp;
</dpl>

Order

ordermethod
determines the order and date to display. The value can be categoryadd (output sorted by date pages added to first category), counter (output sorted based on number of times pages have been viewed, i.e. ~popularity), size (output sorted based on size of articles), firstedit (output sorted by date pages were first edited, i.e. page creation), lastedit (output sorted by date pages were last edited), title (default, output sorted by article (prefix+)title) or titlewithoutnamespace (output sorted by article title regardless of namespace).
lastedit:
<dpl>
category             = Ba'ku
addfirstcategorydate = true
ordermethod          = lastedit
</dpl>

categoryadd:
<dpl>
category             = Ba'ku
addfirstcategorydate = true
ordermethod          = categoryadd
</dpl>

lastedit:

categoryadd:

order
decides the sort direction. The value can be descending (default, most recent to oldest) or ascending (oldest to most recent).