docutils-users — General discussions, questions, help requests.

Re: [Docutils-users] Good ReStructuredText editors

[Kevin H. <kev...@gm...>]

I really like SublimeText with the SublimeRstCompletion plugin:
https://github.com/mgaitan/sublime-rst-completion

The plugin has various completion functions, but also provides header
folding, header navigation, etc.

On Sun, Dec 14, 2014 at 7:18 AM, Peter Funk <pf...@ar...> wrote:

> Virgil Arrington schrieb am Freitag, den 12.12.2014 um 13:03:
> > On 12/12/2014 10:15 AM, Peter Funk wrote:
> > > I've hesitated to respond because I'm one of those greybeards using
> > > VIM and therefore don't know much about Gedit and never tried the
> > > reStructuredText plugin for it: http://kib2.alwaysdata.net/GEdit/
> >
> > I've downloaded both VIM and Emacs, and I must say they both look
> > impressive in their respective feature sets, and their users seem
> > fiercely loyal. But, in both cases, as soon as I try to start using
> > them, the learning curve hits me in the face. They are sooooo different
> > from anything else I've ever used. I'd really like to learn them (or one
> > of them), but right now, it's a little like tackling Greek.
>
> I remember well: In 1983 or 1984 when I had to learn 'vi'
> because it was the only visual editor available for Unix
> in our University at that time I had similar feelings. ☺
> Fortunately times have changed a lot since.
>
> Did you know that both VIM and Emacs today also come with
> a decent graphical user interface which can help you a lot as
> training wheels on your first steps?
>
> Since you mentioned gedit I assume you are using some flavor of Linux.
> On several Linux distributions you have to install one or
> more additional software packages to get the GUI command gvim:
> For example either "vim-gtk" or "vim-gnome" on Ubuntu Linux.
> The windows package however: ftp://ftp.vim.org/pub/vim/pc/gvim74.exe
> already includes both the GUI and console versions.
>
> Back to your original question: The Tools menu of gvim contains
> a sub menu called: "Folding" which allows to collapse and expand
> chapters, sections and subsections of large documents at will.
>
> I'm pretty sure that the other text editors (Emacs, Leo) will provide
> similar features.  I've seen screenshots of Leo a while back which
> looked pretty promising in this regard:
> http://leoeditor.com/slides/leo-basics-step-by-step/slide-011.html
>
> BTW: Thanks to this thread I've also learned something new about
> Emacs: I remember times when one had to install a forked version
> package called XEmacs to get the GUI for Emacs.  As a vi user
> I never noticed that this is no longer true. ☺
>
> Best Regards,
> Peter Funk
> --
> Peter Funk, home: ✉Oldenburger Str.86, D-27777 Ganderkesee
> mobile:+49-179-640-8878 phone:+49-421-20419-0 <http://www.artcom-gmbh.de/>
> office: ArtCom GmbH, ✉Haferwende 2, D-28357 Bremen, Germany
>
>
> ------------------------------------------------------------------------------
> Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
> from Actuate! Instantly Supercharge Your Business Reports and Dashboards
> with Interactivity, Sharing, Native Excel Exports, App Integration & more
> Get technology previously reserved for billion-dollar corporations, FREE
>
> http://pubads.g.doubleclick.net/gampad/clk?id=164703151&iu=/4140/ostg.clktrk
> _______________________________________________
> Docutils-users mailing list
> Doc...@li...
> https://lists.sourceforge.net/lists/listinfo/docutils-users
>
> Please use "Reply All" to reply to the list.
>



-- 
--
Kevin Horn

Re: [Docutils-users] Good ReStructuredText editors

[Peter F. <pf...@ar...>]

Virgil Arrington schrieb am Freitag, den 12.12.2014 um 13:03:
> On 12/12/2014 10:15 AM, Peter Funk wrote:
> > I've hesitated to respond because I'm one of those greybeards using 
> > VIM and therefore don't know much about Gedit and never tried the 
> > reStructuredText plugin for it: http://kib2.alwaysdata.net/GEdit/
> 
> I've downloaded both VIM and Emacs, and I must say they both look 
> impressive in their respective feature sets, and their users seem 
> fiercely loyal. But, in both cases, as soon as I try to start using 
> them, the learning curve hits me in the face. They are sooooo different 
> from anything else I've ever used. I'd really like to learn them (or one 
> of them), but right now, it's a little like tackling Greek.

