TealDoc User's Manual

Description

Thank you for trying TealDoc. A powerful yet intuitive reader for standard PalmPilot document files, TealDoc offers advanced functionality such as bookmarks, automatic scrolling, imbedded images, rotate-able display, antialiased fonts, smooth scrolling, full view mode, tiny font, external application calling, and document linking.

This archive contains the following files:

Program files:

TEALDOC.PRC The TealDoc program file

TDOCMAKE.EXE TealDoc document creation/install utility (Windows)

DEMODOC.PDB Sample Palm document demonstrating features

DEMOIM.PDB Image data for sample document

TPSETUP.EXE Windows easy-installer program

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 Example text source file to the manual doc

Installing

Use the Palm Install Tool that comes with your organizer to install the program file TEALDOC.PRC. The Palm Install Tool can be found as an icon along the left hand side inside the Palm Desktop program on your desktop computer. 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 DemoDoc is also provided. It demonstrates the image, link, and advanced capabilities in TealDoc. To view it, install both the files DEMODOC.PDB and DEMOIM.PDB.

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

On a Windows PC you can also use quick setup installer by double clicking on the TPSETUP.EXE installer program, and following the on screen prompts.

Terms used in this document

Hardware Buttons:

The four physical buttons (date, address, todo, and memo) on the bottom of the handheld

Scroll Up/Down Buttons:

The physical rocker switch at the bottom center of the handheld

Graffiti:

The special letter-like symbols you write to enter text with your stylus.

Graffiti Entry Area:

The rectangular area at the bottom of the display screen where you can write letters in graffiti.

Silkscreen Buttons:

The four printed circular tap areas (Home, Menu, Calculator, and Find) to the left and right of the graffiti drawing area.

Menus:

The drop-down menus you get when tapping on the silkscreen menu button.

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 the program. Shown is a list of all document files currently installed on the handheld under the active category or in the current location on an external storage card. When viewing files in memory, tap on the category selection button in the upper right hand corner of the screen to change categories.

File Selection

To open a document for reading, simply tap on its name. You can also rename it, delete it, move it to another location or category, or beam it to another handheld. To perform any of these functions, tap on the corresponding action pushbutton at the bottom of the screen before tapping on a name of a file.

By default, the document list is sorted alphabetically. You can also choose to sort the list by increasing or decreasing size or leave it unsorted for fast display if you have very many documents. To change the sort order, select the preferences menu. If you choose to sort the documents alphabetically, you can quickly scroll to documents starting with any letter by writing the graffiti stroke for that letter.

When you beam a document to another Palm, that Palm will also need a document reader to read the file. You can beam an evaluation copy of TealDoc to another Palm by using the Beam menu item in the standard PalmOS launcher screen. See your organizer’s documentation for more information on beaming applications.

TealDoc documents can optionally show images from TealPaint-format image databases. While the document list normally shows the documents present on your Palm, you can also use it to display and manage the list of TealPaint-format databases that are installed. To see the list of image databases, change the popup list in the lower right from Docs to Pics.

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 instead of the single one you wanted. Use the provided interface in TealDoc instead.

External Media Devices

TealDoc supports reading doc files and raw text files directly from any external storage card supporting the PalmOS Virtual File System (VFS). VFS-compatible devices include the Sony Memory Stick, Palm SD/MMC cards, and both the Compact Flash (CF) and SD/MMC slots on HandEra organizers. In addition, support has been added for Portable Innovation MemPlug Springboard modules and Kopsis Engineering’s add-on VFS library.

When a VFS-compatible card is detected, an extra row of icons will appear along the top of the Document List Screen for navigating to folders on the external device. On the left are the device icons, used to select the current card or location to list files. The first icon is the memory icon, and is followed by one numbered card icon for every expansion card found. Most devices will support at most one external storage card, and will thus only have one card icon. The Handera 330, however, can support two simultaneous data cards; so two card icons can be present if both slots are occupied.

To show the files on an external card, simply tap on the corresponding card icon. External file devices support a hierarchical folder system, which replaces the Palm category system. Thus, the “category” selector in the upper right corner disappears and is replaced with a “folder” button when an external card is selected. The “Beam” button also disappears, as files can only be beamed directly from internal memory.

