Menu

#31 Dynamic help link to keyword documentation

colorer-take5
open
General (12)
5
2007-04-06
2007-04-06
No

This is probably a new feature request. I would like to be able to link to documentation for keywords. eg in cpp.hrc:

<word name="catch" hovertext="Catch an exception" doclink="http://www.cplusplus.com/doc/tutorial/exceptions.html" />

So we could add some simple hovertext, which would appear if we hover the mouse over the keyword, plus a url link to some documentation.

Any chance of that? Anyone know of previous attempts to do this? Anyone else interested?

----------------

Regarding your first question, the 'doclink' functionality indeed exist, but only in "HTML Generator" component of the colorer.

You can even try it with EclipseColorer — on HTMLGenerator screen, field "DocLink source".

The source file looks like this:

<?xml version="1.0"?>
<!DOCTYPE catalog PUBLIC "-//Cail Lomecb//DTD Colorer DOCLINKS take5//EN"
"http://colorer.sf.net/2003/doclinks.dtd">

<doclinks xmlns="http://colorer.sf.net/2003/doclinks"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://colorer.sf.net/2003/doclinks
http://colorer.sf.net/2003/doclinks.xsd">

<links url='http://java.sun.com/j2se/1.3/docs/api/' scheme="java:TypeDeclaration">
<link token="Enumeration" url="java/lang/Enumeration.html"/>
<link token="String" url="java/lang/String.html"/>
<link token="StringBuffer" url="java/lang/StringBuffer.html"/>
<link token="System" url="java/lang/System.html"/>
</links>

</doclinks>

The Idea to propagate it to the editor is good, however believe it should be implemented more deeply. Just having a hoverlink to the doc is useless (at least for me), since during the coding user wants to see a real help popup. Possibly dynamic link's content retrieval could help here. I'll think on this.

Discussion


Log in to post a comment.