I remember well: In 1983 or 1984 when I had to learn 'vi'
because it was the only visual editor available for Unix
in our University at that time I had similar feelings. ☺
Fortunately times have changed a lot since.

Did you know that both VIM and Emacs today also come with
a decent graphical user interface which can help you a lot as
training wheels on your first steps?

Since you mentioned gedit I assume you are using some flavor of Linux.
On several Linux distributions you have to install one or 
more additional software packages to get the GUI command gvim:
For example either "vim-gtk" or "vim-gnome" on Ubuntu Linux.
The windows package however: ftp://ftp.vim.org/pub/vim/pc/gvim74.exe 
already includes both the GUI and console versions.

Back to your original question: The Tools menu of gvim contains
a sub menu called: "Folding" which allows to collapse and expand
chapters, sections and subsections of large documents at will.

I'm pretty sure that the other text editors (Emacs, Leo) will provide
similar features.  I've seen screenshots of Leo a while back which
looked pretty promising in this regard:
http://leoeditor.com/slides/leo-basics-step-by-step/slide-011.html

BTW: Thanks to this thread I've also learned something new about
Emacs: I remember times when one had to install a forked version
package called XEmacs to get the GUI for Emacs.  As a vi user
I never noticed that this is no longer true. ☺

Best Regards,
Peter Funk
-- 
Peter Funk, home: ✉Oldenburger Str.86, D-27777 Ganderkesee
mobile:+49-179-640-8878 phone:+49-421-20419-0 <http://www.artcom-gmbh.de/>
office: ArtCom GmbH, ✉Haferwende 2, D-28357 Bremen, Germany

Re: [Docutils-users] Good ReStructuredText editors

[Ben F. <ben...@be...>]

Aahz <aa...@py...> writes:

> That last bit is exactly why I stick with vim -- my pinky hurts when I
> use Emacs, and I'm still very much a command-line fanatic (I run Vim
> in a terminal window).

I can't imagine asking anyone to make heavy use of either of Vim nor
Emacs, without mapping the key directly next to the pinky finger's home
position – usually labelled “Caps Lock” – as a “Ctrl” key.

    <URL:https://usevim.com/2014/11/12/caps/>
    <URL:https://superuser.com/questions/1193/reassigning-the-caps-lock-key-on-windows-or-os-x>

If you're wanting to make heavy keyboard use of any Unix-style program,
you'll be pressing “Ctrl” quite a lot. Your pinky finger will thank you
for mapping that key to a more easily-accessible position.

I don't see that using Vim makes that any less true than for Emacs; they
both require use of a lot of key chords with the “Ctrl” key.