If sub-folders are present in the current folder, simply tap on them to move “down” into the sub-folder to see its contents. To the right of the device icons is a display showing the current directory on the card, followed by two folder navigation buttons. Use the first parent icon to move up one level to the folder that contains the current folder. Tap on the last root icon to move all the way back up to the topmost folder.

Managing Files

To copy or move files between categories in RAM, or to move them between RAM and an external card or between folders on the same card, tap on the “Mov” pushbutton and tap on the name of the file to move or copy. Either the RAM File Manager or Card File Manager window will open, depending on your current device.

RAM File Manager

The RAM file manager allows you to change the category of a document file stored in RAM. If the expansion device supports VFS, then you can also copy or move the file to the external card. When either option is selected, the file is moved to the last card and sub-folder viewed.

At this time, the MemPlug system software does not support the VFS-standard interface for moving of files between Card and RAM, so the move-to-card options will not be available when directly accessing a MemPlug device.

Note that on Sony CLIE models running PalmOS 3.5, moving files is permitted but the Sony VFS library prohibits copying files to any folders outside the standard “MSSONY” folder. Subfolders can be made and used within the MSSONY folder however.

Card File Manager

The card file manager window is similar to the RAM File Manager, except that the list of categories is replaced with a list of folders in the current location. A current (.) entry in the list indicates that you want to copy a file into the listed location. If the current location is not the Root of the card, then additional parent (..) and root (\) folders also appear in the list. These folder entries allow you to select a location in which to copy or move the selected file. To change the current location, double-tap on the folder entry.

On VFS-systems, Move to RAM and Copy to RAM options appear. To move or copy a file, select the target location in the folder list and tap on the move or copy button.

Note that these operations are not supported directly by the MemPlug system software. Also, older versions of the Sony CLIE version of VFS do not support copying files outside the MSSONY folder. Lastly, only Palm-format files can be copied or moved to RAM. Text files and other non-palm files cannot be stored in memory.

An additional three buttons for creating, deleting, and renaming folders is also present in the card file manager. These three options can also be reached by tapping on the folders button on the Document List screen. Care should be used when deleting folders, as if non-document files are present in the folder, they will not be listed in TealDoc and can be accidentally deleted. Some VFS implementations will delete a folder even if it is not empty, while others will simply not delete the folder.

Installing Raw Text Files

While TealDoc automatically recognizes standard Doc files and TealDoc files, you can also install raw text files to an external expansion card under OS 4.0 and view them with TealDoc. To do so, you must indicate which files are document files TealDoc should recognize, and tell the Palm HotSync system where to install such files.

By default, TealDoc recognizes files ending in .txt and .text as readable document files. To choose or modify other raw text file types to view (such as .bat, .h, .c, .csv, etc), first change the current location to a folder on an external card device, then select the “File Types…” menu item from the TealDoc document selection screen.

Listed will be all the raw file types currently recognized by TealDoc. File types are determined by the file extension of an installed file, the bit after the period (.) on most files. Use the Add or Rem buttons to add or remove an item from the list, or Set to designate the current folder location on the current device as the install folder for a particular file type. When creating a new type, note that you should enter the file extension without the period symbol. You can also use the Clear button to leave an entry on the list so that TealDoc will recognize it, but specify no install folder for that type of file. This may be useful when another program is not functioning properly because it want to change the install location for a particular type of file, but cannot because it is currently set by TealDoc.

To install the raw files onto the expansion card, please check your HotSync software documentation. Currently, the Palm Install Tool that comes with PalmOS desktop 4.0 can install files to a device running PalmOS 4.0. To do so, change the file filter entry on the file selection dialog from “All Palm Files” to “All files” and select an external expansion card as the target install location. Other handhelds and/or desktop installations may or may not support non-Palm files.

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 area at the top of the screen, and a control panel at the bottom.

Display Area

The display area shows a scrolling view of the current document. You can tap in the display area to either scroll the current window or to select text for copying into another program. There is a setting in TealDoc’s preference screen (described later in this document) to change exactly which is done.

