summaryrefslogtreecommitdiff
path: root/noncore/apps/opie-reader/README
Unidiff
Diffstat (limited to 'noncore/apps/opie-reader/README') (more/less context) (ignore whitespace changes)
-rw-r--r--noncore/apps/opie-reader/README162
1 files changed, 0 insertions, 162 deletions
diff --git a/noncore/apps/opie-reader/README b/noncore/apps/opie-reader/README
deleted file mode 100644
index d091010..0000000
--- a/noncore/apps/opie-reader/README
+++ b/dev/null
@@ -1,162 +0,0 @@
1What is QT Reader?
2==================
3
4QT Reader is an e-text reading program which understands several
5varieties of PalmDoc format (types 1,2 and 4), zTxt, plain text and
6gzipped text.
7
8In addition it supports its own very highly compressed format which is
9based on ppm (regarded by many as the best available compression
10technique) with modifications by Fabrice Bellard for speed and memory
11efficiency and by myself to support random access on smaller
12devices. I call this modified format ppms (for ppm, segmented).
13
14The ppms program which is used to produce ppms files from plain text
15is available from http://www.timwentford.uklinux.net where there is
16also a comparison of file sizes produced by several compression
17methods. This is summarised below:
18
19Compression method Size in bytes Memory required to decompress
20Plain text 573714 N/A
21Makedoc (PalmDoc format) 329543 2k
22ppms (default) 184187 350k
23ppms (best) 151733 800k
24bzip2 -1 180175 340k
25bzip2 -9 154280 2.2M
26
27The default settings used here were chosen to suit the Agenda VR3. I
28would expect the Zaurus to be able to use settings which give 170kb
29file size and 500k memory without any problem. The format encodes the
30settings used so the user may choose whatever suits them. I choose
31based on the amount of memory required and on whether or not pageup
32performance is acceptable.
33
34General Use
35===========
36
37Start it up and then choose "File/Open" from the menu. Select a
38palmdoc, plain text, gzipped text or ppms file from the file selector
39and use the cursor keys to page up/down (up/down keys) and to make the
40text size comfortable (left/right keys) and thats it for most
41uses. See below for more advanced use.
42
43What the Menu Options Do
44========================
45
46File
47====
48
49File operations live in this menu.
50
51Open Brings up the file selector to allow you to choose a
52 new file to read.
53Info Displays info about the currently open file. Needs
54 reformatting.
55Start Block Marks the text at the top of the currently displayed
56 page ready for copying.
57Copy Block Copies all text from the mark to the bottom of the
58 currently displayed page to the clipboard.
59Scroll Starts/stops autoscroll. The speed can be adjusted
60 using the up/down keys while autoscroll is on (page
61 up and down are still functional and can be activated
62 by using the up and down arrows on the task bar).
63Jump Jumps to a specific offset in the file. If you note
64 down the current location from the File/Info display
65 you can then jump to the same position again using
66 this function (or you could bokmark it 8^)).
67Page/Line scroll When this is On pressing the arrows (keys or
68 icons on the task bar) moves you a page at a time.
69 When this is off, pressing the arrows moves you a
70 line at a time.
71Set Overlap Sets the number of lines of overlap between pages
72 when scrolling by page.
73Set Dictionary When you tap on the screen the word under the
74 pointer is copied to the clipboard ready for pasting
75 into (e.g.) a dictionary program. Using this function
76 allows the word to be sent to compatible dictionary
77 programs direct. The format is exename/messagename
78 where exename is the name of the executable for the
79 dictionary program and messagename is the name of the
80 message it is expecting. You can get some idea of how
81 it works by using some debug functionality which I
82 deliberately left in QTReader. Set this to
83 uqtreader/info.
84 To deactivate it again, set it to /.
85Find Brings up the search requester where you can enter a
86 regular expression to search (again) for.
87
88Format
89======
90
91Used to alter the way the text is reformatted before display.
92
93Strip CR Removes those pesky DOS crs from the file.
94Strip HTML Uses a very simple minded filter to remove html mark-up.
95Dehyphen Removes hyphens from e-texts which have been formatted to
96 fit on different sized displays by hyphenating words
97 which no longer appear at the end of the line.
98Unindent Removes leading spaces from the beginning of paragraphs.
99Re-paragraph Removes/adds line breaks as necessary to make the text
100 look nice on the display.
101Double Space Adds an extra space between paragraphs.
102Indent+ Increases the number of extra leading spaces inserted
103 before paragraphs.
104Indent- Decreases the number of extra leading spaces inserted
105 before paragraphs.
106 Bold Sets the font to bold (if its supported by the currently
107 selected font).
108
109For e-texts from fictionwise I don't need any of these enabled. For
110Project Gutenberg e-texts I enable Strip CR, Re-paragraph and either 3 lots
111of indent+ and/or double space.
112
113Zoom Menu option not implemented but pops up an info box
114 telling you that left/right cursor keys will zoom
115 out/in.
116Ideogram/Char grouping When selected, treats each character as a word
117 and enforces uniform character spacing - suitable for
118 many eastern character sets. When not selected, looks for
119 spaces in the text to identify words - suitable for most
120 western texts. (I'm not a language expert so forgive my,
121 probably inaccurate, generalisations).
122Set Width Sets the character spacing as a percentage of the text
123 height to be used when in ideogram mode. Start at 100 and
124 experiment to find what you like best.
125Encoding Allows you to choose from a variety of codings. Ascii is
126 actually unprocessed text so its precise behaviour may
127 depend on the machines locale setting. Palm and code page
128 1252 are very similar and are useful if you have an etext
129 aimed at Palms or Windows machines which use an extended
130 character set - though you will need to use a unicode
131 enabled font to show all the characters. The U... fonts
132 are different varieties of unicode encodings. If you
133 don't know what that means you probably don't need them
134 (they allow texts to access the full range of characters
135 required for non US English languages).
136Set Font Allows you to choose which font the text is displayed
137 in. Helvetica or smoothtimes are probably best for ascii type
138 texts, unifont or cyberbit (if you have installed them)
139 are best for extended character sets (other unicode fonts
140 may also be available but these are all I've found, so far).
141Marks
142=====
143
144 Mark Saves the current position as a bookmark
145Goto Allows selection of a bookmark to jump to.
146Delete Deletes an unwanted bookmark from the current text.
147Autogen Displays a box for entering a regular
148 expression which will be used to determine which
149 paragraphs (not lines) will be marked to allow jumping to
150 directly using the Goto option. The format options
151 described above are applied before the regular expression
152 matching is done.
153 This operation is performed in the background allowing
154 you to continue paging up/down the e-text.
155Clear Deletes all in-memory bookmarks from the current document.
156Save Saves the "in-memory" bookmarks to disk.
157Tidy Deletes bookmark file for a document. The operations
158 above work on an in-memory copy of the bookmarks. This
159 option makes that copy more permanent (you will also be
160 prompted to save the bookmarks when closing a text if the
161 in-memory copy is different to the saved copy).
162