<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <title>
      EtText: Documentation: Contents
    </title>
    <meta name="generator" content="WebMake/2.2" />
    <style>
      body {
       background-color: #ffffff; 
       color: #000000; 
       font-size: medium;
       font-family: verdana,lucida,helvetica,sans-serif;
      }
      // OL,UL,P,BODY,TD,TR,TH,FORM {
       // font-family: verdana,lucida,helvetica,sans-serif;
       // font-size: medium;
       // color: #000000;
      }
      code, samp, pre
      {
       font-family: monospace;
      }
      H1 { font-size: large; font-family: Garamond,Book Antiqua,Times,serif; }
      H2 { font-size: large; font-family: Garamond,Book Antiqua,Times,serif; }
      H3 { font-size: medium; font-family: Garamond,Book Antiqua,Times,serif; }
      H4 { font-size: small; font-family: Garamond,Book Antiqua,Times,serif; }
      H5 { font-size: x-small; font-family: Garamond,Book Antiqua,Times,serif; }
      H6 { font-size: xx-small; font-family: Garamond,Book Antiqua,Times,serif; }
      A:link {
       font-weight: bold;
       color: #004000;
       text-decoration: underline; 
      }
      A:visited {
       font-weight: normal;
       color: #008000;
       text-decoration: underline; 
      }
      A:active {
       font-weight: bold;
       color: #800000;
       text-decoration: underline; 
      }
    </style>
  </head>
  <body bgcolor="#ffffff" text="#000000" link="#3300cc" vlink="#660066">
    <font face="lucida,verdana,sans-serif">
      <div align="center">
        <img src="images/EtTextTitle.png" width="489" height="113" />
      </div>
      <table width="100%">
        <tr>
          <td valign="top">
             <strong><a href="http://ettext.taint.org/">EtText</a>
             Documentation</strong> (version 2.2)
             
          </td>
          <td valign="top">
            <div align="right">
              
               [ <a href="ethtml2text.html">Back</a> | <a href="blurb.html">Forward</a> | <a href="index.html">Index</a>
               | <a href="allinone.html">All&nbsp;In&nbsp;One</a> ]
               
            </div>
          </td>
        </tr>
      </table>
