This is a first comment.
-- Michael Daum on 22 Aug 2005
Powered by WikiRing Consultants |
%SUBST{topic="..." ...}%
insert a topic by processing its content.
topic="..."
: name of the topic text to be processed
text="..."
: text to be processed (has got higher precedence than 'topic')
pattern="..."
: pattern to be extracted or substituted
format="..."
: format expression or pattern substitute
header="..."
: header string prepended to output
footer="..."
: footer string appended to output
limit="<n>"
maximum number of occurences to extract or substitute counted from the start of the text (defaults to 100000
aka all hits)
skip="<n>"
skip the first n occurences
exclude="..."
: skip occurences that match this regular expression
expand="on,off"
: toggle expansion of markup before filtering (defaults to on
)
%STARTSUBST{...}% ... %STOPSUBST%substitute text given inline. see SUBST.
%EXTRACT{topic="..." ...}%
extract text from a topic. see SUBST.
%STARTEXTRACT{...}% ... %STOPEXTRACT%extract content given inline. see SUBST.
%FORMATLIST{"<list>" ...}%
formats a list of items. The <list> argument is separated into items by using
a split expression; each item is matched agains a pattern and then formatted
using a format string while being separated by a separator string; the result is
prepended with a header and appended with a footer in case the list is not empty. $marker
is inserted
selection
regex matches; this will be inserted at the position $marker
as indicated in format
.
format
, header
, footer
) may
contain variables $percnt$
, $nop
, $dollar
and $n
. The variable
$index
referse to the position number within the list being formatted; using $count
in the
footer or header argument refers to the total number of list elements; $marker
is set if
the selection
regular expression matches the current item.
%MAKEINDEX{"<list>" ...}%
formats a list into a multi-column index like in MediaWiki's category topcis.
MAKEINDEX insert capitals as headlines to groups of sorted items. It will try to balance all
columns equally, and keep track of breaks to prevent "schusterkinder", that is avoid
isolated headlines at the bottom of a column.
parameters: format
parameter can make use of $1
, $2
, ... variables
to match the groupings defined in the pattern
argument (like in pattern="(.*);(.*);(.*)"
) .
The first matched grouping $1 will be used as the $item to sort the list.
In addition header
and footer
might contain the $anchors
variable which will expand
to a navigation to jump to the groups within the index.
Date | Author | Headline |
---|---|---|
22 Aug 2005 | Michael Daum | This is a first comment. ... |
22 Aug 2005 | Michael Daum | This is a second comment. ... |
configure
, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.
Plugin Author: | Michael Daum |
Copyright ©: | 2005-2009, Michael Daum http://michaeldaumconsulting.com |
License: | GPL (GNU General Public License) |
Plugin Version: | v1.80 |
Change History: | |
17 Apr 2009: | converted to foswiki, added numerical sorting to MAKETEXT |
08 Oct 2008: | added $anchors to MAKEINDEX (by Dirk Zimoch); added nocase option to FORMATLIST (by Dirk Zimoch); fixed null/empty string match in FORMATLIST |
20 Aug 2008: | added selection and marker to FORMATLIST, similar in use as VarWEBLIST |
03 Jul 2008: | sorting a list before, not after, formatting it in FORMATLIST |
08 May 2008: | added 'text' parameter to SUBST and EXTRACT; fixed SUBST as it was pretty useless before |
07 Dec 2007: | added MAKEINDEX, added lazy compilation |
14 Sep 2007: | added sorting for EXTRACT and SUBST |
02 May 2007: | using registerTagHandler() as far as possible; enhanced parameters to EXCTRACT and SUBST |
05 Feb 2007: | fixed escapes in format strings; added better default value for max number of hits to prevent deep recursions on bad regexpressions |
22 Jan 2007: | fixed SUBST, added skip parameter to FORMATLIST |
18 Dec 2006: | using registerTagHandler for FORMATLIST |
13 Oct 2006: | fixed limit parameter in FORMATLIST |
31 Aug 2006: | added NO_PREFS_IN_TOPIC |
15 Aug 2006: | added use strict; and fixed revealed errors |
14 Feb 2006: | moved in FORMATLIST from the Foswiki:Extensions/NatSkinPlugin; added escape variables to format strings |
06 Dec 2005: | fixed SUBST not to cut off the rest of the text |
09 Nov 2005: | fixed deep recursion using expand="on" |
22 Aug 2005: | Initial version; added expand toggle |
Dependency: | $Foswiki::Plugins::VERSION 1.024 |
CPAN Dependencies: | none |
Other Dependencies: | none |
Perl Version: | 5.005 |
Plugin Home: | Foswiki:Extensions/FilterPlugin |
Support: | Foswiki:Support/FilterPlugin |