| Re: IDLdoc: Embedded HTML code [message #81588] |
Tue, 02 October 2012 10:32  |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
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.
>
> 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.
> ;-
>
>
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.
Adding the html directive (and maybe latex as well) as a feature
request. They will only show up when using that output type.
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 #81625 is a reply to message #81588] |
Fri, 05 October 2012 07:05  |
Yngvar Larsen
Messages: 134
Registered: January 2010
|
Senior Member |
|
|
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.
--
Yngvar
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