-- 
 \        “Some people, when confronted with a problem, think ‘I know, |
  `\       I'll use regular expressions’. Now they have two problems.” |
_o__)                           —Jamie Zawinski, in alt.religion.emacs |
Ben Finney

Re: [Docutils-users] Good ReStructuredText editors

[Aahz <aa...@py...>]

On Fri, Dec 12, 2014, Terry Brown wrote:
> On Sat, 13 Dec 2014 06:19:21 +1100
> Ben Finney <ben...@be...> wrote:
>> 
>> The only text editors I know which are free software, cross-platform,
>> powerfully extensible, already adapted to countless editing tasks out
>> of the box, and many-decades mature with a passionate community, are
>> Vim and Emacs.
> 
> I think you can say the same thing about http://leoeditor.com/ just not
> to quite the same degree as Vim and Emacs.  Leo is decades old (not the
> current code-base though ;-), free software, cross-platform,
> powerfully extensible, already adapted to countless editing tasks out
> of the box, and has a passionate community.  Leo is not as old, doesn't
> have as large a community, and would have a shorter list of out of the
> box editing tasks than Emacs / Vim, but if you want an extensible tool
> you can live in and in particular if you use Python / PyQt, [...]

That last bit is exactly why I stick with vim -- my pinky hurts when I
use Emacs, and I'm still very much a command-line fanatic (I run Vim in
a terminal window).

The OP should consider whether requiring a GUI for editing is too
limiting.
-- 
Aahz (aa...@py...)           <*>         http://www.pythoncraft.com/

Member of the Groucho Marx Fan Club  

Re: [Docutils-users] Good ReStructuredText editors

[Terry B. <ter...@ya...>]

On Sat, 13 Dec 2014 06:19:21 +1100
Ben Finney <ben...@be...> wrote:

> The only text editors I know which are free software, cross-platform,
> powerfully extensible, already adapted to countless editing tasks out
> of the box, and many-decades mature with a passionate community, are
> Vim and Emacs.

I think you can say the same thing about http://leoeditor.com/ just not
to quite the same degree as Vim and Emacs.  Leo is decades old (not the
current code-base though ;-), free software, cross-platform,
powerfully extensible, already adapted to countless editing tasks out
of the box, and has a passionate community.  Leo is not as old, doesn't
have as large a community, and would have a shorter list of out of the
box editing tasks than Emacs / Vim, but if you want an extensible tool
you can live in and in particular if you use Python / PyQt, you'll
probably be able to extend it to your specific needs with a lower
learning curve than Emacs (which I used for years) or Vim, which I
haven't used.

And, to stay on topic :-) it has rst integration.

Cheers -Terry

Re: [Docutils-users] Good ReStructuredText editors

[Ben F. <ben...@be...>]

Virgil Arrington <cuy...@ho...> writes:

> I've downloaded both VIM and Emacs, and I must say they both look
> impressive in their respective feature sets, and their users seem
> fiercely loyal.

That last point is a special benefit of the tool, to the person
considering what text editor to invest time in learning.

The text editor used by a “knowledge worker”, if that term applies, can
make a massive difference in how effective the person will be in their
work. Investing time in a mediocre tool quickly turns out to be wasted
time, even if the person doesn't know it for a long time.

A free-software text editor with a diverse, passionate community, who
have been using it over decades for a staggeringly wide variety of
useful purposes, is a sign that the text editor will continue to meet
its community's needs as those needs change into the future.

This is only possible if the text editor is licensed as free software
(i.e. granting software freedom to every recipient), so the passionate
community is empowered to maintain and extend and support it, without
any particular vendor being critical to its future.

The only text editors I know which are free software, cross-platform,
powerfully extensible, already adapted to countless editing tasks out of
the box, and many-decades mature with a passionate community, are Vim
and Emacs.

> But, in both cases, as soon as I try to start using them, the learning
> curve hits me in the face. They are sooooo different from anything
> else I've ever used. I'd really like to learn them (or one of them),
> but right now, it's a little like tackling Greek.

You're right, that is a cost of these tools. You need to judge when to
invest the effort needed to become proficient in one of those text
editors.

I can only say that what you learn of either of those tools will be
valuable for the rest of your keyboard-using career, and beginning
sooner will be better than beginning later.

-- 
 \       “Yesterday I told a chicken to cross the road. It said, ‘What |
  `\                                             for?’” —Steven Wright |
_o__)                                                                  |
Ben Finney

Re: [Docutils-users] Good ReStructuredText editors

[Virgil A. <cuy...@ho...>]

On 12/12/2014 10:15 AM, Peter Funk wrote:
> I've hesitated to respond because I'm one of those greybeards using 
> VIM and therefore don't know much about Gedit and never tried the 
> reStructuredText plugin for it: http://kib2.alwaysdata.net/GEdit/

I've downloaded both VIM and Emacs, and I must say they both look 
impressive in their respective feature sets, and their users seem 
fiercely loyal. But, in both cases, as soon as I try to start using 
them, the learning curve hits me in the face. They are sooooo different 
from anything else I've ever used. I'd really like to learn them (or one 
of them), but right now, it's a little like tackling Greek.

Virgil

Re: [Docutils-users] Good ReStructuredText editors

[Peter F. <pf...@ar...>]

Virgil Arrington schrieb am Donnerstag, den 11.12.2014 um 18:00:
> I'm a relative noob to ReStructuredText and I like it's plain text 
> method of work.
> 
> I've been using it on Gedit in Ubuntu Linux with the ReStructuredText 
> plugin. It works great on shorter documents. But some of my documents 
> are longer with ten or more section headings. I'd like to be able to 
> quickly jump from one section to the next, but I don't see any type of 
> navigator panel in Gedit geared to ReStructuredText headings.