<!-- yes, it's that Mozilla black-border code again ;) -->
      <!-- stolen from www.mozilla.org via rc3.org -->
            <table border="0" cellpadding="0" cellspacing="0" width="100%">
        <tr>
          <td bgcolor="#aaaaaa">
            <table border="0" cellspacing="4" cellpadding="4" width="100%">
              <tr>
                <td bgcolor="#ffffff">
                  <table border="0" cellspacing="4" cellpadding="4" width="100%">
                    <tr>
                      <td>
                         <h2>Contents</h2> <h1>Contents</h1><ul>
                          <li>
                             <h2>Introduction</h2><ul>
                              <li>
                                <p>
                                  <a href="blurb.html">The Blurb</a> - What it is, and what it does
                                </p>
                              </li>
                              <li>
                                <p>
                                  <a href="contributors.html">Contributors to Text::EtText</a> - Contributors to Text::EtText
                                </p>
                              </li>
                            </ul>
                          </li>
                          <li>
                             <h2>Reference</h2><ul>
                              <li>
                                <p>
                                  <a href="ettext.html">Using EtText</a> - The basics of using EtText
                                </p>
                              </li>
                              <li>
                                <p>
                                  <a href="lists.html">Lists</a> - EtText support for lists
                                </p>
                              </li>
                              <li>
                                <p>
                                  <a href="sidebars.html">Sidebars and Side Images</a> - EtText support for side images
                                </p>
                              </li>
                              <li>
                                <p>
                                  <a href="links.html">Links in EtText</a> - How to link with EtText
                                </p>
                              </li>
                              <li>
                                <p>
                                  <a href="similar.html">Similar Systems</a> - Systems and tools that similar to EtText
                                </p>
                              </li>
                              <li>
                                <p>
                                  <a href="protecting.html">When HTML and EtText Collide</a> - Protecting text from interpretation
                                </p>
                              </li>
                            </ul>
                          </li>
                          <li>
                             <h2>Module Documentation</h2><ul>
                              <li>
                                <p>
                                  <a href="DefaultGlossary.pm.html">Text::EtText::DefaultGlossary</a> - module documentation
                                </p>
                              </li>
                              <li>
                                <p>
                                  <a href="EtText2HTML.pm.html">Text::EtText::EtText2HTML</a> - module documentation
                                </p>
                              </li>
                              <li>
                                <p>
                                  <a href="HTML2EtText.pm.html">Text::EtText::HTML2EtText</a> - module documentation
                                </p>
                              </li>
                              <li>
                                <p>
                                  <a href="LinkGlossary.pm.html">Text::EtText::LinkGlossary</a> - module documentation
                                </p>
                              </li>
                            </ul>
                          </li>
                          <li>
                             <h2>Manual Pages</h2><ul>
                              <li>
                                <p>
                                  <a href="ethtml2text.html">ethtml2text(1)</a> - manual page
                                </p>
                              </li>
                              <li>
                                <p>
                                  <a href="ettext2html.html">ettext2html(1)</a> - manual page
                                </p>
                              </li>
                            </ul>
                          </li>
                        </ul>
                        <hr />
                         <h1>The Blurb</h1><p>
                          EtText is a simple plain-text format which allows conversion to and from HTML.
                          Instead of editing HTML directly, it provides an easy-to-edit, easy-to-read and
                          intuitive way to write HTML, based on the plain-text markup conventions we've
                          been using for years.
                          
                        </p>
                        <p>
                          Like most simple text markup formats (POD, setext, etc.), EtText markup handles
                          the usual things: insertion of P tags, header recognition and markup. However
                          it also adds a powerful link markup system.
                          
                        </p>
                        <p>
                          EtText markup is simple and effective; it's very similar to setext, WikiWikiWeb
                          TextFormattingRules or Zope's StructuredText.
                          
                        </p>
                        <p>
                          EtText is distributed under the same licensing terms as Perl itself.
                          
                        </p>
                        <p>
                          
                        </p>
                        <hr />
                        <h1>Contributors to Text::EtText</h1><p>
                          Here's a list of people who've contributed to Text::EtText:
                          
                        </p>
                        <ul>
                          <li>
                            <p>
                              Justin Mason &lt;jm /at/ jmason.org&gt;: original author and maintainer
                              
                            </p>
                          </li>
                          <li>
                            <p>
                              Caolan McNamara &lt;caolan /at/ csn.ul.ie&gt;: EtText contributions; lists,
                               pre-formatted text, lots of suggestions
                              
                            </p>
                          </li>
                          <li>
                            <p>
                              rudif /at/ bluemail.ch: lots of help with supporting Windows
                              
                            </p>
                          </li>
                          <li>
                            <p>
                              Chris Barrett, chris /at/ getfrank.com: suggested CSS class support for the
                               Latte-style balanced tags
                              
                            </p>
                          </li>
                        </ul>
                        <p>
                          Thanks all! Patches and suggestions are welcomed -- <a href="http://ettext.taint.org/hacking.html">send them in</a>!
                          (By the way, patch contributors get listed at the top, 'cos patches save
                          me writing the code ;)
                          
                        </p>
                        <p>
                          
                        </p>
                      </p>
                      <hr />
                      <h1>Using EtText</h1><p>
                        Like most simple text markup formats (POD, <a href="http://www.bsdi.com/setext/">setext</a>, etc.), EtText markup
                        handles the usual things: insertion of <em>&lt;P&gt;</em> tags, header
                        recognition and markup. However it adds a powerful link markup system
                        and several other useful features.
                        
                      </p>
                      <p>
                        EtText markup is simple and effective; it's based loosely on <a href="http://www.bsdi.com/setext/">setext</a>, with bits
                        of <a href="http://c2.com/cgi/wiki?WikiWikiWeb">WikiWikiWeb</a> <a href="http://c2.com/cgi/wiki?TextFormattingRules">TextFormattingRules</a> thrown in.
                        
                      </p>
                      <p>
                        EtText was previously part of <a href="http://webmake.taint.org/">WebMake</a>, but is now distributed
                        as a standalone component.
                        
                      </p>
                       <a name="Basic_Text_Markup"><h3>Basic Text Markup</h3></a><p>
                        If you leave blank lines between paragraphs, <strong>&lt;p&gt;</strong> and
                        <strong>&lt;/p&gt;</strong> tags will be inserted in the correct places.
                        EtText does quite a good job of this.
                        
                      </p>
                      <p>
                        Words wrap and fill automatically, so there's no need to worry about wrapping
                        before 80 characters. (It's good form to do so anyway, in case other people
                        ever need to edit your text, or you need to mail it around.)
                        
                      </p>
                      <p>
                        A paragraph consisting of a line of 10 or more consecutive - or _ signs will be
                        converted to a HR tag.
                        
                      </p>
                      <p>
                        Sections of text between pairs of certain characters will be turned into
                        markup, as follows:
                        
                      </p>
                      <blockquote>
                        <p>
                          <table>
                            <tr>
                              <th width="30%">
                                <strong>EtText</strong>
                              </th>
                              <th width="30%">
                                <strong>Tag Used</strong>
                              </th>
                              <th width="30%">
                                <strong>Result</strong>
                              </th>
                            </tr>
                            <tr>
                              <td width="30%">
                                <code>&#42;&#42;text&#42;&#42;</code>
                              </td>
                              <td width="30%">
                                &lt;strong&gt;
                              </td>
                              <td width="30%">
                                <strong>text</strong>
                              </td>
                            </tr>
                            <tr>
                              <td width="30%">
                                <code>&#95;&#95;text&#95;&#95;</code>
                              </td>
                              <td width="30%">
                                &lt;em&gt;
                              </td>
                              <td width="30%">
                                <em>text</em>
                              </td>
                            </tr>
                            <tr>
                              <td width="30%">
                                <code>&#35;&#35;text&#35;&#35;</code>
                              </td>
                              <td width="30%">
                                &lt;code&gt;
                              </td>
                              <td width="30%">
                                <code>text</code>
                              </td>
                            </tr>
                          </table>
                        </p>
                      </blockquote>
                      <p>
                        <strong>&amp;</strong> signs that have whitespace on either side will be converted
                        to <strong>&amp;amp;</strong> signs automatically.
                        
                      </p>
                      <p>
                        Text indented from the left margin will be converted into a <strong>&lt;P&gt;</strong>
                        paragraph wrapped in a <strong>&lt;blockquote&gt;</strong> -- unless it starts with a
                        <code>*</code>, <code>-</code>, <code>+</code>, <code>o</code> character
                        followed by whitespace, or is numbered -- <code>1.</code>, <code>A)</code> or <code>a.</code>,
                        etc. -- in which case it's interpreted as a list item; see <a href="lists.html">Lists</a> below.
                        
                      </p>
                      <p>
                        Another exception to the above rule is that text indented by only 1 space, or
                        on lines starting in the first column with two colon characters, will be
                        surrounded by &lt;pre&gt; tags.
                        
                      </p>
                      <p>
                        If you find writing HTML tag-pairs manually annoying, EtText includes an idea
                        from <a href="http://www.latte.org/">Latte</a>; balanced-tag generation. Wrap the text to be tagged with
                        the name of the tag followed immediately by a { character on the left, and a }
                        character on the right. In other words,
                        
                      </p>
                      <blockquote>
                        <p>
                          <code>strong&#123;text&#125;</code>
                        </p>
                      </blockquote>
                      <p>
                        will be rendered as
                        
                      </p>
                      <blockquote>
                        <p>
                          <code>&lt;strong&gt;text&lt;/strong&gt;</code>
                        </p>
                      </blockquote>
                      <p>
                        or, in other words, <strong>text</strong> . This can be nested, so <code>strong&#123;text
                        with i&#123;italic&#125; bits&#125;</code> will be rendered as <strong>text with <i>italic</i>
                        bits</strong>.
                        
                      </p>
                      <p>
                        In addition, the balanced-tag support has a bonus feature, in that it supports
                        CSS classes; follow the name of the tag with a full stop and the class, and
                        it will use that class, like so:
                        
                      </p>
                      <blockquote>
                        <p>
                          <code>i.green&#123;foo&#125;</code>
                        </p>
                      </blockquote>
                      <p>
                        will be rendered as
                        
                      </p>
                      <blockquote>
                        <p>
                          <code>&lt;i class="green&gt;foo&lt;/i&gt;</code>
                        </p>
                      </blockquote>
                      <p>
                        Mail headers, and mail messages, are now marked up automatically.
                        
                      </p>
                      <p>
                        
                      </p>
                    </p>
                    <hr />
                    <h1>Lists</h1><p>
                      A paragraph indented from the left margin (by either spaces or tabs, or both),
                      and starting with a <code>*</code>, <code>-</code>, <code>+</code> or
                      <code>o</code> character followed by whitespace, will be converted into a list
                      item (<strong>&lt;li&gt;</strong> tag).
                      
                    </p>
                    <p>
                      The same goes for indented paragraphs that start with the string
                      <code>1.</code>, <code>a.</code>, <code>A.</code>, <code>1)</code>, <code>A)</code>, or <code>a)</code>, followed by
                      whitespace. However the default list tag in this case will be an
                      <strong>&lt;ol&gt;</strong>...<strong>&lt;/ol&gt;</strong> list. Any positive integer followed
                      immediately by a full stop and a space will do the trick. The <strong>&lt;ol&gt;</strong>
                      tag will use the correct <strong>type</strong> attribute to match the indexing you're using.
                      
                    </p>
                    <blockquote>
                      <p>
                        <em>(Compatibility note: previous versions of EtText required that the
                         <strong>&lt;ul&gt;</strong> or <strong>&lt;ol&gt;</strong> tags be written manually. This is no
                         longer the case, they will be added automatically.)</em>
                      </p>
                    </blockquote>
                    <p>
                      When you're writing <strong>&lt;ul&gt;</strong> lists, note that some text editors (such as
                      <em>vim</em>) will reformat list items automatically, assuming that you want the
                      text to line up with the start of the text, instead of the bullet-point
                      character, on the previous line, like so:
                      
                    </p>
                    <p>
                      <pre>
    - this is a list item. We should make sure that
      blah blah etc. etc.
