DynamicPageList3 Manual

Controlling output order: Difference between revisions

Page Discussion

Controlling output order (view source)

Revision as of 02:48, 1 April 2023

2,060 bytes added ,  1 year ago
m
Minor cleanup
imported>FrozenPlum
m (Hopefully this makes things somewhat clearer, order requires ordermethod to work, that was a big piece of missed information for most. XD)
imported>FrozenPlum
m (Minor cleanup)
 
(8 intermediate revisions by the same user not shown)
Line 1:
{{purgenote}}
{{DPL manual|section=Parameters|subsection=Controlling output order}}
{{tocright}}
DPL3 allows you to define the sort order of its output, as is explained below.
 
In some cases, this is not sufficient, however. Think of the following example: You create a list of pages which use a certain template. You want to show the value of the first parameter each page uses when calling that template. This can easily be done with the {{DPL|include}} feature of DPL. If you now wanted the output to be sorted by the value of that parameter, DPL could not help because it had to analyze all articles before finding those parameter values.
 
DPL3 allows you to define the sort order of its output, as is explained below.
But there is another way: Create a ''sortable wiki table'' (using the {{DPL|table}} option of DPL with 'class=sortable') and you can click on the column headings to sort your output accordingly. However, the initial order shown in that table will still be the order in which DPL parsed the wiki pages (usually an alphabetic order of the page names).
 
Using a handful of JavaScript lines, you can sort a wikitable ''on pageLoad'' by any column. You must insert that JavaScript code AT THE END of your page :
 
sortables_init();
// sort the first sortable table; change [0] to sort other tables.
tab = document.getElementsByTagName("table")[0];
// sort by the first column; change [0] to sort by other columns.
hdr = tab.getElementsByTagName("th")[0];
// get the sort button link
lnk = hdr.getElementsByTagName("a")[0];
ts_resortTable(lnk);
 
Before version 1.16 of MediaWiki, ''wikibits.js'' was typically called at the end of a page and performed ''sortables_init()''. Calling it explicitly did not result in it being recognized, but rather resulted in adding a second set of sort link buttons.
 
 
Line 26 ⟶ 10:
{{DPL Parameter
|name = ordermethod
|purpose= Sets the criteria used to order the list, usuallyby; often combined with <code>{{DPL|order}}{{=}}''descending''</code> andfor descending sort (otherwise ''ascending'' oris ''descending''default); or, alternatively, may be combined with <code>{{DPL|headingmode}}</code>.
}}
 
Line 32 ⟶ 16:
'''Syntax:'''
 
