JavaDocPlugin

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)

Examples

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

• javadoc sources
  • Set DEFAULT = http://java.sun.com/j2se/1.4.1/docs/api/
  • Set L4J = http://jakarta.apache.org/log4j/docs/api/
  • Set IO = http://java.sun.com/j2se/1.4.1/docs/api/java/io/
  • Set GRIM = http://www.ecs.soton.ac.uk/~lavm/projects/Grimoires/javadoc/

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 JavaDocPlugin.zip 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/JavaDocPlugin.pm	Plugin Perl module

• Test if the installation was successful:
  • %JAVADOC{java.lang.String}%

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main.LaurentBovet - 04 Apr 2003
to top