</pre>
                    </p>
                    <p>
                      This is pretty handy, so using a <code>-</code> as the list bullet point character is
                      recommended.
                      
                    </p>
                    <p>
                      Indented paragraphs that start with <code><strong>term</strong>:</code> <em>tab</em> <code><strong>rest
                      of paragraph</strong></code> will be converted into definition lists (this is another
                      <a href="http://c2.com/cgi/wiki?WikiWikiWeb">StolenFromWikiIdea</a>). As a result, this:
                      
                    </p>
                    <p>
                      <!--etsafe-->
                      <pre>
    Foo:	Blah blah blah etc.
</pre><!--/etsafe-->
                      
                    </p>
                    <p>
                      Will look like this:
                      
                    </p>
                    <dl>
                      <dt>
                        Foo
                      </dt>
                      <dd>
                        <p>
                          Blah blah blah etc.
                          
                        </p>
                      </dd>
                    </dl>
                    <p>
                      
                    </p>
                  </p>
                  <hr />
                  <h1>Sidebars and Side Images</h1><p>
                    If you wish to display an image, or small sidebar, beside a paragraph of text,
                    use the <strong>&lt;etleft&gt;</strong> and <strong>&lt;etright&gt;</strong>
                    tags. These are rendered as a one-row, two-column
                    <strong>&lt;table&gt;</strong> wrapping the paragraph and the sidebar, as
                    follows:
                    
                  </p>
                  <p>
                    <pre>
  &lt;etleft&gt;&lt;img src=bubba.png&gt;&lt;/etleft&gt;This is the main
  paragraph body.  Foo bar baz blah blah blah etc.
</pre>
                  </p>
                  <p>
                    Is displayed as:
                    
                  </p>
                  <table>
                    <tr>
                      <td valign="top">
                        <img src="bubba.png"  width="110" height="70" />
                      </td>
                      <td width="99%" valign="top">
                        <p>
                          This is the main paragraph body.
                          Foo bar baz blah blah blah etc.
                        </p>
                      </td>
                    </tr>
                  </table>
                  <p>
                    <pre>
  &lt;etright&gt;&lt;img src=bubba.png&gt;&lt;/etright&gt;This is the
  main paragraph body.  Foo bar baz blah blah blah etc.
</pre>
                  </p>
                  <p>
                    Is displayed as:
                    
                  </p>
                  <table>
                    <tr>
                      <td width="99%" valign="top">
                        <p>
                          This is the main paragraph body.
                          Foo bar baz blah blah blah etc.
                        </p>
                      </td>
                      <td valign="top">
                        <img src="bubba.png"  width="110" height="70" />
                      </td>
                    </tr>
                  </table>
                </p>
                <hr />
                <h1>Links in EtText</h1><p>
                  As well as the standard <strong>&lt;a href=url&gt;...&lt;/a&gt;</strong> link
                  specification used in HTML, EtText will automatically add href tags for URLs
                  and email addresses that occur in the text. In addition, EtText supports its
                  own link format, as follows.
                  
                </p>
                <p>
                  To use labelled links, you surround the link text with double-square-brackets,
                  and (optionally) use a single open-square-bracket on the right-hand side with
                  the link label.
                  
                </p>
                <p>
                  Here's an example:
                  
                </p>
                <p>
                  <!--etsafe-->
                  <pre>
  WebMake's home page is &#91;&#91;at this website &#91;WebMake&#93;&#93;.
</pre><!--/etsafe-->
                  
                </p>
                <p>
                  Alternatively, if the link text matches the link label, the link label is
                  optional.
                  
                </p>
                <p>
                  <!--etsafe-->
                  <pre>
  Here's an example: &#91;&#91;WebMake&#93;&#93;.
</pre><!--/etsafe-->
                  
                </p>
                <p>
                  The href used in the link is then defined at another point in the document, as
                  an indented line like this:
                  
                </p>
                <p>
                  <!--etsafe-->
                  <pre>
	&#91;WebMake&#93;: http://webmake.taint.org/
</pre><!--/etsafe-->
                  
                </p>
                <p>
                  Even simpler: if the link label has been set as an <a href="#Auto_Links_Even_More_Convenient">Auto link</a>, you can omit the square
                  brackets altogether:
                  
                </p>
                <p>
                  <!--etsafe-->
                  <pre>
  Here's an example: WebMake.
</pre><!--/etsafe-->
                  
                </p>
                <p>
                  Text and markup can be enclosed in the double-square-brackets, everything
                  quoted will become part of the link text. Unlike the older form of EtText
                  links (see below), even single words need to be enclosed in brackets
                  to become links. This protects against accidentally interpreting normal
                  text as a broken link.
                  
                </p>
                 <a name="EtText_Linking_Backwards_Compatibility"><h3>EtText Linking, Backwards Compatibility</h3></a><p>
                  The following text describes the old style for EtText links. Since it
                  was way too easy to produce links this way where they were not intended
                  to be, it has now been obsoleted by the method described above. However,
                  support for it will remain on by default for a few revisions.
                  
                </p>
                <p>
                  To turn off this backwards compatibility, set the <strong>EtTextOldLinkStyle</strong> option
                  to 0, either using <a href="http://webmake.taint.org/">WebMake</a>'s &lt;option&gt; tag, or from your code.
                  
                </p>
                <p>
                  The basic concept is of a word or "quoted set of words" followed by an
                  optional link label in [square brackets], like this: <strong>"this is a
                  link" [label]</strong>.
                  
                </p>
                <p>
                  The href used in the link is then defined at another point in the document, as
                  above.
                  
                </p>
                <p>
                  Text and markup can be enclosed in the quotes, everything quoted will become
                  part of the link text. Single words or HTML tags do not need to be quoted, so
                  
                </p>
                <p>
                  <!--etsafe-->
                  <pre>
  &lt;img src="/license_plate.jpg" width="10" height="10"&gt; &#91;homepage&#93;
</pre><!--/etsafe-->
                  
                </p>
                <p>
                  will work correctly.
                  
                </p>
                 <a name="Glossary_Links"><h3>Glossary Links</h3></a><p>
                  EtText also supports a concept called <em>glossary links</em>; if you define a link,
                  the name of that link will automatically become a href if enclosed in
                  double-square-brackets or quotes. For example:
                  
                </p>
                <p>
                  <!--etsafe-->
                  <pre>
  &#91;Justin Mason&#93;: http://jmason.org/