When in scrolling mode, tap in the top half of the screen to scroll up, the bottom half to scroll down. You can scroll either one line at a time, a quarter-page, half-page, three-fourths of a page, a full page, or a full page with a one-line overlap. This setting too can be found in the Preferences menu screen. If you hold down the pen when scrolling, the screen will continue to scroll. The closer to the top or bottom of the screen you go, the faster scrolling will occur in that direction.

In select mode, you can tap on text in a document and “drag-highlight” a selection to copy to the system text clipboard using the Copy menu.

Control Panels

The bottom of the browsing screen contains buttons and controls useful when reading a document. The control panel can be switched back and forth between two modes by tapping the % button or selecting the appropriate menu item:

Font/Find Panel

The font/find panel has buttons used to find text in the document or to change the current display font.

Scroll Panel

The scroll panel allows you to quickly move to a section of the document. It also contains controls for adjusting TealDoc’s auto scroll feature, which lets automatically advances the display down a document like a television auto prompter.

Some controls appear on both panels, while others on only one panel.

Controls

Percentage Button

The third button from the left on both panels is the percentage button. This button serves two purposes. An addition to switching the control panel between its two states: the font/find panel, and the auto scroll panel, it displays the current screen location in the full document.

Close and Back Buttons

In the lower left corner of the document-browsing screen are two buttons. On the left, the close button, with an 'x', returns you to the document selection screen.

On the right is the return arrow. Tap on it to return to your last saved position after moving somewhere as the result of a find, clicking on a link, or seeking in the document using the drag bar on the scroll panel.

Finding Text

The set of three buttons to the right of the percentage button on the font/find panel are shaped like a magnifying glass and two arrows, and are for finding text in a document. Unlike the standard PalmOS find function accessible from the silk-screened “find” button, a find operation done using these buttons only searches the current document. From left to right, they are find-previous, find-new, and find-next. Tap on the find-new button the first time you do a search. Tap on one of the others to find the next occurrence of a previous search either above or below the current location in the document.

Find options include:

· Case Sensitive – Text capitalization must match

· Anchor Left - Text must be the start of a word

· Anchor Right – Text 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. For instance, if you search for the text “and” normally, you might come up with “demand” or “handy” as possible matches. If you select the anchor left option, however, then “andy” or “Andrew” might match, but not “handy” or “Landrew”. If you choose both anchor left and anchor right, then only the exact word “and” will match.

When performing a find operation, you can abort the find by pressing any hardware button, such as the page-up scroll button. Also, when entering text into the new-find dialog, the system cut, copy, and paste functions are accessible from a drop down menu.

Font Selection / Antialiasing

Also on the font/find panel is the font selection button, which contains three ‘AAA’ letters. Tapping on it brings up a dialog allowing you to set antialiasing options or choose the current display font from the standard Palm display fonts and a special monospaced tiny font.

Antialiasing is available on color devices or when running monochrome devices in grayscale mode. Antialiasing improves text readability by adding gray pixels in the corners of the characters to fill in gaps and smooth sharp “jaggies” in the text. When using antialiasing in grayscale mode, it is important to adjust the display’s contrast controls to show an even range of grays. A chart showing a range of gray gradations is shown to help with this adjustment. Set the device’s display contrast to that all five intensity values are even and distinct.

The last font serves two purposes. It is small, allowing for more text on screen than with the standard Palm fonts, and each character is of equal width, like on a typewriter, maintaining formatting of some documents that use spaces to align columns of text.

Screen Rotation

TealDoc supports a sideways-oriented display area. This allows easier access to the Palm’s scroll buttons for one-handed operation. To rotate the display, tap on the screen rotation button, which is the circular arrow button on the right hand side of the font/find panel.

Full Screen Mode

Full Screen Mode allows you to minimize the control panel, freeing up the whole display for text. The full screen mode icon is shaped like a downward pointing arrow on the font/find panel. Tapping on the full screen mode icon will remove the panel, replacing it with a small square in the lower right hand corner of the display. Tapping on this square or choosing the “toggle full screen” menu item brings back the control panel to its former state.

On the Samsung PalmOS-Powered Phone, the full screen and corresponding un-fullscreen buttons also function to minimize and maximize the software graffiti area. The first tap removes the graffiti area; the second removes the control panel. The graffiti area on the Samsung (and Handera 330) can also be toggled on and off using the Toggle Silkscreen menu item.

