Protocol TLA Plugin

THIS PLUGIN IS BETA/DEMO QUALITY ONLY. See TWiki:Plugins.ProtocolTlaPluginDev for known issues & limitations. -- JonathanCline - 28 Aug 2003

There are many TLA's in the world (Three Letter Acronyms), especially in the network protocol world, which is full of RFC's (Request For Comments), STD's (Standards Documents), and SIG's (Special Interest Groups). It's a part time job just keeping up with new protocols these days.

This plugin automatically cross-links the following in wiki text:

• A variety of IETF network acronyms (not just three-letter) link to RFC's and an automagically-generated RFC summary
• IETF RFC (Request For Comments) documents to the IETF site.

So the next time the dude across the table says, "They're asking for delivery of H.462 and SCTP interoperability with an H.248 gateway, including IPSec and IP-QOS" you can discreetly surf over to your twiki intranet and figure out what he just said.

This is a code-generating package, and the plugin uses the generated code. The generated code is based on pre-fetched data and is done off-line (on a periodic basis, i.e. weekly at midnight). Only the Plugin itself is attached here.  The code generator is not included, yet.

Syntax Rules

• Type acronyms with a comma in front. No other special markup required.
  • This format will change in the future.

• Currently, acronyms generate form-based links.
  • This format will change in the future.

Warnings

• This plugin is huge because it parses so much data. Currently it consists of 300+kB of Perl.

Examples

ProtocolTlaPlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Creates links to specific network protocol acronyms for standards bodies; provides a "dictionary lookup" and hyperlinking for acronyms and standards bodies' document numbers

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

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 .PM file from TWiki:Plugins/ProtocolTlaPlugin (see below).
• "Edit" this topic and copy & paste the wiki text into your own site.
• Copy the files into your twiki installation directory. Content:

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

• Test if the installation was successful:
  • Currently active plugins are: SpreadSheetPlugin, AutoSectionsPlugin, BackupRestorePlugin, BlackListPlugin, CalendarPlugin, ChartPlugin, ColorPickerPlugin, CommentPlugin, DatePickerPlugin, EditTablePlugin, GaugePlugin, GeoLookupPlugin, HeadlinesPlugin, IfThenActionPlugin, InterwikiPlugin, JQueryPlugin, LocalCityTimePlugin, PercentCompletePlugin, PerlDocPlugin, PreferencesPlugin, QRCodePlugin, RecentVisitorPlugin, RenderListPlugin, SetGetPlugin, ShareMePlugin, SlideShowPlugin, SmiliesPlugin, SyntaxHighlightingPlugin, TWikiDrawPlugin, TWikiOrgPlugin, TWikiSheetPlugin, TablePlugin, TagMePlugin, TinyMCEPlugin, TwistyPlugin, VarCachePlugin, WatchlistPlugin, WysiwygPlugin
  • The following should display some markup:
    • ,NTP ,IPv6

Plugin Info

Plugin Author:	TWiki:Main/JonathanCline
Plugin Version:	21 Jun 2003 (V1.000)
Change History:
21 Jun 2003:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/ProtocolTlaPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/ProtocolTlaPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/JonathanCline - 21 Jun 2003