</pre><!--/etsafe-->
                  
                </p>
                <p>
                  will mean that any occurrence of <strong>[[Justin Mason]]</strong>, or
                  <strong>"Justin Mason"</strong>, in <em>any</em> EtText content chunk or file in the
                  site, becomes a link to that address.
                  
                </p>
                <blockquote>
                  <p>
                    These links are stored in the <a href="http://webmake.taint.org/">WebMake</a> cache file, if <a href="http://webmake.taint.org/">WebMake</a> is being used.
                     If you use EtText in a standalone mode, without <a href="http://webmake.taint.org/">WebMake</a>, you can provide an
                     implementation of the <strong>Text::EtText::LinkGlossary</strong> interface to store
                     defined links so that they can be used in other EtText files.
                    
                  </p>
                </blockquote>
                <p>
                  Quoted bits of text that do not map to an entry in the glossary are not
                  converted to links (unless they're followed by a square-bracketed link-label
                  reference).
                  
                </p>
                 <a name="Auto_Links_Even_More_Convenient"><h3>Auto Links - Even More Convenient</h3></a><p>
                  In addition, if the link definition is preceded with <code>Auto:</code>, the quotes are
                  not required, and any occurrence of the link label -- with or without quotes or
                  double-square-brackets -- will become a link.
                  
                </p>
                <p>
                  <!--etsafe-->
                  <pre>
  Auto: &#91;WebMake&#93;: http://webmake.taint.org/
  Auto: &#91;any occurrence of the words&#93;: http://webmake.taint.org/
</pre><!--/etsafe-->
                  
                </p>
                 <a name="URLs_and_Email_Addresses"><h3>URLs and Email Addresses</h3></a><p>
                  URLs, such as <a href="http://webmake.taint.org/">http://webmake.taint.org/</a> , and email addresses, such as
                  <a href="mailto:jm@nospam-jmason.org">jm@nospam-jmason.org</a>, are automatically converted into links to that same
                  address.
                  
                </p>
                 <a name="Blocking_EtText_Link_Interpretation"><h3>Blocking EtText Link Interpretation</h3></a><p>
                  To block interpretation as a link, replace square brackets with the HTML
                  entities <strong>&amp;etsqi;</strong> and <strong>&amp;etsqo;</strong>, which map to [ and ]
                  respectively; replace quote characters, <strong>"</strong>, with two apostrophes,
                  <strong>&#39;&#39;</strong>. If that doesn't do the trick, wrap the entire section of text
                  with the <strong>&lt;!--etsafe--&gt;</strong>...<strong>&lt;!--/etsafe--&gt;</strong> tags.
                  
                </p>
                <p>
                  
                </p>
              </p>
              <hr />
              <h1>Similar Systems</h1><p>
                EtText-like plain-text-to-markup conversion systems have a long history. The
                first time I came across the concept was with <a href="http://www.bsdi.com/setext/">Setext</a>, which was
                included with Tony Sanders' <em>Plexus</em> web server, back in September 1993.
                Yes, 1993. Setext has been around for a while!
                
              </p>
              <p>
                <a href="http://c2.com/cgi/wiki?WikiWikiWeb">WikiWikiWeb</a> is quite a recent, well-established system which uses
                a similar markup style.
                
              </p>
              <p>
                <a href="http://www.aigeek.com/txt2html/">txt2html</a> provided a lot of impetus to rewrite the core of EtText since 2.0,
                since its list-parsing engine was <em>much</em> better. However EtText is now up to
                scratch again ;)
                
              </p>
              <p>
                The real inspiration for EtText was Userland's <a href="http://www.userland.com/">Frontier</a>; Dave
                Winer's evangelisation of its easily-editable markup system convinced me that
                it was worth polishing up the rudimentary EtText system I had then. In
                addition, the name "EtText" is derived from "Edit This Text", in
                a tip of the hat to Dave's "Edit This Page" concept.
                
              </p>
              <p>
                Some well-known sites that use their own converters to convert
                plain-text to markup include <a href="http://www.blogger.com/">http://www.blogger.com/</a>, <a href="http://slashdot.org/">http://slashdot.org/</a>
                (for comments) and <a href="http://www.advogato.org/">http://www.advogato.org/</a>.
                
              </p>
              <p>
                Jorn Barger maintains an impressive summary of etext formats at <a href="http://www.robotwisdom.com/net/etextfaq.html">his Robot
                Wisdom site</a>. Skip down to section 3, <em>Internet etext
                standards</em>, for the directly-relevant stuff.
                
              </p>
              <p>
                Zope and ZWiki use a format called <a href="http://dev.zope.org/Wikis/DevSite/Proposals/StructuredText">StructuredText</a>, which again comes from
                WikiLand. There's some interesting work going on there with the <a href="http://www.zope.org/Members/jim/StructuredTextWiki/STXDocument">STXDocument</a>
                object, which is "a web-managable object that contains information marked up
                in the structured text format".
                
              </p>
              <p>
                
              </p>
              <hr />
              <h1>When HTML and EtText Collide</h1><p>
                HTML tags can be used freely throughout an EtText document. However, in some
                situations, you may wish to preserve whitespace, avoid paragraph tags being
                added, etc.; to use your own HTML without meddling from EtText, wrap it in an
                <strong>&lt;!--etsafe--&gt;</strong>...<strong>&lt;!--/etsafe--&gt;</strong>
                tag pair; this will protect it.
                
              </p>
              <p>
                Note that text blocks wrapped in <strong>&lt;pre&gt;</strong>,
                <strong>&lt;listing&gt;</strong> and <strong>&lt;xmp&gt;</strong> tags are
                automatically protected in this way; the <strong>&lt;!--etsafe--&gt;</strong>
                tag pair is not required.
                
              </p>
              <p>
                EtText adds two entities, <strong>&amp;etsqi;</strong> and <strong>&amp;etsqo;</strong>. These represent
                [ and ] respectively, and are used to protect a square-bracketed
                piece of text from being interpreted as a link URL (see <em>Link Markup</em> below).
                
              </p>
              <p>
                If this is insufficient, and you're using <a href="http://webmake.taint.org/">WebMake</a>, the <strong>&lt;safe&gt;</strong> tag
                will escape any type of code to protect it from interpretation by <a href="http://webmake.taint.org/">WebMake</a>,
                EtText or HTML.
                
              </p>
              <p>
                
              </p>
              <hr />
              <h1>Text::EtText::DefaultGlossary</h1><!-- INDEX BEGIN -->
              <ul>
                <li>
                  <a href="#NAME">NAME</a><li>
                    <a href="#SYNOPSIS">SYNOPSIS</a><li>
                      <a href="#DESCRIPTION">DESCRIPTION</a><li>
                        <a href="#METHODS">METHODS</a>
                      </ul>
