#197 external documentation topic prefixes and suffixes

[Patko]

Links to topics in external documentation are at
present generated the same for all topics, that is
"ndoc" prefix + typeid + "ClassTopic" + hash. If
linking to some other help, for instance Developer
Express, this does not work. Solution is to remove all
prefixes, hashcode and "Class" suffix.
So it would be very nice to have some kind of mapping
(as for namespaces) where one could specify mapping
between namespace and what kind of prefix/suffix to use
for that namespace. Example:

<topicNamespace prefix="" useHash=false suffix="topic">
<managedNamespace ns="DevExpress" />
</topicNamespace>

[Stefan Baebler]

Logged In: YES
user_id=200724

similar to javadoc's link parameter:

eg:
http://fisheye.makumba.org/viewrep/makumba/makumba/build.xml?r=2.37#l269

contains
<link href="http://java.sun.com/j2se/1.4.2/docs/api/"/>
<link href="http://java.sun.com/products/servlet/2.2/javadoc/"/>
<link href="http://junit.sourceforge.net/javadoc/"/>

This makes the generated documentation link there (the API
documentation at these location contains a list of all
available classes which are analyzed prior to generating any
new documentation), resulting in properly linked API docs:
http://www.makumba.org/hacking/javadoc/org/makumba/view/jsptaglib/TomcatJsp.html

That would be ideal, but patko's suggestion overcomes the
possibly lack of list of documented classes at locations to
link to.

[Stefan Baebler]

Logged In: YES
user_id=200724

More flexible design draft seems to be something in the lines
of mapping filename patterns to various namespaces:

The ndoc'd default mapping
<FileMapping namespace="" pattern="ndoc{typeID}
ClassTopic{hash}">
would be altered for certain namespaces, eg DevExpress in
patko's case:
<FileMapping namespace="DevExpress" pattern="{typeID}
topic">

Additionally this would also allow defining other patterns for
other namespaces, but provide ndoc's default mapping for
backwards compatibility.

Anybody dares to give it a try?

[Stefan Baebler]

Logged In: YES
user_id=200724

Any idea how MS is composing their documentation?
eg:
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemwebhttpapplicationclassbeginrequesttopic.asp
has a rather weird prefix "frlrf" to the more understandable
"systemwebhttpapplicationclassbeginrequesttopic".

Does "frlrf" mean anything, so that it can be computed?