Skip to topic
|
Skip to bottom
IST-15905
Mobius
Home
Summary
Partners
Work Packages
End User Panel
Scientific Advisory Board
Publications
Deliverables List
Links to Related Projects
Events
News
Visitors: 102
Intranet
Scientific Issues
Scientific Exchanges
Dissemination & Publication
Scientific Deliverables
Tool Development
Inria GForge
Project Management
Calendar
Contractual Documents
Reporting Activity
Project Status
Meetings
Kick-Off Meeting
Annual Meeting
Website information
Admin
MobiusLogo
EmailLists
Help
Tools
Search
Changes
Help Home
Sandbox
Trash
TWiki Home
Start of topic |
Skip to actions
---+ <nop>%TOPIC% Write links to javadoc classes ---++ Syntax Rules * Write the command =%<nop>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 =%<nop>JAVADOC{fullclassname}%=, in this case a default source is used (see settings below) ---++ Examples | *You type...* | *You should see...* | *If installed...*| | =%<nop>JAVADOC{L4J:org.apache.log4j.Logger}%= |<A HREF="http://jakarta.apache.org/log4j/docs/api/org/apache/log4j/Logger.html">Logger</A>| %JAVADOC{L4J:org.apache.log4j.Logger}%| | =%<nop>JAVADOC{java.lang.String}%= |<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> | %JAVADOC{java.lang.String}%| | =%<nop>JAVADOC{IO:BufferedOutputStream}%= |<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/io/BufferedOutputStream.html">BufferedOutputStream</A>| %JAVADOC{IO:BufferedOutputStream}%| In the last example, the source contain the package, so you need only to write the class name. ---++ <nop>%TOPIC% Global Settings Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop><plugin>_<setting>%==, i.e. ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%== * One line description, is shown in the %TWIKIWEB%.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/ ---++ 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 ==%TOPIC%.zip== in your twiki installation directory. Content: | *File:* | *Description:* | | ==data/TWiki/%TOPIC%.txt== | Plugin topic | | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository | | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module | * Test if the installation was successful: * %JAVADOC{java.lang.String}% ---++ Plugin Info | Plugin Author: | TWiki:Main.LaurentBovet | | Plugin Version: | 04 Apr 2003 (V1.000) | | Change History: | <!-- versions below in reverse order --> | | 04 Apr 2003: | Initial version | | CPAN Dependencies: | none | | Other Dependencies: | none | | Perl Version: | 5.005 | | Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% | | Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | __Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins -- TWiki:Main.LaurentBovet - 04 Apr 2003
End of topic
Skip to action links
|
Back to top
r1.1 :
Edit
|
Attach image or document
|
Printable version
|
Raw text
|
Page history
|
More actions
You are here:
TWiki
>
JavaDocPlugin
to top
Ideas, requests, problems regarding the Mobius site