otl2html

  1. Summary

      Converts an outline to an HTML page or pages. It is used for 'pretty' printing of outlines, creating portable (inline CSS) documents and even for creating simple web sites using otlsplit.

  1. Usage
       otl2html.py options inputfile > outputfile
       Options
           -p              Presentation: slide show output for use with HtmlSlides.
           -D              First-level is divisions (<div> </div>) for making
                           pretty web pages.
           -s sheet        Use the specified style sheet with a link. This is the
                           default.
           -S sheet        Include the specified style sheet in-line the output. For
                           encapsulated style.
           -T              The first line is not the title. Treat it as outline data
           -c              comments (line with [ as the first non-whitespace
                           character. Ending with ] is optional.
           -C copyright    Override the internal copyright notice with the
                           one supplied in the quoted string following this
                           flag. Single or double quotes can be used.
           -v              Print version (RCS) information.
           -H              Show the file syntax help.
       output is on STDOUT
         Note: if neither -s or -S are specified, otl2html.py will default to -s. It
             will try to use the css file 'nnnnnn.css' if it exists. If it does not
             exist, it will be created automatically. 
  1. Syntax
       Syntax is Vim Outliner's normal syntax. The following are supported:
      
          Text
               :       Body text marker. This text will wrap in the output.
               ;       Preformmated text. This text will will not wrap.
      
          Tables
               ||      Table header line.
               |       Table and table columns. Example:
                               || Name | Age | Animal |
                               | Kirby | 9 | Dog |
                               | Sparky | 1 | Bird |
                               | Sophia | 8 | Cat |
                               This will cause an item to be left-justified.
                                       | whatever  |
                               This will cause an item to be right-justified.
                                       |  whatever |
                               This will cause an item to be centered.
                                       | whatever |
      
          Character Styles
               **      Bold. **Bold Text** yields Bold Text
               //      Italic. //Italic Text// yields Italic Text
               +++     Highlight. +++Highlight Text+++ yields Highlight Text
               ---     Strikeout. ---Strikeout Text--- yields Strikeout Text
               Insane  ---+++//**Wow! This is insane!**//+++--- yields Wow! This is insane!
                       Just remember to keep it all on one line.
          Horizontal Rule
               ----------------------------------------  (40 dashes).
          Copyright
               (c) or (C)      Converts to a standard copyright symbol ©.
      
          Including Images (for web pages)
               [imagename]     Examples:
                               [logo.gif] [photo.jpg] [car.png]
                               [http://i.a.cnn.net/cnn/.element/img/1.1/logo/logl.gif]
                               or from a database:
                               [http://www.lab.com/php/image.php?id=4]
      
          Including links (for web pages)
               [link text-or-image]    Examples:
                               [about.html About] [http://www.cnn.com CNN]
                               or with an image:
                               [http://www.ted.com [http://www.ted.com/logo.png]]
      
          Note:
               When using -D, the top-level headings become divisions (<div>)
               and will be created using a class of the heading name. Spaces
               are not allowed. If a top-level heading begins with '_', it
               will not be shown but the division name will be the same as
               without the '_'. Example: _Menu will have a division name of
               Menu and will not be shown. 
  1. Examples

      This page and all of the pages of this web site were created with otl2html.

  1. Downloads
    1. Download ZIP
    2. Download tgz
  1. License

      This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License.

      This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

      You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

  1. Credits
       Copyright © 2006 Noel Henson					Updated: 2006-04-21
       noel@noels-lab.com