Skip to topic | Skip to bottom
... Mobius IST-15905

Start of topic | Skip to actions


Write links to javadoc classes

Syntax Rules

  • Write the command %JAVADOC{source:fullclassname}% anywhere in your topics. It will be replaced by a link to the javadoc page.
  • The source refers to a preference variable setting the URL to the javadoc root
  • You can ommit the source and write %JAVADOC{fullclassname}%, in this case a default source is used (see settings below)


You type... You should see... If installed...
%JAVADOC{L4J:org.apache.log4j.Logger}% Logger Logger
%JAVADOC{java.lang.String}% String String
%JAVADOC{IO:BufferedOutputStream}% BufferedOutputStream BufferedOutputStream

In the last example, the source contain the package, so you need only to write the class name.

JavaDocPlugin 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 = Write links to javadoc classes

  • 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 ZIP file from the Plugin web (see below)
  • Unzip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/JavaDocPlugin.txt Plugin topic
    data/TWiki/JavaDocPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/ Plugin Perl module
  • Test if the installation was successful:

Plugin Info

Plugin Author: TWiki:Main.LaurentBovet
Plugin Version: 04 Apr 2003 (V1.000)
Change History:  
04 Apr 2003: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Plugin Home:

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main.LaurentBovet - 04 Apr 2003

You are here: TWiki > JavaDocPlugin

to top

Ideas, requests, problems regarding the Mobius site QUESTION?