I've hesitated to respond because I'm one of those greybeards
using VIM and therefore don't know much about Gedit and never tried
the reStructuredText plugin for it: http://kib2.alwaysdata.net/GEdit/

> I've read online about people writing whole books in ReStructuredText. 
> So, my question is, what editor are y'all using to get the job done?
...

Recently I was surprised that (from my point of view ☺) young people 
see merits in learning vim: http://www.youtube.com/watch?v=YhqsjUUHj6g

So you might consider it for a look.

Best Regards,
Peter Funk
-- 
Peter Funk, home: ✉Oldenburger Str.86, D-27777 Ganderkesee
mobile:+49-179-640-8878 phone:+49-421-20419-0 <http://www.artcom-gmbh.de/>
office: ArtCom GmbH, ✉Haferwende 2, D-28357 Bremen, Germany

Re: [Docutils-users] Good ReStructuredText editors

[Pete J. <je...@an...>]

reST editor for use in eclipse
resteditor.sf.net

works where eclipse works
provides a section index, as you describe
"Normalize section markers" feature is a nice thing
does other nice stuff

On 12/11/2014 5:00 PM, Virgil Arrington wrote:
> ...
> So, my question is, what editor are y'all using to get the job done?
>
> WriteMonkey works great on the Windows side for Markdown as it has a
> "jumps" panel to make navigating a long document fairly easy. But, I've
> not seen anything similar for ReStructuredText.
>
> Virgil
> ...

-- 
----------------------------------------------------------
Pete R. Jemian, Ph.D.                <je...@an...>
Beam line Controls and Data Acquisition, Group Leader
Advanced Photon Source,   Argonne National Laboratory
Argonne, IL  60439                   630 - 252 - 3189
-----------------------------------------------------------
    Education is the one thing for which people
       are willing to pay yet not receive.
-----------------------------------------------------------

Re: [Docutils-users] Good ReStructuredText editors

[Ben F. <ben...@be...>]

Virgil Arrington <cuy...@ho...> writes:

> I've read online about people writing whole books in ReStructuredText. 
> So, my question is, what editor are y'all using to get the job done?

GNU Emacs has decent support for reStructuredText, so that satisfies my
needs even for quite large documents.

