| Equations and URL links in idldoc [message #82152] |
Thu, 22 November 2012 03:54  |
Mats Löfdahl
Messages: 263
Registered: January 2012
|
Senior Member |
|
|
Hi,
Just starting to use idldoc. Very useful! I really like that I can use TeX equations in the documentation when I use the rst format.
Two questions, though:
Is it (or will it be) possible to get numbered displayed equations? $$...$$ doesn't make equation numbers. Neither does \begin{equation}...\end{equation}. At least not when I try them. I realize this is more work to implement because then you can't treat each equation separately anymore. So almost as good would be to implement \hfill (doesn't seem to be at the moment), because then I could do something like $$\hfill a=b+c \hfill (1)$$ and keep track of my own numbering. Or if I could specify that I want left flushed equations, so I could do something like $$(1)\ \ \ \ a=b+c$$
Is there a way to specify a URL so idldoc makes a link? I tried <A href="http://foo.bar">Link text</A> but that was displayed verbatim.
|
|
|
|
| Re: Equations and URL links in idldoc [message #82296 is a reply to message #82152] |
Thu, 22 November 2012 07:46  |
Mats Löfdahl
Messages: 263
Registered: January 2012
|
Senior Member |
|
|
Den torsdagen den 22:e november 2012 kl. 16:25:20 UTC+1 skrev Mike Galloy:
> It appears that numbered equations are available in MathJax 2.0:
>
> http://docs.mathjax.org/en/latest/tex.html
>
> I have a ticket for updating to MathJax 2.0 for the next release:
>
> https://github.com/mgalloy/idldoc/issues/68
>
> That said, I'm not sure how the numbering would be integrated into
> IDLdoc since it is a option in the MathJax configuration file. If you
> have thoughts, please add comments to the GitHub issue.
My thoughts at the moment are only that this would be useful. And maybe it could be turned on with an optional argument to the idldoc command.
Cheers and thanks for making idldoc!
/Mats
|
|
|
|
| Re: Equations and URL links in idldoc [message #82298 is a reply to message #82152] |
Thu, 22 November 2012 07:25 |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On 11/22/12 4:54 AM, Mats L�fdahl wrote:
> Hi,
>
> Just starting to use idldoc. Very useful! I really like that I can use TeX equations in the documentation when I use the rst format.
>
> Two questions, though:
>
> Is it (or will it be) possible to get numbered displayed equations? $$...$$ doesn't make equation numbers. Neither does \begin{equation}...\end{equation}. At least not when I try them. I realize this is more work to implement because then you can't treat each equation separately anymore. So almost as good would be to implement \hfill (doesn't seem to be at the moment), because then I could do something like $$\hfill a=b+c \hfill (1)$$ and keep track of my own numbering. Or if I could specify that I want left flushed equations, so I could do something like $$(1)\ \ \ \ a=b+c$$
>
> Is there a way to specify a URL so idldoc makes a link? I tried <A href="http://foo.bar">Link text</A> but that was displayed verbatim.
>
It appears that numbered equations are available in MathJax 2.0:
http://docs.mathjax.org/en/latest/tex.html
I have a ticket for updating to MathJax 2.0 for the next release:
https://github.com/mgalloy/idldoc/issues/68
That said, I'm not sure how the numbering would be integrated into
IDLdoc since it is a option in the MathJax configuration file. If you
have thoughts, please add comments to the GitHub issue.
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
