Alias Plugin

http://twiki.org/cgi-bin/view/Plugins/AliasPlugin

This plugin allows you to create Aliases for already existing topis. It will be easier then to link to a topic because you don't have to write the full path.

If you write down a WikiWord which is registered as an alias, it will then act as a link to the topic it is assigned to.

Non WikiWord may optionally be used as alias.

An alias must be prefixed by one of:

• A white space character
• One of: - = * # & , ; . : / ( ) ] { } + _ >

Note especially, an alias can not be prefixed by: <[

Configuration of this plugin is done by writing your aliases and the topic they should point to in the configuration table on this page. Note, that you have to to specify the full 'path' to the existing topic for making the aliases work correctly in all Webs.

If you want to prevent an alias to become a link you can use the <nop> tag

Examples

• Just type 'MySelf' and it will become a link to 'Main.MyFullUsername' if defined as an alias

AliasPlugin Global Settings

• Set SHORTDESCRIPTION = Define aliases which will automatically extend to valid wiki links

• Debug:
  See output in data/debug.txt
  0 ~ No debug
  1 ~ Normal debug
  2 ~ Detailed debug
  • Set DEBUG = 2

• Allow non TWiki words to become links
  • Set ACCEPT_NON_TWIKI_WORD_ALIASES = 1

• Put your global aliases in this table:

  the alias	the topic it points to
  CGA	CgA
  CLIC	ProgramaCLIC
  Maese	JoseLuisSanchez
  PHProjekt	PhProjekt
  RUCIO	ServidorRUCIO
  SQUEAK	ProgramaSqueak
  WebMaster?	RicardoDeLosSantos

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip AliasPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/AliasPlugin.txt	Plugin topic
  lib/TWiki/Plugins/AliasPlugin.pm	Plugin Perl module

• Test if the installation was successful:
  • AlPlug^? should be a link to TWiki.AliasPlugin
  • If you set the variable ACCEPT_NON_TWIKI_WORD_ALIASES on this page, then MRX should also be a link to TWiki.AliasPlugin
• Developers test:
  • -MRX MRX MRX #MRX&MRX,MRX×MRX.MRX:MRX/MRX(MRX)MRX{MRX}MRX+MRX_MRXMRX[MRX]

Known Bugs

• For some reason I cannot get alias expanded if prefixed by '+'
  -- TWiki:Main.NielsKoldso - 30 Nov 2003

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/OthelloMaurer - 09 Oct 2003
arriba