|
...discover TWiki details, and how to start your own site.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AliasPluginDescriptionThis plugin allows you to create arbitrary word aliases. If you write down a word that has a defined alias, it will then be replaced with the given text string. If that string is a string of the format<web>.<topic>
it will be replaced by an appropriate TWiki link. Aliases take only effect within the boundaries
if alias areas between %STARTALIASAREA% and %STOPALIASAREA% tags.
Aliases aren't replaced within html tags (<html tag ... TESTALIAS ... >), TWiki tags (%INCLUDE... TESTALIAS ...%) and TWiki links
([[TWiki.WebHome][TESTALIAS]]). A word can be prevented of being substituted by
prefixing it with <nop>.
ConfigurationConfiguration of this plugin is done by writing your aliases into a specific topic which defaults to the topic defined by theDEFAULT_ALIASES variable (see below). This topic is looked up
in the current web. If it does not exist in the current web, the plugin will fallback to
the DEFAULT_ALIASES in the TWiki.
Aliases defined in DEFAULT_ALIASES will be
used within the current web.
Aliases can be defined temporarily also, that is
they will only be taking effect within the current topic. Similarly, aliases can be
disabled. See the Syntax section for more details.
SyntaxThis is the list of TWiki tags defined by this plugin.
regex parameter in the %ALIAS{...}% tag might contain the two variables
$start and $stop that help to match the boundaries of an alias consisting of
non-alphabetic characters. Textile example:
%ALIAS{name="''" regex="$start''$stop" value="”"}%
%ALIAS{name="``" regex="$start``$stop" value="“"}%
%ALIAS{name="-" regex=" - " value=" – "}%
%ALIAS{name="--" regex=" -- " value=" — "}%
%ALIAS{name="(c)" regex="$start\(c\)$stop" value="©"}%
%ALIAS{name="(r)" regex="$start\(r\)$stop" value="®"}%
%ALIAS{name="(tm)" regex="$start\(tm\)$stop" value="™"}%
%ALIAS{name="..." regex="$start\.\.\.$stop" value="…"}%
%ALIAS{name=",," regex="$start,,$stop" value="„"}%
%ALIAS{name="1/2" regex="$start1/2$stop" value="½"}%
%ALIAS{name="1/4" regex="$start1/4$stop" value="¼"}%
%ALIAS{name="3/4" regex="$start3/4$stop" value="¾"}%
The aliases in the topic DEFAULT_ALIASES can be either defined using the %ALIAS{}%
macro or listed in the following way:
* <name1>: <value1> * <name2>: <value2> * <name3>: <value3> ... Plugin Settings
Defined Aliases
Plugin Installation Instructions
if( $viewRaw ) {
$text = &TWiki::Store::readTopicRaw( $webName, $topic );
} else {
( $meta, $text ) = &TWiki::Store::readTopic( $webName, $topic );
+ $text = "%STARTALIASAREA% $text %STOPALIASAREA%"; }
Test-Cases
Plugin Info
-- TWiki:Main/MichaelDaum - 10 Feb 2006 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Copyright © 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.AliasPlugin