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 UserManual:Insert links Manual:Extension/BlueSpiceInsertLink
- 3 About Wiki Links 4
- How do I create links?
- 4.1 Link to a wiki page4.2
- 5 Link to an external website 4.3
- 6 Link to a file
- 5 Technical Details 6
- in the wiki
- 7 Link to a file in the local network
- 8 Related info
- 9 List of common parameters
- 7 10 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-x:hidden; overflow-y:auto;">
{{#dpl:
|category=Editing
|randomcount=1
|includepage=*
|includemaxlength=10
|format=,\n==[[%PAGE%]]==\n,,}}
</div>
Output:
Warning: Display title "Insert links" overrides earlier display title "Creating page lists with DPL3".
How do I create links?[edit | edit source]
Linking pages is
an important feature of browser-based knowledge documentation. The links often differ in their function. Links
connect wiki pages with:
- other wiki pages
- external websites
- files (images, PDF files, Word documents,...)
- files stored on other drives
Use the Insert link menu item in VisualEditor or use the shortcut Ctrl+K. In both cases,
a dialog box opens
connect related pages or other content that provides more information. Page names can exist multiple times in different namespaces. Therefore, under
Search pages
, enter the namespace
if the destination page is not in the same namespace as the current page.
If you have selected some text on the page, you will find some page suggestions
already listed in the
Search pages
tab. Here, you can adjust the search term accordingly or create a link to a new page.
Then click on
Done.
In the source text,
links are created with the following structure:
-
Link to a wiki page:
[[
-
landing page name|caption]]
-
Link to a wiki page in another namespace:
[[
-
namespace:
-
landing page name|caption]]
-
Link to a category page:
[[:Category:category name|caption]]
To create a link to a category, the source code is preceded by a colon
- before the category name.
- In contrast, the link "Category: BlueSpice" would create a category called BlueSpice instead of linking to the category BlueSpice.
- Interwiki
-
link:
[[
-
Imdb:tt2709692]]
If your wiki links to other wikis, you can use the
- tab Search pages also to directly link to a page in a related wiki. For example, if your administrator maintains an
- interwiki link for the IMDb movie database, it can be typed in as in the example above. Ask your administrator which
- interwiki links are available in your wiki.
Link to an external website[edit | edit source]
To link to an external website, mark text on your page, e.g. the word "Wikipedia". Press Ctrl+K and switch to the tab
External link
. There you enter the web address. Then click

Insert.
Note: To easily maintain external links on your wiki, use the page Special:LinkSearch. This page allows you to search for external links in your entire wiki. The page also contains a link to the associated Mediawiki help page.
Link to a file in the wiki[edit | edit source]
To link a file (for example, a picture or a PDF file) in the current page, go to the
Link to File
tab. There, you can search for a file or upload a new file
.
- Search for a file in the wiki and include it as a link: Enter the file name and select the desired file. Then click on "Paste". A link to the file has been added to the page. You can then change the displayed link text.
-
Link file to a network drive: If you want to connect to a file on your company network, enter the path under "Link to file" in the text field and activate "Network share path (URI)". The file path is entered using the following syntax -
[[:file:///Z:/myfolder/vacatio]]

Technical Details
-
. this only works if your wiki has been configured to work with network files. This function also depends on your individual browser security settings.
Link to a file in the local network[edit | edit source]
If you want to link to a file on your company network, you can also use the Link to file tab.
Important! Links to network drives (UNC links) pose a security risk. Therefore, current browsers block these links by default.
It is also possible that your wiki has been configured to disable links to network files.
Talk to your IT department if you have any questions about guidelines related to your browser. If your IT department does not offer a solution, files linked in the wiki can still be copied by wiki users and pasted into the address bar of Windows Explorer.
For more info about UNC-Links, see: https://www.mediawiki.org/wiki/UNC_links.
Insert a link to a local network file:
- Click Insert link in the visual editor.
- Click on the tab Link to file.
- Activate the switch Netzwerkpfad (URI). In the file search field (4) you now see the link symbol.
-
Enter the path to your file. You can get this path by right-clicking on the file properties in Windows Explorer. From the tab Security you can copy the object name and paste it into the wiki accordingly.
-
Click Insert. The link is automatically added in the correct format (
file://S:/7_Benutzer/....
). Whether the link can be directly followed through the browser, depends on your browser security settings and installed add-ons. Talk to your IT department to get help if the links are not active.
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-x:hidden; overflow-y:auto;"> {{#dpl: |category=Editing |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- overflow-x:hidden; overflow-y:auto;"> {{#dpl: |category=Editing |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 108: | Line 108: | ||
=== Show a random page in a category === | === Show a random page in a category === | ||
<syntaxhighlight lang="text"> | <syntaxhighlight lang="text"> | ||
− | <div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow-y:auto;"> | + | <div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow-x:hidden; overflow-y:auto;"> |
{{#dpl: | {{#dpl: | ||
|category=Editing | |category=Editing | ||
Line 121: | Line 121: | ||
'''Output:''' | '''Output:''' | ||
− | <div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow-y:auto;"> | + | <div style="border:2px solid #f6f6f6; padding:10px; width:500px; height:500px; overflow-x:hidden; overflow-y:auto;"> |
{{#dpl: | {{#dpl: | ||
|category=Editing | |category=Editing |