Difference between revisions of "Manual:Extension/DynamicPageList3"
[quality revision] | [quality revision] |
(Tag: 2017 source edit) |
(Tag: 2017 source edit) |
The extension DynamicPageList3 allows you to include lists of wiki pages on any content page.
Contents
- 1 Application examples
- 2 Error messages
- 3 Creating a custom 404 error page
- 4 How to update an error message
- 5 Related info 6
- Manual:Edit pages
- 3 Enable edit mode
- 4 Editing
- 5 Preview
- 6 Elements of the "save" dialog
- 7 Editing conflicts
- 8 Blocked pages
- 9 Related info
- 10 List of common parameters
- 7 11 Related info
Application examples[edit | edit source]
You can view a documentation of all selection criteria and formatting options at Gamepedia.
This help page contains some examples of typical applications for this extension as well as a list of common parameters and their values.
List of subpages[edit | edit source]
The following code shows the subpages of the current page in a 3-column layout:
{{#dpl:
|titlematch={{PAGENAME}}/%
|shownamespace=false
|replaceintitle=/{{PAGENAME}}\//,
|columns=3
|mode=none
|rowcolformat=width=100%
}}
{{#dpl:
|titlematch=VisualEditor/%
|shownamespace=false
|namespace= Manual
|replaceintitle=/VisualEditor\//,
|columns=1
|mode=ubordered
|rowcolformat=width=100%
}}
Output:
Selecting pages by namespace[edit | edit source]
{{#dpl:
|namespace=Manual
|includesubpages=true
|shownamespace=false
|count=5
|ordermethod=title
}}
Output:
- Admin Manual Introduction
- Archive/Extension/DocumentManager
- Archive:Extension/RatedComments
- BlueSpice Layout
- BlueSpice Layout/Footer
Selecting pages by category[edit | edit source]
{{#dpl:
|category=QM
|addcategories = true
|includesubpages=true
|shownamespace=false
|count=5
|ordermethod=title
|mode=ordered
}}
Output:
Extension:DynamicPageList (DPL), version 3.3.2: Warning: No results.
Selecting pages with specific naming patterns[edit | edit source]
{{#dpl:
|namespace=File
|titlematch=A%
|count=5
}}
Show a random page in a category[edit | edit source]
<div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow:auto;">
{{#dpl:
|category=CustomizationEditing
|randomcount=1
|includepage=*
|includemaxlength=10
|format=,\n==[[%PAGE%]]==\n,,}}
</div>
Output:
Error messagesManual:Edit pages[edit | edit source]
The wiki contains a number of system error messages. These messages can be customized to your needs.
For example, if a wiki has a lot of visitors with anonymous read-access only, these visitors get a permissions error when they try to access a page that does not exist:
This creates the impression that a page with that name exists, but the visitor does not have sufficient rights to view the page. In reality, the page simply does not exist and a user with write-permissions could now log in and create the page.
Therefore, we want to distinguish between anonymous visitors and users with write-access and show a tailored error message.
Creating a custom 404 error pageWarning: Display title "Edit pages" overrides earlier display title "Creating page lists with DPL3".
Enable edit mode[edit | edit source]
To edit an existing page, click the "edit" button.
Editing[edit | edit source]
You can now add and change content in the content area of the page.
Most users will edit page content using the VisualEditor toolbar. VisualEditor has many features that make page editing much easier.
However, special pages such as templates are edited directly in the source text. Therefore, a knowledge of the Wikitext syntax is necessary for these pages.
Preview[edit | edit source]
If a page does not exist yetWith the Preview button, you can display a custom message.
To create the message:
- Create the page MediaWiki:Noarticletext-nopermission
- Add your custom message in edit mode.
- Save the page.
- To test the message, try to access a page that does not exist.Make sure you are not logged in, because this message is displayed to anonymous users only.
check if you really want to save your changes. This way, you can gradually test small changes. Saving the page repeatedly after small editing steps will result in a large amount of entries in the article's version history. That does not always make sense.
The function SaferEdit automatically saves intermediate versions at defined time intervals while editing an article so that content is not lost if a page has not been saved for a while.
Elements of the "save" dialog[edit | edit source]
The text for the error pages on the wiki is stored in the form of system notifications. You can access these error messages from the page Special:AllMessages
.
To find the message or the messages that are being used on a particular error page, add ?uselang=qqx
or, if the url already contains a question mark, &uselang=qqx
to the page url:
This will expose the actual sources for the error messages on the page:
In the above example, there are two error messages on the page:
- permissionserrortext-withaction: displays the text "You do not have permission to edit this page, for the following reason"
- badaccess-groups: displays the text "The action you have requested is limited to users in one of the groups: Administrators, Editors, Reviewers.
These pages do not actually exist, and therefore the standard text message from the database is displayed. If you want to change a message, you must first create the page.
To update a system message:-
Go to the special page "System messages" (
Special:AllMessages
) -
Enter the full name of the system message in the "Prefix" field of the filter:
The link to the system message apears in red.
- Click on the name to create a page for this system message
- Enter your custom error message and save the page. The system message has now been customized.
- Continue to update any other system messages on the page.
Note: Many of these messages use parameters (e.g., "$1"), which should be considered when you change the default text. If something went wrong, you can also delete the custom error pages you created - then the default text from the database will be used again.
Related info
To save the page, click the "Save changes" button. The corresponding dialog window opens:
The following elements are part of the dialog window:
Element | Type | Description |
---|---|---|
Summary | textarea |
A brief description of the changes makes it easier to understand the changes in the version history.
|
This is a minor edit | checkbox |
Spelling corrections or formatting changes are usually marked as such. Under Recent Changes, such changes are marked with the letter m ("minor changes"). This makes it easy to differentiate in which article version major changes have been made. In addition minor changes can be excluded from the watchlist.
|
Watch this page | checkbox |
A check mark in this box causes the page to be included in the personal Watchlist.
|
Accept this unreviewed page | checkbox |
This box will only be displayed if the revision function is activated in a namespace. A user with the corresponding rights of release can release the page design directly here.
|
Copyright notice | text |
The slightly longer text between the article field and the page-save functions is the copyright notice.
|
Save changes |
Clicking on this button saves the article with all changes made. The edit view will be closed.
|
|
Resume editing |
This button returns directly to the page without saving the article. Editing is simply continued.
|
|
Show preview |
The page opens in a preview window and can be saved from this window.
|
|
Review your changes |
Shows a comparison of the article before editing and at the time of the current processing status with marking of the differences. The changes can be saved directly from this page
|
Editing conflicts[edit | edit source]
If you try to save a page that someone else is currently also working on, the system will report an editing conflict. Each author can compare the current changes and merge them as needed.
Blocked pages[edit | edit source]
Some pages can be protected and edited only by administrators. Instead of the edit option, a link to "View source code" appears. The cause is often obvious from the version history of the page. In this case, you can contact an administrator who can unlock the page.
Related info
List of common parameters[edit | edit source]
Criteria for page selection[edit | edit source]
Parameter | Syntax | Description |
---|---|---|
category | |category=QM|Setup... | Pages in the category QM OR Setup |
|category=QM&Setup&... | Pages in the categories QM AND Setup | |
|category=QM|Setup...|category=Admin | Pages in the categories QM OR Setup, and pages in the category Admin | |
notcategory | |notcategory=QM | Pages that are not in the category QM |
categoriesminmax | |category=QM|categoriesminmax=2 | Pages that are in the category QM and in at least 2 more categories |
|category=QM|categoriesminmax=,1 | Pages that are only in the category QM and in no other category | |
namespace | |namespace= | Pages in the namespace (Main) |
|namespace=Help|Manual | Pages in the namespace Help OR Manual | |
namespacenot | |namespacenot=Help | Pages that are not in the namespace Help |
|namespacenot={{NAMESPACE}} | Pages that are not in the namespace of the current wiki page |
Output-Format[edit | edit source]
Parameter | Syntax | Description |
---|---|---|
mode | |mode=ordered | Unordered list |
|mode=unordered | Numbered list | |
|mode=none | Line breaks | |
|mode=category | Pages are grouped alphabetically with a letter heading (similar to category pages) | |
|mode=inline|inlinetext= • | Page names are listed on the same line and separated with a bullet point |
Sorting[edit | edit source]
Parameter | Syntax | Description |
---|---|---|
ordermethod | |ordermethod=title | Ordered by page (prefix+)title |
|ordermethod=titlewithoutnamespace | Ordered by page name independent of namespace | |
|ordermethod=counter | Ordered by number of page views (popularity) | |
|ordermethod=size | Ordered by page size | |
|ordermethod=firstedit | Ordered by creation date | |
|ordermethod=lastedit | Ordered by last edit date | |
|ordermethod=user,firstedit | Ordered by author, then by creation date | |
|ordermethod=user,lastedit | Ordered by last editor, then by last edit date | |
order | |order=ascending | Sorted in ascending order |
|order=descending | Sorted in descending order |
Display of meta data[edit | edit source]
Parameter | Syntax | Description |
---|---|---|
addcategories | |addcategories=true | Shows all categories of a page after the page name |
addpagecounter |
|category:QM|ordermethod=counter|order=descending
|addpagecounter=true|count=5 |
Shows the 5 most popular pages in the category QM |
adduser | |category=QM|ordermethod=lastedit|adduser=true | Adds the name of the last editor in front of the page name |
addauthor | |category=QM|addauthor=true | Adds the name of the original author in front of the page name. |
Related info
{{DISPLAYTITLE:Creating page lists with DPL3}} The extension '''DynamicPageList3''' allows you to include lists of wiki pages on any content page. ==Application examples== You can view a documentation of all selection criteria and formatting options at [https://help.gamepedia.com/Extension:DPL3 Gamepedia]. This help page contains some examples of typical applications for this extension as well as a [[Manual:Extension/DynamicPageList3#List of common parameters and their values|list of common parameters and their values]]. <br /> ===List of subpages=== The following code shows the subpages of the current page in a 3-column layout: <syntaxhighlight lang="text"> {{#dpl: |titlematch={{PAGENAME}}/% |shownamespace=false |replaceintitle=/{{PAGENAME}}\//, |columns=3 |mode=none |rowcolformat=width=100% }} </syntaxhighlight> Example: Display the subpages of the page ''VisualEditor'' imn the namespace ''Manual'' in a 1-column layout:<syntaxhighlight lang="text"> {{#dpl: |titlematch=VisualEditor/% |shownamespace=false |namespace= Manual |replaceintitle=/VisualEditor\//, |columns=1 |mode=ubordered |rowcolformat=width=100% }} </syntaxhighlight> '''Output:''' {{#dpl: |titlematch=VisualEditor/% |shownamespace=false |namespace= Manual |replaceintitle=/VisualEditor\//, |columns=1 |mode=unordered |rowcolformat=width=100% }} ===Selecting pages by namespace=== <syntaxhighlight lang="text"> {{#dpl: |namespace=Manual |includesubpages=true |shownamespace=false |count=5 |ordermethod=title }} </syntaxhighlight> Output: {{#dpl: |namespace=Manual |includesubpages=true |shownamespace=false |count=5 |ordermethod=title }} ===Selecting pages by category=== <syntaxhighlight lang="text"> {{#dpl: |category=QM |addcategories = true |includesubpages=true |shownamespace=false |count=5 |ordermethod=title |mode=ordered }} </syntaxhighlight> Output: {{#dpl: |category=QM |addcategories = true |includesubpages=true |shownamespace=false |count=5 |ordermethod=title |mode=ordered }} ===Selecting pages with specific naming patterns=== <syntaxhighlight lang="text"> {{#dpl: |namespace=File |titlematch=A% |count=5 }} </syntaxhighlight>Output:{{#dpl: |namespace=File |titlematch=A% |count=5 }} === Show a random page in a category === <syntaxhighlight lang="text"> <div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow:auto;"> {{#dpl: |category=CustomizationEditing |randomcount=1 |includepage=* |includemaxlength=10 |format=,\n==[[%PAGE%]]==\n,,}} </div> </syntaxhighlight> '''Output:''' <div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow:auto;"> {{#dpl: |category=CustomizationEditing |randomcount=1 |includepage=* |includemaxlength=10 |format=,\n==[[%PAGE%]]==\n,,}} </div> ==List of common parameters== ===Criteria for page selection=== {| class="wikitable" style="width:100%;" !Parameter !Syntax ! style="width:380px;" |Description |- |category |''<nowiki>|category=QM|Setup...</nowiki>'' | style="width:380px;" |Pages in the category QM OR Setup |- | |''<nowiki>|category=QM&Setup&...</nowiki>'' | style="width:380px;" |Pages in the categories QM AND Setup |- | |''<nowiki>|category=QM|Setup...|category=Admin</nowiki>'' | style="width:380px;" |Pages in the categories QM OR Setup, and pages in the category Admin |- |notcategory |''<nowiki>|notcategory=QM</nowiki>'' | style="width:380px;" |Pages that are not in the category QM |- |categoriesminmax |''<nowiki>|category=QM|categoriesminmax=2</nowiki>'' | style="width:380px;" |Pages that are in the category QM and in at least 2 more categories |- | |''<nowiki>|category=QM|categoriesminmax=,1</nowiki>'' | style="width:380px;" |Pages that are only in the category QM and in no other category |- |namespace |''<nowiki>|namespace=</nowiki>'' | style="width:380px;" |Pages in the namespace (Main) |- | |''<nowiki>|namespace=Help|Manual</nowiki>'' | style="width:380px;" |Pages in the namespace Help OR Manual |- |namespacenot |''<nowiki>|namespacenot=Help</nowiki>'' | style="width:380px;" |Pages that are not in the namespace Help |- | |''<nowiki>|namespacenot={{NAMESPACE}}</nowiki>'' | style="width:380px;" |Pages that are not in the namespace of the current wiki page |} ===Output-Format=== {| class="wikitable" style="width:100%;" data-ve-attributes="{"style":"width:100%;"}" !Parameter !Syntax ! style="width:380px;" data-ve-attributes="{"style":"width:380px;"}" |Description |- |mode |''<nowiki>|mode=ordered</nowiki>'' | style="width:380px;" data-ve-attributes="{"style":"width:380px;"}" |Unordered list |- | |''<nowiki>|mode=unordered</nowiki>'' |Numbered list |- | |<nowiki>|</nowiki>''mode=none'' |Line breaks |- | |<nowiki>|</nowiki>''mode=category'' |Pages are grouped alphabetically with a letter heading (similar to category pages) |- | |''<nowiki>|mode=inline|inlinetext=&nbsp; &bull; &nbsp;</nowiki>'' |Page names are listed on the same line and separated with a bullet point |} ===Sorting=== {| class="wikitable" style="width:100%;" data-ve-attributes="{"style":"width:100%;"}" !Parameter !Syntax ! style="width:380px;" data-ve-attributes="{"style":"width:380px;"}" |Description |- |ordermethod |''<nowiki>|ordermethod=title</nowiki>'' | style="width:380px;" data-ve-attributes="{"style":"width:380px;"}" |Ordered by page (prefix+)title |- | |''<nowiki>|ordermethod=titlewithoutnamespace</nowiki>'' |Ordered by page name independent of namespace |- | |''<nowiki>|ordermethod=counter</nowiki>'' |Ordered by number of page views (popularity) |- | |''<nowiki>|ordermethod=size</nowiki>'' |Ordered by page size |- | |''<nowiki>|ordermethod=firstedit</nowiki>'' |Ordered by creation date |- | |''<nowiki>|ordermethod=lastedit</nowiki>'' |Ordered by last edit date |- | |''<nowiki>|ordermethod=user,firstedit</nowiki>'' |Ordered by author, then by creation date |- | |''<nowiki>|ordermethod=user,lastedit</nowiki>'' |Ordered by last editor, then by last edit date |- |order |''<nowiki>|order=ascending</nowiki>'' |Sorted in ascending order |- | |''<nowiki>|order=descending</nowiki>'' |Sorted in descending order |} ===Display of meta data=== {| class="wikitable" style="width:100%;" data-ve-attributes="{"style":"width:100%;"}" !Parameter !Syntax ! style="width:380px;" data-ve-attributes="{"style":"width:380px;"}" |Description |- |addcategories |''<nowiki>|addcategories=true</nowiki>'' | style="width:380px;" data-ve-attributes="{"style":"width:380px;"}" |Shows all categories of a page after the page name |- |addpagecounter |''<nowiki>|category:QM|ordermethod=counter|order=descending</nowiki>'' ''|addpagecounter=true|count=5'' |Shows the 5 most popular pages in the category QM |- |adduser |''<nowiki>|category=QM|ordermethod=lastedit|adduser=true</nowiki>'' |Adds the name of the last editor in front of the page name |- |addauthor |''<nowiki>|category=QM|addauthor=true</nowiki>'' |Adds the name of the original author in front of the page name. |}<br /> {{Box Links-en|Topic1=[[Reference:DynamicPageList3]]}} [[en:{{FULLPAGENAME}}]] [[de:Handbuch:Erweiterung/DynamicPageList3]] [[Category:Organization]] [[Category:Customization]]
Line 110: | Line 110: | ||
<div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow:auto;"> | <div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow:auto;"> | ||
{{#dpl: | {{#dpl: | ||
− | |category= | + | |category=Editing |
|randomcount=1 | |randomcount=1 | ||
|includepage=* | |includepage=* | ||
Line 123: | Line 123: | ||
<div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow:auto;"> | <div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow:auto;"> | ||
{{#dpl: | {{#dpl: | ||
− | |category= | + | |category=Editing |
|randomcount=1 | |randomcount=1 | ||
|includepage=* | |includepage=* |