Home »
Public Forums »
archive »
Re: user defined idl_catalog.xml
| Re: user defined idl_catalog.xml [message #50247] |
Sat, 23 September 2006 07:32  |
sebinjapan
Messages: 14
Registered: June 2004
|
Junior Member |
|
|
thank you for your quick response,
Yes I provide my source code so I could add something like
;; %%%HTML-HELP%%% /path/to/html/help/file.html
but I agree with mike
- that's not so convenient when file location change
- idldoc provides great html files with anchors for each keywords etc...
that could not be used efficiently.
idldoc does a wonderful job and builds all the necessary files for the
idl_assistant: the adp file, home.html and of course one html file for
each .pro file.
The nicest part is that once you have the idldoc-lib.adp file you can
merge it with idl.adp file provided with IDL (you just have to take some
care of the file headers, specify the full paths of the links in both adp
files and change you !help_path). In that way, you get in one unique
online_help documentation of IDL and your own files which is great because
users do not know at first glance if a program is coming from IDL or from
the package you provided.
I made some screenshots to give you a quick overview of what I am talking
about:
- the home page of my merged online_help (my package is called SAXO)
http://forge.ipsl.jussieu.fr/saxo/download/xmldoc/figpng/onl ine_help_home.png
- the result of IDL> ?monthname (see that monthname is listed within IDL
documentation files)
http://forge.ipsl.jussieu.fr/saxo/download/xmldoc/figpng/onl ine_help_index.png
- the result of a seach of contour (see that idl_assistant found
occurrences in both IDL and my own files)
http://forge.ipsl.jussieu.fr/saxo/download/xmldoc/figng/onli ne_help_search.png
- browse additional html documentation files (created by hand to give a
full review of a specific routine)
http://forge.ipsl.jussieu.fr/saxo/download/xmldoc/figpng/onl ine_help_doc.png
With this additional details, I guess you understand why I would be so
happy to be able to load my own html files from IDLWAVE.
The question is now how could we push ITTVIS to release IDLdoc as an open
source project?
sebastien
|
|
|
|
Current Time: Fri Oct 10 20:56:45 PDT 2025
Total time taken to generate the page: 0.42338 seconds
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
