MakeDocJ v3.5.1

This program was created to make it easier to create documents for the PalmPilot. The biggest feature this program offers over the other text file to PilotDOC programs is the ability to have preset bookmarks. I found MakeDocJ originally written by Pat Beirne, fixed the bugs, and added the ability to generate bookmarks directly into the PilotDOC. The regular expression text search routines are provided by the package gnu.regexp. The full package can be found at http://www.cacas.org/java/gnu/regexp/.

It is possible to process more than one file by using a file to indicate the options. To indicate the file containing the options, precede the file with '@'. MakeDocJ will read this and each line is considered a complete command line. See Example\options.BSA_Advancement for more information.

Terms of Use The MakeDocJ is distributed under the terms of the GNU Lesser General Public License. The lesser.txt file included in the distribution contains the details. This program is free software. You are encouraged to adapt it to your own needs, and contribute to the program's ongoing development.

NOTE: Requires Java Runtime Environment or Java Development Kit 1.1.7a or higher. Tested with Java 2 (Java Development Kit 1.2.x, 1.3.x).

Usage: of runj
Java 1.1.x:Replace runj with java -classpath %CLASSPATH%;MakeDocJ.jar MakeDocJ
Java 2.x:Replace runj with java -jar MakeDocJ.jar to use the Java 2 Runtime Environment.

Tested on the following platforms: Windows 95, Windows 98, Windows NT, Solaris 2.6

History


Encode a PilotDOC file:
runj [-options] <text-file> <PilotDOC-file> <story-name> <bookmark-file>

-c compress multi-linefeeds out of <text-file>
-i <database ID> four character database ID
-n builds the PilotDOC file without compression
-q quiet (i.e. minimal reporting during encoding process)
-r remove binary
-t database ID is TealDoc instead of generic reader

Format of <bookmark-file>:
<bookmark>,<string-to-search>
<bookmark>
= Text to be displayed as bookmark, can be up to 16 characters
<string-to-search>
= optional (if not specified, <bookmark> is used), can be regex. NOTE: Only the first occurrence of a given bookmark is recorded.

Decode a PilotDOC file:

runj -d [-options] <PilotDOC-file> <text-file>

-d decodes the PilotDOC file into a text file
-1 end of line is CR/LF (i.e. DOS)
-2 end of line is CR (i.e. MAC)
-b generate a bookmark file (<text-file>.bm) if there are any bookmarks

Based on code was originally written by Pat Beirne (MakeDocJ, MakeDoc)
MakeDocJ v3.5.1

If database name is longer than 31 character, last three characters are replaced with '...'

First release of Native Win32 executable. Contained in Win32 directory.

Moved MakeDocJ.jar under Java directory.


MakeDocJ v3.5

Replace javaregex package with gnu.regexp package. Since the source for MakeDocJ is available, I felt it was more appropriate to use a regular expression package that had the sources freely available also.

Internally had typeID and creatorID reversed. This had NO adverse affects on anything generated by MakeDocJ.


MakeDocJ v3.4

Really generates a correct modification date to store in the PilotDoc.

Doesn't add "extra" 2 bytes with encoding. These 2 bytes are found when the PilotDoc in downloaded from the Palm device. Can properly decode with or without these bytes.


MakeDocJ v3.3

Based on documentation at www.RoadCoders.com changed how the PilotDoc is being built.

Correctly generate creation and modification dates to be from January 1, 1904.

Added -p to set the private bit in the PilotDoc file.


MakeDocJ v3.2

Fixed a problem when specifying regular expressions for bookmarks. The regular expression was ignored.

If all bookmarks are not found, the PilotDoc file is deleted. This is because the internal indexes will be incorrect.

Renamed classes to be inline with "Java Coding Standards"

Compression is now fully inline with the original unixdoc/makedoc.


MakeDocJ v3.1

When specifying bookmarks, if only the name of the bookmark is specified, we will really search the text. Also, regular expressions are not used if only the name is specified.

Fixed another compression corruption error. i believe these have all been found and fixed. This was do to the fact the Java doesn't have unsigned data types. Will have to remember this when porting other C/C++ programs to Java.

Added the ability to add comments to the bookmark file. Any line beginning with a '!' will be ignored as a comment.

Split the code up more so it can be used in other stuff.


MakeDocJ v3.0

Added -c to compress multi-linefeeds out of the when encoding.

Read the entire into memory, then do processing. This speeds the entire encoding operation at the cost of consuming RAM. It is necessary to have about twice as much free RAM as the largest file to process for the various buffers used.

Fixed a couple of bugs in the textBuffer::compress. No longer seems to corrupt the compressed data.


MakeDocJ v2.1

Added the ability to specify a file of command lines. This allows for multiple files to be processed.

Never released to public


MakeDocJ v2.0

First version released by Jeffrey A. Krzysztow

Mostly bug fixes to original code and convert to my style of coding.

Added the ability to specify preset bookmarks.