multi-file or single file *.rst for a book doc

2 views
Skip to first unread message

Gour

unread,
Nov 20, 2009, 1:25:09 PM11/20/09
to leo-e...@googlegroups.com
Hi!

I see that Leo's user manual is written as single rst file.

Otoh, when I was writing book-long documents (e.g. in LyX/LaTeX), I
usually used master document and put every chapter in a separate file.

Now, I would like to hear some pro/cons of the above two strategies
when using Leo & writing in rst markup?

(Of course, the docs is going to be under VCS - darcs.)


Sincerely,
Gour

--

Gour | Hlapicina, Croatia | GPG key: F96FF5F6
----------------------------------------------------------------

signature.asc

Ville M. Vainio

unread,
Nov 20, 2009, 2:48:32 PM11/20/09
to leo-e...@googlegroups.com
On Fri, Nov 20, 2009 at 8:25 PM, Gour <go...@gour-nitai.com> wrote:

> Now, I would like to hear some pro/cons of the above two strategies
> when using Leo & writing in rst markup?

Pro single file: you can provide the .txt file as the "whole document"

Pro multiple files: plays better with version control & multiple authors.

At this point I'd probably suggest multiple @auto-rst .txt files. Or
@thin .txt files if everyone is using Leo.

--
Ville M. Vainio
http://tinyurl.com/vainio

Edward K. Ream

unread,
Nov 20, 2009, 3:42:59 PM11/20/09
to leo-e...@googlegroups.com

I agree.

BTW,  I have disabled the '@rst leoUsersGuide.txt' node in LeoDocs.leo by converting it to '@@rst...'  I did this awhile ago because it was causing problems.  Don't remember the details.

Edward

Gour

unread,
Nov 22, 2009, 8:38:22 AM11/22/09
to leo-e...@googlegroups.com
On Fri, 20 Nov 2009 21:48:32 +0200
>>>>>> "Ville" == "Ville M. Vainio" >>>>>> wrote:

Ville> Pro multiple files: plays better with version control & multiple
Ville> authors.

Thanks.

Ville> At this point I'd probably suggest multiple @auto-rst .txt
Ville> files. Or @thin .txt files if everyone is using Leo.

What about @shadow?

I'm still experimenting with different options and see that Leo (sometimes)
gets confused when I change node options and refuses to write my *.leo file.

signature.asc

Gour

unread,
Nov 22, 2009, 8:43:33 AM11/22/09
to leo-e...@googlegroups.com
On Fri, 20 Nov 2009 14:42:59 -0600
>>>>>> "Edward" == "Edward K. Ream" >>>>>> wrote:

Edward> BTW, I have disabled the '@rst leoUsersGuide.txt' node in
Edward> LeoDocs.leo by converting it to '@@rst...' I did this awhile
Edward> ago because it was causing problems. Don't remember the
Edward> details.


Let me tell you that having @@rst above does not bring much clarity to
the Leo noob looking for an optimal setup to have multi-file setup
(the book divided ala latex: front-matter etc.) for a book to be
written in rst markup and automatically convert it via Sphinx to
html/pdf output.


If @@rst does not bring anything it would be better to get removed to
spare us some unnecessary confusion.

signature.asc

Edward K. Ream

unread,
Nov 26, 2009, 12:32:01 PM11/26/09
to leo-e...@googlegroups.com
On Sun, Nov 22, 2009 at 7:43 AM, Gour <go...@gour-nitai.com> wrote:
Let me tell you that having @@rst above does not bring much clarity to
the Leo noob

Fixed on the trunk at rev 2493.

Edward
Reply all
Reply to author
Forward
0 new messages