| IDLdoc: Embedded HTML code [message #81591] |
Tue, 02 October 2012 09:51  |
Yngvar Larsen
Messages: 134
Registered: January 2010
|
Senior Member |
|
|
A useful feature of IDLdoc when MARKUP_STYLE='verbatim', is that you may embed small snippets of HTML code directly in the text and it will show up correctly in the generated HTML output. For instance a small table. (Maybe this is considered cheating, and not really intended functionality ?) However, when using MARKUP_STYLE='rst', this trick does not work anymore. There are embedding options for graphics and links, but I cannot find anything about embedding HTML code.
Of course, I could stick with 'verbatim' for the files where I use this trick, but then I don't get the other nice features of the 'rst' style.
Any solutions? Have I misunderstood something here? If not, I would like to make the following feature request:
Add something like this to the rst markup style:
; docformat = 'rst'
;
;+
; Normal comment text.
;
; .. html::
;
; <table>
; <tr><th>Type</th><th>Format</th> </tr>
; <tr><td>type 1</td><td>format 1</td> </tr>
; <tr><td>type 2</td><td>format 2</td> </tr>
; </table>
;
; More normal comment text.
;-
--
Yngvar
|
|
|
|
| Re: IDLdoc: Embedded HTML code [message #81620 is a reply to message #81591] |
Fri, 05 October 2012 08:22  |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On 10/5/12 9:16 AM, David Fanning wrote:
> Michael Galloy writes:
>
>> Yes, eventually I hope to have rst markup support for all common
>> features like lists and tables. It already supports links, code (inline
>> and block), and headers.
>
> If you don't mind my asking, how much are you getting paid
> to do this? I've been thinking of renegotiating my contract. ;-)
Don't look to me for help negotiating; this work doesn't bring in much
money. (But I do accept PayPal donations at http://idldoc.idldev.com!)
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation
|
|
|
|
| Re: IDLdoc: Embedded HTML code [message #81621 is a reply to message #81591] |
Fri, 05 October 2012 08:16 |
David Fanning
Messages: 11724
Registered: August 2001
|
Senior Member |
|
|
Michael Galloy writes:
> Yes, eventually I hope to have rst markup support for all common
> features like lists and tables. It already supports links, code (inline
> and block), and headers.
If you don't mind my asking, how much are you getting paid
to do this? I've been thinking of renegotiating my contract. ;-)
Cheers,
David
--
David Fanning, Ph.D.
Fanning Software Consulting, Inc.
Coyote's Guide to IDL Programming: http://www.dfanning.com/
Sepore ma de ni thue. ("Perhaps thos speakest truth.")
|
|
|
|
| Re: IDLdoc: Embedded HTML code [message #81622 is a reply to message #81591] |
Fri, 05 October 2012 08:01 |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On 10/5/12 8:05 AM, Yngvar Larsen wrote:
> On Tuesday, 2 October 2012 19:32:49 UTC+2, Mike Galloy wrote:
>> On 10/2/12 10:51 AM, Yngvar Larsen wrote:
>>
>>> A useful feature of IDLdoc when MARKUP_STYLE='verbatim', is that you may embed small snippets of HTML code directly in the text and it will show up correctly in the generated HTML output. For instance a small table. (Maybe this is considered cheating, and not really intended functionality ?) However, when using MARKUP_STYLE='rst', this trick does not work anymore. There are embedding options for graphics and links, but I cannot find anything about embedding HTML code.
>
>> Yes, you are right the rst style does not allow HTML embedding, but the
>> other styles (IDL, IDLdoc, and verbatim) do.
>>
>> One workaround right now would be to use a separate docformat statement
>> for that single file, though that is not very satisfactory for the rest
>> of the comments.
>
> Yes, that is my problem here.
>
>>
>>
>>
>> Adding the html directive (and maybe latex as well) as a feature
>> request. They will only show up when using that output type.
>
> Another possibility is support for some simple markup like textile (http://textile.thresholdstate.com) and/or the Wiki formatting system used by trac.
>
Yes, eventually I hope to have rst markup support for all common
features like lists and tables. It already supports links, code (inline
and block), and headers.
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