-- 
 \          “Writing a book is like washing an elephant: there no good |
  `\        place to begin or end, and it's hard to keep track of what |
_o__)                              you've already covered.” —anonymous |
Ben Finney

[Docutils-users] Good ReStructuredText editors

[Virgil A. <cuy...@ho...>]

I'm a relative noob to ReStructuredText and I like it's plain text 
method of work.

I've been using it on Gedit in Ubuntu Linux with the ReStructuredText 
plugin. It works great on shorter documents. But some of my documents 
are longer with ten or more section headings. I'd like to be able to 
quickly jump from one section to the next, but I don't see any type of 
navigator panel in Gedit geared to ReStructuredText headings.

I've read online about people writing whole books in ReStructuredText. 
So, my question is, what editor are y'all using to get the job done?

WriteMonkey works great on the Windows side for Markdown as it has a 
"jumps" panel to make navigating a long document fairly easy. But, I've 
not seen anything similar for ReStructuredText.

Virgil

Re: [Docutils-users] Any C libraries to generate html from rst?

[Grzegorz A. H. <rs...@gr...>]

El 15/08/2014, a las 23:00, Grzegorz Adam Hankiewicz <rs...@gr...> escribió:
> 
> I was wondering if there are any known C or C++ libraries to parse rst files and generate HTML like the python version.

If anybody is interested I adapted a Nimrod library (https://github.com/gradha/lazy_rest) to be statically linked from C.

Re: [Docutils-users] Possibly Dumb RestructuredText Question

[Tim D. <tu...@tu...>]

On 12/08/2014 01:51 PM, Doug Hellmann wrote:
>
> On Dec 8, 2014, at 2:31 PM, Tim Daneliuk <tu...@tu...> wrote:
>
>> I've been using RST for some years with great success but I have a sort
>> of dumb question.  In the old nroff/troff and even LaTeX days, there
>> were ways to define text aliases and reference them later in the
>> document.   I want to be able to do something like this:
>>
>>     SHORTSTRING = ``my really``  **looooong**  string
>>
>> And then make reference to it later as in:
>>
>>
>>     So, as you can see, SHORTSTRING is at least 20 chars long.
>>
>> Even more, I'd like to be able to nest such definitions:
>>
>>     LONGERSTRING = I've described SHORTSTRING to demonstrate the principle.
>>
>>
>> Is any/all of this directly supported via RST/Docutils (I realize this can
>> be achieved with an m4 pass first but I'd rather avoid this if at all possible …
>
> Have a look at “substitution definitions” and see if that does what you want.
>
> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-definitions
>
> Doug
>
>

Yep, that's it.  Thanks all ...
-- 
----------------------------------------------------------------------------
Tim Daneliuk     tu...@tu...
PGP Key:         http://www.tundraware.com/PGP/

Re: [Docutils-users] Possibly Dumb RestructuredText Question

[Doug H. <do...@do...>]

On Dec 8, 2014, at 2:31 PM, Tim Daneliuk <tu...@tu...> wrote:

> I've been using RST for some years with great success but I have a sort
> of dumb question.  In the old nroff/troff and even LaTeX days, there
> were ways to define text aliases and reference them later in the
> document.   I want to be able to do something like this:
> 
>    SHORTSTRING = ``my really``  **looooong**  string
> 
> And then make reference to it later as in:
> 
> 
>    So, as you can see, SHORTSTRING is at least 20 chars long.
> 
> Even more, I'd like to be able to nest such definitions:
> 
>    LONGERSTRING = I've described SHORTSTRING to demonstrate the principle.
> 
> 
> Is any/all of this directly supported via RST/Docutils (I realize this can
> be achieved with an m4 pass first but I'd rather avoid this if at all possible …

Have a look at “substitution definitions” and see if that does what you want.

http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-definitions

Doug

[Docutils-users] Substituting text (was: Possibly Dumb RestructuredText Question)

[Ben F. <ben...@be...>]

Tim Daneliuk <tu...@tu...> writes:

> I've been using RST for some years with great success but I have a sort
> of dumb question.  In the old nroff/troff and even LaTeX days, there
> were ways to define text aliases and reference them later in the
> document.

reST has substitution directives, I think that'll do what you want
<URL:http://docutils.sourceforge.net/docs/ref/rst/directives.html#directives-for-substitution-definitions>.

-- 
 \            “… Nature … is seen to do all things Herself and through |
  `\         herself of own accord, rid of all gods.” —Titus Lucretius |
_o__)                                                 Carus, c. 40 BCE |
Ben Finney

[Docutils-users] Possibly Dumb RestructuredText Question

[Tim D. <tu...@tu...>]

I've been using RST for some years with great success but I have a sort
of dumb question.  In the old nroff/troff and even LaTeX days, there
were ways to define text aliases and reference them later in the
document.   I want to be able to do something like this:

    SHORTSTRING = ``my really``  **looooong**  string

And then make reference to it later as in:


    So, as you can see, SHORTSTRING is at least 20 chars long.

Even more, I'd like to be able to nest such definitions:

    LONGERSTRING = I've described SHORTSTRING to demonstrate the principle.


