Readme for MakeDocW.txt ----------------------- Author: Mark Pierce Updated: 13th March 1997 Version: 0.7 Comments to: Mark_Pierce@compuserve.com Updates from: http://ourworld.compuserve.com/homepages/Mark_Pierce Copyright 1996,1997 Mark Pierce All Rights Reserved MakeDocW works with Windows 95/NT4. These notes should help you get the most out of the software. When reporting bugs or making comments, please state the version number of MakeDocW which you have used. Conversion ---------- This tab allows you to select and convert files, and optionally install the converted documents onto the Pilot. The "Browse" button lets you select multiple files for conversion. If you uncheck "Title", the titles of the output file(s) will be the same as the filename(s). When checked, you can specify your own title (caution: 32 chars max). If you are using splitting, allow for a space and the section number, which will be appended automatically to the title of each generated .PRC file. You can disable compression, if you want... When "Auto-Install" is checked, the converted files will be marked for automatic transfer to your Pilot on the next HotSync. If more than one Pilot gets "HotSunc" on your PC, you can choose which Pilot to install onto. See the "Advanced" tab for information on removing intermediate .PRC files. The "Category" selection allows you to nominate a Pilot Doc category for the .PRC file which is created (see the notes on the "Categories" tab). Line Breaks ----------- The "CR/LF Removal" radio buttons allow you exclude _all_ occurrences of _one_ of these characters, if desired. The "CR/LF Translation" radio buttons allow you to convert Carriage Return characters into Line-Feeds, or vice-versa. Section Splitting ----------------- You can specify minimum and maximum limits for the sections into which a document will be split. Note that these figures relate to _uncompressed_ size (at present). The minimum section size is 4 KB (this does _not_ prevent you converting files which are smaller than 4K). If the max section size is set less than the minimum, this will be corrected when the "Convert" button is pressed. "No Splitting" allows you to disable the section-splitting feature. "Output Base Name" must be filled in if splitting is enabled. The output .PRC files will be named with consecutive numbers appended to the base name. Not sure if Pilot can handle > 8 chars, so allow for the appended text when choosing a base name (6 chars should usually be OK). "Heading Tag" allows you to specify a single word which will introduce the start of each chapter. This allows much better splitting of big files, if the source contains such tags. The string is treated _case-sensitively_, ie "Chapter" does _not_ match "CHAPTER". This can be left blank if you don't want to use this feature. "Heading Pattern" allows a bit more sophistication in section finding. The characters in this field are interpreted as follows: 0 means optional numeric 9 means required numeric A means upper case alpha a means lower case alpha X means any character By including a pattern, you can prevent false section breaks occurring when the heading tag appears elsewhere in the body of the text. You can leave this field blank to bypass the feature. If the heading tag is left blank (or cannot be found in the source text), The section splits will be made where a line-break immediately follows a full stop, question or exclamation mark (or a double-quote immediately preceded by one of these). This approach usually results in a clean break between paragraphs. Advanced -------- "Ignore Single Line-Breaks" is useful for retaining paragraph breaks in (eg) Gutenberg files. Any 2 consecutive line-breaks will be converted to a _single_ break in the output file. "Tabs --> Line-Breaks" causes a new-line to be substituted for a Tab character (useful for paragraphing some documents). "Allow Low ASCII Codes" overrides the default MakeDocW behaviour, which is to ignore all ASCII characters below 9. "Remove HTML Tags" causes removal of all text between "<" and ">" brackets. In addition, valid HTML character entities (introduced by an ampersand, "&" and terminated by a semicolon, ";") are substituted with extended ASCII characters (not fully tested). "Remove Intermediate Files After Auto-Install" is useful for preventing your disk getting clogged with converted .PRC files. When the "Auto-Install" feature is used, the intermediate files are erased after being transferred to the Pilot desktop's Install sub-directory. Note that, in the case of a failed HotSync, these files will be retained in the Install sub-directory. Original text source files are never erased. "Pilot File Extension" allows the output files to be named as .PDB, etc. No dot "." character is required in this parameter. Categories ---------- Use these fields to set up duplicates of your Doc category names (sorry, they can't be automatically read from the Pilot without a Doc conduit, which is hardly worthwhile since Doc files are read-only on the Pilot). Once set up, the categories can be selected using the "Category" option on the "Conversion" tab. If you set up categories which do not match those in Doc, .PRC files created for these categories will be installed as "Unfiled".