Skip to main content

Ralsina.Me — Roberto Alsina's website

It shall be called Bookrest, and it has an outline view.

Yes, the pro­gram known so far as "my rst2pdf ed­i­tor/pre­view­er ap­pli­ca­tion" is now called Bookrest.

What's a bookrest? It's a thing you put a book on.

Why Bookrest? I hope some­day peo­ple will have books open in bookrest. Plus, it ends with "rest", which is the pre­ferred ab­bre­vi­a­tion for re­Struc­tured Tex­t.

And what's the out­line view? It's a click­able tree with the out­line of the doc­u­men­t, of course.

As usu­al, let's go to the video:

The back­ground ren­der­ing was done us­ing python's awe­some mul­ti­pro­cess­ing mod­ule.

Doug Napoleone / 2009-09-25 22:27:

Ok, I am sold. Where can I get it?!!?!?

I have a PyCon talk proposal to write and I would love to do it using this tool!

(submissions are in ReStrucutredText).

Roberto Alsina / 2009-09-25 22:45:

It's in rst2pdf's SVN, in the gui folder.

It's tricky to build (check the README) and stylesheet loading is pretty broken right now.

Doug Napoleone / 2009-09-25 23:10:

thank you!!!

Ludvig Ericson / 2009-09-26 02:44:

Hm, would be even more awesome to do with HTML. Think that would be possible?

I often write my blog entries using ReStructured Text, and I wind up writing the contents, using rst2html.py (actually a Pygments-enabled replacement I have) and then copying the HTML into my blog hosting thing.

André Roberge / 2009-09-26 02:56:

Roberto: very impressive!!

Ludvig: it's certainly possible. I have done a simple version of this with Crunchy - but it's not nearly as nice as Roberto's bookrest.

Roberto Alsina / 2009-09-26 04:04:

Ludvig, sure, there are a couple of those, one was announced perhap a month ago. Check the docutils mailing lists.

Roberto Alsina / 2009-09-26 04:05:

Oh, and changing this to work with HTML is quite simple, if you want to take a look ;-)

Juha / 2009-09-26 07:49:

Hi Roberto - nicely done, as always. It is really nice to see the implementation of the outline as well (I've been missing that when writing documentation with Jedit - and it is really must-have with big documents).

One additional feature you should consider for the outline are the link targets, to make it easier to make reference to them. Example::

.. _my-title:

My title
========
Lorem ipsum and link to :ref:`my-title`

And the above should be seen in outline something like follows:

[+] My title (my-title)

Roberto Alsina / 2009-09-26 13:25:

@juha in the case of titles you can always link with the title itself (unless of course it's repeated):

`My title`_

But yes, I can add that!