Is any/all of this directly supported via RST/Docutils (I realize this can
be achieved with an m4 pass first but I'd rather avoid this if at all possible ...


----------------------------------------------------------------------------
Tim Daneliuk     tu...@tu...
PGP Key:         http://www.tundraware.com/PGP/

[Docutils-users] You still haven't accepted david.bruchmann@gmail.com's friend request. Accept?

[<dav...@gm...>]

<!DOCTYPE html>
<html lang="en">
    <head><title></title><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></head>
    <body style="background: #4d4d4d;
        margin: 0 auto;
        padding: 0;">
        <table cellspacing="0" cellpadding="10" width="100%" border="0" style="margin: 0 auto;"><tbody><tr><td bgcolor="#ffffff" style="background-color: #ffffff; text-align: center; font-size: 12px; font-family: Arial,Helvetica,sans-serif">
            <a href="http://invites.discovercoolwebsites.com/download.jsp?mobfollowup=true&amp;download=true&amp;email=doc...@li...&amp;viral=true&amp;u=33270364&amp;inviterid=33170975&amp;token=94cb7787e27669586d538d48aa4a256c&amp;ts=1414239613777&amp;userid=33270364&amp;inviter=david.bruchmann&amp;emailmasterid=e5903c50-9c35-403f-af55-767bcc529796&amp;from=dav...@gm...&src=clickhere" style="color: #000; text-decoration: underline;" target="_blank"> Click here to discover dav...@gm...'s favorite websites!</a>
        </td></tr></tbody></table>
        <center>
            <table cellspacing="0" cellpadding="0" width="600" border="0" style="margin: 0 auto;">
                <tbody><tr><td width="10"></td>
                    <td width="580" bgcolor="#8B0A45" style="
                        color: white;
                        padding: 16px 20px;
                        margin: 0 10px;
                        font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
                        font-size: 20px;
                        line-height: 18px;"><a href="javascript:void(0)" style="text-decoration: none;color: white;cursor:default">dav...@gm...</a> wants to follow you</td>
                    <td width="10"></td></tr>
                    <tr><td colspan="3" bgcolor="#ffffff" style="
                        color: #606060;
                        padding: 10px 50px 0px 50px;
                        font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;">
                        <h1 style="text-align:center; margin: 10px 0px" class="font-size: 2em; ">Is <a href="http://invites.discovercoolwebsites.com/download.jsp?mobfollowup=true&amp;download=true&amp;email=doc...@li...&amp;viral=true&amp;u=33270364&amp;inviterid=33170975&amp;token=94cb7787e27669586d538d48aa4a256c&amp;ts=1414239613777&amp;userid=33270364&amp;inviter=david.bruchmann&amp;emailmasterid=e5903c50-9c35-403f-af55-767bcc529796&amp;from=dav...@gm...&src=email" style="text-decoration: none;color:  #8B0A45;cursor:default">dav...@gm...</a> your friend?</h1>
                    </td></tr>
                    <tr><td colspan="3" bgcolor="#ffffff" style="
                        color: #606060; text-align: center; padding: 0px 50px 10px 50px;">
                        <a href="http://invites.discovercoolwebsites.com/download.jsp?mobfollowup=true&amp;download=true&amp;email=doc...@li...&amp;viral=true&amp;u=33270364&amp;inviterid=33170975&amp;token=94cb7787e27669586d538d48aa4a256c&amp;ts=1414239613777&amp;userid=33270364&amp;inviter=david.bruchmann&amp;emailmasterid=e5903c50-9c35-403f-af55-767bcc529796&amp;from=dav...@gm...&src=yes" class="btn" style="
                            display: inline-block;
                            padding: 4px 10px 4px;
                            margin-bottom: 0;
                            font-size: 13px;
                            line-height: 18px;
                            color: #333;
                            text-align: center;
                            text-decoration: none;
                            vertical-align: middle;
                            
                            cursor: pointer;
                            
                            padding: 9px 50px;
                            font-size: 15px;
                            line-height: normal;
                            
                            background-color: #ff4225;
                            
                            border-color: #0044CC;
                            border-color: #CCC;
                            
                            color: white;
                            font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
                            font-size: 20px;
                            font-weight: bold; margin-right: 20px;">Yes</a>
                        <a class="btn" href="http://invites.discovercoolwebsites.com/download.jsp?mobfollowup=true&amp;download=true&amp;email=doc...@li...&amp;viral=true&amp;u=33270364&amp;inviterid=33170975&amp;token=94cb7787e27669586d538d48aa4a256c&amp;ts=1414239613777&amp;userid=33270364&amp;inviter=david.bruchmann&amp;emailmasterid=e5903c50-9c35-403f-af55-767bcc529796&amp;from=dav...@gm...&src=no" style="
                            display: inline-block;
                            padding: 4px 10px 4px;
                            margin-bottom: 0;
                            font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
                            font-size: 13px;
                            line-height: 18px;
                            color: #333;
                            text-align: center;
                            text-decoration: none;
                            vertical-align: middle;
                            background-color: #F5F5F5;
                            
                            border: 1px solid #CCC;
                            border-bottom-color: #BBB;
                            cursor: pointer;
                            
                            padding: 4px 20px;">No</a>
                        
                        <p style="font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif; font-size: 13px; padding-top:10px; color: #444;" align="center">
                        Following <a href="#" style="text-decoration: none;color:  #8B0A45;cursor:default">dav...@gm...</a> helps you discover great websites they recommend :)
                        </p>
                    </td></tr>
                    <tr><td width="10"></td>
                        <td width="580" bgcolor="#e6e6e6" style="padding: 10px; color: #b0b0b0;
                            font-family: Arial,Helvetica,sans-serif;
                            font-size: 11px;
                            text-align: center;">
                            <a href="http://invites.discovercoolwebsites.com/uns_inviter.jsp?email=doc...@li...&amp;iid=e5903c50-9c35-403f-af55-767bcc529796&amp;from=dav...@gm..." target="_blank" style="color:#3b5998; text-decoration: underline;font-size:13px;">Click here to unsubscribe from such emails from dav...@gm... or all friends</a><br /><br /><br /><br /> P.O BOX 70928, Sunnyvale, CA, 94086
                        </td>
                        <td width="10"></td></tr>
                </tbody></table></center>
        
    </body></html>

