Tags:
development1Add my vote for this tag documentation1Add my vote for this tag create new tag
, view all tags

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 omit the source and write %JAVADOC{fullclassname}%, in this case a default source is used (see settings below)

Examples

You type... You should see... If installed...
%JAVADOC{L4J:org.apache.log4j.Logger}% Logger %JAVADOC{L4J:org.apache.log4j.Logger}%
%JAVADOC{java.lang.String}% String %JAVADOC{java.lang.String}%
%JAVADOC{IO:BufferedOutputStream}% BufferedOutputStream %JAVADOC{IO: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 repository on twiki.org (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
  • Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • Test if the installation was successful:
    • %JAVADOC{java.lang.String}%

Plugin Info

Plugin Author: TWiki:Main.LaurentBovet
Copyright: © 2003 TWiki:Main.LaurentBovet
© 2006-2010 TWiki:TWiki.TWikiContributor
Plugin Version: 2010-12-11 (V1.1)
Change History:  
2010-12-11: TWikibug:Item6530: Doc improvements, changing TWIKIWEB to SYSTEMWEB
04 Apr 2003: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/JavaDocPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/JavaDocPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

Topic attachments
I Attachment History Action Size Date Who Comment
Unknown file formatmd5 JavaDocPlugin.md5 r3 r2 r1 manage 0.2 K 2010-12-12 - 05:17 PeterThoeny  
Compressed Zip archivetgz JavaDocPlugin.tgz r4 r3 r2 r1 manage 4.4 K 2010-12-12 - 05:17 PeterThoeny  
Compressed Zip archivezip JavaDocPlugin.zip r5 r4 r3 r2 r1 manage 5.7 K 2010-12-12 - 05:17 PeterThoeny  
Unknown file formatEXT JavaDocPlugin_installer r1 manage 3.4 K 2010-12-12 - 05:17 PeterThoeny  
Edit | Attach | Watch | Print version | History: r10 < r9 < r8 < r7 < r6 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r10 - 2013-10-16 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2015 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.