Index of /sandbox/gschwant/htmlnav

[ICO]NameLast modifiedSizeDescription

[DIR]Parent Directory  -  
[TXT]rst2htmlnav.py22-Mar-2013 08:14 474  
[   ]setup.py22-Mar-2013 08:14 614  
[DIR]writer/22-Mar-2013 08:14 -  

README: htmlnav

README: htmlnav

An HTML writer for docutils which supports navigation-bars

Author: Gunnar Schwant
Contact: g.schwant@gmx.de
Date: 2003-06-09

Contents

Introduction

This is the writer which I use to build my homepage: http://schwant.gmxhome.de. [1] The name htmlnav is a short term for HTML with navigation-bars.

System Requirements

Docutils and everything needed to use docutils has to be installed.

Installation

Perform the usual setup.py install procedure.

Usage

Most parts of the writer are inherited from David Goodger's html4css1. In fact, if no .nav-files do exist in the destination directory, it produces the same output as David's writer.

Short example

  1. Go to docutils' "tools"-directory and create a file called "left.nav" with the following contents:

    colors  | #000000  | #8E8E8E
    section | Home
    link    | Python   | http://www.python.org
    link    | Docutils | http://docutils.sf.net
    raw     | <br>
    raw     | &copy; 2003 MyCompany
    
  2. Process "test.txt" to HTML using "rst2htmlnav.py":

    rst2htmlnav.py test.txt test.html
    

    Open "test.html" in your browser. You will notice the left navigation-bar.

  3. Create a file called "right.nav" in docutils' "tools"-directory. This time the contents are:

    colors  | #000000 | #8E8E8E
    section | Contact
    link    | me@MyCompany.org | mailto:me@mycompany.org
    
  4. Now perform step 2 again and open "test.html" in your browser. You will notice that there is a right navigation-bar now.

  5. Create a file called "top.nav" in docutils' "tools"-directory with the following contents:

    color     | #C8DBEB
    cornerpic | ../docs/rst/images/ball1.gif
    link      | Home     | test.html
    link      | Python   | http://www.python.org
    link      | Docutils | http://docutils.sf.net
    link      | Search   | http://www.google.com
    
  6. Once again perform step 2 and open "test.html" in your browser. Now a top navigation-bar is there, too.

Footnotes

[1]Sorry, my homepage is in german language. However, even if you don't understand what the text says, you'll get an impression of the writers output.