MatrixPlugin < TWiki

---++ Matrix Plugin

Generates a matrix in table form. Input are two lists, containing the values for the x and y axis. The lists may be given directly, or as TWiki variables.

In effect, it is similar to a nested use of the <tt>FOREACH</tt> variable (see ForEachPlugin), but it will work better for complex substitutions in the cell content, since there is only one "replace". Also, it is easier to use.

---+++ Basic Usage

Using the two lists =X= and =Y= defined at the end of this topic, we generate an =X*Y= matrix like this:
<verbatim>%MATRIX{ 
  x="%X%" 
  y="%Y%" 
  xtext="Eins, Zwei, Drei"
  ytext="Aa,Bb,Cc" 
  corner="Letter \ Digit"
  cell="$x:$y" 
}%</verbatim>

This gives

%MATRIX{ x="%X%" y="%Y%" corner="Letter \ Digit" cell="$x:$y" xtext="Eins, Zwei, Drei" ytext="Aa,Bb,Cc"}%

---+++ Parameters

The parameters prefixed with $ will be provided for the templates, whenever it makes sense from the context. In particular, in the =cell= template, =$x=, =$y=, =$xtext= and =$ytext= are available.

| *Name*  | *Description*  | *Template variable* |
| x  | The horizontal values  | =$x=  |
| y  | The vertical values  | =$y=  |
| xtext  | Concomitant for x, can be used in templates  | =$xtext=  |
| ytext  | Concomitant for y, can be used in templates  | =$ytext=  |
| corner  | Text for the upper left corner of the matrix | |
| xtitle  | Title template for x  | Template  |
| ytitle  | Title template for y  | Template |
| cell  | Template for cell  | Template |
| verbatim | For debugging. If =true=, shows generated Twiki markup  | |

Additionally, to allow delayed rendering of generated TWiki variable calls, the variable <tt>$percnt</tt> can be used.

   * Set X=1,2,3
   * Set Y=a,b,c

-- Main.RuedigerPlantiko - 2012-11-09

This topic: TWiki > InstalledPlugins > MatrixPlugin
Topic revision: r1 - 2012-11-21 - TWikiGuest

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.MatrixPlugin.