1 \subsection{Text Viewer
}
2 \screenshot{plugins/images/ss-text_viewer-main
}{Text Viewer
}{img:text_viewer-main
}
3 This is a Viewer for text files with word wrap. Just open a
\fname{.txt
} or
4 \fname{.nfo
} file to display it. The text viewer features controls to handle
5 various styles of text formatting and has top
{}-of
{}-file and bottom
{}-of
{}-file
6 buttons. You can view files without a
\fname{.txt
} or
\fname{.nfo
} extension
7 by using
\emph{Open with
} from the
\emph{Context Menu
}
8 (see
\reference{ref:Contextmenu
}). You can also bookmark pages.
10 \subsubsection{Default keys
}
12 \opt{PLAYER_PAD
}{\ButtonLeft}
13 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD
%
14 ,SANSA_E200_PAD,SANSA_FUZE_PAD,GIGABEAT_PAD,MROBE100_PAD
}{\ButtonUp}
15 \opt{IPOD_4G_PAD,IPOD_3G_PAD
}{\ButtonScrollBack}
16 \opt{IRIVER_H10_PAD
}{\ButtonScrollUp}
17 \opt{SANSA_C200_PAD,SANSA_CLIP_PAD
}{\ButtonVolUp}
18 \opt{GIGABEAT_S_PAD
}{\ButtonPrev}
19 \opt{COWON_D2_PAD
}{\ButtonMinus{} /
}%
20 \opt{touchscreen
}{\TouchTopMiddle}
21 \opt{PBELL_VIBE500_PAD
}{\ButtonOK}
22 \opt{MPIO_HD200_PAD
}{FIXME
}
23 \opt{HAVEREMOTEKEYMAP
}{&
24 \opt{IAUDIO_M3_PAD
}{\ButtonRCUp}
28 \opt{PLAYER_PAD
}{\ButtonRight}
29 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD
%
30 ,SANSA_E200_PAD,SANSA_FUZE_PAD,GIGABEAT_PAD,MROBE100_PAD
}{\ButtonDown}
31 \opt{IPOD_4G_PAD,IPOD_3G_PAD
}{\ButtonScrollFwd}
32 \opt{IRIVER_H10_PAD
}{\ButtonScrollDown}
33 \opt{SANSA_C200_PAD,SANSA_CLIP_PAD
}{\ButtonVolDown}
34 \opt{GIGABEAT_S_PAD
}{\ButtonNext}
35 \opt{COWON_D2_PAD
}{\ButtonPlus{} /
}%
36 \opt{touchscreen
}{\TouchBottomMiddle}
37 \opt{PBELL_VIBE500_PAD
}{\ButtonCancel}
38 \opt{MPIO_HD200_PAD
}{FIXME
}
39 \opt{HAVEREMOTEKEYMAP
}{&
40 \opt{IAUDIO_M3_PAD
}{\ButtonRCDown}
44 \opt{PLAYER_PAD
}{\ButtonMenu+
\ButtonLeft}
45 \opt{GIGABEAT_S_PAD
}{\ButtonPlay+
\ButtonLeft}
46 \opt{MPIO_HD200_PAD
}{FIXME
}
47 \opt{touchscreen
}{\TouchMidLeft}
48 \nopt{PLAYER_PAD,GIGABEAT_S_PAD,touchscreen,IAUDIO_M3_PAD,MPIO_HD200_PAD
}
50 \opt{HAVEREMOTEKEYMAP
}{&
51 \opt{IAUDIO_M3_PAD
}{\ButtonRCLeft}
53 & Top of file (Narrow mode) /
54 One screen left (Wide mode)\\
56 \opt{PLAYER_PAD
}{\ButtonMenu+
\ButtonRight}
57 \opt{GIGABEAT_S_PAD
}{\ButtonPlay+
\ButtonRight}
58 \opt{MPIO_HD200_PAD
}{FIXME
}
59 \opt{touchscreen
}{\TouchMidRight}
60 \nopt{PLAYER_PAD,GIGABEAT_S_PAD,touchscreen,IAUDIO_M3_PAD,MPIO_HD200_PAD
}
62 \opt{HAVEREMOTEKEYMAP
}{&
63 \opt{IAUDIO_M3_PAD
}{\ButtonRCRight}
65 & Bottom of file (Narrow mode) /
66 One screen right (Wide mode)\\
68 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,SANSA_E200_PAD
%
69 ,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,GIGABEAT_S_PAD
%
70 ,GIGABEAT_PAD,PBELL_VIBE500_PAD,MPIO_HD200_PAD
}{%
71 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD
}{\ButtonOn+
\ButtonUp}
72 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD
}{\ButtonScrollBack}
73 \opt{SANSA_C200_PAD,SANSA_CLIP_PAD,GIGABEAT_S_PAD,PBELL_VIBE500_PAD
}{\ButtonUp}
74 \opt{MPIO_HD200_PAD
}{FIXME
}
75 \opt{GIGABEAT_PAD
}{\ButtonA+
\ButtonUp}
76 \opt{HAVEREMOTEKEYMAP
}{&
}
80 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,SANSA_E200_PAD
%
81 ,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,GIGABEAT_S_PAD
%
82 ,GIGABEAT_PAD,PBELL_VIBE500_PAD,MPIO_HD200_PAD
}{%
83 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD
}{\ButtonOn+
\ButtonDown}
84 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD
}{\ButtonScrollFwd}
85 \opt{SANSA_C200_PAD,SANSA_CLIP_PAD,GIGABEAT_S_PAD,PBELL_VIBE500_PAD
}{\ButtonDown}
86 \opt{MPIO_HD200_PAD
}{FIXME
}
87 \opt{GIGABEAT_PAD
}{\ButtonA+
\ButtonDown}
88 \opt{HAVEREMOTEKEYMAP
}{&
}
92 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,
%
93 GIGABEAT_S_PAD,MPIO_HD200_PAD
}{
94 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD
}{\ButtonOn+
\ButtonLeft}
95 \opt{GIGABEAT_S_PAD
}{\ButtonLeft}
96 \opt{GIGABEAT_PAD
}{\ButtonA+
\ButtonLeft}
97 \opt{MPIO_HD200_PAD
}{FIXME
}
98 \opt{HAVEREMOTEKEYMAP
}{&
}
102 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,
%
103 GIGABEAT_S_PAD,MPIO_HD200_PAD
}{
104 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD
}{\ButtonOn+
\ButtonRight}
105 \opt{GIGABEAT_S_PAD
}{\ButtonRight}
106 \opt{GIGABEAT_PAD
}{\ButtonA+
\ButtonRight}
107 \opt{MPIO_HD200_PAD
}{FIXME
}
108 \opt{HAVEREMOTEKEYMAP
}{&
}
112 \opt{RECORDER_PAD,PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD
%
113 ,IRIVER_H10_PAD,GIGABEAT_S_PAD,PBELL_VIBE500_PAD
}{\ButtonPlay}
114 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD
}{\ButtonSelect}
115 \opt{ONDIO_PAD
}{\ButtonMenu}
116 \opt{GIGABEAT_PAD
}{\ButtonA}
117 \opt{SANSA_C200_PAD,SANSA_E200_PAD
}{\ButtonRec}
118 \opt{SANSA_CLIP_PAD
}{\ButtonHome}
119 \opt{SANSA_FUZE_PAD
}{\ButtonDown+
\ButtonSelect}
120 \opt{MROBE100_PAD
}{\ButtonDisplay}
121 \opt{MPIO_HD200_PAD
}{FIXME
}
122 \opt{touchscreen
}{\TouchCenter}
123 \opt{HAVEREMOTEKEYMAP
}{&
124 \opt{IAUDIO_M3_PAD
}{\ButtonRCMode}
126 & Toggle autoscroll\\
128 \opt{PLAYER_PAD
}{\ButtonOn}
129 \opt{RECORDER_PAD
}{\ButtonFTwo}
130 \opt{ONDIO_PAD
}{\ButtonMenu+
\ButtonOff}
131 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD
}{\ButtonOn+
\ButtonSelect}
132 \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD
}{\ButtonSelect}
133 \opt{IRIVER_H10_PAD
}{\ButtonFF}
134 \opt{IAUDIO_X5_PAD
}{\ButtonRec}
135 \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD
}{\ButtonDown+
\ButtonSelect}
136 \opt{COWON_D2_PAD
}{\ButtonMenu+
\ButtonPlus}
137 \opt{SANSA_FUZE_PAD
}{\ButtonUp+
\ButtonSelect}
138 \opt{PBELL_VIBE500_PAD
}{\ButtonPower}
139 \opt{MPIO_HD200_PAD
}{FIXME
}
140 \opt{HAVEREMOTEKEYMAP
}{&
141 \opt{IAUDIO_M3_PAD
}{\ButtonRCPlay+
\ButtonRCMode}
143 & Set/Reset bookmarks\\
145 \opt{RECORDER_PAD
}{\ButtonFOne}
146 \opt{ONDIO_PAD
}{Long
\ButtonMenu}
147 \opt{PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD
%
148 ,MROBE100_PAD,PBELL_VIBE500_PAD
}{\ButtonMenu}
149 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD
}{\ButtonMode}
150 \opt{IAUDIO_X5_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,SANSA_E200_PAD
}{\ButtonSelect}
151 \opt{SANSA_FUZE_PAD
}{Long
\ButtonSelect}
152 \opt{IRIVER_H10_PAD
}{\ButtonRew}
153 \opt{COWON_D2_PAD
}{\ButtonMenu{} /
}%
154 \opt{MPIO_HD200_PAD
}{FIXME
}
155 \opt{touchscreen
}{\TouchTopRight}
156 \opt{HAVEREMOTEKEYMAP
}{&
157 \opt{IAUDIO_M3_PAD
}{\ButtonRCPlay}
161 \opt{PLAYER_PAD
}{\ButtonStop}
162 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD
}{\ButtonOff}
163 \opt{IPOD_4G_PAD,IPOD_3G_PAD
}{\ButtonSelect+
\ButtonMenu}
164 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD
%
165 ,GIGABEAT_PAD,MROBE100_PAD
}{\ButtonPower}
166 \opt{SANSA_FUZE_PAD
}{Long
\ButtonHome}
167 \opt{GIGABEAT_S_PAD
}{\ButtonBack}
168 \opt{COWON_D2_PAD
}{\ButtonPower{} /
}%
169 \opt{touchscreen
}{\TouchTopLeft}
170 \opt{IAUDIO_M3_PAD,PBELL_VIBE500_PAD
}{\ButtonRec}
171 \opt{MPIO_HD200_PAD
}{FIXME
}
172 \opt{HAVEREMOTEKEYMAP
}{&
173 \opt{IAUDIO_M3_PAD
}{\ButtonRCRec}
174 \opt{IRIVER_RC_H100_PAD
}{\ButtonRCStop}
183 \item[Return
] Return to the file being viewed.
184 \item[Viewer Options
] Change settings for the current file.
186 \item[Encoding
] Set the codepage in the text viewer.
187 % ToDo: wrap some of the following settings into a \opt{lcd_bitmap} to exlude
188 % ones that don't work on charcell - as soon as the plugin itself does
190 \setting{ISO-
8859-
1} (Latin
1).
191 \setting{ISO-
8859-
7} (Greek),
193 \setting{ISO-
8859-
8} (Hebrew),
195 \setting{CP1251
} (Cyrillic),
197 \setting{ISO-
8859-
11} (Thai),
198 \setting{CP1256
} (Arabic),
200 \setting{ISO-
8859-
9} (Turkish),
201 \setting{ISO-
8859-
2} (Latin Extended),
202 \setting{CP1250
} (Central European),
204 \setting{SJIS
} (Japanese),
205 \setting{GB-
2312} (Simple Chinese),
206 \setting{KSX-
1001} (Korean),
207 \setting{BIG5
} (Traditional Chinese),
209 \setting{UTF-
8} (Unicode),
210 This setting only applies to the plugin and is independent from the
211 \setting{Default Codepage
} setting (see
\reference{ref:Defaultcodepage
}).
212 \item[Word Wrap
] Toggle word wrap mode.
214 \item[On
] Break lines at the maximum column limit.
215 \item[Off (Chop Words)
] Break lines at white space or hyphen.
217 \item[Line Mode
] Change how lines are displayed.
219 \item[Normal
] Break lines at newline characters.
220 \item[Join
] Join lines together.
221 \item[Expand
] Add a blank line at newlines. Useful for making paragraphs
222 clearer in some book style text files.
224 \item[Reflow Lines
] Justify the text.
227 \item[Screens Per Page
] Set the number of screens per page. Available
228 options are
\setting{1} to
\setting{5} screens per page.
229 \item[Alignment
] Set the text alignment.
231 \item[Right
] Set the text alignment to the right.
232 (Useful for displaying right-to-left languages, such as Arabic or Hebrew)
233 \item[Left
] Set the text alignment to the left.
236 \item[Show Header
] Select whether to show the header. The header displays the file path.
238 \item[No
] Do not display the header.
239 \item[Yes
] Display the header.
241 \item[Show Footer
] Select whether to show the footer. The footer dispays the page number.
243 \item[No
] Do not display the footer.
244 \item[Yes
] Display the footer.
247 \item[Font
] Select the font to be used by the Text Viewer.
248 \item[Show Statusbar
] Select whether to show the status bar. If you select
249 a theme settings that the status bar does not display (see
250 \reference{ref:configure_rockbox_themes
}), the status bar is not
251 displayed even if you select
\setting{Yes
}.
253 \item[No
] Do not display the status bar.
254 \item[Yes
] Display the status bar.
257 \item[Scroll Settings
] The scrolling settings submenu.
259 \item[Horizontal
] Submenu for horizontal scrolling settings.
261 \item[Scrollbar
] Toggle the horizontal scrollbar for the
262 current mode. If the file fits on one screen, there is no
263 scrollbar and this setting has no effect.
265 \item[No
] Do not display the horizontal scroll bar.
266 \item[Yes
] Display the horizontal scroll bar.
268 \item[Scroll Mode
] Change the function of the ``Left'' and
271 \item[Scroll by Screen
] Move to the previous/next
273 \item[Scroll by Column
] Move to the previous/next
277 \item[Vertical
] Submenu for vertical scrolling settings.
279 \item[Scrollbar
] Toggle the vertical scrollbar for the
280 current mode. If the file fits on one screen, there is no
281 scrollbar and this setting has no effect.
283 \item[No
] Do not display the vertical scroll bar.
284 \item[Yes
] Display the vertical scroll bar.
286 \item[Scroll Mode
] Change the function of the ``Scroll-up''
287 and ``Scroll-down'' buttons.
289 \item[Scroll by Page
] Scroll up or down one full screen.
290 \item[Scroll by Line
] Scroll up or down one line.
293 \item[Overlap Pages
] Set whether the last line from the
294 previous screen is retained when scrolling pages.
296 \item[No
] Do not retain previous line.
297 \item[Yes
] Retain previous line.
300 \item[Auto-scroll Speed
] Control the speed of auto-scrolling
301 in number of lines per second. Available options are
302 \setting{1} to
\setting{10} lines per second. As an example,
303 \setting{4} will scroll the text at four lines per second.
304 \item[Left/Right Key (Narrow mode)
] Change the function of
305 the ``Left'' and ``Right'' buttons when the screen is in
306 narrow mode (i.e. one screen per page).
308 \item[Previous/Next Page
] Scroll up or down one full screen.
309 \item[Top/Bottom Page
] Move to the top or bottom page.
313 \item[Indent Spaces
] Set the number of spaces to indent the text when line
314 mode is set to
\setting{Reflow Lines
}. Available options are
\setting{0}
315 to
\setting{5} spaces. If you select
\setting{0}, a blank line is
316 displayed as an indent.
319 \item[Show Playback Menu
] Display the playback menu to allow control of the
320 currently playing music without leaving the plugin.
322 \item[Select Bookmark
] Select a saved bookmark. In the screenshot below, the
323 ``*'' denotes the current page.
325 \screenshot{plugins/images/ss-text_viewer-sel_bk_menu
}{The select bookmark menu
}{img:text_viewer-sel_bk
}
327 \item[Global Settings
] Set the default settings for the text viewer.
328 The setting items are the same as
\setting{Viewer Options
}. The global
329 settings are stored in
330 \fname{.rockbox/rocks/viewers/viewer.dat
}.
332 \item[Quit
] Exits the plugin. The text viewer automatically
333 stores its settings, the current position and bookmarks in
334 \fname{.rockbox/rocks/viewers/viewer
\_file.dat
}.
337 \subsubsection{Bookmarks
}
338 To add a bookmark, press
339 \opt{PLAYER_PAD
}{\ButtonOn}\opt{RECORDER_PAD
}{\ButtonFTwo}%
340 \opt{ONDIO_PAD
}{\ButtonMenu+
\ButtonOff}%
341 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD
}{\ButtonOn+
\ButtonSelect}%
342 \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD
}{\ButtonSelect}%
343 \opt{IRIVER_H10_PAD
}{\ButtonFF}\opt{IAUDIO_X5_PAD
}{\ButtonRec}%
344 \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD
}{\ButtonDown+
\ButtonSelect}%
345 \opt{COWON_D2_PAD
}{\ButtonMenu+
\ButtonPlus}%
346 \opt{SANSA_FUZE_PAD
}{\ButtonUp+
\ButtonSelect}%
347 \opt{IAUDIO_M3_PAD
}{\ButtonRCPlay+
\ButtonRCMode}.
348 \opt{MPIO_HD200_PAD
}{FIXME
}
349 The bookmark will be displayed as shown below. To delete the bookmark
350 press the same button again.
352 \screenshot{plugins/images/ss-text_viewer-bookmark
}{A bookmark
}{img:text_viewer-bookmark
}