<?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: Using EtText
</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="contributors.html">Back</a> | <a href="lists.html">Forward</a> | <a href="index.html">Index</a>
| <a href="allinone.html">All In 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>Using EtText</h2><p>
Like most simple text markup formats (POD, setext, etc.), EtText markup
handles the usual things: insertion of <em><P></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 setext, 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><p></strong> and
<strong></p></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>**text**</code>
</td>
<td width="30%">
<strong>
</td>
<td width="30%">
<strong>text</strong>
</td>
</tr>
<tr>
<td width="30%">
<code>__text__</code>
</td>
<td width="30%">
<em>
</td>
<td width="30%">
<em>text</em>
</td>
</tr>
<tr>
<td width="30%">
<code>##text##</code>
</td>
<td width="30%">
<code>
</td>
<td width="30%">
<code>text</code>
</td>
</tr>
</table>
</p>
</blockquote>
<p>
<strong>&</strong> signs that have whitespace on either side will be converted
to <strong>&amp;</strong> signs automatically.
</p>
<p>
Text indented from the left margin will be converted into a <strong><P></strong>
paragraph wrapped in a <strong><blockquote></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 <pre> 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{text}</code>
</p>
</blockquote>
<p>
will be rendered as
</p>
<blockquote>
<p>
<code><strong>text</strong></code>
</p>
</blockquote>
<p>
or, in other words, <strong>text</strong> . This can be nested, so <code>strong{text
with i{italic} bits}</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{foo}</code>
</p>
</blockquote>
<p>
will be rendered as
</p>
<blockquote>
<p>
<code><i class="green>foo</i></code>
</p>
</blockquote>
<p>
Mail headers, and mail messages, are now marked up automatically.
</p>
<p>
</p>
</p>
</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="contributors.html">Back</a> | <a href="lists.html">Forward</a> | <a href="index.html">Index</a>
| <a href="allinone.html">All In 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>