| Re: IDLDOC question [message #66971] |
Tue, 30 June 2009 05:36  |
David Gell
Messages: 29
Registered: January 2009
|
Junior Member |
|
|
On Jun 29, 11:06 am, mgalloy <mgal...@gmail.com> wrote:
> David Gell wrote:
>> I'm starting to seriously use IDLDOC. In several program headers I
>> have text that I want to appear in the IDLDOC page exactly as it
>> appears in the header. For example, I have a illustration of a
>> directory tree that I wan to include:
>
>> ; path/specified/by/path +---- 2003 +---
>> 2003_180_L1A_00_00_00_1.CSV
>> ; | +---
>> 2003_180_L1A_01_00_00_1.CSV
>> ; | +---
>> 2003_181_L1A_01_00_00_1.CSV
>> ; | +---
>> 2003_181_L1A_01_00_00_1.CSV
>> ; +---- 2004 +---
>> 2004_180_L1A_00_00_00_1.CSV
>> ; | +---
>> 2004_182_L1A_01_00_00_1.CSV
>> ; | +---
>> 2004_183_L1A_01_00_00_1.CSV
>> ; | +---
>> 2004_184_L1A_01_00_00_1.CSV
>> ; +---- 2005
>
>> How do I induce IDLDOC to not remove all the blank space before the
>> start of each line of text?
>
>> And thanks Michael Galloy for a terrific tool
>
> Set your markup style to 'rst' and use something like below:
>
> ;+
> ; Some normal text comments here. Now, I want to include some verbatim
> ; text::
> ;
> ; IDL> my_routine
> ; output from my_routine
> ;-
>
> To set the markup style to rst, either 1) set MARKUP_STYLE='rst' to
> globally change the style for all pages in a doc set or 2) use one of:
>
> ; docformat = 'rst'
> ; docformat = 'idldoc rst'
> ; docformat = 'idl rst'
>
> as the FIRST line of your .pro file. These lines also set the format
> style, so choose the appropriate line for the format style you are using
> (rst, idldoc, or idl).
>
> Mike
> --www.michaelgalloy.com
> Associate Research Scientist
> Tech-X Corporation
Mike,
I thought that is what I've done. The command I use to run IDLDOC is
idldoc,root='/Users/dgell/IDL_Projects/Analysis-redocument/t runk/
pro', $
output='/Users/dgell/IDL_Projects/Analysis-redocument/trunk/ docs',
$
/nosource, /quiet, /embed, $
format='rst',markup='rst',index=1,title='INMS Analysis Library'
The portion of the program header is
; doydir : in, optional, type=boolean
; Keyword arguments that control the search for files
within
; the specified timerange. If neither are present,
; files for the specified time range are to be found
in the directory
; directory specified by the path keyword. If yeardir
is
; present the files are organized in subdirectories
by year
; within the directory specified by the path keyword
argument.
; If doydir is present the files are orgainized by
; year and day-of-year subdirectories within the
specified directory.::
;
; if neither doydir nor yeardir is present the
following structure
; is assumed
;
; path/specified/by/pathKeyword -+---
2003_180_L1A_00_00_00_1.CSV
; +---
2003_181_L1A_00_00_00_1.CSV
; +---
2004_181_L1A_00_00_00_1.CSV
; +---
2004_182_L1A_00_00_00_1.CSV
Since I can't seem to attach the resulting html, I'll email it to you.
Thanks for the help.
Dave
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
