comp.lang.idl-pvwave archive: archive

Home » Public Forums » archive » IDLDoc + HTML

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

IDLDoc + HTML [message #84597]

Thu, 17 April 2014 19:32

Phillip Bitzer
Messages: 223
Registered: June 2006

Senior Member

Instead of digging up an old post:
https://groups.google.com/d/msg/comp.lang.idl-pvwave/bkyETBT ZTk4/U3enLDUF68sJ

I decided to start a new one.

Recently, I wanted the ability to embed a YouTube video in my IDL documentation, using the fabulous IDLDoc. YouTube provides some HTML embed code, which is nice. But since I nominally use HTML output, I can't put snippets of HTML code in the doc.

So, after an afternoon of chasing rabbits down holes, I was able to make it happen.

You can see an example that I created for testing here:

http://www.nsstc.uah.edu/ats/bitzer/idl/temp_idldoc.html

Pretty nifty, right?

Basically, I created a new "directive" called, well, html. I look for the opening character for an HTML tag ("<") and if I find it, takes the rest of the line and puts into the output.

(Oh, and it turns out I only needed to add something - very little, actually - in two routines. So, I'd like to claim I did all this work, but it was actually pretty straightforward. Most of my time was spent walking through the myriad of objects Mike uses. Whew!)

I haven't tested to see if this hack makes any sort of sense if you're not producing HTML output, so I haven't pushed the changes to Mike...yet.

Any one else have a use for this? I pretty hacked things into IDLDoc to make it happen, so it would need Mike's eyes before I release it into the wild

Report message to a moderator

Re: IDLDoc + HTML [message #88381 is a reply to message #84597]

Fri, 18 April 2014 02:42

Fabzi
Messages: 305
Registered: July 2010

Senior Member

On 18.04.2014 04:32, Phillip Bitzer wrote:
> Pretty nifty, right?

Haha, nice one!

To be honest, I can't really imagine when I'll have to put a youtube
video in my IDL doc but embedded stuffs could be useful!

Report message to a moderator

Re: IDLDoc + HTML [message #88386 is a reply to message #84597]

Fri, 18 April 2014 15:37

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

On 4/17/14, 8:32 pm, Phillip Bitzer wrote:

> I haven't tested to see if this hack makes any sort of sense if
> you're not producing HTML output, so I haven't pushed the changes to
> Mike...yet.
>
> Any one else have a use for this? I pretty hacked things into IDLDoc
> to make it happen, so it would need Mike's eyes before I release it
> into the wild.

That looks very useful! I would definitely be interesting in adding that
into the next release. Did you you fork IDLdoc on GitHub? That will make
a pull request easy to manage.

Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation

Report message to a moderator

Re: IDLDoc + HTML [message #88472 is a reply to message #88386]

Wed, 30 April 2014 18:07

Phillip Bitzer
Messages: 223
Registered: June 2006

Senior Member

On Friday, April 18, 2014 5:37:20 PM UTC-5, Mike Galloy wrote:

>
>
> That looks very useful! I would definitely be interesting in adding that
>
> into the next release. Did you you fork IDLdoc on GitHub? That will make
>
> a pull request easy to manage.
>
>
>
> Mike
>
> --

Done. Sent the pull request. I put the changes in a branch called html_directive.

(It necessitated a change in lib submodule, but I'm not sure that got sent too. Let me know if not.)

Report message to a moderator

Re: IDLDoc + HTML [message #88474 is a reply to message #88472]

Thu, 01 May 2014 02:16

kramers541
Messages: 3
Registered: April 2014

Junior Member

I realize this is off-topic, but... I was interested in trying out IDLdoc and cloned the Github repository. What I got was 30000+ files!

My IDLDE slowed down significantly after that.. probably because it was trying to keep track of that huge directory tree.

Is there a better way to download IDLdoc, without ending up with such a massive repo?

Report message to a moderator

Re: IDLDoc + HTML [message #88482 is a reply to message #88474]

Thu, 01 May 2014 12:15

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

On 5/1/14, 3:16 AM, superchromix wrote:
>
> I realize this is off-topic, but... I was interested in trying out
> IDLdoc and cloned the Github repository. What I got was 30000+
> files!
>
> My IDLDE slowed down significantly after that.. probably because it
> was trying to keep track of that huge directory tree.
>
> Is there a better way to download IDLdoc, without ending up with such
> a massive repo?
>
>

That's because of MathJax which allows LaTeX style mathematical notation
in comments. I don't have a way currently to download it without MathJax
support, but you can delete the src/resources/mathjax directory and I
think everything should work fine (without LaTeX support).

Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation

Report message to a moderator

Re: IDLDoc + HTML [message #88483 is a reply to message #88472]

Thu, 01 May 2014 12:18

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

On 4/30/14, 7:07 PM, Phillip Bitzer wrote:
> On Friday, April 18, 2014 5:37:20 PM UTC-5, Mike Galloy wrote:
>
>>
>>
>> That looks very useful! I would definitely be interesting in adding
>> that
>>
>> into the next release. Did you you fork IDLdoc on GitHub? That will
>> make
>>
>> a pull request easy to manage.
>>
>>
>>
>> Mike
>>
>> --
>
> Done. Sent the pull request. I put the changes in a branch called
> html_directive.
>
> (It necessitated a change in lib submodule, but I'm not sure that got
> sent too. Let me know if not.)

Thanks!

I will have to take a look at this about the change to lib, but don't
have a lot of time today. Will get back to you as soon as I can.

Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation

Report message to a moderator

Previous Topic:	Re: Error detected while calling MPFIT_FDJAC2
Next Topic:	Changing the symbol, color, etc., of "mean" indicator in box plots

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Wed Oct 08 11:44:22 PDT 2025

Total time taken to generate the page: 0.00621 seconds