Inverted Screen Mode

Available from the menu only, the Inverted screen mode shows text as white on black, which some find easier on the eyes. Inverted screen mode works in any display mode except when text selection mode is selected.

Scroll Bar

The horizontal scroll bar on the scroll panel lets you quickly seek to another location in the document. Tap on the solid rectangle, or “knob” to drag the current position to another location, tap in the space to the right or left of the knob to scroll forwards or backwards one page.

AutoScroll

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.

On a HandEra 330, when auto-scroll is active, you can adjust the speed of the scrolling by using the jog dial control.

Bookmarks and Notes

You can mark your current location in the file as a bookmark or note (annotated 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 and notes 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.

Scanning for Bookmarks

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 text to search-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 to keep the program from looping endlessly if an unintended search string is selected (such as a space).

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

Editing Bookmarks and Notes

The Edit Bookmarks menu item brings up the Edit Bookmarks window, which allows you to move, rename, edit, and delete bookmarks and notes attached to the current document.

The Edit Text button can be used to rename a bookmark or note or modify the contents of a note, while the Move Loc button will change the location of a bookmark on the list to the current location in the document.

Sorting Bookmarks

The Sort Bookmarks menu item allows you to sort the current list of bookmarks either by alphabetical order, or by the order in which the appear in the document.

Preferences

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

§ Scroll Buttons

This setting changes how the up and down scroll buttons on the PalmPilot scroll a document being viewed by line, ¼ Page, ½ Page, ¾ Page, full page, or full page with a 1-line overlap.

§ Screen Taps

This setting changes how tapping on the screen scrolls a document being viewed. It can scroll by line, ¼ Page, ½ Page, ¾ Page, full page, or full page with a 1-line overlap. You can also choose the Select option to allow you to drag-select (highlight) a region of text to subsequently copy to the system text clipboard using the drop down ‘copy’ menu.

§ App buttons control autoscroll 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 independently linked to which control panel is currently active, either the font/find control panel or scroll panel.

§ Sort Document list

The document selection list can be sorted alphabetically or by file size. The ‘unfiled’ option simply lists the files in their order in memory, which is useful for faster text display when many documents are installed.

§ Open docs on VFS cards in RAM

Normally, documents on VFS cards are opened directly off the card, minimizing their footprint for better memory efficiency. Doc files are not designed to be editable when residing outside of memory, however, so the last-viewed position is not saved and bookmarks are not editable when opening files directly off VFS cards. When this option is chosen, however, documents on VFS cards are temporarily copied into main memory when they are opened, and then copied back to the cards when the document is closed. This allows bookmarks and notes to be used with files on VFS cards, but requires sufficient free memory to comfortably hold any documents to be viewed. This option has no effect on raw text files, which cannot be copied into main memory.

§ Scan for bookmarks on open

When this option is checked, TealDoc scans a new document for bookmark tags and markers when it is first opened, adding any bookmarks it found to the document’s bookmark list. If not checked, the document is just opened with no bookmarks, but these can be added manually later using the Scan for bookmarks menu.

§ 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.

§ Decode 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 in the text.

§ Support Global Find

When checked, the system global find command, accessible from the silkscreen find button, also searches TealDoc documents. Turning on this option can significantly slow down a Global Find if you have many or large documents, however, as every document installed gets scanned.

§ Right Justify Text

Check this option to display text as right-justified. This option is useful for languages that read right-to-left such as Hebrew and is usually useful only when used in conjunction with a third-party language support program. TealDoc auto-detects when Hebrew Support, from Penticon Software, is active, and should automatically right justify any line beginning with a Hebrew character when this option is off. When set, this option instead automatically right-justifies all lines regardless of how they begin, but will not work with tap select mode active.

§ Enable Grayscale

When checked, TealDoc opens up in grayscale mode on a PalmOS 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. This option has no effect on a color device.

§ Smooth Scrolling

When checked, TealDoc implements smooth scrolling by smoothly moving the on-screen text up or down before filling in the newly-revealed text. This helps keep the reader from losing his or her place when scrolling from page to page, especially in autoscroll mode.

Special Features

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 memory mapped Flash Rom. This includes files moved into unused operating system memory using programs such as FlashPro (by HandEra) or the Visor Springboard flash module. Other flash cards are not memory-mapped, but accessed as peripherals through Palm’s VFS mechanism and are supported by TealDoc’s VFS document system. 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. As the interface for moving files to and from operating system flash is proprietary and not supported by PalmOS function calls, you’ll need to use third party utilities (like FlashPro or JackFlash) or utilities accompanying the hardware (for Springboard flash) to move files to and from this type of flash memory.

Sony CLIE Support

On a Sony CLIE, the jog wheel can be used to select and open files. When reading a document, it is mapped to the settings for the hardware scroll buttons, while page-scroll motion on the jog wheel always scrolls one full page. High-resolution fonts are fully supported, though the small mono-spaced font is not available, as the CLIE does not have a high-resolution version of this custom font.

HandEra 330 Support

The HandEra 330 is fully supported, including both full screen and high-resolution modes, as well as using the extra font choices. The jog dial is supported as well, though the small mono-spaced font is not available. Rotation is supported through TealDoc’s standard rotation feature, and it functions in full screen mode as well.

Upgrading from other browsers

TealDoc uses the standard PalmOS document file format commonly called “Doc”. 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.

SPECIAL NOTE

If you have installed Aportis Doc, do not delete it while documents are in public format, as that program uses the same Palm Creator ID as the documents, and PalmOS will delete all your documents in memory if you don’t first change the documents to TealDoc’s “local” format.

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.

Security

On the document browsing screen, and Details menu allows you to set whether the current document should be considered “secret” and thus subject to the current palm secret record setting. Under PalmOS 3.5 or higher, TealDoc adds an extra Security menu for accessing the Palm’s hidden and masked-record features. When hidden, private documents do not appear in the document list, while their names are blanked out when private records are masked (OS3.5 or higher only).

Oversized Images

Some TealDoc documents contain images that, when tapped, link to an oversized image larger than the display screen. These document open the oversized image window to display the image. On this screen, four screen buttons are present along the bottom of the document to scroll the display window around the larger image. You can also tap on the display area and drag it in a direction to pan around to another location as well.

Creating Document Files

TealDoc Maker

Use TDOCMAKE.EXE, the TealDoc Maker program, to create your own TealDoc files from text for HTML files under Windows. Double-click on the TealDoc Maker icon to start the program.

Document Source Types

TealDoc Maker supports options for creating documents from a number of sources, including:

§ Text File – A plain text file such as one created in Notepad or exported from Word

§ HTML File – An HTML document or web page saved as a file in HTML format

§ New Blank Doc – A new document you can edit paste text into

§ TealDoc Document – An existing unprotected TealDoc or Doc file

§ Clipboard – The current contents of the text clipboard

The text file option is handy when converting documents already stored in text format or when converting from other formats, as most programs, such as Microsoft Word, support exporting of documents to plain text format. When this option is chosen, enter the location of the source file to convert in the source file field.

The HTML option strips HTML tags from the source text, and does some simple text-based formatting based on the original layout. Images, fonts, and styles are not converted, however, as these are not supported in standard doc files.

The TealDoc option, combined with the preview/edit text option, allows text previously converted to Doc format to be modified and saved into another document file.

The clipboard option is often the most convenient way of quickly creating a document file from text in another program. It uses the Windows cut and paste mechanism, allowing you to easily “cut,” say, copy a passage from an email or web page “paste” it into a new document. To use it, drag-select the text in the email program, web browser or other program and copy that text using the Copy (typically) item under that program’s Edit menu. Then run TealDoc Maker and select the “Clipboard” option.

Advanced Options

TealDoc Maker supports the following advanced options:

§ Preview/Edit Text – Brings up a window containing the document to be created showing estimated formatting for the text. Text can also be saved in raw format to a separate file. If the document is less than 32k in size, the text can be edited here as well prior to completing the conversion.

§ Strip Single Line Breaks – Removes line break characters from the text except when two or more consecutive line breaks are present. Use this option to reformat text which has been pre-formatted with long line breaks which would otherwise produce irregular formatting on the small Palm screen.

§ Save to file instead of installing – Saves the completed .PDB file in a designated location but does not automatically install the file onto a handheld.

§ Use “Public Doc” format – Codes the document with the standard doc Creator ID so other document readers can find it, and omits use of special TealDoc tags when converting HTML files.

Document Protection

TealDoc support four optional protection mechanisms for limiting use or distribution of created documents:

§ Password – Asks the user for a specified password every time the document is opened

§ Register – Asks the user for a password the first time the document is opened. If the document is in memory, the password is saved so this will not be necessary in the future.

§ Lock – Scrambles the text so that it cannot be read by other document readers (which occurs when any protection options is used), but does not require a password. This option also locks the document name, so that the file will not open if renamed.

§ User – Keys the document to a specified HotSync User name, so that it will not open on a device with a different name.

Unmaking Doc Files

To convert unprotected document back to raw text format, use TealDoc Maker, selecting TealDoc Doc as the source format type and check the Preview/Edit option. Begin the conversion process, but use the Save as Text button to save out the decoded text in the document to a separate text file.

Third Party Utilities

A number of other excellent utilities by various authors exist for creating and transferring document files to standard Doc format supported by TealDoc. 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.

Converting Microsoft Word Docs

To create TealDoc files from formatted documents like Microsoft Word files, export the files as plain text before attempting to convert them, or use one of the third party Word macros which allow saving of Doc files directly from within Word. Visit the TealDoc information page at http://www.tealpoint.com/softinfo.htm for links to some of the available utilities.

Converting HTML Web Files

TealDoc Maker supports simple conversion of HTML files, performing simple text formatting based on HTML tags. To add images and other HTML-like formatting, TealDoc tags can be added. A reference of various HTML tags follows in the Appendix.

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 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:

Example:

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.

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 downward.

TealPaint images can also be linked to another image larger than the screen in the same database by using the LINK tag. Typically, a small version of the full image is used as the main image. Tapping on the small image brings up the oversized image window so you can scroll around within the full sized picture. The larger image can be specified either as a FULLVIEW image, which is a moderately oversized single TealPaint image, or a SUPERMAP image, which is an image made up of individual 160x160 panels adding up to create a large image of practically unlimited size.

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

ž LINK
Links the image to another oversized image which is opened in the oversize image window when tapped. Values can be LINK=SUPERMAP or LINK=FULLVIEW

ž FULLIMAGE

Specifies the image number of the oversized image when linking to a Fullview image. Fullview images are limited to the Palm record maximum of 64k per image, which is about 240x240 pixels for a color image.

ž SUPERIMAGE

Supermap images are made up of individual 160x160 images that are arranged in text reading order. For instance, for a 640x480 pixel image, 12 separate 160x160 pixel images need to be created and ordered from left to right and top to down. TealPaint Image Manager 3.80+ can cut up an image automatically for this purpose, as well as shrink it to screen size for the small “tappable” version. The SUPERIMAGE tag specifies the image number of the first of the 12 individual parts.

ž SUPERX,SUPERY,FULLX,FULLY

Specifies the initial offset in pixels from the upper left hand corner in which to open the oversized image window. For instance, SUPERX=0 and SUPERY=0 will specify that the window always opens looking at the upper left hand corner of the oversized image. If neither value is specified, then the initial scroll position will depend on where the initial small picture was tapped, which makes sense if the small picture is a small representation of the oversized picture.

ž SUPERW, FULLW

Specify the full width of the oversized Supermap or Fullview image.

ž SUPERH, FULLH

Specify the full height of the oversized Supermap or Fullview image.

Example:

<TEALPAINT SRC="Pictures" IMAGE=0 LINK=FULLVIEW

FULLIMAGE=1 FULLW=200 FULLH=200>

<TEALPAINT SRC="Pictures" IMAGE=0 LINK=SUPERMAP

SUPERIMAGE=1 SUPERW=640 SUPERH=480>

§ 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:

§ LINK

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

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.

LINK tags can also be used to launch other applications. Depending on what the called application supports, it can optionally be told to open up a specific document, image, or media file, and return back to TealDoc when closed. The application is specified by its 4-letter Creator-ID and the APP tag. It’s calling mode is determined by the MODE tag and FILE tags.

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, folio, image, database to jump to (default = current doc)

ž TAG
Name of label to find

ž START
Position in document from START=0 to START=100 percent to initially seek or CURRENT. If TAG is not specified, tapping on this link will just go to the specified percentage.

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

ž STYLE
Drawing style for the button. Either STYLE=BOX (default), STYLE=UNDERLINE, or STYLE=BARE.

ž APP
Specifies the Creator-ID of the application to launch, if not a TealDoc document. For instance, APP=”TlPt” will open TealPaint. If missing, TealDoc will call the application who is the registered owner of the specified FILE.

ž MODE
Specifies how the external app will be called. MODE=NORMAL will just launch the app normally, and will work with all applications. MODE=OPENDB will call the app with the SysCmdLaunchCmdOpenDB launch command, passing it the database specified by the FILE tag. Applications which support this launch command typically open the specified file for editing or playback. MODE=GOTO usually has a similar effect, but uses the SysCmdLaunchCmdGoTo launch command instead, which works on many programs which support global find. Lastly, the MODE=RETURN setting calls the app with the GOTO command as well, but places TealDoc’s creator ID in the matchCustom field of the launch parameter block. TealPoint programs like TealPaint use this value to know to return to TealDoc when the passed image is closed.

Examples:

<LINK TEXT="Edit Picture" FILE="StatesIm" RECORD=0

APP="TlPt" MODE=RETURN>

<LINK TEXT="PostalCalc" APP="TlIf"

FILE="US Postal Calculator 2001" MODE=OPENDB>

§ 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. Text is automatically wrapped in TealDoc 4.5 or higher, and has a maximum length of 79 characters.

ž 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:

§ 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:

· LABEL

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

Required Parameters:

ž NAME
Name of this label

Example:

APPENDIX B - Products

Visit us online for our complete product line, including:

TEALAGENT ( http://www.tealpoint.com/softagnt.htm )

A PC-based Palm data converter, installer, and web clipper which formats local, network, and web-resident data into standard Palm formats.

TEALAUTO ( http://www.tealpoint.com/softauto.htm )

The complete automobile mileage, service, and expense tracking program, TealAuto, supports unmatched features and customization options.

TEALDOC ( http://www.tealpoint.com/softdoc.htm )

Powerful reader for Palm documents, e-books, and newspapers, supporting advanced features such as pictures, links, and flash cards.

TEALECHO ( http://www.tealpoint.com/softecho.htm )

Digital "ink" lets you see what you write, vastly increasing graffiti writing speed and accuracy. No more writing blind!

TEALGLANCE ( http://www.tealpoint.com/softglnc.htm )

Pop-up utility shows time, date, appointments and to-dos, and other useful information at power-up. See your day at a glance.

TEALINFO ( http://www.tealpoint.com/softinfo.htm )

A system for creating and displaying interactive databases, reference works, and mini-application folios; a handheld reference library.

TEALLAUNCH ( http://www.tealpoint.com/softlnch.htm )

A pop-up application launcher and mapping utility for launching apps and special functions from pen taps, graffiti strokes, or button presses.

TEALLOCK ( http://www.tealpoint.com/softlock.htm )

Secure automatic locking program with optional data encryption and numerous activation and customization options.

TEALMAGNIFY ( http://www.tealpoint.com/softlens.htm )

An ever-ready magnifying glass that works with most any program, TealMagnify saves your eyes when looking at tiny text.

TEALMASTER ( http://www.tealpoint.com/softmstr.htm )

A supercharged Hackmaster replacement with 100%-compatibility and enhanced stability, configuration, diagnostic and activation features.

TEALMEAL ( http://www.tealpoint.com/softmeal.htm )

A personal restaurant database and selection wizard. Keep a database of your favorites and easily find them by type or category.

TEALMEMBRAIN ( http://www.tealpoint.com/softmemb.htm )

Memory monitor and stack manager which helps identify conflicts and greatly improves stability running multiple hacks and drivers.

TEALMOVER ( http://www.tealpoint.com/softmovr.htm )

File management utility for beaming, deleting, renaming, and copying files both in memory and on VFS-compatible storage cards.

TEALMOVIE ( http://www.tealpoint.com/softmovi.htm )

High-quality multimedia system with video and synchronized sound. Includes audio/video player and Windows AVI converter program.

TEALNOTES ( http://www.tealpoint.com/softnote.htm )

Insert freehand graphic "Sticky Notes" into memos, to-do lists, address book entries--almost anywhere you currently have editable text.

TEALPAINT ( http://www.tealpoint.com/softpnt.htm )

The most powerful paint and sketch app on Palm OS handhelds, featuring 16 tools, 16 patterns, 12 brushes, color, and desktop image conversion.

TEALPHONE ( http://www.tealpoint.com/softphon.htm )

A powerful Address Book replacement with superior interface, display, search, and indexing options.

TEALPRINT ( http://www.tealpoint.com/softprnt.htm )

The all-in-one text and graphic printing solution for Palm OS, supporting infrared, serial, and HotSync printing to any Windows printer.

TEALSCRIPT ( http://www.tealpoint.com/softscrp.htm )

An improved, tuneable, Graffiti text recognition system that lets you modify the handwriting recognition to suit your handwriting.

TEALTOOLS ( http://www.tealpoint.com/softtool.htm )

Six pop-up desk accessories, including a calculator, clock/stopwatch, preferences panel, editing panel, memopad, and a file/backup manager.

APPENDIX C - Revision History

Version 5.00 - May 30, 2002

· Added TealDoc Maker, (preliminary) Windows file converter/installer

· Added antialiased text options for all standard Palm OS text fonts

· Added "Open in RAM" option to allow editing of bookmarks for files on SD cards

· Added "NOTE" bookmarks for annotating locations in document

· Added color to icons

· Added full screen mode for Samsung i300

· Added menu shortcut stroke for silkscreen toggle on Samsung or Handera

· Added high resolution icons for OS 5.0

· Fixed caseless searches with accented or european characters

· Fixed caseless searches with capitalized search text

· Fixed opening of documents protected with document name

· Fixed placement of category list on ram file manager when more than 12 categories

· Fixed beaming of files with periods and slashes in names

· Fixed opening of doc files mangled by opening in Iambic reader

· Fixed memory leak when beaming files

· Fixed memory leak using global search function

Version 4.60 - January 15, 2002

· Added category cycling when mapped to hardware button

· Added capability of beaming from SD card

· Added saving of position if last viewed doc is a text file

· Added progress bar for bookmark adding

· Added automatic VFS-safe filename conversion when copying to card

· Added mechanism for document links to launch external files on SD cards

· Added mechanism for external programs to launch TealDoc to open SD-resident docs

· Added code for future OS compatibility

· Increased speed loading filenames from VFS cards

· Fixed beaming of files with colons (:) in name

Version 4.51 – September 6, 2001

Reduced stack space to fix reset crashes on Handspring visors (OS 3.1?)

Version 4.50 - August 15, 2001

Added support for reading docs from VFS expansion devices (SD/MMC)

Added support for reading raw text files from SD/MMC cards and other VFS devices
Added interface for specifying file extensions to recognize as text-readable files

Added high-resolution font support for Sony Clie 7xx series
Added auto-wrapping for long header text (up to 79 characters)

Added option for inverting screen colors
Added menu for screen rotation
Added menu for font selection
Added menu for autoscroll speed adjustment

Added menu item for bookmark goto
Added menu item for screen rotation

Added system to robustly handle non-text binary data in doc and text files
Updated HandEra jog wheel support to change speed during auto-scroll

Enlarged selection area for full screen close box

Removed screen refreshes during bookmark scans to vastly increase speed

Fixed auto-centering feature tapping on full-view images on HandEra

Fixed display updating when using menu shortcuts

APPENDIX D - Credits

Manual by Vince Lee, Tex Tennison, and Diane Dybalski

APPENDIX E - Contact Info

TealDoc by TealPoint Software

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 on US Bank Paper (no international checks please) for ($16.95 US) to

TealPoint Software

TealDoc Registration

454 Las Gallinas Ave #318

San Rafael, CA 94903-3618

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.

TealDoc User's Manual

Table of Contents

Inverted Screen Mode