<!-- INDEX END -->
                                            <hr />
                       <h1><a name="NAME">NAME</a></h1><p>
                        
                        Text::EtText::DefaultGlossary - default, non-persistent link glossary
                        <hr />
                         <h1><a name="SYNOPSIS">SYNOPSIS</a></h1><hr />
                         <h1><a name="DESCRIPTION">DESCRIPTION</a></h1><p>
                          
                          The <code>Text::EtText::DefaultGlossary</code> is an implementation of
                          <code>Text::EtText::LinkGlossary</code> which is used if no other implementation is registered.
                          <p>
                            
                            It will not save glossary link details persistently.
                            <hr />
                             <h1><a name="METHODS">METHODS</a></h1>
                          </dl>
                          <hr />
                          <h1>Text::EtText::EtText2HTML</h1><!-- INDEX BEGIN -->
                          <ul>
                            <li>
                              <a href="#NAME">NAME</a><li>
                                <a href="#SYNOPSIS">SYNOPSIS</a><li>
                                  <a href="#DESCRIPTION">DESCRIPTION</a><li>
                                    <a href="#METHODS">METHODS</a><li>
                                      <a href="#MORE_DOCUMENTATION">MORE DOCUMENTATION</a><li>
                                        <a href="#SEE_ALSO">SEE ALSO</a><li>
                                          <a href="#AUTHOR">AUTHOR</a><li>
                                            <a href="#COPYRIGHT">COPYRIGHT</a><li>
                                              <a href="#AVAILABILITY">AVAILABILITY</a>
                                            </ul>
<!-- INDEX END -->
                                                                                        <hr />
                                             <h1><a name="NAME">NAME</a></h1><p>
                                              
                                              Text::EtText::EtText2HTML - convert from the simple EtText editable-text
                                              format into HTML
                                              <hr />
                                               <h1><a name="SYNOPSIS">SYNOPSIS</a></h1><p>
                                                <pre>  my $t = new Text::EtText::EtText2HTML;
  print $t-&gt;text2html ($text);
</pre><p>
                                                  
                                                  or
                                                  <p>
                                                    <pre>  my $t = new Text::EtText::EtText2HTML;
  print $t-&gt;text2html ();               # from STDIN
</pre><hr />
                                                     <h1><a name="DESCRIPTION">DESCRIPTION</a></h1><p>
                                                      
                                                      ettext2html will convert a text file in the EtText editable-text format
                                                      into HTML.
                                                      <p>
                                                        
                                                        For more information on the EtText format, check the WebMake documentation
                                                        on the web at <a href="http://webmake.taint.org/">http://webmake.taint.org/</a> .
                                                        <hr />
                                                         <h1><a name="METHODS">METHODS</a></h1><dl>
                                                          <dt>
                                                            <strong><a name="item__f">$f = new Text::EtText::EtText2HTML</a></strong>
                                                          </dt>
                                                          <dd>
                                                            <p>
                                                              
                                                              Constructs a new <code>Text::EtText::EtText2HTML</code> object.
                                                              
                                                            </dd>
                                                            <dt>
                                                              <strong><a name="item__f_set_option">$f-&gt;set_option ($optname, $optval);</a></strong>
                                                            </dt>
                                                            <dd>
                                                              <p>
                                                                
                                                                Set an EtText option. (Options can also be set on the WebMake object
                                                                itself, or from inside the WebMake file.) Currently supported options are:
                                                                <dl>
                                                                  
                                                                </dd>
                                                                <dt>
                                                                  <strong><a name="item_EtTextOneCharMarkup">EtTextOneCharMarkup (default: 0)</a></strong>
                                                                </dt>
                                                                <dd>
                                                                  <p>
                                                                    
                                                                    Allow one-character sets of asterisks etc. to mark up as strong, emphasis
                                                                    etc., instead of the default two-character markup.
                                                                    
                                                                  </dd>
                                                                  <dt>
                                                                    <strong><a name="item_EtTextOldLinkStyle">EtTextOldLinkStyle (default: 1)</a></strong>
                                                                  </dt>
                                                                  <dd>
                                                                    <p>
                                                                      
                                                                      Use the older EtText link-markup style, with quote characters and single
                                                                      square brackets. This is easy to type, but if you're using text from other
                                                                      people, it can easily destroy formatting; so the new link-markup style,
                                                                      with double square brackets, can be used instead.
                                                                      
                                                                    </dd>
                                                                    <dt>
                                                                      <strong><a name="item_EtTextBaseHref">EtTextBaseHref (default: '')</a></strong>
                                                                    </dt>
                                                                    <dd>
                                                                      <p>
                                                                        
                                                                        The base HREF to use for relative links. If set, all relative links in tags
                                                                        with HREF attributes will be rewritten as absolute links, making the output
                                                                        HTML independent of the URL tree structure.
                                                                        
                                                                      </dd>
                                                                      <dt>
                                                                        <strong><a name="item_EtTextHrefsRelativeToTop">EtTextHrefsRelativeToTop (default: 0)</a></strong>
                                                                      </dt>
                                                                      <dd>
                                                                        <p>
                                                                          
                                                                          Indicates that all EtText links are relative to the top of the WebMake
                                                                          document tree. This (obviously) is only relevant if you are using EtText in
                                                                          conjunction with WebMake, and WebMake sets it by default. If set, all
                                                                          relative links in tags with HREF attributes will be rewritten as relative
                                                                          to the ''top'' of the WebMake site, making the output HTML independent of
                                                                          the URL tree structure.
                                                                          
                                                                        </dd>
                                                                      </dl>
                                                                    </dd>
                                                                    <dt>
                                                                      <strong><a name="item__html">$html = $f-&gt;set_glossary ($glosobj)</a></strong>
                                                                    </dt>
                                                                    <dd>
                                                                      <p>
                                                                        
                                                                        Provide a glossary for shared link definitions, allowing link definitions
                                                                        to be shared and reused across multiple EtText files. <code>$glosobj</code> must implement the interface defined by <code>Text::EtText::LinkGlossary</code>.
                                                                        <p>
                                                                          
                                                                          See below for more information on this interface.
                                                                          
                                                                        </dd>
                                                                        <dt>
                                                                          <strong>$html = $f-&gt;text2html( [$text] )</strong>
                                                                        </dt>
                                                                        <dd>
                                                                          <p>
                                                                            
                                                                            Convert text, either from the argument or from STDIN, into HTML.
                                                                            
                                                                          </dd>
                                                                        </dl>
                                                                        <hr />
                                                                         <h1><a name="MORE_DOCUMENTATION">MORE DOCUMENTATION</a></h1><p>
                                                                          
                                                                          See also <a href="http://webmake.taint.org/">http://webmake.taint.org/</a>
                                                                          for more information.
                                                                          <hr />
                                                                           <h1><a name="SEE_ALSO">SEE ALSO</a></h1><p>
                                                                             <code>webmake</code> <code>ettext2html</code> <code>ethtml2text</code> <code>HTML::WebMake</code> <code>Text::EtText::EtText2HTML</code> <code>Text::EtText::HTML2EtText</code> <code>Text::EtText::LinkGlossary</code> <code>Text::EtText::DefaultGlossary</code><hr />
                                                                             <h1><a name="AUTHOR">AUTHOR</a></h1><p>
                                                                              
                                                                              Justin Mason &lt;jm /at/ jmason.org&gt;
                                                                              <hr />
                                                                               <h1><a name="COPYRIGHT">COPYRIGHT</a></h1><p>
                                                                                
                                                                                WebMake is distributed under the terms of the GNU Public License.
                                                                                <hr />
                                                                                 <h1><a name="AVAILABILITY">AVAILABILITY</a></h1><p>
                                                                                  
                                                                                  The latest version of this library is likely to be available from CPAN as
                                                                                  well as:
                                                                                  <p>
                                                                                    <pre>  <a href="http://webmake.taint.org/">http://webmake.taint.org/</a>
