diff options
author | Alex Parker <rockbox@aeparker.com> | 2010-03-17 21:58:41 +0000 |
---|---|---|
committer | Alex Parker <rockbox@aeparker.com> | 2010-03-17 21:58:41 +0000 |
commit | c3c928b29feb592ec9a4d9c93580611d129c991d (patch) | |
tree | 7fb618323fc83b958e1a1f7a98cdc01fcc003eb2 | |
parent | 80786564859ec95913560f549dec93081369755d (diff) | |
download | rockbox-c3c928b29feb592ec9a4d9c93580611d129c991d.tar.gz rockbox-c3c928b29feb592ec9a4d9c93580611d129c991d.zip |
Try to improve the English for the text viewer plugin. Only the English has been changed, the actual content still needs some work.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25238 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r-- | manual/plugins/text_viewer.tex | 139 |
1 files changed, 71 insertions, 68 deletions
diff --git a/manual/plugins/text_viewer.tex b/manual/plugins/text_viewer.tex index 88f4815c1e..1206b1d273 100644 --- a/manual/plugins/text_viewer.tex +++ b/manual/plugins/text_viewer.tex | |||
@@ -1,11 +1,11 @@ | |||
1 | \subsection{Text Viewer} | 1 | \subsection{Text Viewer} |
2 | \screenshot{plugins/images/ss-text_viewer-main}{Text Viewer}{img:text_viewer-main} | 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 \fname{.nfo} file to | 3 | This is a Viewer for text files with word wrap. Just open a \fname{.txt} or |
4 | display it. The text viewer features controls to handle various styles of text | 4 | \fname{.nfo} file to display it. The text viewer features controls to handle |
5 | formatting, has top{}-of{}-file and bottom{}-of{}-file buttons. You can view | 5 | various styles of text formatting and has top{}-of{}-file and bottom{}-of{}-file |
6 | files without a \fname{.txt} or \fname{.nfo} extension by using \emph{Open with} from the | 6 | buttons. You can view files without a \fname{.txt} or \fname{.nfo} extension |
7 | \emph{Context Menu} (see \reference{ref:Contextmenu}). You can put bookmarks any pages | 7 | by using \emph{Open with} from the \emph{Context Menu} |
8 | and it can jump the page where the bookmark is put. | 8 | (see \reference{ref:Contextmenu}). You can also bookmark pages. |
9 | 9 | ||
10 | \subsubsection{Default keys} | 10 | \subsubsection{Default keys} |
11 | \begin{table} | 11 | \begin{table} |
@@ -116,7 +116,7 @@ and it can jump the page where the bookmark is put. | |||
116 | \opt{HAVEREMOTEKEYMAP}{& | 116 | \opt{HAVEREMOTEKEYMAP}{& |
117 | \opt{IAUDIO_M3_PAD}{\ButtonRCPlay+\ButtonRCMode} | 117 | \opt{IAUDIO_M3_PAD}{\ButtonRCPlay+\ButtonRCMode} |
118 | } | 118 | } |
119 | & Set/Reset Bookmark\\ | 119 | & Set/Reset bookmarks\\ |
120 | 120 | ||
121 | \opt{RECORDER_PAD}{\ButtonFOne} | 121 | \opt{RECORDER_PAD}{\ButtonFOne} |
122 | \opt{ONDIO_PAD}{Long \ButtonMenu} | 122 | \opt{ONDIO_PAD}{Long \ButtonMenu} |
@@ -150,14 +150,13 @@ and it can jump the page where the bookmark is put. | |||
150 | \end{btnmap} | 150 | \end{btnmap} |
151 | \end{table} | 151 | \end{table} |
152 | 152 | ||
153 | \subsubsection{The Viewer's Menu} | 153 | \subsubsection{Menu} |
154 | 154 | ||
155 | \begin{description} | 155 | \begin{description} |
156 | \item[Return] to the text view. | 156 | \item[Return] Return to the file being viewed. |
157 | \item[Viewer Options] set the settings for the reading file. | 157 | \item[Viewer Options] Change settings for the current file. |
158 | \begin{description} | 158 | \begin{description} |
159 | \item[Encoding] | 159 | \item[Encoding] Set the codepage in the text viewer. |
160 | sets the codepage in the text viewer. | ||
161 | % ToDo: wrap some of the following settings into a \opt{lcd_bitmap} to exlude | 160 | % ToDo: wrap some of the following settings into a \opt{lcd_bitmap} to exlude |
162 | % ones that don't work on charcell - as soon as the plugin itself does | 161 | % ones that don't work on charcell - as soon as the plugin itself does |
163 | Available settings: | 162 | Available settings: |
@@ -183,91 +182,99 @@ and it can jump the page where the bookmark is put. | |||
183 | \setting{UTF-8} (Unicode), | 182 | \setting{UTF-8} (Unicode), |
184 | This setting only applies to the plugin and is independent from the | 183 | This setting only applies to the plugin and is independent from the |
185 | \setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}). | 184 | \setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}). |
186 | \item[Word Wrap] toggles between Wrap and Chop. | 185 | \item[Word Wrap] Toggle word wrap mode. |
187 | \begin{description} | 186 | \begin{description} |
188 | \item[On] breaks lines at the maximum column limit. | 187 | \item[On] Break lines at the maximum column limit. |
189 | \item[Off (Chop Words)] breaks lines at white space or hyphen. | 188 | \item[Off (Chop Words)] Break lines at white space or hyphen. |
190 | \end{description} | 189 | \end{description} |
191 | \item[Line Mode] cycles through Normal, Join and Expand and Reflow Lines. | 190 | \item[Line Mode] Change how lines are displayed. |
192 | \begin{description} | 191 | \begin{description} |
193 | \item[Normal] breaks lines at newline characters. | 192 | \item[Normal] Break lines at newline characters. |
194 | \item[Join] joins lines. Useful for adopting the orphans that | 193 | \item[Join] Join lines together. |
195 | occur with e{}-mail style (i.e. pre{}-wrapped) text files. | 194 | \item[Expand] Add a blank line at newlines. Useful for making paragraphs |
196 | \item[Expand] adds a blank line. Useful for making the paragraphs | ||
197 | clearer in some book style text files. | 195 | clearer in some book style text files. |
198 | \opt{lcd_bitmap}{ | 196 | \opt{lcd_bitmap}{ |
199 | \item[Reflow Lines] justifies the text fully. | 197 | \item[Reflow Lines] Justify the text. |
200 | } | 198 | } |
201 | \end{description} | 199 | \end{description} |
202 | \item[Wide View] toggles between Narrow and Wide. | 200 | \item[Wide View] Set the viewmode. |
203 | \begin{description} | 201 | \begin{description} |
204 | \item[No (Narrow)] sets maximum column to the screen width. | 202 | \item[No (Narrow)] Set the maximum column width to the screen width. |
205 | \item[Yes] sets maximum column to 114. Useful for navigating large files. | 203 | \item[Yes] Set the maximum column width to 114 pixels. |
206 | (Currently, Wide and Join cannot be selected together.) | 204 | (Currently, \setting{Wide} and \setting{Join} cannot be selected together.) |
207 | \end{description} | 205 | \end{description} |
208 | \opt{lcd_bitmap}{ | 206 | \opt{lcd_bitmap}{ |
209 | \item[Show Scrollbar] toggles scrollbar for the current View mode. If the | 207 | \item[Show Scrollbar] Toggle the scrollbar for the current mode. If the |
210 | file fits on one screen, there is no scrollbar and toggling this setting | 208 | file fits on one screen, there is no scrollbar and toggling this setting |
211 | has no effect. | 209 | has no effect. |
212 | \begin{description} | 210 | \begin{description} |
213 | \item[Off] has no scrollbar by default, until toggled. | 211 | \item[Off] Turn the scrollbar off. |
214 | \item[On] has a scrollbar by default, until toggled. | 212 | \item[On] Turn the scrollbar on. |
215 | \end{description} | 213 | \end{description} |
216 | \item[Overlap Pages] toggles between Normal and Overlap. | 214 | \item[Overlap Pages] Set whether the last line from the previous screen is |
215 | retained when scrolling pages. | ||
217 | \begin{description} | 216 | \begin{description} |
218 | \item[No] sets page{}-down/page{}-up to one full screen. | 217 | \item[No] Set page{}-down/page{}-up to one full screen. |
219 | \item[Yes] tells page{}-down/page{}-up to retain one line from previous screen. | 218 | \item[Yes] Set page{}-down/page{}-up to retain one line from the |
219 | previous screen. | ||
220 | \end{description} | 220 | \end{description} |
221 | } | 221 | } |
222 | \opt{lcd_bitmap}{ | 222 | \opt{lcd_bitmap}{ |
223 | \item[Show Header] selects whether or not the status bar and the reading file path. | 223 | \item[Show Header] Select whether to show the status bar and the current file path. |
224 | \begin{description} | 224 | \begin{description} |
225 | \item[None] do not display the status bar and the reading file path. | 225 | \item[None] Do not display the status bar or the current file path. |
226 | \item[File Path] displays the reading file path. (the status bar does not display.) | 226 | \item[File Path] Display only the current file path. |
227 | \item[Status bar] displays the status bar. (the reading file path does not display.) | 227 | \item[Status bar] Display only the status bar. |
228 | \item[Both] display the status bar and the reading file path. | 228 | \item[Both] Display both the status bar and the current file path. |
229 | \end{description} | 229 | \end{description} |
230 | \note{If the position of the status bar is not top, then \setting{Status bar} and \setting{Both} are not displayed.} | 230 | \note{If the status bar position is not set to the top of the screen then |
231 | \setting{Status bar} and \setting{Both} are not available.} | ||
231 | 232 | ||
232 | \item[Show Footer] selects whether or not the status bar and the page number. | 233 | \item[Show Footer] Select whether to show the status bar and the page number. |
233 | \begin{description} | 234 | \begin{description} |
234 | \item[None] do not display the status bar and the page number. | 235 | \item[None] Do not display the status bar or the page number. |
235 | \item[Page Num] displays the page number. (the status bar does not display.) | 236 | \item[Page Num] Display only the page number. |
236 | \item[Status bar] s the status bar. (the page number does not display.) | 237 | \item[Status bar] Display only the status bar. |
237 | \item[Both] display the status bar and the page number. | 238 | \item[Both] Display both the status bar and the page number. |
238 | \end{description} | 239 | \end{description} |
239 | \note{If the position of the status bar is not bottom, then \setting{Status bar} and \setting{Both} are not displayed.} | 240 | \note{If the status bar position is not set to the bottom of the screen then |
241 | \setting{Status bar} and \setting{Both} are not available.} | ||
240 | 242 | ||
241 | \item[Font] selects the font which displsy the text. When the font is changed, also the font of the text viewer's menu changes. But when this plugin exit, \setting{Main Menu} is displayed with the original font (i.e., the font which selects \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Font}. See \reference{ref:configure_rockbox_themes}). | 243 | \item[Font] Select the font to be used by the Text Viewer. |
242 | } | 244 | } |
243 | \item[Scroll Mode] controls the function of the ``Scroll-up'' and | 245 | \item[Scroll Mode] Change the function of the ``Scroll-up'' and |
244 | ``Scroll-down'' buttons. | 246 | ``Scroll-down'' buttons. |
245 | \begin{description} | 247 | \begin{description} |
246 | \item[Scroll by Page] | 248 | \item[Scroll by Page] |
247 | \item[Scroll by Line] | 249 | \item[Scroll by Line] |
248 | \end{description} | 250 | \end{description} |
249 | \item[Auto-scroll Speed] | 251 | \item[Auto-scroll Speed] Control the speed of auto-scrolling in number |
250 | controls the speed of auto-scrolling in number of lines per scroll step, | 252 | of lines per second. Available options are \setting{1} to |
251 | available options are \setting{1} to \setting{10} lines. As an example, | 253 | \setting{10} lines per second. As an example, |
252 | a setting of \setting{4} will scroll up the text four lines per second. | 254 | \setting{4} will scroll the text at four lines per second. |
253 | \end{description} | 255 | \end{description} |
254 | \note{When the setting is changed, it takes time to calculate the number of pages again when the size of the text file is large.} | ||
255 | 256 | ||
256 | \item[Show Playback Menu] controls the playback of the currently loaded playlist | 257 | \item[Show Playback Menu] Display the playback menu to allow control of the |
257 | and change the volume of your \dap{} without leaving the plugin. | 258 | currently playing music without leaving the plugin. |
258 | \item[Select Bookmark] selects the bookmark which is registered and jump to the corresponding page. | ||
259 | In the figure below, the line where '*' is displayed at the head shows the page which is running now. | ||
260 | If you do not select any bookmarks, the text viewer displays the page which is reading now. | ||
261 | 259 | ||
260 | \item[Select Bookmark] Select a saved bookmark. In the screenshot below, the | ||
261 | ``*'' denotes the current page. | ||
262 | 262 | ||
263 | \screenshot{plugins/images/ss-text_viewer-sel_bk_menu}{select bookmark menu}{img:text_viewer-sel_bk} | 263 | \screenshot{plugins/images/ss-text_viewer-sel_bk_menu}{The select bookmark menu}{img:text_viewer-sel_bk} |
264 | 264 | ||
265 | \item[Global Settings] set global settings for the text viewer. When reading a file for the first time, this setting is used. The setting items are the same as \setting{Viewer Options}. The global settings are stored in \fname{.rockbox/rocks/viewers/viewer.dat}. | 265 | \item[Global Settings] Set the default settings for the text viewer. |
266 | \item[Quit] Exits the plugin. At this time, the text viewer automatically stores its settings, the current position and bookmarks in \fname{.rockbox/rocks/viewers/viewer\_file.dat}. | 266 | The setting items are the same as \setting{Viewer Options}. The global |
267 | settings are stored in | ||
268 | \fname{.rockbox/rocks/viewers/viewer.dat}. | ||
269 | |||
270 | \item[Quit] Exits the plugin. The text viewer automatically | ||
271 | stores its settings, the current position and bookmarks in | ||
272 | \fname{.rockbox/rocks/viewers/viewer\_file.dat}. | ||
267 | \end{description} | 273 | \end{description} |
268 | 274 | ||
269 | \subsubsection{Bookmarks} | 275 | \subsubsection{Bookmarks} |
270 | When you press the \opt{PLAYER_PAD}{\ButtonOn}\opt{RECORDER_PAD}{\ButtonFTwo}% | 276 | To add a bookmark, press |
277 | \opt{PLAYER_PAD}{\ButtonOn}\opt{RECORDER_PAD}{\ButtonFTwo}% | ||
271 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonOff}% | 278 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonOff}% |
272 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonSelect}% | 279 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonSelect}% |
273 | \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonSelect}% | 280 | \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonSelect}% |
@@ -275,19 +282,15 @@ If you do not select any bookmarks, the text viewer displays the page which is r | |||
275 | \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonDown+\ButtonSelect}% | 282 | \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonDown+\ButtonSelect}% |
276 | \opt{COWON_D2_PAD}{\ButtonMenu+\ButtonPlus}% | 283 | \opt{COWON_D2_PAD}{\ButtonMenu+\ButtonPlus}% |
277 | \opt{SANSA_FUZE_PAD}{\ButtonUp+\ButtonSelect}% | 284 | \opt{SANSA_FUZE_PAD}{\ButtonUp+\ButtonSelect}% |
278 | \opt{IAUDIO_M3_PAD}{\ButtonRCPlay+\ButtonRCMode} button, the bookmark is added to the first | 285 | \opt{IAUDIO_M3_PAD}{\ButtonRCPlay+\ButtonRCMode}. |
279 | line on this page and | 286 | The bookmark will be displayed as shown below. To delete the bookmark |
280 | \opt{PLAYER_PAD}{the bookmark symbol adds the first line}% | 287 | press the same button again. |
281 | \nopt{PLAYER_PAD}{the first line reverses} as shown in the figure below. | ||
282 | And when you press this button again, this bookmark is deleted, and returns to the original | ||
283 | screen. | ||
284 | 288 | ||
285 | \screenshot{plugins/images/ss-text_viewer-bookmark}{bookmark}{img:text_viewer-bookmark} | 289 | \screenshot{plugins/images/ss-text_viewer-bookmark}{A bookmark}{img:text_viewer-bookmark} |
286 | 290 | ||
287 | 291 | ||
288 | \subsubsection{Limitations} | 292 | \subsubsection{Limitations} |
289 | 293 | ||
290 | \begin{itemize} | 294 | \begin{itemize} |
291 | \item The display of the menu is English regardless of the codepgae. | 295 | \item The Text Viewer does not currently support right{}-to{}-left languages. |
292 | \item Does not currently support right{}-to{}-left languages. | ||
293 | \end{itemize} | 296 | \end{itemize} |