• View
• Edit
• History
• Attach
• Print
• Backlinks

MessagesReplacement

Questions answered by this recipe

Can I display selected debugging messages from $MessagesFmt from only one, or from selected, message sources?
Can I make the messages from each message source hidden until shown on user demand?

Description

A drop in replacement for the PmWiki (:messages keys= :) directive. Based on code from PITS:01368.

The global variable $MessagesFmt is written to by PmWiki recipes with debug and similar information. By convention the array has two dimensions, the first a string identifying the source of the message, and the optional second dimension, a string with the debug message itself.

• $MessagesFmt ['sourcename'] = $string; # concatenated lines
• $MessagesFmt ['sourcename'][] = $string; # multiple lines

Differences are:

• comma or space separated name parameters, with wildcards, can be supplied to select the groups of messages displayed
• only messages for specified name parameters are displayed
• name parameters are case insensitive
• directive does not have to start at the beginning of a line
• the output is placed within a HTML section of class=messages
• groups of messages are separated by a blank line
• groups of messages can be rolled up by using the details=show | hide parameter

Installation

• download messagesreplacement-2024-05-31.phpΔ
• copy to the /cookbook/ directory as messagesreplacement.php
• add to config.php the line
  include_once ($FarmD/cookbook/messagesreplacement.php);

Usage

Place the directive, as described below, in your PmWiki page.

The recipe provides a page variable {$MessagesReplacementVersion} which contains the current version, and page variable $@MessagesReplacement for a (:if enabled MessagesReplacement:) recipe installation check.

Configuration

(:messages optional,list of names with,wildcards* keys="names,with,*wildcards" details=hide :)

Parameters are optional and case-insensitive:

• names can include wild cards
• keys= a comma separated list of names
• details='show' or details = 'hide' provides a clickable name for each group of messages with initial value of show or hide

config.php settings

You can change the following in config.php. For example

Change log / Release notes

See also

• PITS:01368 add parameter to (:messages:) page directive
• PmWiki (:messages:) directive.
• $MessagesFmt

Contributors

Special thanks to Petko

Comments

See discussion at MessagesReplacement-Talk?