rest2web-develop

[Rest2web-develop] disabling promotion of top-level section to title

[Steven B. <ste...@gm...>]

How can I disable the promotion of the top-level section to a title?
That is, I'm giving rest2html a file like::

    restindex
        crumb: Crumb
        page-title: My Page Title
    /restindex

    Header
    ======

    Sub-section
    -----------

and rest2html is outputting a document structure like::

    <h1 class="title">Header</h1>
    <div class="section">
        <h1>
            <a id="sub-section" name="sub-section">Sub-section</a>
        </h1>
    </div>

Note that the "Header" got interpreted as a "title" and therefore the
"Sub-section" is still given "h1" instead of "h2".

I gather this is because of docutils, but I couldn't figure out how to
make rest2html use the appropriate "doctitle_xform" from the Docutils
Configuration:

    http://docutils.sourceforge.net/docs/user/config.html#configuration-files

I tried putting the following docutils.conf in the directory from
which I'm running r2w.py and setting the DOCUTILSCONFIG environment
variable to the same directory, but with no luck::

    [standalone reader]
    doctitle_xform = 0

Steve
-- 
I'm not *in*-sane. Indeed, I am so far *out* of sane that you appear a
tiny blip on the distant coast of sanity.
        --- Bucky Katt, Get Fuzzy

Re: [Rest2web-develop] disabling promotion of top-level section to title

[Michael F. <fuz...@vo...>]

Steven Bethard wrote:
> How can I disable the promotion of the top-level section to a title?
> That is, I'm giving rest2html a file like::
>
>   
Currently there is no way to pass options to docutils from individual pages.

At some point I would like to add this.

However... how about this :

If you set an explicit page title, then rest2web will switch off 
promotion to title ?

This sounds fairly logical and should be easy for me to implement.

Fuzzyman


>     restindex
>         crumb: Crumb
>         page-title: My Page Title
>     /restindex
>
>     Header
>     ======
>
>     Sub-section
>     -----------
>
> and rest2html is outputting a document structure like::
>
>     <h1 class="title">Header</h1>
>     <div class="section">
>         <h1>
>             <a id="sub-section" name="sub-section">Sub-section</a>
>         </h1>
>     </div>
>
> Note that the "Header" got interpreted as a "title" and therefore the
> "Sub-section" is still given "h1" instead of "h2".
>
> I gather this is because of docutils, but I couldn't figure out how to
> make rest2html use the appropriate "doctitle_xform" from the Docutils
> Configuration:
>
>     http://docutils.sourceforge.net/docs/user/config.html#configuration-files
>
> I tried putting the following docutils.conf in the directory from
> which I'm running r2w.py and setting the DOCUTILSCONFIG environment
> variable to the same directory, but with no luck::
>
>     [standalone reader]
>     doctitle_xform = 0
>
> Steve
>   

Re: [Rest2web-develop] disabling promotion of top-level section to title

[Michael F. <ar...@vo...>]

Steven Bethard wrote:
> On 12/10/06, Michael Foord <mi...@vo...> wrote:
>> Steven Bethard wrote:
>> > How can I disable the promotion of the top-level section to a title?
> [snip]
>> However... how about this :
>>
>> If you set an explicit page title, then rest2web will switch off
>> promotion to title ?
>
> That would be great.  That's pretty much what I was hoping for.
I've just checked this change into subversion.

It is not enabled by default because with rest2web you should always 
pass in an explicit 'page-title' for index pages. Having this enabled by 
default would change the behaviour unexpectedly.

There is a new config file option 'promote_headers' which defaults to 
True. Set this to False in your config file to prevent the automatic 
promotion of section headers to a title.

I'm preparing a new release which will be out soon...

Fuzzyman
http://www.voidspace.org.uk/index2.shtml
>
> Steve



-- 
No virus found in this outgoing message.
Checked by AVG Free Edition.
Version: 7.1.409 / Virus Database: 268.15.21/589 - Release Date: 15/12/2006