headers
François Pinard | 2 Oct 2004 03:22
Picon
Gravatar

Concept index, etc.

Hi, people.  This is my first message to `docutils', be kind with me! :-)

In one shop where I have been working for a few years, container formats
for various documents, as most people have each a preference.  So, we
end up with a mix of LaTeX, Roff, Texinfo, MS-Word or HTML, and also
many flat ASCII files.

Many documents are small enough to consider Roff or Texinfo, say, as
overkill.  We are now trying to reasonably unify most simple documents
behind Docutils and ReST, and it is going surprisingly well so far: I've
not seen any serious reluctance yet, and all involved people grasped
ReST rather quickly.  It's pretty encouraging.

A few of our documents are less small, without being big, and would
be good candidates also for ReST-ification.  For two Texinfo small
manuals, we would loose index tables at the end, and this hurts a bit.
We considered a few stunts by which we would mark the original ReST text
and try post-processing the generated LaTeX, say, but this would be
rather kludgey.  I wonder if this particular of producing indexes (or
should it be "indices" in English?) need has been already discussed in
the past among Docutils users or developers, and whether it is or not
part of the development plans for ReST and Docutils?

P.S. - Another tiny thing we saw is the difficulty of "including"
together many files written independently, as title styles ought to be
unified first prior to inclusion.  It would be easier, for us at least,
if title styles were analysed "per file" instead of globally, allowing
each author of a chapter (say), to work with the greatest possible
freedom.  This would have to imply, of course, that each included
file should be kind of self-contained, structurally, with no awkward
(Continue reading)

Permalink | Reply | 2 comments |
headers
Aahz | 2 Oct 2004 15:29

Re: Concept index, etc.

On Fri, Oct 01, 2004, François Pinard wrote:
>
> I wonder if this particular of producing indexes (or should it be
> "indices" in English?) need has been already discussed in the past
> among Docutils users or developers, and whether it is or not part of
> the development plans for ReST and Docutils?

I've done a fair bit of work in this area for my own needs, but it's far
from ready for integration into the core.  Take a look at the stuff in
my sandbox, paying less attention to the OO stuff.
--

-- 
Aahz (aahz <at> pythoncraft.com)           <*>         http://www.pythoncraft.com/

"A foolish consistency is the hobgoblin of little minds, adored by little
statesmen and philosophers and divines."  --Ralph Waldo Emerson

-------------------------------------------------------
This SF.net email is sponsored by: IT Product Guide on ITManagersJournal
Use IT products in your business? Tell us what you think of them. Give us
Your Opinions, Get Free ThinkGeek Gift Certificates! Click to find out more
http://productguide.itmanagersjournal.com/guidepromo.tmpl
Permalink | Reply | 0 comments |
headers
Josef Dalcolmo | 4 Oct 2004 09:47
Picon

Re: Concept index, etc.

on Fri, 1 Oct 2004 21:22:04 -0400
François Pinard <pinard <at> iro.umontreal.ca> wrote:

FP> P.S. - Another tiny thing we saw is the difficulty of "including"
FP> together many files written independently, as title styles ought to be
FP> unified first prior to inclusion.  It would be easier, for us at least,
FP> if title styles were analysed "per file" instead of globally, allowing
FP> each author of a chapter (say), to work with the greatest possible
FP> freedom.  This would have to imply, of course, that each included
FP> file should be kind of self-contained, structurally, with no awkward
FP> assymetrical stretches of structures between included parts.

I'm getting around this problem by using Leo as editor and generate rst (or HTML, Latex) from the Leo source.
Since Leo naturally supports hierarchy, there is no need for heading styles: they are generated when
producing an derived rst file. Inserting a document as a chapter or subchapter becomes as easy as cutting
and pasting one node from one document to another.

Unfortunately there is no rst -> Leo translator yet, and I am afraid I do not have the time to write one,
although this would not be difficult as a Leo plugin.
Note also: this "natural" hierarchy thing is available with Leo's rst plugin - the rst2 plugin works differently.

- Josef

-------------------------------------------------------
This SF.net email is sponsored by: IT Product Guide on ITManagersJournal
Use IT products in your business? Tell us what you think of them. Give us
Your Opinions, Get Free ThinkGeek Gift Certificates! Click to find out more
http://productguide.itmanagersjournal.com/guidepromo.tmpl
Permalink | Reply | 0 comments |
headers
David Goodger | 5 Oct 2004 04:10
Favicon

line block syntax added

I just added code for the new "line block" syntax to the parser.
Docs, tests, Docutils support, and HTML writer support also added.
The structure of line blocks has changed.  The old "line-block"
directive is now marked as deprecated, and the directive itself now
produces the new structure.

This may pose a problem for users of LaTeX and other output formats.
I hope that they can be updated quickly.  If not, we can temporarily
produce both old and new structures depending on context, but I'd
rather avoid that if possible.

docs:
http://docutils.sf.net/docs/ref/rst/restructuredtext.html#line-blocks

demo:
http://docutils.sf.net/docs/user/rst/demo.html#line-blocks

CVS snapshot:
http://docutils.sf.net/docutils-snapshot.tgz

--

-- 
David Goodger <http://python.net/~goodger>
Permalink | Reply | 0 comments |
headers
grubert | 5 Oct 2004 08:41
Picon
Gravatar

Re: line block syntax added

On Mon, 4 Oct 2004, David Goodger wrote:

> I just added code for the new "line block" syntax to the parser.
> Docs, tests, Docutils support, and HTML writer support also added.
> The structure of line blocks has changed.  The old "line-block"
> directive is now marked as deprecated, and the directive itself now
> produces the new structure.

which is, am i correct ? ::

  | eric sings
  | a lullaby
  |   a lull
  | and a bye

gives ::

  visit_line_block
  visit_line "eric sings" depart_line
  visit_line "a lullaby" depart_line
  visit_line_block
  visit_line "a lull" depart_line
  depart_line_block
  visit_line "and a bye" depart_line
  depart_line_block

> This may pose a problem for users of LaTeX and other output formats.
> I hope that they can be updated quickly.  If not, we can temporarily
> produce both old and new structures depending on context, but I'd
> rather avoid that if possible.
(Continue reading)

Permalink | Reply | 0 comments |
headers
grubert | 5 Oct 2004 08:55
Picon
Gravatar

Re: [Docutils-users] line block syntax added

i patched the latexwriter

but the indentation is wrong !

how do i know how much the original was indented ?

On Mon, 4 Oct 2004, David Goodger wrote:

> I just added code for the new "line block" syntax to the parser.
> Docs, tests, Docutils support, and HTML writer support also added.
> The structure of line blocks has changed.  The old "line-block"
> directive is now marked as deprecated, and the directive itself now
> produces the new structure.
>
> This may pose a problem for users of LaTeX and other output formats.
> I hope that they can be updated quickly.  If not, we can temporarily
> produce both old and new structures depending on context, but I'd
> rather avoid that if possible.
>
> docs:
> http://docutils.sf.net/docs/ref/rst/restructuredtext.html#line-blocks
>
> demo:
> http://docutils.sf.net/docs/user/rst/demo.html#line-blocks
>
> CVS snapshot:
> http://docutils.sf.net/docutils-snapshot.tgz
>
>
(Continue reading)

Permalink | Reply | 0 comments |
headers
Pierre-Yves Delens | 5 Oct 2004 09:39
Picon

docFactory ver 0.3 on Win XP - Problem with CSS

To Schwant + CC:docutils :
====================

I thank you very much for your quick answer.

your solution is OK.
I do inform hereby the DocUtils people about this docUtils conf problem for
CSS.
(see attachment)

Yours

PY Delens

----- Original Message -----
From: "Gunnar Schwant" <g.schwant <at> gmx.de>
To: "Pierre-Yves Delens" <py.delens <at> lienterfaces.be>
Sent: Monday, October 04, 2004 7:27 PM
Subject: Re: docFactory ver 0.3 on Win XP - Problem with CSS

| Hello :))
|
| You are right. I have the same problem on my machine. This is not a
| DocFactory problem. It is the processing of Docutils' html4css-writer
whichs
| seems to forget the slash.
|
| However, I only have this problem, if I use "stylesheet-path" in
| docutils.conf. It works fine, if I use "stylesheet". (Check
| http://docutils.sourceforge.net/docs/user/config.html#html4css1-writer for
(Continue reading)

Permalink | Reply | 2 comments |
headers
Pierre-Yves Delens | 5 Oct 2004 09:53
Picon

DocFactory - Suggestion for Output Path

Bonjour,

I am working on a hierarchic set of documentation-help rst-html files.

I would find easy and natural , for such a docFactory 'Project', to get each
html outputted file straight into the same folder as the original txt file,
because my txt tree and my html tree are the same.
However I would need to keep the conf file cnetralized of course, the same
for the whole set.

Did I mis this possibility of working in your tool as it is ?
If NOT, isn't this a suggestion for a feature interesting for otherrfellows
out there ?

Thanks for your idea about this

___________________________________________________
P-Y Delens, ing-arch. manager

LIENTERFACES - PY Delens, sprl
Avenue Dolez, 243  -  1180   Bruxelles

phone : 32 2 375 55 62
fax :      32 2 374 75 74
mail : py.delens <at> lienterfaces.be
web : www.lienterfaces.be
___________________________________________________

-------------------------------------------------------
This SF.net email is sponsored by: IT Product Guide on ITManagersJournal
(Continue reading)

Permalink | Reply | 1 comment |
headers
François Pinard | 5 Oct 2004 17:21
Picon
Gravatar

docutils - bug report

Hi, people.  I'm receiving:

10:49:23 0 pinard <at> griffon:~/sram/pyam $ rst2html.py pyam.txt > pyam.html
AttributeError: NestedStateMachine instance has no attribute 'language'
Exiting due to error.  Use "--traceback" to diagnose.
Please report errors to <docutils-users <at> lists.sf.net>.
Include "--traceback" output, Docutils version (0.3.5),
Python version (2.3.3), your OS type & version, and the
command line used.

So, here are these informations, below.  If you need anything else, please
tell me!

10:49:35 1 pinard <at> griffon:~/sram/pyam $ rst2html.py --traceback pyam.txt > pyam.html 
Traceback (most recent call last):
  File "/usr/bin/rst2html.py", line 25, in ?
    publish_cmdline(writer_name='html', description=description)
  File "/usr/lib/python2.3/site-packages/docutils/core.py", line 309, in publish_cmdline
    config_section=config_section, enable_exit_status=enable_exit_status)
  File "/usr/lib/python2.3/site-packages/docutils/core.py", line 194, in publish
    self.settings)
  File "/usr/lib/python2.3/site-packages/docutils/readers/__init__.py", line 66, in read
    self.parse()
  File "/usr/lib/python2.3/site-packages/docutils/readers/__init__.py", line 72, in parse
    self.parser.parse(self.input, document)
  File "/usr/lib/python2.3/site-packages/docutils/parsers/rst/__init__.py", line 135, in parse
    self.statemachine.run(inputlines, document, inliner=self.inliner)
  File "/usr/lib/python2.3/site-packages/docutils/parsers/rst/states.py", line 171, in run
    input_source=document['source'])
  File "/usr/lib/python2.3/site-packages/docutils/statemachine.py", line 232, in run
(Continue reading)

Permalink | Reply | 501 comments |
headers
Dave Kuhlman | 5 Oct 2004 18:29

Re: DocFactory - Suggestion for Output Path

On Tue, Oct 05, 2004 at 09:53:48AM +0200, Pierre-Yves Delens wrote:
> Bonjour,
> 
> I am working on a hierarchic set of documentation-help rst-html files.
> 
> I would find easy and natural , for such a docFactory 'Project', to get each
> html outputted file straight into the same folder as the original txt file,
> because my txt tree and my html tree are the same.
> However I would need to keep the conf file cnetralized of course, the same
> for the whole set.
> 
> Did I mis this possibility of working in your tool as it is ?
> If NOT, isn't this a suggestion for a feature interesting for otherrfellows
> out there ?

What about docutils/tools/buildhtml.py?  How close does it come to
doing what you need?  See docutils/README.txt for instructions on
how to run it on the documentation that comes with the Docutils
distribution.  And, I believe that the command line flage --config=
will enable you to specify your config file, if it is not in the
standard location.

Dave

--

-- 
Dave Kuhlman
http://www.rexx.com/~dkuhlman

-------------------------------------------------------
This SF.net email is sponsored by: IT Product Guide on ITManagersJournal
(Continue reading)

Permalink | Reply | 0 comments |

Gmane