<code>ordermethod=<i>method1,method2,...</i></code> means ordered by ''method1'' first, then by ''method2'', etc., (like the [https://www.w3schools.com/sql/sql_orderby.asp ORDER BY] clause in SQL).
 
 
'''''methodN''''' can be one of the following '''single''' values (which will be sorted in ''ascending'' order by default, see <code>{{DPL|order}}</code>):
 
{| class="wikitable" style="max-width:1200px;"
! Method
! Description
|-
|'''''categoryadd'''''
|OutputsOrders list based on the most recent addition to the first category specified (requires tothe include'category' parameter, only one category andcan onebe onlyincluded usingto 'category' parameterwork).
{{note|See '''''sortkey''''' for sorting by page order in a category.}}
|-
|'''''counter'''''
|OutputsOrders list based on the number of times the page has been viewed (by ~popularity).
{{note|'''Note:''' Requires the [[mw:Extension:HitCounters|HitCounters]] extension for wikis on MediaWiki 1.25.0 or higher since the counter feature was removed<ref>[https://www.mediawiki.org/wiki/Manual:$wgDisableCounters Manual:$wgDisableCounters]</ref>; this extension is not yet available on Miraheze wikis.}}
|-
|'''''size'''''
|OutputsOrders list based on the size of the article (bytes of wiki text).
|-
|'''''firstedit'''''
|OutputsOrders list based on first edit to the pages (creation).
|-
|'''''lastedit'''''
|OutputsOrders list based on the most recent edit to the pages.
|-
|'''''pagetouched'''''
|OutputsOrders list based on 'page_touched' timestamp. Read the comment on the page_touched field in [[mw:Page_table|Page_table]] to see the difference from most recent edit by an author.
|-
|'''''pagesel'''''
|OutputsOrders list based on the names of the reference pages which are used in the selection of a <code>linksfrom</code> or <code>linksto</code> statement. ''pagesel'' only makes sense if there is more than one page mentioned in the <code>linksfrom</code> or <code>linksto</code> condition.
|-
|'''''title'''''
|OutputsOrders list sorted by article (prefix +) title.
|-
|'''''titlewithoutnamespace'''''
|OutputsOrders list sorted by the article name regardless of namespace.
|-
|'''''sortkey'''''
|OutputsOrders list sorted by [[mw:Help:Categories#Sort key|(category) sortkey]] (is ordered by sortkey of the '''first category specified''', if there are multiple); requires at least one category statement. Sortkey provides either the default category sort order (alphabetical), andor a sortkey can be manually specified on each page ifin desiredthe rathercategory. thanSince the''sortkey'' categoryrelates defaultdirectly sortto the sorting order (seeof [[mw:Help:Categories#Sortpages in one key|(category), ''sortkey]])'' functions as an alias of sorts for "category".
|-
|'''''none'''''
|Do not apply any ordering (except ordering by timestamp if you requested a list of revisions); this method '''mustis beset usedby whendefault youif specify '''<code>openreferences=yes'''.</code> —is '''(default)'''set.
|}
 
 
'''''methodN''''' can also be one of the following '''combination''' of values (seewhich alsowill [[Controllingbe outputsorted in format#headingmode|''headingmodeascending'']] optionorder by default, see <code>{{DPL|order}}</code>):
 
{| class="wikitable" style="max-width:1200px;"
! Method
! Description
! Note
|-
|'''''user,firstedit'''''
|Orders list sorted by user, then by last edit.
|rowspan="6"|If the user who did the first or last edit is nonexistent locally (an editor from page import), the user link appears escaped on-page.
|-
|'''''user,lastedit'''''
|Orders list sorted by user, then by first edit.
|-
|'''''title,firstedit'''''
|Orders list sorted by title, then by lastedit by any user.
|-
|'''''title,lastedit'''''
|Orders list sorted by title, then by firstedit by any user.
|-
|'''''titlewithoutnamespace,firstedit'''''
|Orders list sorted by title (without the namespace), then by firstedit by any user.
|-
|'''''titlewithoutnamespace,lastedit'''''
|Orders list sorted by title (without the namespace), then by lastedit by any user.
|-
!colspan="3"|For use with <code>{{DPL|headingmode}}</code>, see {{DPL|headingmode}}.
|-
! Method
! Description
! Use
|-
|'''''category,title'''''
|Orders list sorted by category, then by title.
|rowspan="5"|
* The first argument sets each ''category'' as a heading and orders by
* The second argument sets ''MethodN'' as the order of article results ''under'' each category heading; if used without <code>headingmode</code>, these values will cause unwanted duplication of results. Requires at least one category statement.
'''Note:''' If pages in the result set belong to more than one category, all categories are listed and the results will appear more than once in the output. See {{DPL|headingmode}} for more information.
|-
|'''''category,firstedit'''''
|OutputsOrders list sorted by category, then by first edit.
|-
|'''''category,lastedit'''''
|OutputsOrders list sorted by category, then by last edit within a category.
|-
|'''''category,pagetouched'''''
|OutputsOrders list sorted by category, then by pagetouched.
|-
|'''''category,sortkey'''''
|OutputsOrders list sorted by title and [[mw:Help:Categories#Sort key|(category) sortkey]],; requires at least one category statement and a sortkey must be set on at least one of the output pages.
|-
|'''''user,firstedit'''''
|Outputs list sorted by user, then by firstedit by the user.
|-
|'''''user,lastedit'''''
|Outputs list sorted by user, then by lastedit by the user.
|}
 
 
'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: ordermethod (example 1)|Example}}
'''Example:'''<br>
{{ViewTest|Examples|Parameter: ordermethod (example 1)}}
 
<pre><nowiki>
{{#dpl:
|category=Africa
|ordermethod=lastedit
}}
</nowiki></pre>
 
'''Result:'''<br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: ordermethod (example 1)|Result}}
This list will output pages that have <nowiki>[[Category:Africa]]</nowiki> showing most recently edited articles at the top.
 
 
Line 120 ⟶ 125:
{{DPL Parameter
|name = order
|purpose= Controls the sort direction of the list,; a value of ''descending'' '''requires''' <code>{{DPL|ordermethod}}</code> to be set, so that DPLDPL3 knows which criterion (or criteria) to sort by.
}}
 
Line 127 ⟶ 132:
 
''orderdirection'' can be one of:
* ''ascendingdescending'' — dependingDepending on the critriacriteria set, smallestlargest to largestsmallest, leastmost to mostleast, 09 to 90 and/or AZ to Z — '''(default)'''A
* ''descendingascending'' — dependingDepending on the critriacriteria set, largestsmallest to smallestlargest, mostleast to leastmost, 90 to 09 and/or ZA to AZ — ('''default''', need not be set)
 
 
'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: order (example 1)|Example}}
'''Example:'''
{{ViewTest|Examples|Parameter: order (example 1)}}
<pre>
 
{{#dpl:
|category = Africa
|ordermethod = lastedit
|order = ascending
|addeditdate = true
}}
</pre>
 
'''Result:'''<br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: order (example 1)|Result}}
This will list pages that have <nowiki>[[Category:Africa]]</nowiki> shown, ordered from oldest to newest.
In addition, the edit date will be presented with each article.
 
 
Line 159 ⟶ 157:
* For case insensitivity during the ''selection'' of articles, see {{DPL|ignorecase}}.
* You may want to try <code>latin1_swedish_ci</code> or other collation mapping table names as well. If you use a name for the first time, you should make sure that it is spelled correctly. Otherwise, you will see a SQL error message.
* A very special (proprietary) function can be used to sort card suit symbols according to the rank of suits that is used in the card game of bridge (this cannot be done by standard collating sequences). To trigger this function, set <code>ordercollation=bridge</code>.
 
==Other ways to sort==
 
===tablesortcol===
{{#lsth:Examples|tablesortcol}}<!-- transclude from other page -->
 
===Using JavaScript===
 
In some cases, DPL3 sorting features are sufficient; think of the following example:
* You create a list of pages which use a certain template.
* You want to show the value of the first parameter each page uses when calling that template. This can easily be done with the {{DPL|include}} feature of DPL.
* If you now wanted the output to be sorted by the ''value'' of that parameter, DPL3 could not help because it had to analyze all articles before finding those parameter values.
 
 
But there is another way:
* Create a ''sortable wiki table'' (using the {{DPL|table}} option of DPL3 with <code>class="wikitable sortable"</code>) and you can click on the column headings to sort your output accordingly. However, the initial order shown in that table will still be the order in which DPL3 parsed the wiki pages (usually an alphabetical order of the page names).
 
Using a handful of JavaScript lines, you can sort a wikitable ''on pageLoad'' by any column. You must insert that JavaScript code AT THE END of your page:
 
<syntaxhighlight lang="javascript">
sortables_init();
// sort the first sortable table; change [0] to sort other tables.
tab = document.getElementsByTagName("table")[0];
// sort by the first column; change [0] to sort by other columns.
hdr = tab.getElementsByTagName("th")[0];
// get the sort button link
lnk = hdr.getElementsByTagName("a")[0];
ts_resortTable(lnk);
</syntaxhighlight>
 
Before version 1.16 of MediaWiki, ''wikibits.js'' was typically called at the end of a page and performed ''sortables_init()''. Calling it explicitly did not result in it being recognized, but rather resulted in adding a second set of sort link buttons.
 
==References==
Anonymous user
Retrieved from "https://dpl3.wikitide.org/wiki/Special:MobileDiff/881...890"