.
_K Keep "As Is". Enclose in .
_X End. Exit the current mode.
Lines beginning with these special characters will be parsed as follows:
~ Highlight line in bold ().
! Highlight line in bold (), and add break (
) at end.
How Tagged Files Are Processed
------------------------------
The first 3 lines of a tagged file should contain the following information
about the book:
1. Title This is printed at the top and bottom of each chapter page and
serves as a link back to the index page.
2. Author This is used only once near the top of the index page (just below
the title of the book).
3. Etext # This is used in a string at the top and bottom of the index page.
After the 3 information lines, the next part of the file is assumed to be the
Project Gutenberg Information (included at the top of each PG etext). This PG
Info will be written to a file called "-pg.html" until gTextCvt
encounters the first Stop tag. A Stop tag can be either a StopChapter or
NewCaption tag. When the first Stop tag is encountered, gTextCvt closes the
PG Info file and starts a new file. This new file is the first chapter file
and gTextCvt continues writing to it until it encounters another Stop tag.
Each subsequently encountered Stop tag will close the current file and start a
new one until the end of the tagged etext file is reached.
The Heading tag is used to specify that the next line should be used as a main
entry in the index file. The SubHeading tag is used to specify that the next
line should be used as a sub-entry in the index file. Main entries are links
that point to chapter files, while sub-entries point to specific sections of a
chapter file.
Note: Newer Project Gutenberg eBooks have PG info at the top and bottom of the
file. To avoid having 2 separate HTML pages with PG info, it may be a good
idea to Cut&Paste the PG info from the bottom of the file to somewhere near the
top of the file. Ideally, the bottom PG info should be moved to a location
that is _after_ the top PG info and _before_ the first Stop tag.
Options
-------
"BaseName" is used to name the newly-created HTML files.
"Digits" specifies how many digits to use when naming sequential files (e.g., 3
means that files will be named BaseName001, BaseName002, and so on).
"Use BaseName for Index File" specifies that BaseName should be used as the
main index file (otherwise, index.html is used). Use this option if you plan
to keep several eBooks in the same directory.
"Head Style" specifies which H value to use for main topics.
"Sub" specifies which H value to use for subtopics.
"Graphical Nav Buttons" specifies that bitmaps should be used for the
navigation buttons at the top and bottom of each HTML page. The bitmaps must
be named "prev.jpg" and "next.jpg" and must reside in the same directory as the
HTML files.
Book > HTML PRE
===============
This is basically the same as Book To HTML (see above) except that the text
will be enclosed in HTML and
tags. This essentially leaves the
body of the text "as is".
Text > Dict Source Data
=======================
This creates a tagged Dict Source Data file which can then be used to create
the actual Dict DZ and Index files.
The conversion starts by creating the following 3 keywords (dictionary entries)
at the top of the output file: 00-database-url, 00-database-short, and
00-database-info. The first part of the input text file is assumed to be
introductory text describing the dictionary. This introductory text will be
appended to the 00-database-info topic. When gTextCvt encounters at least 2
blank lines, the next non-blank line is assumed to be a new keyword. The text
following this new keyword becomes the body of the definition until another
series of blank lines are encountered. This process continues until the end of
the text file is reached.
Note 1: If your dictionary has no introductory text (i.e., it begins with a
dictionary keyword instead), you'll need to insert at least 2 completely blank
lines (with no spaces) at the top of the file.
Note 2: If you need more than one blank line inside of a definition, you can
use lines consisting of one or more spaces to give them the appearance of being
blank lines.
Dict Source Data > Dict Dz
==========================
This creates the actual Dict files (xxxx.dict.dz and xxxx.index) to be used
by the dictd server. The Dict Source Data should have the following three
keywords (dictionary entries) at the top of the file:
00-database-short A short name for the dictionary (e.g., "New Dictionary").
00-database-url The site where the original database can be found.
00-database-info Can be any kind of pertinent introductory info.
The Dict Source Data file is processed as follows:
:entry: Use "entry" as a dictionary entry. The text following this entry
becomes the body of the dictionary definition, until a new entry
is encountered.
{keyword} Use "keyword" as an index entry. Index entries are words that
correspond to dictionary entries. Therefore, "keyword" must be a
valid entry in the current dictionary.
After creating the xxxx.dict file, gTextCvt will try to compress it using
dictzip to create xxxx.dict.dz. dictzip is part of the dictd package, so if
you don't end up with a dict.dz file, it probably means that you don't have
dictd installed.
After creating the xxxx.index file, gTextCvt will try to sort the lines in that
file using sort. AFAIK, all GNU/Linux systems include sort, so there shouldn't
be a problem here. However... it appears that some versions of sort ignore the
-d (dictionary order) option. If you come across missing entries (ones that
you know are in the dictionary, but aren't being found by the dict client), a
possible cause might be incorrectly sorted lines in the index file. If the
index file is fairly small, you can try editing it manually moving lines in the
correct order. Otherwise, you can try sorting the index on a different distro
(Debian machines are known to include a version of sort that works correctly).
Sort the file using: sort -df [name2].index > [name].index
Text > HTML
===========
In this mode, the contents of an input file are read and placed inside a set of
HTML header and footer tags.
Text > HTML BODY Only
=====================
This is basically the same as Text To HTML (see above) except that no HTML
header () or footer () is added to the output file.
The output is meant to be copied and pasted into an existing HTML file.
Text > HTML Index Entries
=========================
This is basically only useful if you're creating something like a dictionary in
HTML format, where the index consists of several sub-links that point to the
same page. The output from this mode is meant to be copied and pasted into an
index.html file.
In this mode, the input file is read 3 lines at a time. The 3 lines are then
inserted inside and pairs. The output will be something like:
line1, line2, line3,
line4, line5, line6,
In the ouput file, the filename "tmpname.html" should be changed (using a text
editor's "Search & Replace") to whatever filename the sub-links point to.
Text > HTML PRE
===============
This is basically the same as Text To HTML (see above) except that the text
will be enclosed in HTML and
tags. This essentially leaves the
body of the text "as is".
Text > HTML Contents Table
==========================
This reads an input file and creates an HTML file containing a table. Each
line of the input file is inserted 3 times to create an entry of the form
"| line | line |
".
Text > HTML Table Data
======================
This also reads an input file and creates an HTML file containing a table.
However, the input file should be a tab-delimited text file (usually exported
from a spreadsheet file) and there should be no more than 1 tab character
separating the fields.
HTML > Text
===========
In this mode, an HTML input file is read to produce an output file with the
HTML tags stripped. Processing procedes as follows:
- When gTextCvt encounters a '<' character, a flag is set indicating that we
are now inside of an HTML tag. The following characters are ignored until a
'>' is encountered.
- When gTextCvt encounters a '>' character, the "In Tag" flag is cleared and
the following characters are written to the output file until the next '<'.
Note: If the HTML input file contains '<' or '>' characters which are not used
to specify HTML tags, the characters should be replaced with "<" (less than)
and ">" (greater than) strings (or any other unique strings) which can later
be replaced with '<' and '>'.
==============================================================================
Miscellaneous Notes
==============================================================================
The File|Save menu item writes the current contents of the editor to the file
named in the 'Src' field, NOT the file named in the 'Dst' field. The file or
directory named in the 'Dst' field is used as the destination path when the
[Convert] button is pressed. It's important not to confuse the two.