README
1
2Welcome to EtText!
3------------------
4
5EtText is a simple plain-text format which allows conversion to and from HTML.
6Instead of editing HTML directly, it provides an easy-to-edit, easy-to-read and
7intuitive way to write HTML, based on the plain-text markup conventions we've
8been using for years.
9
10Like most simple text markup formats (POD, setext, etc.), EtText markup handles
11the usual things: insertion of P tags, header recognition and markup. However
12it also adds a powerful link markup system.
13
14EtText markup is simple and effective; it's very similar to WikiWikiWeb
15TextFormattingRules or Zope's StructuredText.
16
17EtText is distributed under the same licensing terms as Perl itself.
18
19Name DSLI Description Info
20------------- ---- -------------------------------------------- -----
21Text::EtText RmpO editable-text format for HTML output JMASON
22
23---------------------------------------------------------------------------
24
25INSTALLATION
26------------
27
28For all UNIX platforms:
29-----------------------
30
31Untar the .tar.gz file, and "cd" into the directory. Then run:
32
33 perl Makefile.PL
34 make
35 make install (as root)
36
37That will install the Text::EtText modules and the commands "ettext2html" and
38"ethtml2text".
39
40---------------------------------------------------------------------------
41
42For Windows using ActiveState Perl or IndigoPerl:
43-------------------------------------------------
44
45Unzip the .zip distribution, and "cd" into the directory created. Then
46run:
47
48 perl windows_install.pl
49
50This will generate some .bat files which allow you to run the scripts
51from that directory.
52
53If this command fails, you probably do not have Perl installed, or the
54directory it's installed in is not in your PATH. Check this and try
55again.
56
57---------------------------------------------------------------------------
58
59For Windows using ActiveState Perl, or IndigoPerl, and NMAKE:
60-------------------------------------------------------------
61
62Another way to install WebMake is as a traditional Perl module, using
63"perl Makefile.PL" and Microsoft's NMAKE, included with MS DevStudio.
64Here's what one user has to say on this subject:
65
66 nmake works nicely, and the installation process looks the same as on
67 other platforms.
68
69 My understanding is that nmake.exe is available for free from Redmond.
70 In fact I downloaded it just a few minutes ago, following the
71 suggestion found on the IndigoPerl home page:
72
73 Installing CPAN modules requires that you have Microsoft DevStudio
74 or nmake.exe installed. If you are installing modules that contain
75 xs files, then you need DevStudio, otherwise you only need
76 nmake.exe. You can download nmake from [the url below].
77
78 Run the self-extracting exe and copy nmake.exe to the perl\bin
79 directory.
80
81[the URL is:
82http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe
83]
84
85 Nmake15.exe expands to nmake.exe (64K) and Nmake.Err (5k) - a text
86 file. I copied both to C:\perl\bin, then renamed nmake.exe to
87 make.exe and now I can pretend to be on Unix:
88
89 H:\devperl\Text-EtText-0.5>makefile
90 Writing Makefile for Text::EtText
91
92 H:\devperl\Text-EtText-0.5>make ...
93
94 H:\devperl\Text-EtText-0.5>make test
95 ...
96
97The upshot is: if you download NMAKE, rename it to "make.exe", and install
98it in your path, Perl can install modules just fine using the traditional
99perl module install procedure on Windows. In fact, it may be possible to
100simply use NMAKE as "nmake.exe" instead of "make.exe", from the look of
101it.
102
103---------------------------------------------------------------------------
104
105For Macs using MacPerl:
106-----------------------
107
108(haven't tried yet. TODO)
109
110---------------------------------------------------------------------------
111
112