GutenMark Usage Page
Attractively formatting Project Gutenberg texts
[home]    [download]    [usage]

Contents

GutenMark Tutorial
Features
Wish List
What if I want to ...
Software Developers

GutenMark Tutorial

GutenMark is a command-line utility, so you have to use it from the Win32 "MS-DOS Prompt" or from the Linux/UNIX/BSD/MacOS-X command shell:
GutenMark [options] [inputfile [outputfile]]
For example,
GutenMark tomco10.txt tomco10.html
Other possibilities are to use the program in "filter" style:
GutenMark tomco10.txt >tomco10.html
     or
GutenMark <tomco10.txt >tomco10.html
Because GutenMark is intended to be fully automatic, there are very few options:
 
Option
Description
--help
Displays a list of the available options.
--no-justify
Outputs paragraphs in ragged-right format.  The default format is right-justified.  This option is useful if the htmldoc utility is used to convert HTML to Postscript because htmldoc is (or has been) buggy in regard to right-justfication.


Features

Here are some of the things GutenMark does:

Wish List

Some of the items below represent things that are merely hard to accomplish, whereas others are simply not possible because the information that would be needed to accomplish them is not present in the PG files.  But I still can wish ... In general, the closer the etext conforms to PG guidelines, the better GutenMark can handle it.


What if I want to ...

First, if you want to do any of the things mentioned in the previous section -- you can't!

But seriously, as I am writing this there haven't yet been any "howto" questions that I can answer.  If and when there are some, I'll put the answers here.


Software Developers

I don't know at the time this is being written whether anyone will want to contribute features or bug-fixes to GutenMark, so I haven't really allowed any way to do it.  If you want to do so, I'd suggest communicating the changes directly to me.  If there's enough interest, I'll set up a CVS repository at SourceForge later.

Oh, and I know that the code isn't very pretty.  I was really just throwing together a proof-of-concept, and it started being useful much more quickly than I thought it would.  Perhaps I'll pretty it up later.



Last updated 11/02/01 by RSB.  Contact me.