Extension:PropertyTable

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
PropertyTable
Release status: unmaintained
Implementation Tag, Parser function
Description Outputs a table with keys and values.
Author(s) Fernando Correia
Latest version 1.2.0 (2007-07-25)
MediaWiki 1.8, 1.9
License No license specified
Download PropertyTable.php
Translate the PropertyTable extension if it is available at translatewiki.net
Check usage and version matrix.

Introduction[edit]

Sample of property table created by the PropertyTable extension.

PropertyTable is an extension to MediaWiki that outputs a table of keys and values (titles and descriptions, or fields and contents).

Its purpose is to make it easier to create simple tables with a predefined style.

PropertyTable2 is a more recent development of this extension which may be more suitable, depending on your requirements.

Features[edit]

  • Simple syntax.
  • Customizable style.
  • Optional auto numbering.

Installation[edit]

  1. Download PropertyTable.php and save it in the extensions directory of your wiki.
  2. Insert these lines in the LocalSettings.php file:
// Activate PropertyTable extension
include_once('extensions/PropertyTable.php');

Configuration[edit]

Customizing the visual style[edit]

There are two ways to customize the appearance of the generated table: HTML and CSS.

  • HTML: To change the HTML attributes, add these lines to LocalSettings.php, below the reference to PropertyTable.php, and edit them according to your needs:
// HTML attributes of the table tag
$wgPropertyTableAttributes = 'class="property_table" border="0" cellpadding="2" cellspacing="4"';
// HTML attributes of key cells
$wgPropertyTableKeyAttributes = 'class="property_key_cell" valign="top" bgcolor="#E8F3FF" style="font-weight: bold"';
// HTML attributes of value cells
$wgPropertyTableValueAttributes = 'class="property_value_cell" valign="top" bgcolor="#F3F3F3"';
  • CSS: One simple way to change CSS properties in recent releases of MediaWiki is by editing the MediaWiki:Common.css page on your wiki. The default CSS classes are property_table, property_key_cell and property_value_cell.

Translating[edit]

The tag used by the extension can be translated. The default English tag is <properties>.

To add another translation, change the section Internationalized messages in the PropertyTable.php source code file.

Please post your translation on the discussion page so other people can use it!

Usage[edit]

Basic usage[edit]

  • Within the extension tag (<properties> by default), add a line of text for each line you want on the table.
  • Separate the key from the value using an "=" sign.
  • You can use wiki markup in the keys and in the values.

For instance,

== Meeting information ==
<properties>
Id=01/2007
Title=First monthly meeting
Place=[http://en.wikipedia.org/wiki/Chicago Chicago]
Date=Jan 10, 2007
Time='''9am''' to '''11am'''
</properties>

Produces:

PropertyTableSample.png

Automatic numbering[edit]

You can also produce formatted tables with automatic numbering, using the "#" character. For example:

<properties>
#=first<br>line
#=second line
#=third line
</properties>

Produces:

PropertyTableSample2.png

Automatic sequence with letters[edit]

Alternative, you can use the "@" character to have automatic increments using letters. For example:

<properties>
@=alfa
@=beta
@=gamma
@=delta
</properties>

Produces:

PropertyTable Extension Alphabetic.png

Using in templates[edit]

If you want to create property tables inside templates using parameters, you'll need to use the parser function form of the PropertyTable extension.

For instance, create a Template:Test page like this:

{{#properties:
Document Id={{{1}}}
Document Type={{{2}}}
Document Status={{{3}}}
Last Review={{{4}}}
Review Period={{{5}}} Days
}}

Then use it in another page, like this:

{{Test|A1234-X|98|Pending|2007-06-27|60}}

The result will be:

PropertyTable Extension Template.png

Alternatives[edit]

Feedback[edit]

Use the discussion page for feedback, questions, feature requests and bug reports.