</pre><hr />
                                                                                    <h1>Text::EtText::HTML2EtText</h1><!-- INDEX BEGIN -->
                                                                                    <ul>
                                                                                      <li>
                                                                                        <a href="#NAME">NAME</a><li>
                                                                                          <a href="#SYNOPSIS">SYNOPSIS</a><li>
                                                                                            <a href="#DESCRIPTION">DESCRIPTION</a><li>
                                                                                              <a href="#METHODS">METHODS</a><li>
                                                                                                <a href="#MORE_DOCUMENTATION">MORE DOCUMENTATION</a><li>
                                                                                                  <a href="#SEE_ALSO">SEE ALSO</a><li>
                                                                                                    <a href="#AUTHOR">AUTHOR</a><li>
                                                                                                      <a href="#COPYRIGHT">COPYRIGHT</a><li>
                                                                                                        <a href="#AVAILABILITY">AVAILABILITY</a>
                                                                                                      </ul>
<!-- INDEX END -->
                                                                                                                                                                                                            <hr />
                                                                                                       <h1><a name="NAME">NAME</a></h1><p>
                                                                                                        
                                                                                                        Text::EtText::HTML2EtText - convert from HTML to the EtText editable-text
                                                                                                        format
                                                                                                        <hr />
                                                                                                         <h1><a name="SYNOPSIS">SYNOPSIS</a></h1><p>
                                                                                                          <pre>  my $t = new Text::EtText::HTML2EtText;
  print $t-&gt;html2text ($html);
</pre><p>
                                                                                                            
                                                                                                            or
                                                                                                            <p>
                                                                                                              <pre>  my $t = new Text::EtText::HTML2EtText;
  print $t-&gt;html2text ();                       # from STDIN
</pre><hr />
                                                                                                               <h1><a name="DESCRIPTION">DESCRIPTION</a></h1><p>
                                                                                                                
                                                                                                                ethtml2text will convert a HTML file into the EtText editable-text format,
                                                                                                                for use with webmake or ettext2html.
                                                                                                                <p>
                                                                                                                  
                                                                                                                  For more information on the EtText format, check the WebMake documentation
                                                                                                                  on the web at <a href="http://webmake.taint.org/">http://webmake.taint.org/</a> .
                                                                                                                  <hr />
                                                                                                                   <h1><a name="METHODS">METHODS</a></h1><dl>
                                                                                                                    <dt>
                                                                                                                      <strong><a name="item__f">$f = new Text::EtText::HTML2EtText</a></strong>
                                                                                                                    </dt>
                                                                                                                    <dd>
                                                                                                                      <p>
                                                                                                                        
                                                                                                                        Constructs a new <code>Text::EtText::HTML2EtText</code> object.
                                                                                                                        
                                                                                                                      </dd>
                                                                                                                      <dt>
                                                                                                                        <strong><a name="item__text">$text = $f-&gt;html2text( [$html] )</a></strong>
                                                                                                                      </dt>
                                                                                                                      <dd>
                                                                                                                        <p>
                                                                                                                          
                                                                                                                          Convert HTML, either from the argument or from STDIN, into EtText.
                                                                                                                          
                                                                                                                        </dd>
                                                                                                                      </dl>
                                                                                                                      <hr />
                                                                                                                       <h1><a name="MORE_DOCUMENTATION">MORE DOCUMENTATION</a></h1><p>
                                                                                                                        
                                                                                                                        See also <a href="http://webmake.taint.org/">http://webmake.taint.org/</a>
                                                                                                                        for more information.
                                                                                                                        <hr />
                                                                                                                         <h1><a name="SEE_ALSO">SEE ALSO</a></h1><p>
                                                                                                                           <code>webmake</code> <code>ettext2html</code> <code>ethtml2text</code> <code>HTML::WebMake</code> <code>Text::EtText::EtText2HTML</code> <code>Text::EtText::HTML2EtText</code><hr />
                                                                                                                           <h1><a name="AUTHOR">AUTHOR</a></h1><p>
                                                                                                                            
                                                                                                                            Justin Mason &lt;jm /at/ jmason.org&gt;
                                                                                                                            <hr />
                                                                                                                             <h1><a name="COPYRIGHT">COPYRIGHT</a></h1><p>
                                                                                                                              
                                                                                                                              WebMake is distributed under the terms of the GNU Public License.
                                                                                                                              <hr />
                                                                                                                               <h1><a name="AVAILABILITY">AVAILABILITY</a></h1><p>
                                                                                                                                
                                                                                                                                The latest version of this library is likely to be available from CPAN as
                                                                                                                                well as:
                                                                                                                                <p>
                                                                                                                                  <pre>  <a href="http://webmake.taint.org/">http://webmake.taint.org/</a>
</pre><hr />
                                                                                                                                  <h1>Text::EtText::LinkGlossary</h1><!-- INDEX BEGIN -->
                                                                                                                                  <ul>
                                                                                                                                    <li>
                                                                                                                                      <a href="#NAME">NAME</a><li>
                                                                                                                                        <a href="#SYNOPSIS">SYNOPSIS</a><li>
                                                                                                                                          <a href="#DESCRIPTION">DESCRIPTION</a><li>
                                                                                                                                            <a href="#METHODS">METHODS</a>
                                                                                                                                          </ul>
<!-- INDEX END -->
                                                                                                                                                                                                                                                                                    <hr />
                                                                                                                                           <h1><a name="NAME">NAME</a></h1><p>
                                                                                                                                            
                                                                                                                                            Text::EtText::LinkGlossary - interface for EtText link glossaries to
                                                                                                                                            implement.
                                                                                                                                            <hr />
                                                                                                                                             <h1><a name="SYNOPSIS">SYNOPSIS</a></h1><p>
                                                                                                                                              <pre>  use Text::EtText::LinkGlossary;
