Description

Thank you for trying TealDoc. A powerful but intuitive reader for standard PalmPilot document files TealDoc offers advanced functionality such as bookmarks, automatic scrolling, imbedded images, and document linking.

Contents

This archive contains the following files:

Program files:

TEALDOC.PRC The TealDoc program file

MKTLDOC.EXE TealDoc creation/encoding/password utility

STATESDC.PRC Sample PalmPilot document demonstrating images

STATESIM.PDB Image data for sample document

Document files:

DOCDOC.PDF This document in Adobe Acrobat (PDF) format

DOCDOC.HTM This document in HTML format (sans images)

DOCDOC.PRC This document in TealDoc format

DOCDOC.SRC Sample source to the manual doc

REGISTER.HTM TealPoint Registration form in HTML format

REGISTER.TXT TealPoint Registration form in text format

Installing

Use the Palm Install Tool that comes with your organizer to install the program file TEALDOC.PRC. For it to be useful, you’ll also need to install some document files, available on our web site or most software archive sites like MemoWare.com or PalmGear HQ (http://www.palmgear.com/). This manual is provided in this archive as the PalmPilot document DOCDOC.PRC. A sample document US State Data is also provided. It demonstrates the image capabilities in TealDoc. To view it, install both the files STATESDC.PRC and STATESIM.PDB.

Instructions on how to use the Palm installer are in the Palm Handbook that came with your Pilot, PalmPilot, or WorkPad.

Using the Program

TealDoc is easy to use, and consists of two basic interface screens.

Document Selection Screen

The first screen, the Document selection screen, appears when you first run TealDoc. On it, is a list of all document files installed in the PalmPilot under the current category. You can select or edit categories by clicking on the category selection button in the upper right hand corner of the screen. When you click on a listed document file, you can either open that document for reading, to change its category, or to delete it permanently from the PalmPilot memory. To change the action performed, click on the action-selection buttons at the bottom of the screen.

If you choose to display the documents in a sorted list (under preferences), you can scroll through a long list of documents to items starting in a particular letter by entering the graffiti stroke for that letter.

Warning: Do not use the Palm Application launcher to delete documents, as the Palm OS groups files together under a single heading, and you can end up deleting all of your documents at once. Use the provided interface in TealDoc instead.

Document Browsing Screen

When you open a document file for reading, you are brought to the file browsing screen, which is divided into two regions; a large display/selection region at the top of the screen, and a control panel at the bottom.

The display/selection area shows a window into the document file. It can be clicked on to either scroll the screen or select text for copying to another application. To choose the operation performed, change the setting in TealDoc’s Preferences Menu, described below. When scrolling, you click in the top half of the screen to scroll up, the bottom to scroll down. You can scroll either one line at a time, one page at a time, or a partial page, which is a full page minus one overlapping line. This setting too can be found in the Preferences menu screen. If you hold down the pen, the screen will continue to scroll. The closer to the top or bottom of the screen you go, the faster scrolling will occur.

Close and Back Buttons

In the lower left corner of the document browsing screen are two buttons. On the left, the close button contains an 'x' and will return you to the document selection screen.

On the right is the return arrow. You can press it while browsing to return the browser to its previous position after performing a find, clicking on a link, or seeking in the document using the drag bar on the seek control panel.

Font/Find Panel

Besides the close and back buttons, the font/find panel has six buttons. The first, the percentage display button, also functions to switch between the font/find panel and the scroll panel. The last button is used for creating and selecting bookmarks (described later in this document), and the one to its left is used to set the current display font. The middle three buttons, for find functions, are respectively: Find-Previous, Find-New, and Find-Next. Click on Find-New the first time you do a search, one of the other two to continue the same search in a particular direction. When you perform a find operation in this manner (not the global system find using the silk-screened find button), you have four options in addition to your choice of text to search for.

Find options include:

§ Case Sensitive - Found string must match upper/lower case

§ Anchor Left - Found string must be the start of a word

§ Anchor Right - Found string must be the end of a word

§ Reverse Search - Search going backwards from the current position

If you select both Anchor Left and Anchor Right, then the entered text must be an isolated word, not a part of some other word.

When performing a find operation, you can abort the find by pressing any hardware button, such as the page-up button.

Scroll Panel

The scroll panel allows you to quickly go to any part of the file, or to control TealDoc's autoscroll mode. To go to another part of a file, click on the top drag bar on the panel and drag it all the way to the left for the start of the file, all the way to the right for the end, or anywhere in between to go somewhere in the middle of the file.

TealDoc provides an AutoScroll feature to allow you to conveniently step forward through a file in a hands-off operation. When autoscroll is on, the file automatically steps forward or backwards through the file line-by-line.

There are four buttons at the bottom of the scroll panel control auto-scroll operation. These are the auto-scroll control buttons. In the center between the four buttons is a speed bar that indicates the current forward or backwards speed. To the right of the control buttons is a small display bar showing the state and speed of the auto-scroll. When auto-scroll is active, the bar is solid. When inactive, the bar is hollow. The length of the bar indicates the scrolling speed and direction.

From left to right, the auto-scroll control buttons are STOP, GO, SLOWER (backward), and FASTER (forward). The four application buttons on the Pilot correspond to the autoscroll control buttons, and can be mapped to substitute for them in the Preferences Menu Screen. The application button can be made to control autoscroll when either the scroll panel is up, the font panel is up, all the time, or never.

Bookmarks

You can mark your current location in the file as a bookmark by creating a named bookmark using the button in the far lower right corner of the display. This button brings up a list of current bookmarks that work using the familiar category-selection interface. Select a bookmark to immediately move to that location.

Automatic bookmarks are imbedded into many document files using markers defined at the end of the file and enclosed in “<>” symbols. For instance, placing "<(BM)>" at the bottom of a document file will cause all other instances of "(BM)" in the document to be found when the document is scanned for bookmarks. The rest of the line of text following the mark is used as the bookmark's name.

TealDoc also supports more advanced automatic bookmarks, which can be defined with specific text that does not appear in the document itself.

By default, when a document file is first opened, it is automatically scanned for both such marks. A bookmark is automatically created for each instance found. As this will cause a slight delay when you open a new document for the first time, you may wish to turn this feature off. You can do so using the Preferences Menu, and perform the scan later using the Scan for Bookmarks menu item.

To manually scan for bookmarks, choose the Custom Scan option. Enter a search string and options, and when you click OK, TealDoc will automatically scan the file for the string entered and place a bookmark at each occurrence. The bookmark's name will be constructed from the following of optional elements:

§ Some specified text

§ The string being searched-for

§ A specified count of characters found after the search string.

§ An auto-incremented number starting at 1

A maximum of 50 bookmarks will be added in this manner each time.

When performing a scan operation, you can abort the scan by pressing any hardware button, such as the page-up button.

Preferences

TealDoc supports a number of options under the Preferences menu item, available on both the Document Selection and Browsing screens.

§ Scroll Btns

This setting changes how the up and down buttons on the PalmPilot scroll a document being viewed, either by line, by partial page (page with one overlapping line), or by full page.

§ On Tap

This setting changes how tapping on the screen scroll a document being viewed. It can scroll, either by line, by partial page (page with one overlapping line), or by full page. Lastly, you can also choose the Select option to allow you to drag-select a region of text to copy to the system text clipboard.

§ Autoscroll keys active on:

Normally, pressing any of the four PalmPilot Memo, To Do, Address, and Datebook buttons leaves TealDoc and starts a corresponding application. This option lets you override these buttons while within TealDoc, remapping their function to the Autoscroll Stop, Start, Slower, and Faster commands, making it easy to read documents in Pen-Free mode. Furthermore, you can choose to optionally have this functionality only active when the font/find control panel or scroll panel is up.

§ Scan imbedded bookmarks

When this option is checked, TealDoc scans a document for bookmark tags and markers when it is first opened.

§ Force single space

When this option is checked, TealDoc ignores multiple line breaks in a document, treating them as one. Use this option to view a double-spaced document as single-spaced.

§ Allow Graphics /Links/Tags

When this option is checked, TealDoc recognizes TealDoc's enhanced graphics, formatting, and link tags. When unchecked, TealDoc functions as a basic text-only browser, letting you see any embedded TealDoc-format tags and markers.

§ Allow Global Find

Enables the system Global Find in searching TealDoc documents. Turning on this option can significantly slow down a Global Find if you have many or large documents, however.

§ Sort Document list

Check this to show the document list sorted alphabetically. Turn off this option for faster text display.

§ Right Justify text

Check this option to display text as right-justified. This is primarily useful for right-justified languages like Hebrew.

§ Enable Grayscale

When checked, TealDoc opens up in grayscale mode on an OS 3.0+ monochrome device, either with 4-shades or 16-shades depending on the PalmPilot model and Palm OS version. A PalmPilot with the DragonBall EZ processor (Palm IIIx, Palm V, Palm Vx, Visor) and OS 3.3 or higher is required for 16-shade mode. When in grayscale mode, color images in TealDoc documents are remapped to grayscale.

Global Find

TealDoc supports the PalmPilot's Find button as an option. To activate it, check the appropriate checkmark in the Preferences screen. When you do so and do a search through the Find button, TealDoc will search all document files on your organizer whenever you do a global find. Note that this process can be quite slow, so you may not wish to have this option activated at all times.

Flash Rom Support

TealDoc supports read-only document files, such as those present in Flash Rom. Read-only files cannot have their bookmarks or details modified, and they may seek and scroll more slowly. For best results, open a document first in normal memory before moving it into flash. This allows TealDoc to scan the document for any embedded bookmarks, and generate an internal quick-index table for the document.

Upgrading from other browsers

TealDoc uses the standard document file format on the PalmPilot. If you are using another document browser, TealDoc will use the same files, but categories will not be consistent between the two programs, as the document file format stores document names separate from the documents themselves.

If you are using another document browser, it will likely have a Palm Creator ID that will cause it to be listed together with the document files in the Memory application. You will not be able to delete it separately from the document files without changing the ID using the instructions below.

To move files to be listed under TealDoc, chose All to TealDoc format to convert all document files currently loaded from the standard format to TealDoc's local format. When you do this, all the currently installed files will be marked as TealDoc files, and other browsers may not be able to read the files anymore. You can always convert them back using the All to public format menu choice.

You can also set the format of individual files on an individual basis using the Details dialog accessible from the menu in an open doc.

Creating document Files

Normal Documents

TealDoc documents are made from plain ASCII text files, which are converted using a converter program. A number of excellent utilities by various authors exist for creating and transferring document files. MakeDoc was the original DOS program created for this purpose. MakeDocW is an excellent Windows program which does the same thing but using an intuitive graphical interface with many options. These programs are available at many software archives or from our web site. You can also use MKTLDOC (below) with no password options specified.

MKTLDOC – Protected Documents

Included in this archive is a simple program MKTLDOC, which can be used to make either protected or normal documents. Run this from a command line (DOS box) with the following syntax:

Usage:

MkTlDoc <input file name> <output file name> <Palm File Name> [options]

Where options are

/t = Use TealDoc Creator ID (Local format)

/p <password> = Password protect document

/P <password> = Password protect, password only needed once

/u <user id> = Link doc to HotSync User ID

Example:

MkTlDoc MYTEXT.TXT MYTEXT.PDB "My Text" /P "Rosebud"

The /t option causes the created file to be coded with TealDoc's Creator ID so that the file will be grouped by the Palm OS as a file meant specifically for TealDoc. Using the /t option makes the file unavailable to other doc readers as well.

The Password options allow you to specify that a password be entered before using the doc, either once or every time you open it.

The User ID options lets you create a document that will only open on a document with the specified user name.

Microsoft Word

To create TealDoc files from formatted documents like Microsoft Word files, export the files as plain text before attempting to convert them. For HTML files, MakeDocW also offers options to strip HTML tags from the document when converting them.

To add back some formatting and imagery to the documents special TealDoc tags can be inserted into the plain text file before converting them. Don’t use MakeDocW’s “Remove HTML Tags” option when inserting TealDoc tags. Further documentation on TealDoc’s tags exists in an Appendix at the end of this document.

Imbedding Graphics/Links/Headers

Tag Overview

TealDoc supports imbedding of graphics into TealDoc documents, links to other places in the document, other documents, and even TealInfo folios. This is done by inserting special HTML-like tags into a text file before converting them into PalmPilot documents. When the Show Graphics/Links option is set in TealDoc preferences, these tags insert graphics and link buttons into a document. The graphics scroll up and down with the document, allowing the insertion of charts, illustrations, and figures into the text, perfect for creating catalogs, price guides, and technical documents.

TealDoc tags appear like HTML as text within less-than and greater-than symbols. The text begins with the name of the tag, followed by optional parameters. Text parameters should be enclosed in quotation marks. To include quotations marks within a text parameters, use two adjacent quotation marks ("") for every desired quotation mark. Most of the time, tags should appear alone on a single line. This takes the format:

<TAGNAME PARAM1=VALUE PARAM2=VALUE>

Example:

<TEALPAINT SRC="Pictures" IMAGE=0>

Tag Placement

Normally, objects defined by tags are spaced out vertically on the screen. Occasionally, you may want to place tag objects side-by-side. To do this, place the tags next to each other with no spaces or between them.

By default, tag objects appear at the far left side of the screen with their top edge aligned with the line in which they are defined. Thus, in the above example, all your objects would appear on top of each other unless you explicitly move them. You can adjust the placement of graphic and link objects using the X and Y parameters to respectively move the tag from their default horizontal and vertical positions. X and Y must be positive values, moving the object to the right or down.

<LINK TEXT="Left" TAG="$A" X=20><LINK TEXT="Right" TAG="$B" X=40>

TRICK: you can fool the system into implementing a negative value for moving objects up or left by subtracting your offset from 65536. Thus, 65535 will shift the graphic by one pixel to the left. 65534 moves it two pixels.

A tag can follow text on line, but will always be placed at the far left edge unless it's manually shifted to another location. Any text following a tag, however, will always appear on a line below the tag object. Since the relative position of a tag definition in the line of text does not affect the tag object's placement, always place tags at the end of the line. To make text appear to the right of a tag object, insert the text before the tag definition, but leave space for where the tag object should go, and use the X parameter value to place the tag object in the correct location.

APPENDIX A – TealDoc Tag Reference

§ TEALPAINT

Inserts a TealPaint picture, or even a subrectangle of pixels from a picture. Using subrectangles, you can use memory efficiently by packing multiple graphic elements into single TealPaint images and extract them individually to display in different parts of a document.

To create TealPaint pictures, use TealPaint or the Windows program TealPaint Image Manager that comes with TealPaint. For the images to appear properly both the document file and image database must be loaded properly.

The SRC parameter defines the name of the Image Database to use. This is the name of the file as it appears on the PalmPilot, (as in TealPaint) not necessarily the name of the file on the PC.

You define the subrectangle to grab using the parameters SX,SY,WIDTH,and HEIGHT. If you omit these, the whole source image will be grabbed. This will be placed into the document on the current line at the left edge, unless the X and Y parameters are used to offset the image to the right and downwards.

Required Parameters:

ž SRC
Name of the source image database containing the picture.

Optional Parameters:

ž IMAGE
Image number in the database of the image to use

ž WIDTH
Width, in pixels, of the rectangle to grab (multiple of 8)

ž HEIGHT
Height, in pixels, of the rectangle to grab

ž SX
Horizontal offset of subrectangle to grab (multiple of 8)

ž SY
Vertical offset of subrectangle to grab

ž X
Horizontal screen offset from left edge to place image (multiple of 8)

ž Y
Vertical screen offset from current line to place image

Example:

<TEALPAINT SRC="Pictures" IMAGE=0>

§ HRULE

Inserts a horizontal ruled line into the document. This is useful for dividing parts of a document in a way that works independent of the current font setting.

Optional Parameters:

ž WIDTH
Width (length), in pixels, of the line (default 160)

ž HEIGHT
Height (thickness), in pixels, of the line (default 2)

ž X
Horizontal screen offset from left edge (default 0)

ž Y
Vertical screen offset from top of current line (default 4)

ž STYLE
"OUTLINE" or "SOLID" (default)

Example:

<HRULE STYLE=OUTLINE>

§ LINK

Inserts a link button into the document that can be pressed to jump elsewhere into the document or into another document.

You typically define a button by naming it using the TEXT parameter. Place a uniquely-named LABEL object (described below) elsewhere in the document where the LINK object will jump, and set the TAG parameter to the LABEL’s name. If you wish to link to another document, the FILE parameter should also be defined to reference the name of the other document. You can also link to the name of a TealInfo folio, if TealInfo is installed. Note that the parameter is case-sensitive, and must exactly match the name of the FILE as it appears on the PalmPilot.

The TAG used to mark a document must be unique from any text within the document, as a standard 'find' command is used to locate the tag after a link is selected. By default, this search begins at the top of a file and proceeds downwards. You can optimize the search by using the START parameter to start the search elsewhere in the document, and the DIR parameter to search backwards, if appropriate.

Optional Parameters:

ž TEXT
Text to draw within the button (default 'link')

ž FONT
Font 0 (normal), 1 (bold), or 2 (large) to use for the text

ž WIDTH
Width (length), in pixels, of the line (default 160)

ž HEIGHT
Height (thickness), in pixels, of the line (default 2)

ž X
Horizontal screen offset from left edge (default 0)

ž Y
Vertical screen offset from top of current line (default 4)

ž FILE
Name of document or folio to jump to (default = current doc)

ž TAG
Name of label to find

ž START
Position in document (0-100) percent to initially seek or CURRENT.

ž DIR
Find direction: "FORWARD" (default) or "REVERSE"

ž STYLE
"BOX" (default), "UNDERLINE", or "BARE"

Example:

<LINK TEXT="Press Me" TAG="Contents" FILE="My Novels">

§ HEADER

Adds a text header in the specified text and options. (New for 2.5)

This option is designed to be used to create topic headers with specified justification much like the HTML <H1>...etc tags. Note that when justifying, alignment is relative to the X coordinate, if specified. For instance, if right justification is used, the text is rendered so the right edge of the text lines up onto the X coordinate.

Optional Parameters:

ž TEXT
Text to draw for the header

ž FONT
Font 0 (normal), 1 (bold), or 2 (large) to use for the text

ž X
Horizontal screen position

ž Y
Vertical screen offset from top of current line (default 0)

ž STYLE
"NORMAL" (default), "UNDERLINE", or "INVERT"

ž ALIGN
"LEFT" (default), "RIGHT", or "CENTER"

Example:

<HEADER TEXT="Contents" ALIGN=CENTER STYLE=UNDERLINE>

§ BOOKMARK

Adds a bookmark at the current location when a bookmark autoscan is done

This option provides a way to insert invisible bookmarks in a file. It's similar to the standard method of inserting a marker at the end of the file, but both the marker and bookmark name are not normally visible in the file.

Optional Parameters:

ž NAME
Name of the bookmark to add.

Example:

<BOOKMARK NAME="Contents" >

· LABEL

Inserts nonprinting text into a document to be used as a target for a link.

Required Parameters:

ž NAME
Name of this label

Example:

<LABEL NAME="Contents">

APPENDIX B - Products

Visit us online for our complete product line, including:

TEALAGENT

A Palm data converter, installer, and web clipper, TealAgent intelligently formats local, network, and web-resident data for the Palm handhelds, converting them to standard TealDoc, TealMeal, and TealInfo files.

TEALDOC

A Doc format text reader that's nice... without the price! TealDoc reads thousands of free docs and ebooks on the web, and hasexclusive support for images, link buttons, protected documents, and more.

TEALECHO

Palm text entry as it always should have been. Real-time preview in digital ink lets you see what you're writing, increasing speed and accuracy

TEALGLANCE

Keep the info you need the most at your fingertips. Shows date, time, upcoming appointments, and to-do items at power up.

TEALINFO

The reference library at your fingertips; TealInfo lets you make or browse from hundreds of free interactive TealInfo Folio files, which are mini information applets with lists, tables, popup windows, and more.

TEALLAUNCH

Lets you quickly launch your favorite apps and useful system and editing functions. Powerful button-programming features map functions and apps to hundreds of keypresses and keypress combos.

TEALLOCK

What the security app should have been: custom text and images, graffiti shortcuts for hide privates, show privates, and lock, and automatic locking when turned off or by time.

TEALMAGNIFY

Never squint at a phone number again. An ever-ready magnifying glass compatible with most any program.

TEALMEAL

Answer the day's biggest question... where to go for lunch! A Restaurant chooser and editable database.

TEALMOVIE

Play movies and videos on your Palm with sound! Amazing system supports smooth video, sound playback, and full screen display. Includes windows encoder for making your own movies.

TEALNOTES

Sticky notes for your PalmPilot! Draw freehand notes, maps and doodles directly into your Memos, To-do entries, datebook entries--almost anywhere.

TEALPAINT

The most full-featured paint and sketch program on the Pilot. Includes 16 patterns, 12 brushes, paint bucket, magnified mode, text tool, lasso tool, screen-grabber, color and grayscale support and much more.

TEALPHONE

The better Address book app, with large, easy-to-see numbers, viewing by first, last, or company name, advanced searching, and more!

TEALPRINT

The all-in-one PalmPilot printing solution. Print both text and graphics to Infared, Serial, and Parallel Printers (with adapter), and even any Windows printer with exclusive 'HotSync' printing!

TEALSCRIPT

Graffiti reinvented; a replacement for the system text recognition system that allows you to tune, modify, and add your own strokes

TEALTOOLS

An invaluable collection of pop-up Palm Desk Accessories, including a pop- up calculator, lock/stopwatch, preferences panel, editing panel, memopad, and a file and backup manager.

APPENDIX C - Revision History

Release 3.61 January 8, 2001

ž Fixed image clipping redraw problem

Release 3.60 December 26, 2000

ž Added screen indicator when scanning for bookmarks

ž Added support for documents in Digital Owl Library format

ž Added support for 2 and 4-bit images

ž Added MKTLDOC document creation/protecting utility, replacing TLENCODE.EXE

ž Added transparency to color icons for third party launchers with background color support

Release 3.47 May 29, 2000

ž Added support for Palm OS 3.5

ž Added support for basic text printing through TealPrint

ž Added support for side-by-side link and graphic objects

ž Added support for remapping color images when viewing on a monochrome device

ž Added support for running in grayscale mode (for color TealPaint images)

ž Added "Move list to category" menu item

ž Added individual local/public format item in doc details dialog

ž Added preselect of "find" text

ž Added support for enhanced "find-hack" replacements using system find routines

ž Added Backdrop EZ compatibility in drawing routines

ž Added NT and long file name support to encoding utility

ž Added support for protected documents keyed to a Hotsync User Name

ž Added support for finding text in header tags

ž Added color icon for Palm IIIc

ž Removed reverse decoding feature in TlEncode; modified keys so new encoded docs are not reversible

ž Rearranged menus for better consistency

ž Fixed detecting documents in Visor flash

ž Fixed crash changing categories in flash memory

ž Fixed crash changing document type with Visor flash

ž Fixed double-draw when changing categories

ž Fixed overdraw of autoscroll controls after exitting when autoscroll is on

ž Fixed crash reading documents with a trailing long HTML tag

ž Fixed crash reading documents with bad seek tables created by Mobibook utilities

ž Fixed global find bug looping when more than one page of hits

APPENDIX D - Credits

Manual by Vince Lee, Tex Tennison, and Diane Dybalski

APPENDIX E - Contact Info

TealDoc by TealPoint Software

©1998-2000 All Rights Reserved.

TealPoint Software

454 Las Gallinas Ave #318

San Rafael, CA 94903-3618

We look forward to hearing from you.

Please visit us at www.tealpoint.com, or email us at contact@tealpoint.com.

APPENDIX F - Registering

Currently, you may register by snail mail, electronically through our website with a credit card and a secured server, or through PalmGear HQ at 1-800-741-9070. For the first option, the enclosed registration form is provided for your convenience. You may use this form or simply send the following to the address above.

§ Product Name

§ E-Mail Address

§ HotSync User ID (Pilot Name Required for Passkey generation. It can be found on the main screen of the HotSync application on the PalmPilot as "Welcome ________" or in the corner on a PalmIII or newer device)

§ Check or Money Order for ($16.95 US) to TealPoint Software

Disclaimer

We at TealPoint Software are committed to providing quality, easy-to-use software. However, this product is provided without warranty and the user accepts full responsibility for any damages, consequential or otherwise, resulting from its use.

This archive is freely redistributable, provided it is made available only in its complete, unmodified form with no additional files and for noncommercial purposes only. Any other use must have prior written authorization from TealPoint Software.

Unauthorized commercial use includes, but is not limited to:

§ A product for sale.

§ Accompanying a product for sale.

§ Accompanying a magazine, book or other publication for sale.

§ Distribution with "Media", "Copying" or other incidental costs.

§ Available for download with access or download fees.

This program may be used on a trial basis for 30 days. The program will continue to function afterwards. However, if after this time you wish to continue using it, please register with us for the nominal fee listed in the program.