|
|
|
|
| Re: IDLDoc questions: [message #78889 is a reply to message #78881] |
Tue, 03 January 2012 12:58   |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On 1/2/12 2:10 PM, wlandsman wrote:
>
> I have a couple questions about the use of IDLDoc:
>
> 1. The SEARCH button does not appear to ever find anything, at least not in my tests or in public examples of IDLDoc output
>
> http://www.idlcoyote.com/idldoc/cg/index.html
> http://docs.idldev.com/idllib/
>
> Is SEARCH not yet implemented yet, or am I not doing something correctly?
>
> 2. My current documentation has section titles made up on a adhoc basis for particular programs. One program might have a section titled "Comparison with other algorithms", and another might have "Speed tests" or "Error Handling" or "Program Limitations". The IDLDoc format has a limited number of categories, which would be OK if there were someplace I could put these miscellaneous notes. There is the :description: category but that is at the top of the documentation, and I'd rather place these less important notes at the end.
>
> Thanks, --Wayne
1. Search in the latest version (not sure how far it goes back) appears
to be broken. I will look into it.
2. While you can't currently make user-defined fields (it's a feature
request), you can make section heading in the main description if using
rst markup. For an example, see:
http://docs.idldev.com/idllib/animation/animation_example.ht ml
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL, A Guide to Learning IDL: http://modernidl.idldev.com
Research Mathematician
Tech-X Corporation
|
|
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