</pre><p>
                                                                                                                                                <pre>  @ISA = qw(Text::EtText::LinkGlossary);
</pre><p>
                                                                                                                                                  <pre>  sub open { ... }
  sub close { ... }
  ...
</pre><hr />
                                                                                                                                                   <h1><a name="DESCRIPTION">DESCRIPTION</a></h1><p>
                                                                                                                                                    
                                                                                                                                                    The <code>Text::EtText::LinkGlossary</code> is an interface which allows EtText to support ''link glossaries'',
                                                                                                                                                    persistent collections of link text and its corresponding HREF.
                                                                                                                                                    <p>
                                                                                                                                                      
                                                                                                                                                      The interface which needs to be implemented is as follows:
                                                                                                                                                      <hr />
                                                                                                                                                       <h1><a name="METHODS">METHODS</a></h1><dl>
                                                                                                                                                        <dt>
                                                                                                                                                          <strong><a name="item__g_open_">$g-&gt;open()</a></strong>
                                                                                                                                                        </dt>
                                                                                                                                                        <dd>
                                                                                                                                                          <p>
                                                                                                                                                            
                                                                                                                                                            Open the link glossary <code>$g</code> for reading and writing.
                                                                                                                                                            
                                                                                                                                                          </dd>
                                                                                                                                                          <dt>
                                                                                                                                                            <strong><a name="item__g_close_">$g-&gt;close()</a></strong>
                                                                                                                                                          </dt>
                                                                                                                                                          <dd>
                                                                                                                                                            <p>
                                                                                                                                                              
                                                                                                                                                              Close the link glossary; no more links can be written or read.
                                                                                                                                                              
                                                                                                                                                            </dd>
                                                                                                                                                            <dt>
                                                                                                                                                              <strong><a name="item__url">$url = $g-&gt;get_link ($name)</a></strong>
                                                                                                                                                            </dt>
                                                                                                                                                            <dd>
                                                                                                                                                              <p>
                                                                                                                                                                
                                                                                                                                                                Get a named link from the glossary.
                                                                                                                                                                
                                                                                                                                                              </dd>
                                                                                                                                                              <dt>
                                                                                                                                                                <strong><a name="item__g_put_link">$g-&gt;put_link ($name, $url)</a></strong>
                                                                                                                                                              </dt>
                                                                                                                                                              <dd>
                                                                                                                                                                <p>
                                                                                                                                                                  
                                                                                                                                                                  Put a named link to the glossary.
                                                                                                                                                                  
                                                                                                                                                                </dd>
                                                                                                                                                                <dt>
                                                                                                                                                                  <strong>$url = $g-&gt;get_auto_link ($name)</strong>
                                                                                                                                                                </dt>
                                                                                                                                                                <dd>
                                                                                                                                                                  <p>
                                                                                                                                                                    
                                                                                                                                                                    Get a named automatic link from the glossary.
                                                                                                                                                                    
                                                                                                                                                                  </dd>
                                                                                                                                                                  <dt>
                                                                                                                                                                    <strong><a name="item__g_put_auto_link">$g-&gt;put_auto_link ($name, $url)</a></strong>
                                                                                                                                                                  </dt>
                                                                                                                                                                  <dd>
                                                                                                                                                                    <p>
                                                                                                                                                                      
                                                                                                                                                                      Put a named automatic link to the glossary.
                                                                                                                                                                      
                                                                                                                                                                    </dd>
                                                                                                                                                                    <dt>
                                                                                                                                                                      <strong><a name="item__keys">@keys = $g-&gt;get_auto_link_keys ()</a></strong>
                                                                                                                                                                    </dt>
                                                                                                                                                                    <dd>
                                                                                                                                                                      <p>
                                                                                                                                                                        
                                                                                                                                                                        Get a list of the names of automatic links stored in the glossary.
                                                                                                                                                                        
                                                                                                                                                                      </dd>
                                                                                                                                                                      <dt>
                                                                                                                                                                        <strong><a name="item__g_add_auto_link_keys">$g-&gt;add_auto_link_keys (@keys)</a></strong>
                                                                                                                                                                      </dt>
                                                                                                                                                                      <dd>
                                                                                                                                                                        <p>
                                                                                                                                                                          
                                                                                                                                                                          Add to the list of names of automatic links stored in the glossary.
                                                                                                                                                                          
                                                                                                                                                                        </dd>
                                                                                                                                                                      </dl>
                                                                                                                                                                      <hr />
                                                                                                                                                                      <h1>ethtml2text(1)</h1><!-- INDEX BEGIN -->
                                                                                                                                                                      <ul>
                                                                                                                                                                        <li>
                                                                                                                                                                          <a href="#NAME">NAME</a><li>
                                                                                                                                                                            <a href="#SYNOPSIS">SYNOPSIS</a><li>
                                                                                                                                                                              <a href="#DESCRIPTION">DESCRIPTION</a><li>
                                                                                                                                                                                <a href="#INSTALLATION">INSTALLATION</a><li>
                                                                                                                                                                                  <a href="#ENVIRONMENT">ENVIRONMENT</a><li>
                                                                                                                                                                                    <a href="#SEE_ALSO">SEE ALSO</a><li>
                                                                                                                                                                                      <a href="#AUTHOR">AUTHOR</a><li>
                                                                                                                                                                                        <a href="#PREREQUISITES">PREREQUISITES</a>
                                                                                                                                                                                      </ul>
<!-- INDEX END -->
                                                                                                                                                                                                                                                                                                                                                                            <hr />
                                                                                                                                                                                       <h1><a name="NAME">NAME</a></h1><p>
                                                                                                                                                                                        
                                                                                                                                                                                        ethtml2text - convert from HTML to the EtText editable-text format
                                                                                                                                                                                        <hr />
                                                                                                                                                                                         <h1><a name="SYNOPSIS">SYNOPSIS</a></h1><p>
                                                                                                                                                                                          <pre>  ethtml2text file.html &gt; file.txt