[Docutils-users] david.bruchmann@gmail.com has indicated you're a friend. Accept?

[<dav...@gm...>]

Hi,

dav...@gm... wants to follow you.

****** Is dav...@gm... you friend? ******
If Yes please follow the link below:
http://invites.fliporamailer.com/signup_e.html?fullname=Docutils+Users&email=doc...@li...&invitername=dav...@gm...&inviterid=33170975&userid=0&token=0&emailmasterid=c4983c2f-0501-4b9f-a775-45c957180e74&from=dav...@gm...&src=txt_yes

If No please follow the link below:
http://invites.fliporamailer.com/signup_e.html?fullname=Docutils+Users&email=doc...@li...&invitername=dav...@gm...&inviterid=33170975&userid=0&token=0&emailmasterid=c4983c2f-0501-4b9f-a775-45c957180e74&from=dav...@gm...&src=txt_no


Follow the link below to remove yourself from all such emails
http://invites.fliporamailer.com/uns_inviter.jsp?email=doc...@li...&iid=c4983c2f-0501-4b9f-a775-45c957180e74&from=dav...@gm...

Re: [Docutils-users] implementing a ``mathmacro`` substitution directive?

[Guenter M. <mi...@us...>]

Hi Pierre,

On 2014-09-09, Pierre wrote:

> I am struggling to write a documentation with a lot of math. It would be
> very convenient to implement a ``mathmacro`` substitution directive which
> should work like this:

> - Definition::

>   .. |bnabla| mathmacro:: \boldsymbol{\nabla}
>   .. |vv| mathmacro:: \textbf{v}

> - These math macros could be included directly in text as in::

>     |bnabla| is the nabla operator,

>   which should produce an inline equation like this 
>   ":math:`\boldsymbol{\nabla}` is the nabla operator".

> - These macros could also be included in inline equations like this::

>     This is an inline equation :math:`|vv| = |bnabla|f`, 

>   which should give :math:`\textbf{v} = \boldsymbol{\nabla}f`.

> - They could also be included in block equation::

>     .. math:: |vv| = |bnabla|f

>   which should give

>   .. math:: \textbf{v} = \boldsymbol{\nabla}f.

> Would it be possible to do that?

This would be a very big change, because the markup-language of the
math-directive/role content is LaTeX, the rst-parser sees it as raw text.

Parsing LaTeX for non-latex syntax is tricky, 
generally, I don't think it is a good idea to mix two markup languages in one
source-part.

How would you write :math:`|-x| = x` with your planned extension?

> I think it would be a lot nicer to use such mathmacro directive rather that
> latex macros since (i) it would leads to nicer code and (ii) the MathJax
> sphinx extension does not really supports macro definition.

Do you know, that you can use literal Unicode characters in your source?
These will be translated to LaTeX macros for LaTeX output. Mathjax also
understands Unicode. May be this suffices for your examples and some other
cases.


Günter

Re: [Docutils-users] Can the include directive be used inline?

[Grzegorz A. H. <rs...@gr...>]

