comp.lang.idl-pvwave archive: archive

Home » Public Forums » archive » Re: IDLDOC question

Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend

Re: IDLDOC question [message #66973 is a reply to message #66971]

Mon, 29 June 2009 09:06

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

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

Report message to a moderator

[Message index]

		Re: IDLDOC question By: David Gell on Tue, 30 June 2009 05:36
		Re: IDLDOC question By: Michael Galloy on Mon, 29 June 2009 09:06
		Re: IDLDOC question By: Michael Galloy on Tue, 30 June 2009 11:25

Previous Topic:	Airlines
Next Topic:	In catalyst, how do I decide which object need to be destroyed by hand?

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Tue Dec 02 23:15:56 PST 2025

Total time taken to generate the page: 2.08665 seconds