</pre><hr />
                                                                                                                                                                                           <h1><a name="DESCRIPTION">DESCRIPTION</a></h1><p>
                                                                                                                                                                                            
                                                                                                                                                                                            ethtml2text will convert a HTML file into the EtText editable-text format,
                                                                                                                                                                                            for use with webmake or ettext2html.
                                                                                                                                                                                            <p>
                                                                                                                                                                                              
                                                                                                                                                                                              For more information on the EtText format, check the WebMake documentation
                                                                                                                                                                                              on the web at <a href="http://ettext.taint.org/">http://ettext.taint.org/</a> .
                                                                                                                                                                                              <hr />
                                                                                                                                                                                               <h1><a name="INSTALLATION">INSTALLATION</a></h1><p>
                                                                                                                                                                                                
                                                                                                                                                                                                The <strong>ethtml2text</strong> command is part of the <strong>HTML::WebMake</strong> Perl module set. Install this as a normal Perl module, using <code>perl -MCPAN -e shell</code>, or by installing WebMake.
                                                                                                                                                                                                <hr />
                                                                                                                                                                                                 <h1><a name="ENVIRONMENT">ENVIRONMENT</a></h1><p>
                                                                                                                                                                                                  
                                                                                                                                                                                                  No environment variables, aside from those used by perl, are required to be
                                                                                                                                                                                                  set.
                                                                                                                                                                                                  <hr />
                                                                                                                                                                                                   <h1><a name="SEE_ALSO">SEE ALSO</a></h1><p>
                                                                                                                                                                                                     <code>webmake</code> <code>ettext2html</code> <code>ethtml2text</code> <code>HTML::WebMake</code> <code>Text::EtText</code><hr />
                                                                                                                                                                                                     <h1><a name="AUTHOR">AUTHOR</a></h1><p>
                                                                                                                                                                                                      
                                                                                                                                                                                                      Justin Mason &lt;jm /at/ jmason.org&gt;
                                                                                                                                                                                                      <hr />
                                                                                                                                                                                                       <h1><a name="PREREQUISITES">PREREQUISITES</a></h1><p>
                                                                                                                                                                                                         <code>HTML::Entities</code><hr />
                                                                                                                                                                                                        <h1>ettext2html(1)</h1><!-- INDEX BEGIN -->
                                                                                                                                                                                                        <ul>
                                                                                                                                                                                                          <li>
                                                                                                                                                                                                            <a href="#NAME">NAME</a><li>
                                                                                                                                                                                                              <a href="#SYNOPSIS">SYNOPSIS</a><li>
                                                                                                                                                                                                                <a href="#DESCRIPTION">DESCRIPTION</a><li>
                                                                                                                                                                                                                  <a href="#INSTALLATION">INSTALLATION</a><li>
                                                                                                                                                                                                                    <a href="#ENVIRONMENT">ENVIRONMENT</a><li>
                                                                                                                                                                                                                      <a href="#SEE_ALSO">SEE ALSO</a><li>
                                                                                                                                                                                                                        <a href="#AUTHOR">AUTHOR</a><li>
                                                                                                                                                                                                                          <a href="#PREREQUISITES">PREREQUISITES</a>
                                                                                                                                                                                                                        </ul>
<!-- INDEX END -->
                                                                                                                                                                                                                                                                                                                                                                                                                                                <hr />
                                                                                                                                                                                                                         <h1><a name="NAME">NAME</a></h1><p>
                                                                                                                                                                                                                          
                                                                                                                                                                                                                          ettext2html - convert from the simple EtText editable-text format into HTML
                                                                                                                                                                                                                          <hr />
                                                                                                                                                                                                                           <h1><a name="SYNOPSIS">SYNOPSIS</a></h1><p>
                                                                                                                                                                                                                            <pre>  ettext2html file.txt &gt; file.html
</pre><hr />
                                                                                                                                                                                                                             <h1><a name="DESCRIPTION">DESCRIPTION</a></h1><p>
                                                                                                                                                                                                                              
                                                                                                                                                                                                                              ettext2html will convert a text file in the EtText editable-text format
                                                                                                                                                                                                                              into HTML.
                                                                                                                                                                                                                              <p>
                                                                                                                                                                                                                                
                                                                                                                                                                                                                                For more information on the EtText format, check the WebMake documentation
                                                                                                                                                                                                                                on the web at <a href="http://ettext.taint.org/">http://ettext.taint.org/</a> .
                                                                                                                                                                                                                                <hr />
                                                                                                                                                                                                                                 <h1><a name="INSTALLATION">INSTALLATION</a></h1><p>
                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                  The <strong>ettext2html</strong> command is part of the <strong>HTML::WebMake</strong> Perl module set. Install this as a normal Perl module, using <code>perl -MCPAN -e shell</code>, or by installing WebMake.
                                                                                                                                                                                                                                  <hr />
                                                                                                                                                                                                                                   <h1><a name="ENVIRONMENT">ENVIRONMENT</a></h1><p>
                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                    No environment variables, aside from those used by perl, are required to be
                                                                                                                                                                                                                                    set.
                                                                                                                                                                                                                                    <hr />
                                                                                                                                                                                                                                     <h1><a name="SEE_ALSO">SEE ALSO</a></h1><p>
                                                                                                                                                                                                                                       <code>webmake</code> <code>ettext2html</code> <code>ethtml2text</code> <code>HTML::WebMake</code> <code>Text::EtText</code><hr />
                                                                                                                                                                                                                                       <h1><a name="AUTHOR">AUTHOR</a></h1><p>
                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                        Justin Mason &lt;jm /at/ jmason.org&gt;
                                                                                                                                                                                                                                        <hr />
                                                                                                                                                                                                                                         <h1><a name="PREREQUISITES">PREREQUISITES</a></h1><p>
                                                                                                                                                                                                                                           <code>HTML::Entities</code><hr />
                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                        </td>
                                                                                                                                                                                                                                      </tr>
                                                                                                                                                                                                                                    </table>
                                                                                                                                                                                                                                  </td>
                                                                                                                                                                                                                                </tr>
                                                                                                                                                                                                                              </table>
                                                                                                                                                                                                                            </td>
                                                                                                                                                                                                                          </tr>
                                                                                                                                                                                                                        </table>
                                                                                                                                                                                                                        <table width="100%">
                                                                                                                                                                                                                          <tr>
                                                                                                                                                                                                                            <td valign="top">
                                                                                                                                                                                                                               <strong><a href="http://ettext.taint.org/">EtText</a>
                                                                                                                                                                                                                               Documentation</strong> (version 2.2)
                                                                                                                                                                                                                               
                                                                                                                                                                                                                            </td>
                                                                                                                                                                                                                            <td valign="top">
                                                                                                                                                                                                                              <div align="right">
                                                                                                                                                                                                                                
                                                                                                                                                                                                                                 [ <a href="ethtml2text.html">Back</a> | <a href="blurb.html">Forward</a> | <a href="index.html">Index</a>
                                                                                                                                                                                                                                 | <a href="allinone.html">All&nbsp;In&nbsp;One</a> ]
                                                                                                                                                                                                                                 
                                                                                                                                                                                                                              </div>
                                                                                                                                                                                                                            </td>
                                                                                                                                                                                                                          </tr>
                                                                                                                                                                                                                        </table>
                                                                                                                                                                                                                        <div align="right">
                                                                                                                                                                                                                           <a href="http://webmake.taint.org/"> <img src="images/BuiltWithWebMake.png" border="0" width="88" height="31" /></a>
                                                                                                                                                                                                                        </div>
                                                                                                                                                                                                                      </font>
                                                                                                                                                                                                                    </body>
                                                                                                                                                                                                                  </html>