diff options
-rw-r--r-- | manual/plugins/text_viewer.tex | 254 |
1 files changed, 145 insertions, 109 deletions
diff --git a/manual/plugins/text_viewer.tex b/manual/plugins/text_viewer.tex index 4028f56adc..2bffae0ad7 100644 --- a/manual/plugins/text_viewer.tex +++ b/manual/plugins/text_viewer.tex | |||
@@ -5,135 +5,171 @@ formatting, has top{}-of{}-file and bottom{}-of{}-file buttons. You can view | |||
5 | files without a \fname{.txt} extension by using \emph{Open with} from the | 5 | files without a \fname{.txt} extension by using \emph{Open with} from the |
6 | \emph{Context Menu} (see \reference{ref:Contextmenu}). | 6 | \emph{Context Menu} (see \reference{ref:Contextmenu}). |
7 | 7 | ||
8 | \subsubsection{Mode settings} | ||
9 | |||
10 | \begin{description} | ||
11 | \item[Word mode] toggles between Wrap and Chop. | ||
12 | \begin{description} | ||
13 | \item[Wrap] breaks lines at white space or hyphen. | ||
14 | \item[Chop] breaks lines at the maximum column limit. | ||
15 | \end{description} | ||
16 | \item[Line mode] cycles through Normal, Join and Expand. | ||
17 | \begin{description} | ||
18 | \item[Normal] breaks lines at newline characters. | ||
19 | \item[Join] ignores unpaired newline characters (i.e., joins lines). | ||
20 | Useful for adopting the orphans that occur with e{}-mail style | ||
21 | (i.e.,pre{}-wrapped) text files. | ||
22 | \item[Expand] doubles unpaired newlines (i.e., adds a blank line). | ||
23 | Useful for making the paragraphs clearer in some book style text files. | ||
24 | \end{description} | ||
25 | \item[View mode] toggles between Narrow and Wide. | ||
26 | \begin{description} | ||
27 | \item[Narrow] sets maximum column to the screen width. | ||
28 | \item[Wide] sets maximum column to 114. Useful for navigating large files. (Currently, Wide and Join cannot be selected together.) | ||
29 | \end{description} | ||
30 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,SANSA_E200_PAD}{ | ||
31 | \item[Page mode] toggles between Normal and Overlap. | ||
32 | \begin{description} | ||
33 | \item[Normal] sets page{}-down/page{}-up to one full screen. | ||
34 | \item[Overlap] tells page{}-down/page{}-up to retain one line from previous screen. | ||
35 | \end{description} | ||
36 | \item[Scrollbar mode] toggles scrollbar for the current View mode. | ||
37 | \begin{description} | ||
38 | \item[Narrow mode] has no scrollbar by default, until toggled. | ||
39 | \item[Wide mode] has a scrollbar by default, until toggled. | ||
40 | \end{description} | ||
41 | } | ||
42 | \end{description} | ||
43 | Settings are not remembered after the viewer has been exited. | ||
44 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,ANSA_E200_PAD}{ | ||
45 | If file fits on one screen, there is no scrollbar and toggling Scrollbar mode has no effect.} | ||
46 | 8 | ||
47 | \begin{table} | 9 | \begin{table} |
48 | \begin{btnmap}{}{} | 10 | \begin{btnmap}{}{} |
49 | \opt{PLAYER_PAD}{\ButtonLeft} | 11 | \opt{PLAYER_PAD}{\ButtonLeft} |
50 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonUp} | 12 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD% |
51 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack} | 13 | ,SANSA_E200_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonUp} |
14 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack} | ||
52 | \opt{IRIVER_H10_PAD}{\ButtonScrollUp} | 15 | \opt{IRIVER_H10_PAD}{\ButtonScrollUp} |
53 | & Page{}-up (one screen up)\\ | 16 | \opt{SANSA_C200_PAD}{\ButtonVolUp} |
54 | 17 | & Scroll{}-up\\ | |
18 | |||
55 | \opt{PLAYER_PAD}{\ButtonRight} | 19 | \opt{PLAYER_PAD}{\ButtonRight} |
56 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonDown} | 20 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD% |
57 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd} | 21 | ,SANSA_E200_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonDown} |
22 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd} | ||
58 | \opt{IRIVER_H10_PAD}{\ButtonScrollDown} | 23 | \opt{IRIVER_H10_PAD}{\ButtonScrollDown} |
59 | & Page{}-down (one screen down)\\ | 24 | \opt{SANSA_C200_PAD}{\ButtonVolDown} |
60 | 25 | & Scroll{}-down\\ | |
26 | |||
61 | \opt{PLAYER_PAD}{\ButtonMenu+\ButtonLeft} | 27 | \opt{PLAYER_PAD}{\ButtonMenu+\ButtonLeft} |
62 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonLeft} | 28 | \nopt{PLAYER_PAD}{\ButtonLeft} |
63 | & Top of file (Narrow mode) One screen left (Wide mode)\\ | 29 | & Top of file (Narrow mode) / |
64 | 30 | One screen left (Wide mode)\\ | |
31 | |||
65 | \opt{PLAYER_PAD}{\ButtonMenu+\ButtonRight} | 32 | \opt{PLAYER_PAD}{\ButtonMenu+\ButtonRight} |
66 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,GIGABEAT_PAD,MROBE100_PAD} | 33 | \nopt{PLAYER_PAD}{\ButtonRight} |
67 | {\ButtonRight} | 34 | & Bottom of file (Narrow mode) / |
68 | & Bottom of file (Narrow mode) One screen right (Wide mode)\\ | 35 | One screen right (Wide mode)\\ |
69 | 36 | ||
70 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD} | 37 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{% |
71 | {\ButtonOn+\ButtonUp & One line up\\} | 38 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonUp} |
72 | 39 | \opt{SANSA_E200_PAD}{\ButtonScrollBack} | |
73 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD} | 40 | \opt{SANSA_C200_PAD}{\ButtonUp} |
74 | {\ButtonOn+\ButtonDown & One line down\\} | 41 | & One line up\\ |
75 | 42 | } | |
76 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD} | 43 | |
77 | {\ButtonOn+\ButtonLeft & One column left\\} | 44 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{% |
78 | 45 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonDown} | |
79 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD} | 46 | \opt{SANSA_E200_PAD}{\ButtonScrollFwd} |
80 | {\ButtonOn+\ButtonRight & One column right\\} | 47 | \opt{SANSA_C200_PAD}{\ButtonDown} |
81 | 48 | & One line down\\ | |
82 | \opt{PLAYER_PAD}{\ButtonOn+\ButtonLeft} | 49 | } |
50 | |||
51 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{ | ||
52 | \ButtonOn+\ButtonLeft | ||
53 | & One column left\\ | ||
54 | } | ||
55 | |||
56 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{ | ||
57 | \ButtonOn+\ButtonRight | ||
58 | & One column right\\ | ||
59 | } | ||
60 | |||
61 | \opt{RECORDER_PAD,PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPlay} | ||
62 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect} | ||
63 | \opt{ONDIO_PAD}{\ButtonMenu} | ||
64 | \opt{GIGABEAT_PAD}{\ButtonA} | ||
65 | \opt{SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonRec} | ||
66 | \opt{MROBE100_PAD}{\ButtonDisplay} | ||
67 | & Toggle autoscroll\\ | ||
68 | |||
83 | \opt{RECORDER_PAD}{\ButtonFOne} | 69 | \opt{RECORDER_PAD}{\ButtonFOne} |
84 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft} | 70 | \opt{ONDIO_PAD}{Long \ButtonMenu} |
85 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec} | 71 | \opt{PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonMenu} |
86 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonLeft} | ||
87 | \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPlay} | ||
88 | \opt{SANSA_E200_PAD}{\ButtonScrollBack} | ||
89 | & Toggles Word mode\\ | ||
90 | |||
91 | \opt{PLAYER_PAD}{\ButtonOn+\ButtonMenu+\ButtonRight} | ||
92 | \opt{RECORDER_PAD}{\ButtonFTwo} | ||
93 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonUp} | ||
94 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode} | 72 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode} |
95 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonPlay} | 73 | \opt{IAUDIO_X5_PAD,SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonSelect} |
96 | \opt{IAUDIO_X5_PAD}{Long press on \ButtonPlay} | 74 | \opt{IRIVER_H10_PAD}{\ButtonRew} |
97 | \opt{IRIVER_H10_PAD,SANSA_E200_PAD}{n/a} | 75 | & Enter menu\\ |
98 | & Cycles line mode\\ | 76 | |
99 | |||
100 | \opt{PLAYER_PAD}{\ButtonOn+\ButtonRight} | ||
101 | \opt{RECORDER_PAD}{\ButtonFThree} | ||
102 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight} | ||
103 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonSelect} | ||
104 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonRight} | ||
105 | \opt{IRIVER_H10_PAD,SANSA_E200_PAD}{n/a} | ||
106 | & Toggles view mode\\ | ||
107 | |||
108 | \opt{RECORDER_PAD}{\ButtonOn+\ButtonFOne & Toggles page mode\\} | ||
109 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown & Toggles page mode\\} | ||
110 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD} | ||
111 | {\ButtonOn+\ButtonMode & Toggles page mode\\} | ||
112 | \opt{IPOD_4G_PAD,IPOD_3G_PAD} | ||
113 | {\ButtonSelect+\ButtonMenu+\ButtonLeft & Toggles page mode\\} | ||
114 | |||
115 | \opt{RECORDER_PAD}{\ButtonOn+\ButtonFThree & Toggles scrollbar mode\\} | ||
116 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonOff & Toggles scrollbar mode\\} | ||
117 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD} | ||
118 | {\ButtonOn+\ButtonRec & Toggles scrollbar mode\\} | ||
119 | \opt{IPOD_4G_PAD,IPOD_3G_PAD} | ||
120 | {\ButtonSelect+\ButtonLeft+\ButtonRight & Toggles scrollbar mode\\} | ||
121 | |||
122 | \opt{PLAYER_PAD}{\ButtonStop} | 77 | \opt{PLAYER_PAD}{\ButtonStop} |
123 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff} | 78 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff} |
124 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu} | 79 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu} |
125 | \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonPower} | 80 | \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD% |
81 | ,MROBE100_PAD}{\ButtonPower} | ||
126 | & Exit text viewer\\ | 82 | & Exit text viewer\\ |
83 | |||
127 | \end{btnmap} | 84 | \end{btnmap} |
128 | \end{table} | 85 | \end{table} |
129 | 86 | ||
87 | \subsubsection{The Viewer's Menu} | ||
88 | |||
89 | \begin{description} | ||
90 | \item[Quit] Exits the plugin. | ||
91 | \item[Viewer Options] | ||
92 | \begin{description} | ||
93 | \item[Encoding] | ||
94 | sets the codepage in the text viewer. | ||
95 | % ToDo: wrap some of the following settings into a \opt{lcd_bitmap} to exlude | ||
96 | % ones that don't work on charcell - as soon as the plugin itself does | ||
97 | Available settings: | ||
98 | \setting{UTF-8} (Unicode), | ||
99 | \setting{BIG5} (Traditional Chinese), | ||
100 | \setting{KSX-1001} (Korean), | ||
101 | \setting{GB-2312} (Simple Chinese), | ||
102 | \setting{SJIS} (Japanese), | ||
103 | \setting{CP1250} (Central European), | ||
104 | \setting{ISO-8859-2} (Latin Extended), | ||
105 | \setting{ISO-8859-9} (Turkish), | ||
106 | \setting{ISO-8859-6} (Arabic), | ||
107 | \setting{ISO-8859-11} (Thai), | ||
108 | \setting{CP1251} (Cyrillic), | ||
109 | \setting{ISO-8859-8} (Hebrew), | ||
110 | \setting{ISO-8859-7} (Greek), | ||
111 | \setting{ISO-8859-1} (Latin 1). | ||
112 | This setting only applies to the plugin and is independent from the | ||
113 | \setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}). | ||
114 | \item[Word Wrap] toggles between Wrap and Chop. | ||
115 | \begin{description} | ||
116 | \item[Off (Chop Words)] breaks lines at white space or hyphen. | ||
117 | \item[On] breaks lines at the maximum column limit. | ||
118 | \end{description} | ||
119 | \item[Line Mode] cycles through Normal, Join and Expand and Reflow Lines. | ||
120 | \begin{description} | ||
121 | \opt{lcd_bitmap}{ | ||
122 | \item[Reflow Lines] justifies the text fully. | ||
123 | } | ||
124 | \item[Expand] adds a blank line. Useful for making the paragraphs | ||
125 | clearer in some book style text files. | ||
126 | \item[Join] joins lines. Useful for adopting the orphans that | ||
127 | occur with e{}-mail style (i.e. pre{}-wrapped) text files. | ||
128 | \item[Normal] breaks lines at newline characters. | ||
129 | \end{description} | ||
130 | \item[Wide View] toggles between Narrow and Wide. | ||
131 | \begin{description} | ||
132 | \item[Yes] sets maximum column to 114. Useful for navigating large files. | ||
133 | (Currently, Wide and Join cannot be selected together.) | ||
134 | \item[No (Narrow)] sets maximum column to the screen width. | ||
135 | \end{description} | ||
136 | \opt{lcd_bitmap}{ | ||
137 | \item[Show Scrollbar] toggles scrollbar for the current View mode. If the | ||
138 | file fits on one screen, there is no scrollbar and toggling this setting | ||
139 | has no effect. | ||
140 | \begin{description} | ||
141 | \item[On] has a scrollbar by default, until toggled. | ||
142 | \item[Off] has no scrollbar by default, until toggled. | ||
143 | \end{description} | ||
144 | \item[Overlap Pages] toggles between Normal and Overlap. | ||
145 | \begin{description} | ||
146 | \item[Yes] tells page{}-down/page{}-up to retain one line from previous screen. | ||
147 | \item[No] sets page{}-down/page{}-up to one full screen. | ||
148 | \end{description} | ||
149 | } | ||
150 | \item[Scroll Mode] controls the function of the ``Scroll-up'' and | ||
151 | ``Scroll-down'' buttons. | ||
152 | \begin{description} | ||
153 | \item[Scroll by Line] | ||
154 | \item[Scroll by Page] | ||
155 | \end{description} | ||
156 | \item[Auto-scroll Speed] | ||
157 | controls the speed of auto-scrolling in number of lines per scroll step, | ||
158 | available options are \setting{1} to \setting{10} lines. As an example, | ||
159 | a setting of \setting{4} will scroll up the text four lines per second. | ||
160 | \end{description} | ||
161 | |||
162 | \item[Show Playback Menu] controls the playback of the currently loaded playlist | ||
163 | and change the volume of your \dap without leaving the plugin. | ||
164 | \item[Return] to the text view. | ||
165 | \end{description} | ||
166 | |||
167 | \note{The text viewer automatically saves its settings and also stores the | ||
168 | current position in the viewed text files (up to the last 46 files).} | ||
169 | |||
130 | \subsubsection{Compatibility} | 170 | \subsubsection{Compatibility} |
131 | 171 | ||
132 | \begin{itemize} | 172 | \begin{itemize} |
133 | \item Correctly reads plain text files in Unix, Win/DOS, or Macintosh | 173 | \item Currently messages are in English |
134 | format. Latin{}-alphabet Unicode files are \emph{almost} readable. | ||
135 | \item Currently prefers fixed{}-width fonts. With proportional fonts, | ||
136 | pretends all characters are the width of a lower{}-case `o'. | ||
137 | \item Currently messages are in English | ||
138 | \item Does not currently support right{}-to{}-left languages. | 174 | \item Does not currently support right{}-to{}-left languages. |
139 | \end{itemize} | 175 | \end{itemize} |