Tags:
create new tag
, view all tags

Question

I like to use Twiki for adding documentation to a C++ library which has the class documentation generated by Doxygen. Each C++ class mentioned in the Twiki Topics i like to link to that documentation automatically. I already can do this from docbook documentation, but Twiki documentation i like to achieve the same.

The question: is it possible to couple a special variable (e.g CLASSNAME), having the classname as value, to a unix script on the server? The script will be used to translate the variable+value into the right URL to reach the class documentation, when viewing/displaying the topic.

So something like a hook to a script when the topic renderer is generating the HTML from the raw topics text. Or is something like this only possible by writing a plugin, which i don't know how to yet.

Any ideas welcome.

Environment

TWiki version: TWikiRelease04x00x05
TWiki plugins: DefaultPlugin, EmptyPlugin, InterwikiPlugin
Server OS:  
Web server:  
Perl version:  
Client OS:  
Web Browser:  
Categories: Plugins, Add-Ons

-- KlaasHolwerda - 09 Dec 2006

Answer

ALERT! If you answer a question - or have a question you asked answered by someone - please remember to edit the page and set the status to answered. The status is in a drop-down list below the edit box.

Not sure I understand your question properly, but a new InterwikiPlugin link rule might be all you need.

You can also define a preferences value in WebPreferences, such as CLASSROOT, and use it for example as %CLASSROOT%/Bicycles.cpp

-- PeterThoeny - 10 Dec 2006

Like in docbook this: <classname role="lnk">a2dPropObject</classname>

Is translated using TSL ( transforming style sheets ) into:

http://wxart2d.sourceforge.net/docs/docbook_html/classa2dPropObject.html

The first part is constant, next the value of the tag is added, and at last .html.

And from what i see InterwikiPlugin can do the job, perfect, by translating/substituting the $page being the classname into the fixed Url.

-- KlaasHolwerda - 11 Dec 2006

The DoxygenPlugin is the real answer to this question.

-- KlaasHolwerda - 07 Mar 2007

 
Change status to:
Topic revision: r5 - 2007-03-08 - PeterThoeny
 
Twitter Delicious Facebook Digg Google Bookmarks E-mail LinkedIn Reddit StumbleUpon    
  • Download TWiki
TWiki logo Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2012 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.