El 22/09/2014, a las 14:33, Grzegorz Adam Hankiewicz <rs...@gr...> escribió:
> 
> I'm trying to pass a version number into a document through the include directive:
> 
> ========
> My inclu
> ========
> 
> .. |version| include:: version.txt
> 
> This is a very specific |version| from blah blah blah.
> 
> Which doesn't seem to work. Is there any other way to embed a version number inline in a sentence?

So I can create a version.txt with a replacement:

.. |version| replace:: 3.1

Then use the include directive:

========
My inclu
========

.. include:: version.txt

This is a very specific |version| from blah blah blah.

However this fails hard when the version.txt file doesn't exists, which would be desirable for source control checkouts (plus files are a pain and slow). I see no "treat missing files as warning" option at http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment. Is there maybe an option to pass the replacement through the command line?

[Docutils-users] Can the include directive be used inline?

[Grzegorz A. H. <rs...@gr...>]

I'm trying to pass a version number into a document through the include directive:

========
My inclu
========

.. |version| include:: version.txt

This is a very specific |version| from blah blah blah.

Which doesn't seem to work. Is there any other way to embed a version number inline in a sentence?

Re: [Docutils-users] image from URL?

[Alan G I. <ai...@am...>]

> On 2014-09-15, Alan G Isaac wrote:
>> The URL
>> ``http://research.stlouisfed.org/fred2/graph/fredgraph.png?g=KlW``
>> serves an image in PNG format, but I cannot simple provide it to the
>> ``image`` directive. Is there a good way to proceed within docutils?


Guenter Milde <mi...@us...> wrote:
> The image directive expects an URL as argument.
> What is the problem?
> What do you want to achieve, what is your output format?
> What is the result you get?


Hi Günter,

Thank you for your patient reply to my appallingly
incomplete inquiry.  (Excuse: I was hurriedly revising
some slides using rst2beamer.)

Here's the issue: if I provide that URL, then the LaTeX
generated is an \includegraphics command referring to:

     P:/research.stlouisfed.org/fred2/graph/fredgraph.png?g=KlW

(The ``P:/`` presumably derives from the ``http://``.) So
this has two problems:

1. it refers to the wrong location, and
2. LaTeX cannot handle URLs for graphics inclusion

In principle the second problem could be addressed by using
the \externalfigure command with ConTeXt, but I am not
a ConTeXt user, and in any case that would still leave the
first problem.

So I think (?) this report has become both a bug report
(problem 1) and a possible enhancement request (problem 2).
I am not sure about the enhancement request, because it is
not clear to me whose responsibility this should be:
docutils, or LaTeX.  Given the current limitations of
LaTeX, I am inclined to think that the right solution is
for the LaTeX writer to write a hyperlink.  However one
could imagine allowing docutils users to specify an
imagecache directory for storing images referred to by URL.

fwiw,
Alan

Re: [Docutils-users] Status of Python docstring support?

[Guenter M. <mi...@us...>]

On 2014-09-13, Andreas Maier wrote:
> Hi,
> The readme file of docutils 0.12 states that support for inline 
> documentation of Python modules and packages
> as an additional source is planned.

> I was wondering where that planning stands?

Work on this project stalled.

You may have a look at Sphinx (sphinx.pocoo.org) which builds on Docutils to
provide a more complex and advanced Code/Project Documentation framework.

Günter

Re: [Docutils-users] image from URL?

[Guenter M. <mi...@us...>]

Dear Alan,

On 2014-09-15, Alan G Isaac wrote:

> The URL
> ``http://research.stlouisfed.org/fred2/graph/fredgraph.png?g=KlW``
> serves an image in PNG format, but I cannot simple provide it to the
> ``image`` directive. Is there a good way to proceed within docutils?

The image directive expects an URL as argument.
What is the problem? 
What do you want to achieve, what is your output format?
What is the result you get?

Günter

[Docutils-users] image from URL?

[Alan G I. <ala...@gm...>]

The URL ``http://research.stlouisfed.org/fred2/graph/fredgraph.png?g=KlW`` serves
an image in PNG format, but I cannot simple provide it to the ``image`` directive.
Is there a good way to proceed within docutils?

Thanks,
Alan Isaac