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
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:
Manual:Extension/WebDAV[edit | edit source]
With the BlueSpice WebDAV integration you can open, edit and save files from your wiki directly in their native applications. After saving, the files are automatically updated and versioned in the wiki.
Editing options[edit | edit source]
With WebDAV, you have two editing options for files:
- Open the file in the wiki and edit it in the Office application
- Open the file using your local file explorer (for example, Windows Explorer) and edit it in the Office application. This requires a connection between the WebDAV server and your local file explorer. The wiki file directories are then mapped like a network drive.
With WebDAV you can work on OpenDocument files or Microsoft Office files such as Word, Excel or PowerPoint in their associated programs. You can also exchange image formats such as jpg, gif or png and PDF files directly with the wiki via your WebDAV connection.
The supported file formats also depend on your wiki configuration.
Open a file via the browser [edit | edit source]
To open a file directly from the wiki, hold down the control key and right-click on a file link to open the context menu. If the browser context menu is displayed instead of the wiki context menu, simply click with the right mouse button without holding down the control key. You can adjust this behavior in your settings under Appearance > Context menu.
After saving the file, you can see the latest version on the file page.
Associating file types with their applications [edit | edit source]
When you open a file for the first time via the context menu, you may have to associate the necessary application and the file type in your browser. For example, Excel may not open here if you have never opened an Excel file in the browser. However, this changes after you have linked the Excel file extension with the Excel application.
If you then get an error message in Excel, go to the browser settings and change the application for the content type ms-excel to Standard (this is the procedure for Firefox as an example). The file can then be opened and edited directly in Excel.
OpenDocument files[edit | edit source]
OpenDocument files are linked to the corresponding Microsoft Office applications and are opened there by default. You can change your browser settings and associate the ms-word content type with LibreOffice. Afterwards, both OpenDocument text documents and Microsoft Word documents are opened in LibreOffice.
Open a file via Windows Explorer [edit | edit source]
With WebDAV, you can also open a file on the wiki in your Windows Explorer. You simply need to specify the wiki as a network drive. These are the necessary steps under Windows 10:
First you need your personal WebDAV path. Go to your Preferences, tab User profile. If you don't see the WebDAV path here, contact your wiki administrator.
- Copy your personal WebDAV URL from your user preferences page.
- Open Windows Explorer.
- Right-click This PC> Map Network Drive.
- Paste the URL from your clipboard into the text field and select a free drive of your choice. For example W for Wiki. Make sure that you did not paste any spaces at the beginning of the URL. Make sure to remove them.
- Click Finish.
- Type in your wiki username and password. This is only necessary if you use your own wiki password. If your wiki uses single sign-on or LDAP for authentication, you will not be asked for a password at this point.
You can then rename the network label if you like.
Edit a wiki page[edit | edit source]
Now you see the namespaces to which you have view permissions in the wiki. The Pages folder contains all wiki pages in the main namespace, for example the start page. The pages have the file extension .wiki. In theory, you can change a wiki page locally and then save it. To do this, select a simple text editor and edit the page content in wikitext format. The changes are automatically displayed live in the wiki. The version history of the page indicates that this version was edited via WebDAV.
When you open a file from the file page, you can left-click or right-click to open the file. Right-clicking opens the file via WebDAV and saves it directly to the wiki. A left-click also opens the associated application immediately. But here, the file is saved as a local file and you need to manually save the file back to the wiki. You can either save the file locally and manually upload it back into the wiki, or you can save the page directly in the wiki via WebDAV in Windows Explorer.
Subpages [edit | edit source]
If you create a subpage in the wiki, it is displayed in Windows Explorer in a subfolder that is named after the parent page.
In general, it makes more sense to edit wiki pages directly in the wiki, since they can be edited more comfortably in visual editing mode. There, you also have access to important meta information, for example whether a page is locked for editing or whether other users are currently editing the page.
Open a file[edit | edit source]
Uplaoded images and documents are located in the folder Media. This directory lists all files that you can now edit locally using an Office application to then save them directly in the wiki. If the extension NSFileRepo is installed in your wiki, you see the uploaded files organized in folders. These folders correspond to the namespace associations of the files in the wiki.
The files without a specific namespace association, that is the files in the main namespace, are located in the folder (Main).
From here you can edit and save a Powerpoint file, for example. It is versioned directly in the wiki.
As an alternative, you can open the file directly with a left-click from the file page. The file is now saved locally and you have to manually save file back to the wiki using Windows Explorer. You have to make sure that you save the file back into the correct namespace and with the original filename. In the wiki ayou will see the updated version entry with a WebDAV comment.
Additional file actions[edit | edit source]
- Uploading files: With WebDAV, vou can also quickly upload multiple files to the wiki. Simply copy the files from the source location to their target folder in Windows Explorer.
- Create a wiki page: You can also create wiki pages. Simply create a page with the extension .wiki in the editor. Make sure that you are not creating a text file with the extension .txt, but a file with the extension .wiki.
- Delete: Pages that are deleted via WebDAV are marked accordingly in the delete log.
- Copy: It is also possible to copy a document into a different namespace, because documents and wiki pages can exist in different namespaces with the same file name.
- Move/rename: If you try to rename a wiki page or a file using Windows Explorer in the same folder or if you want to move it to a different namespace, you will receive an error message. In this case, moving or renaming a page must be done by moving the page directly on the wiki.
Summary [edit | edit source]
- With WebDAV, office documents in the wiki can be edited directly in their native applications so that you don't have to manualle download and re-upload them.
- Files are versioned accordingly and the version is marked as a WebDAV change.
- Files can be opened from the browser or from Windows Explorer.
- Wiki pages should not be edited using a text editor. They are better suited for direct browser editing.
- Files that are deleted from Windows Explorer can be tracked in the delete log.
- Files that are added from Windows Explorer can be tracked in the upload log.
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-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 105: | Line 105: | ||
}} | }} | ||
+ | === 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-x:hidden; overflow-y:auto;"> | ||
+ | {{#dpl: | ||
+ | |category=Editing | ||
+ | |randomcount=1 | ||
+ | |includepage=* | ||
+ | |includemaxlength=10 | ||
+ | |format=,\n==[[%PAGE%]]==\n,,}} | ||
+ | </div> | ||