home *** CD-ROM | disk | FTP | other *** search
/ PalmOS Software Digest / PalmDigest.iso / 办公 / tealdoc / DOCDOC.SRC < prev    next >
Encoding:
Text File  |  2001-04-04  |  45.5 KB  |  788 lines

  1. <HEADER TEXT="TealDoc User's Manual" FONT=1 STYLE=UNDERLINE>
  2.  
  3. Program Version 4.12
  4. Last Updated: March 28, 2001
  5.  
  6. <HRULE>
  7. ìDescription
  8.  
  9. 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, rotate-able display, smooth scrolling, full view mode, tiny font, external application calling, and document linking.
  10.  
  11. <HRULE>
  12. ìContents
  13. This archive contains the following files:
  14.  
  15. Program files:
  16.  
  17. TEALDOC.PRC    The TealDoc program file
  18. MKTLDOC.EXE    TealDoc creation/encoding/password utility
  19. DEMODOC.PDB    Sample PalmPilot document demonstrating features
  20. DEMOIM.PDB    Image data for sample document
  21.  
  22. Document files:
  23.  
  24. DOCDOC.PDF    This document in Adobe Acrobat (PDF) format
  25. DOCDOC.HTM    This document in HTML format (sans images)
  26. DOCDOC.PRC    This document in TealDoc format
  27. DOCDOC.SRC    Sample source to the manual doc
  28. REGISTER.HTM    TealPoint Registration form in HTML format
  29. REGISTER.TXT    TealPoint Registration form in text format
  30.  
  31. <HRULE>
  32. ìInstalling
  33.  
  34. 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.
  35.  
  36. Instructions on how to use the Palm installer are in the Palm Handbook that came with your Pilot, PalmPilot, or WorkPad.
  37.  
  38. On a Windows PC you can also use quick setup installer by double clicking on the SETUP.EXE installer program, and following the on screen prompts.
  39.  
  40. <HRULE>
  41. ìTerms used in this document
  42.  
  43. Hardware Buttons:
  44.  
  45. The four physical buttons (date, address, todo, and memo) on the bottom of the Palm.
  46. Scroll Up/Down Buttons:
  47. The physical rocker switch at the bottom center of the palm
  48. Graffiti:
  49.  
  50. The special letter-like symbols you write on a Palm to enter text with your stylus.
  51. Graffiti Entry Area:
  52.  
  53. The rectangular area at the bottom of the display screen where you can write letters in graffiti.
  54. Silkscreen Buttons:
  55.  
  56. The four printed circular tap areas (Home, Menu, Calculator, and Find) to the left and right of the graffiti drawing area.
  57. Menus:
  58.  
  59. The drop-down menus you get when tapping on the silkscreen menu button.
  60.  
  61. <HRULE>
  62. ìUsing the Program
  63.  
  64. TealDoc is easy to use, and consists of two basic interface screens.
  65. <HRULE>
  66. ìDocument Selection Screen
  67.  
  68. 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. To change or edit categories, tap on the category selection button in the upper right hand corner of the screen. To open a document for reading, simply tap on its name.  You can also beam the document to another Palm, change its category, delete it, or rename it by changing the value of the highlighted action buttons at the bottom of the screen before tapping on a name.
  69.  
  70. 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.
  71.  
  72. 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.
  73.  
  74. 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.
  75.  
  76. 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.
  77.  
  78. <HRULE>
  79. ìDocument Browsing Screen
  80.  
  81. 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.
  82.  
  83. <HRULE>
  84. ìDisplay Area
  85.  
  86. 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.
  87.  
  88. 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.
  89.  
  90. 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.
  91.  
  92. <HRULE>
  93. ìControl Panels
  94.  
  95. 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:
  96.  
  97. <HRULE>
  98. ìFont/Find Panel
  99.  
  100. The font/find panel has buttons used to find text in the document or to change the current display font.
  101.  
  102. <HRULE>
  103. ìScroll Panel
  104.  
  105. 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.
  106.  
  107. Some controls appear on both panels, while others on only one panel.
  108.  
  109. <HRULE>
  110. ìControls
  111. <HRULE>
  112. ìPercentage Button
  113.  
  114. 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.
  115. <HRULE>
  116. ìClose and Back Buttons
  117.  
  118. 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.
  119.  
  120. 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.
  121.  
  122. <HRULE>
  123. ìFinding Text
  124.  
  125.   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.
  126.  
  127. Find options include:
  128.  
  129. * Case Sensitive - Text capitalization must match
  130. * Anchor Left - Text must be the start of a word
  131. * Anchor Right - Text must be the end of a word
  132. * Reverse Search - Search going backwards from the current position
  133.  
  134. 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.
  135.  
  136. 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.
  137.  
  138. <HRULE>
  139. ìFont Selection
  140.  
  141. 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 choose the current display font from the standard Palm display fonts, as well as a special monospaced tiny font.  This is 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 which use spaces to align columns of text.
  142.  
  143. <HRULE>
  144. ìScreen Rotation
  145.  
  146. 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.
  147.  
  148. <HRULE>
  149. ìFull Screen Mode
  150.  
  151. 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 brings back the control panel to its former state.
  152.  
  153. <HRULE>
  154. ìScroll Bar
  155.  
  156. 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.
  157.  
  158. <HRULE>
  159. ìAutoScroll
  160.  
  161. 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.
  162.  
  163. 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.
  164.  
  165. 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.
  166.  
  167. <HRULE>
  168. ìBookmarks
  169.  
  170. 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.
  171.  
  172. 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.
  173.  
  174. TealDoc also supports more advanced automatic bookmarks, which can be defined with specific text that does not appear in the document itself.
  175.  
  176. Scanning for Bookmarks
  177.  
  178. 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.
  179.  
  180. 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:
  181.  
  182. * Some specified text
  183. * The string being searched-for
  184.  
  185. * A specified count of characters found after the search string.
  186. * An auto-incremented number starting at 1
  187.  
  188. A maximum of 50 bookmarks will be added in this manner each time.
  189.  
  190. When performing a scan operation, you can abort the scan by pressing any hardware button, such as the page-up button.
  191.  
  192. Editing Bookmarks
  193.  
  194. The Edit Bookmarks menu item brings up the Edit Bookmarks window, which allows you to rename and move individual bookmarks, as well as rename or delete them.
  195.  
  196. Sorting Bookmarks
  197.  
  198. 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.
  199.  
  200. <HRULE>
  201. ìPreferences
  202.  
  203. TealDoc supports a number of options under the Preferences menu item, available on both the Document Selection and Browsing screens.
  204.  
  205. * Scroll Buttons
  206.  
  207. This setting changes how the up and down scroll buttons on the PalmPilot scroll a document being viewed by line, 1/4 Page, 1/2 Page, 3/4 Page, full page, or full page with a 1-line overlap.
  208.  
  209. * Screen Taps
  210.  
  211. This setting changes how tapping on the screen scrolls a document being viewed. It can scroll by line, 1/4 Page, 1/2 Page, 3/4 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.
  212.  
  213. * App buttons control autoscroll on
  214.  
  215. 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.
  216.  
  217. * Sort Document list
  218.  
  219. 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.
  220.  
  221. * Scan for bookmarks on open
  222.  
  223. 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.
  224.  
  225. * Force single space
  226.  
  227. 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.
  228.  
  229. *
  230. Decode Allow Graphics /Links/Tags
  231.  
  232. 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.
  233.  
  234. * Support Global Find
  235.  
  236. 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.
  237.  
  238. * Right Justify Text
  239.  
  240. 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.
  241.  
  242. * Enable Grayscale
  243.  
  244. 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.
  245.  
  246. * Smooth Scrolling
  247.  
  248. 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.
  249.  
  250. <HRULE>
  251. ìSpecial Features
  252. <HRULE>
  253. ìGlobal Find
  254.  
  255. 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.
  256.  
  257. <HRULE>
  258. ìFlash Rom Support
  259.  
  260. 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.
  261.  
  262. <HRULE>
  263. ìSony Clie Support
  264.  
  265. On a Sony Clie, the jog wheel is mapped to the settings for the hardware scroll buttons, while page-scroll motion on the jog wheel always scrolls one full page.
  266. <HRULE>
  267. ìUpgrading from other browsers
  268.  
  269. 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.
  270.  
  271. SPECIAL NOTE
  272.  
  273. 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.
  274.  
  275. 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.
  276.  
  277. 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.
  278.  
  279. <HRULE>
  280. ìSecurity
  281.  
  282. 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 they are blanked out when private records are masked (OS3.5 only).
  283. <HRULE>
  284. ìOversized Images
  285.  
  286. 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.
  287.  
  288. <HRULE>
  289. ìCreating document Files
  290. <HRULE>
  291. ìNormal Documents
  292.  
  293. 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.
  294.  
  295. <HRULE>
  296. ìMKTLDOC - Protected Documents
  297.  
  298. 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:
  299.  
  300. Usage:
  301.  
  302.         MkTlDoc <input file name> <output file name> <Palm File Name> [options]
  303.  
  304.         Where options are
  305.  
  306.                 /t      = Use TealDoc Creator ID (Local format)
  307.                 /p <password>     = Password protect document
  308.                 /P <password>     = Password protect, password only needed once
  309.                 /u <user id>      = Link doc to HotSync User ID
  310. /c     = Encrypt document from export editing in a doc editor but don't require a password to read.
  311.  
  312. Example:
  313.  
  314.         MkTlDoc MYTEXT.TXT MYTEXT.PDB "My Text" /P "Rosebud"
  315.  
  316. The /t TealDoc 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.
  317.  
  318. The Password options allow you to specify that a password be entered before using the doc, either once or every time you open it.
  319.  
  320. The User ID options lets you create a document that will only open on a document with the specified user name or flash ID (for units with flash memory).
  321.  
  322. The encrypt option encodes the document so it can't be printed or read in a doc-editing program, but does not require a password to open in TealDoc.  It also protects the document name, so that if it is renamed, it will not open.
  323.  
  324. <HRULE>
  325. ìMicrosoft Word
  326.  
  327. 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.
  328.  
  329. 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.
  330.  
  331. <HRULE>
  332. ìImbedding Graphics/Links/Headers
  333. <HRULE>
  334. ìTag Overview
  335.  
  336. 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.
  337.  
  338. 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:
  339.  
  340. <TAGNAME PARAM1=VALUE PARAM2=VALUE>
  341.  
  342. Example:
  343.    <TEALPAINT SRC="Pictures" IMAGE=0>
  344.  
  345. <HRULE>
  346. ìTag Placement
  347.  
  348. 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.
  349.  
  350. 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.
  351.  
  352. <LINK TEXT="Left" TAG="$A" X=20><LINK TEXT="Right" TAG="$B" X=40>
  353.  
  354. 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.
  355.  
  356. 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.
  357.  
  358. <HRULE>
  359. ìAPPENDIX A - TealDoc Tag Reference
  360.  
  361. * TEALPAINT
  362.  
  363. 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.
  364.  
  365. 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.
  366.  
  367. 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.
  368.  
  369. 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.
  370.  
  371. 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.
  372.  
  373. Required Parameters:
  374.  
  375. * SRC
  376. Name of the source image database containing the picture.
  377.  
  378. Optional Parameters:
  379.  
  380. * IMAGE
  381. Image number in the database of the image to use
  382.  
  383. * WIDTH
  384. Width, in pixels, of the rectangle to grab (multiple of 8)
  385.  
  386. * HEIGHT
  387. Height, in pixels, of the rectangle to grab
  388.  
  389. * SX
  390. Horizontal offset of subrectangle to grab (multiple of 8)
  391.  
  392. * SY
  393. Vertical offset of subrectangle to grab
  394.  
  395. * X
  396.  
  397. Horizontal screen offset from left edge to place image (multiple of 8)
  398.  
  399. * Y
  400. Vertical screen offset from current line to place image
  401.  
  402. * LINK
  403.  
  404. 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
  405.  
  406. * FULLIMAGE
  407.  
  408. 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.
  409.  
  410. * SUPERIMAGE
  411.  
  412. 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.
  413.  
  414. * SUPERX,SUPERY,FULLX,FULLY
  415.  
  416. 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.
  417.  
  418. * SUPERWIDTH, FULLWIDTH
  419.  
  420. Specify the full width of the oversized Supermap or Fullview image.
  421.  
  422. * SUPERHEIGHT, FULLHEIGHT
  423.  
  424. Specify the full height of the oversized Supermap or Fullview image.
  425.  
  426. Example:
  427.  
  428.       <TEALPAINT SRC="Pictures" IMAGE=0>
  429.  
  430. <TEALPAINT SRC="Pictures" IMAGE=0 LINK=FULLVIEW
  431.            FULLIMAGE=1 FULLWIDTH=200 FULLHEIGHT=200>
  432.  
  433. <TEALPAINT SRC="Pictures" IMAGE=0 LINK=SUPERMAP
  434.            SUPERIMAGE=1 SUPERWIDTH=640 SUPERHEIGHT=480>
  435.  
  436. * HRULE
  437.  
  438. 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.
  439.  
  440. Optional Parameters:
  441.  
  442. * WIDTH
  443. Width (length), in pixels, of the line (default 160)
  444.  
  445. * HEIGHT
  446. Height (thickness), in pixels, of the line (default 2)
  447.  
  448. * X
  449. Horizontal screen offset from left edge (default 0)
  450.  
  451. * Y
  452. Vertical screen offset from top of current line (default 4)
  453.  
  454. * STYLE
  455. "OUTLINE" or "SOLID" (default)
  456.  
  457. Example:
  458.  
  459.       <HRULE STYLE=OUTLINE>
  460.  
  461. * LINK
  462.  
  463. 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.
  464.  
  465. 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.
  466.  
  467. 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.
  468.  
  469. 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.
  470.  
  471. Optional Parameters:
  472.  
  473. * TEXT
  474. Text to draw within the button (default 'link')
  475.  
  476. * FONT
  477. Font 0 (normal), 1 (bold), or 2 (large) to use for the text
  478.  
  479. * WIDTH
  480. Width (length), in pixels, of the line (default 160)
  481.  
  482. * HEIGHT
  483. Height (thickness), in pixels, of the line (default 2)
  484.  
  485. * X
  486. Horizontal screen offset from left edge (default 0)
  487.  
  488. * Y
  489. Vertical screen offset from top of current line (default 4)
  490.  
  491. * FILE
  492.  
  493. Name of document, folio, image, database to jump to (default = current doc)
  494.  
  495. * TAG
  496. Name of label to find
  497.  
  498. * START
  499.  
  500. 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.
  501.  
  502. * DIR
  503. Find direction: DIR=FORWARD (default) or DIR=REVERSE
  504.  
  505. * STYLE
  506.  
  507. Drawing style for the button.  Either STYLE=BOX (default), STYLE=UNDERLINE, or STYLE=BARE.
  508.  
  509. * APP
  510.  
  511. 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.
  512.  
  513. * MODE
  514.  
  515. 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.
  516.  
  517. Examples:
  518.  
  519.       <LINK TEXT="Press Me" TAG="Contents" FILE="My Novels">
  520.  
  521. <LINK TEXT="AddressBook" APP="addr" MODE=NORMAL>
  522.  
  523. <LINK TEXT="Edit Picture" FILE="StatesIm" RECORD=0
  524.       APP="TlPt" MODE=RETURN>
  525.  
  526. <LINK TEXT="PostalCalc"  APP="TlIf"
  527.       FILE="US Postal Calculator 2001" MODE=OPENDB>
  528.  
  529. * HEADER
  530.  
  531. Adds a text header in the specified text and options. (New for 2.5)
  532.  
  533. 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.
  534.  
  535. Optional Parameters:
  536.  
  537. * TEXT
  538. Text to draw for the header
  539.  
  540. * FONT
  541. Font 0 (normal), 1 (bold), or 2 (large) to use for the text
  542.  
  543. * X
  544. Horizontal screen position
  545.  
  546. * Y
  547. Vertical screen offset from top of current line (default 0)
  548.  
  549. * STYLE
  550. "NORMAL" (default), "UNDERLINE", or "INVERT"
  551.  
  552. * ALIGN
  553. "LEFT" (default), "RIGHT", or "CENTER"
  554.  
  555. Example:
  556.  
  557.       <HEADER TEXT="Contents" ALIGN=CENTER STYLE=UNDERLINE>
  558.  
  559. * BOOKMARK
  560.  
  561. Adds a bookmark at the current location when a bookmark autoscan is done
  562.  
  563. 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.
  564.  
  565. Optional Parameters:
  566.  
  567. * NAME
  568. Name of the bookmark to add.
  569.  
  570. Example:
  571.  
  572.       <BOOKMARK NAME="Contents" >
  573.  
  574. * LABEL
  575.  
  576. Inserts nonprinting text into a document to be used as a target for a link.
  577.  
  578. Required Parameters:
  579.  
  580. * NAME
  581. Name of this label
  582.  
  583. Example:
  584.  
  585.       <LABEL NAME="Contents">
  586.  
  587. <HRULE>
  588. ìAPPENDIX B - Products
  589.  
  590. Visit us online at http://www.tealpoint.com for our complete product line, including:
  591.  
  592. TEALAGENT
  593.  
  594. 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.
  595.  
  596. TEALDOC
  597.  
  598. A Doc format text reader that's nice... without the price!  TealDoc reads thousands of free docs and ebooks on the web, and has exclusive support for images, link buttons, protected documents, and more.
  599.  
  600. TEALECHO
  601.  
  602. 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
  603.  
  604. TEALGLANCE
  605.  
  606. Keep the info you need the most at your fingertips.  Shows date, time, upcoming appointments, and to-do items at power up.
  607.  
  608. TEALINFO
  609.  
  610. 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.
  611.  
  612. TEALLAUNCH
  613.  
  614. 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.
  615.  
  616. TEALLOCK
  617.  
  618. 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.
  619.  
  620. TEALMAGNIFY
  621.  
  622. Never squint at a phone number again.  An ever-ready magnifying glass compatible with most any program.
  623.  
  624. TEALMASTER
  625.  
  626. A hackmaster-compatible system extensions manager with advanced features such as multiple profiles, hack priorities, delete-protection, and automatic timed reenable after system reset.
  627.  
  628. TEALMEAL
  629.  
  630. Answer the day's biggest question... where to go for lunch! A Restaurant chooser and editable database.
  631.  
  632. TEALMOVIE
  633.  
  634. 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.
  635.  
  636. TEALNOTES
  637.  
  638. Sticky notes for your PalmPilot!  Draw freehand notes, maps and doodles directly into your Memos, To-do entries, datebook entries--almost anywhere.
  639.  
  640. TEALPAINT
  641.  
  642. 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.
  643.  
  644. TEALPHONE
  645.  
  646. The better Address book app, with large, easy-to-see numbers, viewing by first, last, or company name, advanced searching, and more!
  647.  
  648. TEALPRINT
  649.  
  650. 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!
  651.  
  652. TEALSCRIPT
  653.  
  654. Graffiti reinvented;  a replacement for the system text recognition system that allows you to tune, modify, and add your own strokes
  655.  
  656. TEALTOOLS
  657.  
  658. 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.
  659.  
  660. <HRULE>
  661. ìAPPENDIX C - Revision History
  662. Release 4.12 March 28, 2001
  663.  
  664. * Added external program calling mechanism to open document, seeking to a tag.
  665. * Added auto-detection of Hebrew text so right-justification automaticaly occurs with lines beginning with Hebrew characters if Penicon Hebrew Support is running
  666. * Added workaround for bug in Penticon for display of parentheses in Hebrew documents
  667. * Fixed clipping of text when running Penticon Hebrew font support
  668. * Fixed restoring of document position after calling external program
  669. * Fixed display scrambling from switching grayscale mode on/off
  670. * Fixed selection of options on search screen
  671. * Fixed crash selecting space below last item on document list
  672.  
  673. Release 4.00 March 10, 2001
  674.  
  675. * Added support for beaming documents
  676. * Added full-screen view mode
  677. * Added tiny monospaced custom font
  678. * Added optional smooth scrolling support
  679. * Added optional screen rotation
  680. * Added support for Sony Clie jog dial
  681.  
  682. * Added support for cycling categories with app button if mapped to TealDoc
  683. * Added option when adding bookmark to replace existing bookmark of same name
  684. * Added support for "protected" encoded documents which don't require a passcode to view
  685. * Added sort-by-size options for document list
  686. * Added menu item to sort bookmarks by name or position
  687. * Added bookmark edit dialog to move and modify bookmarks
  688. * Added support for OS3.5 masked records feature
  689. * Added security menu under OS3.5+
  690. * Added cut/copy/paste menus to document search window
  691. * Added on-screen indicator when "searching" or jumping to link
  692. * Added 1/4 page, 1/2 page, and 3/4 page scrolling options
  693. * Added preselect of bookmark name when renaming
  694. * Added support for OS3.5 copy popup menu
  695. * Added Double-buffered screen updates for snappy display.
  696. * Added support for linked scrollable images with FULLVIEW and SUPERVIEW tabs
  697. * Added support for LINK tags linking only to doc percentage
  698. * Added support for locking docs to flash id instead of Hotsync Name
  699. * Added error message if select mode chosen with right justification or screen rotation
  700. * Added mechanism for adding document links to external programs
  701. * Updated file size to round up to nearest kilobyte.
  702. * Increased display update speed
  703.  
  704. * Fixed bug doing case-insensitive searches with upper case chars in string
  705. * Fixed tap-and-hold proportional-speed scrolling
  706. * Fixed START tag functionality for LINK tags
  707. * Fixed extra OS record release call when opening image
  708. * Fixed private record hiding when performing global search
  709.  
  710. Release 3.60 December 26, 2000
  711. * Added screen indicator when scanning for bookmarks
  712. * Added support for documents in Digital Owl Library format
  713. * Added support for 2 and 4-bit images
  714.  
  715. * Added MKTLDOC document creation/protecting utility, replacing TLENCODE.EXE
  716. * Added transparency to color icons for third party launchers with background color support
  717.  
  718. Release 3.47 May 29, 2000
  719. * Added support for Palm OS 3.5
  720. * Added support for basic text printing through TealPrint
  721. * Added support for side-by-side link and graphic objects
  722. * Added support for remapping color images when viewing on a monochrome device
  723. * Added support for running in grayscale mode (for color TealPaint images)
  724. * Added "Move list to category" menu item
  725. * Added individual local/public format item in doc details dialog
  726. * Added preselect of "find" text
  727.  
  728. * Added support for enhanced "find-hack" replacements using system find routines
  729. * Added Backdrop EZ compatibility in drawing routines
  730. * Added NT and long file name support to encoding utility
  731. * Added support for protected documents keyed to a Hotsync User Name
  732. * Added support for finding text in header tags
  733. * Added color icon for Palm IIIc
  734.  
  735. * Removed reverse decoding feature in TlEncode; modified keys so new encoded docs are not reversible
  736. * Rearranged menus for better consistency
  737. * Fixed detecting documents in Visor flash
  738. * Fixed crash changing categories in flash memory
  739. * Fixed crash changing document type with Visor flash
  740. * Fixed double-draw when changing categories
  741. * Fixed overdraw of autoscroll controls after exiting when autoscroll is on
  742. * Fixed crash reading documents with a trailing long HTML tag
  743. * Fixed crash reading documents with bad seek tables created by Mobibook utilities
  744. * Fixed global find bug looping when more than one page of hits
  745.  
  746. <HRULE>
  747. ìAPPENDIX D - Credits
  748. Manual by Vince Lee, Tex Tennison, and Diane Dybalski
  749.  
  750. <HRULE>
  751. ìAPPENDIX E - Contact Info
  752. TealDoc by TealPoint Software
  753. (c)1998-2001 All Rights Reserved.
  754.  
  755. TealPoint Software
  756. 454 Las Gallinas Ave #318
  757. San Rafael, CA 94903-3618
  758. We look forward to hearing from you.
  759.  
  760. Please visit us at www.tealpoint.com, or email us at contact@tealpoint.com.
  761. <HRULE>
  762. ìAPPENDIX F - Registering
  763.  
  764. 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.
  765.  
  766. * Product Name
  767. * E-Mail Address
  768.  
  769. * 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)
  770. * Check or Money Order for ($16.95 US) to TealPoint Software
  771. <HRULE>
  772. ìDisclaimer
  773.  
  774. 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.
  775.  
  776. 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.
  777.  
  778. Unauthorized commercial use includes, but is not limited to:
  779. * A product for sale.
  780. * Accompanying a product for sale.
  781.  
  782. * Accompanying a magazine, book or other publication for sale.
  783. * Distribution with "Media", "Copying" or other incidental costs.
  784. * Available for download with access or download fees.
  785.  
  786. 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.
  787.  
  788. <ì>