Difference between revisions of "DPL:Manual - dplmatrix"

From FollowTheScore
Jump to: navigation, search
(New page: {{Type:Manual|section=dplmatrix}} === Syntax === <pre><nowiki> {{#dplmatrix: name | yes | no | mode | indented_list }} </nowiki></pre> === Effect === This function is a side entry int...)
 
Line 13: Line 13:
 
You pass an indented list and you get a matrix view back.
 
You pass an indented list and you get a matrix view back.
  
{{subst::DPLMATRIX]]
+
Besides the main entry point (called '''DPL''') there is a small auxiliary function called DPLMATRIX.
 +
 
 +
It can be used to transform an indented list of dependencies into a matrix view. With copy/paste you can easily transfer such a matrix to Excel and do some polishing there like turning column texts to vertical, highlight interesting cells etc..)
 +
 
 +
There are five parameters which MUST be given in thr order listed here:
 +
# The name of the matrix. Appears in the upper left cell. Arbitrary wiki formatting (even images) are possible.
 +
# The symbol for cells which symbolize a link. Default is "x".
 +
# The symbol for cells which symbolize the absence of a link. Default is 'empty cell'.
 +
# The word 'normal' or 'flip'; default is 'normal'. When 'flip' is specified rows and columns will be exchanged.
 +
# The indented list.
 +
#* source items must start in column 1
 +
#* target items must be indented by at least one space
 +
#* after the item name you can add ~~ and a 'label'. Row and column titles of the matrix will contain hyperlinks to the items. If lables are specified they will be used instead of the item names.
 +
 
 +
The idea is that you can generate the indented list by DPL statements. See the following example:
 +
 
 +
----
 +
 
 +
{{:Test matrix}}
  
  

Revision as of 19:58, 17 December 2007

Template:Type:Manual

Syntax

 {{#dplmatrix: name | yes | no | mode | indented_list }}

Effect

This function is a side entry into DPL.

You pass an indented list and you get a matrix view back.

Besides the main entry point (called DPL) there is a small auxiliary function called DPLMATRIX.

It can be used to transform an indented list of dependencies into a matrix view. With copy/paste you can easily transfer such a matrix to Excel and do some polishing there like turning column texts to vertical, highlight interesting cells etc..)

There are five parameters which MUST be given in thr order listed here:

  1. The name of the matrix. Appears in the upper left cell. Arbitrary wiki formatting (even images) are possible.
  2. The symbol for cells which symbolize a link. Default is "x".
  3. The symbol for cells which symbolize the absence of a link. Default is 'empty cell'.
  4. The word 'normal' or 'flip'; default is 'normal'. When 'flip' is specified rows and columns will be exchanged.
  5. The indented list.
    • source items must start in column 1
    • target items must be indented by at least one space
    • after the item name you can add ~~ and a 'label'. Row and column titles of the matrix will contain hyperlinks to the items. If lables are specified they will be used instead of the item names.

The idea is that you can generate the indented list by DPL statements. See the following example:



Test matrix

generating a matrix from an indented list

Input is:

one
 oho
 aha
two ~~ Two
 ehem
three
four
 aha
 uhui ~~ UHU
two ~~ Two
   uhui ~~ UHU

Output is:

normal flipped
{{#dplmatrix:a simple demo matrix||||
one
 oho
 aha
two ~~ Two
 ehem
three
four
 aha
 uhui ~~ UHU
two ~~ Two
   uhui ~~ UHU
}}
{{#dplmatrix:a simple demo matrix|<big>•</big>|.|flip|
one
 oho
 aha
two ~~ Two
 ehem
three
four
 aha
 uhui ~~ UHU
two ~~ Two
   uhui ~~ UHU
}}
a simple demo matrix aha ehem oho UHU
one x   x  
Two   x   x
three        
four x     x
a simple demo matrix one Two three four
aha . .
ehem . . .
oho . . .
UHU . .
  • "from" items ("source") start in col 1
  • "to" items ("target") are indented by at least one space
  • source appears in input sequence
  • target is sorted by alphabet
  • items are treated as pages and shown as a link
  • the label can be defined by adding it after the iterm, separated by "~~"
  • symbols for "yes" and "no" can be defined
  • via the stylesheet in Mediawiki:Common.css you can control the layout (class=dplmatrix)

Links to DPL Manual pages

Now we use two nested DPL queries and Test matrix2 to generate the indented list:

{{#dplmatrix:''links from articles to the DPL manual''|'''x'''|-|flip|
  {{#dpl:
    |debug=1
    |category=DPL Manual
    |format=,%PAGE% ~~ %TITLE%\n²{:Test matrix2¦page=%PAGE%¦category=DPL Manual¦namespace=}²,
  }}
}}
links from articles to the DPL manual Manual Manual - Authors and History Manual - Compatibility Manual - DPL Bug Reporting and Feature Requests Manual - DPL parameters: Controlling output format Manual - DPL parameters: Controlling output volume Manual - DPL parameters: Other parameters Manual - DPL Special Page with Parameters Manual - DPL with PostgreSQL Manual - dplnum Manual - dplreplace Manual - dplvar Manual - General Usage and Invocation Syntax Manual - DPL parameters: Controlling output order Manual - DPL parameters: Criteria for page selection Manual - dplchapter Manual - Source and Installation
Manual - x x x x x x x x x x x x x x x x
Manual - Authors and History x - - - - - - - - - - - - - - - -
Manual - Compatibility x x - - - - - - - - - - - - - - x
Manual - DPL Bug Reporting and Feature Requests x - - - - - - - - - - - - - - - -
Manual - DPL parameters: Controlling output format x - - - - - - - - - - - x x - - -
Manual - DPL parameters: Controlling output order x - - - x - - - - - - - - - - - -
Manual - DPL parameters: Controlling output volume x - - - x - - - - - - - - - x - -
Manual - DPL parameters: Criteria for page selection x - - - - x - - - - - - - - - - x
Manual - DPL parameters: Other parameters x - - - - - - - - - - - - - - - -
Manual - DPL with PostgreSQL - - - - - - - - - - - - - - - - x
Manual - General Usage and Invocation Syntax x - - - - - - - - - - - - - x - -
Manual - Source and Installation x - - - - - - - - - - - - - x - -