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:
UserManual:Extension/DrawioEditor[edit | edit source]
Warning: Display title "Drawio" overrides earlier display title "Creating page lists with DPL3".
Draw.io offers extensive drawing possibilities for process flowcharts, infographics and other visualizations on a wiki page. Descriptive graphics like process chains or decision trees can be constructed directly on a wiki page.
Inserting a chart[edit | edit source]
To insert a drawing with VisualEditor:
- Create or choose a page where you want to insert a drawing.
- Select Insert > Magic word from the editor toolbar.
- Choose drawio from the list of magic words.
- Click Done. This opens a dialog box. Enter a name for your drawing.
-
Click Insert.
This inserts the following tag in your source code
{{#drawio:Name_of_the_flowchart}}
- Save the page.
Editing the drawing[edit | edit source]
- Click Edit on the saved page above the drawio placeholder to open the draw.io editor. For the best editing experience, set your wiki into full-screen mode using the toggle button in the main toolbar.You can now edit your drawing.
- Click Save in the draw.io window to save your drawing.
- Click Exit next to the Save button in the draw.io window to close the draw.io editor.
About PNG and SVG files[edit | edit source]
In BlueSpice, draw.io diagrams are always saved in PNG format. It is currently not possible to save diagrams in SVG formats. If you have installed your wiki in-house (i.e., you are not working in the cloud), you can activate SVG support via an additional extension.
Import of existing diagrams[edit | edit source]
Visio diagrams[edit | edit source]
You can import files with the extension .vsdx directly into draw.io and edit them further. To do this, create an empty draw.io diagram on a wiki page. Save the empty diagram and then switch to draw.io's edit mode. From there, choose File> Import From> Device. You can then edit the imported diagram in draw.io.
SVG files[edit | edit source]
When you import an SVG file into the BlueSpice draw.io editor, it is automatically converted into PNG format and can, therefore, no longer be edited. It is also not saved as an SVG file in the wiki. As an alternative to importing it into draw.io, you should upload the SVG file to the wiki and embed it on a wiki page. The versioning of the file cannot be done directly in the wiki. The updated version of the SVG file would then have to be updated accordingly via the file page by uploading it again.
Using draw.io with image maps[edit | edit source]
Draw.io creates a versioned png-file in the File namespace. This means that every change of the flowchart creates a new, updated version of this png-file. You can integrate this file on another page in your wiki or create an image map.
Note: It is not possible to use an image map on the same page as a drawio-diagram.
Related info
- draw.io Website
- mediawiki.org/wiki/Extension:DrawioEditor
- Reference:DrawioEditor
- Anja Ebersbach, draw.io für MediaWiki und BlueSpice, BlueSpice News & Know How, February 13 2020.
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> | ||