summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Parker <rockbox@aeparker.com>2010-03-17 21:58:41 +0000
committerAlex Parker <rockbox@aeparker.com>2010-03-17 21:58:41 +0000
commitc3c928b29feb592ec9a4d9c93580611d129c991d (patch)
tree7fb618323fc83b958e1a1f7a98cdc01fcc003eb2
parent80786564859ec95913560f549dec93081369755d (diff)
downloadrockbox-c3c928b29feb592ec9a4d9c93580611d129c991d.zip
rockbox-c3c928b29feb592ec9a4d9c93580611d129c991d.tar.gz
rockbox-c3c928b29feb592ec9a4d9c93580611d129c991d.tar.bz2
rockbox-c3c928b29feb592ec9a4d9c93580611d129c991d.tar.xz
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.tex139
1 files changed, 71 insertions, 68 deletions
diff --git a/manual/plugins/text_viewer.tex b/manual/plugins/text_viewer.tex
index 88f4815..1206b1d 100644
--- a/manual/plugins/text_viewer.tex
+++ b/manual/plugins/text_viewer.tex
@@ -1,11 +1,11 @@
\subsection{Text Viewer}
\screenshot{plugins/images/ss-text_viewer-main}{Text Viewer}{img:text_viewer-main}
-This is a Viewer for text files with word wrap. Just open a \fname{.txt} or \fname{.nfo} file to
-display it. The text viewer features controls to handle various styles of text
-formatting, has top{}-of{}-file and bottom{}-of{}-file buttons. You can view
-files without a \fname{.txt} or \fname{.nfo} extension by using \emph{Open with} from the
-\emph{Context Menu} (see \reference{ref:Contextmenu}). You can put bookmarks any pages
-and it can jump the page where the bookmark is put.
+This is a Viewer for text files with word wrap. Just open a \fname{.txt} or
+\fname{.nfo} file to display it. The text viewer features controls to handle
+various styles of text formatting and has top{}-of{}-file and bottom{}-of{}-file
+buttons. You can view files without a \fname{.txt} or \fname{.nfo} extension
+by using \emph{Open with} from the \emph{Context Menu}
+(see \reference{ref:Contextmenu}). You can also bookmark pages.
\subsubsection{Default keys}
\begin{table}
@@ -116,7 +116,7 @@ and it can jump the page where the bookmark is put.
\opt{HAVEREMOTEKEYMAP}{&
\opt{IAUDIO_M3_PAD}{\ButtonRCPlay+\ButtonRCMode}
}
- & Set/Reset Bookmark\\
+ & Set/Reset bookmarks\\
\opt{RECORDER_PAD}{\ButtonFOne}
\opt{ONDIO_PAD}{Long \ButtonMenu}
@@ -150,14 +150,13 @@ and it can jump the page where the bookmark is put.
\end{btnmap}
\end{table}
-\subsubsection{The Viewer's Menu}
+\subsubsection{Menu}
\begin{description}
-\item[Return] to the text view.
-\item[Viewer Options] set the settings for the reading file.
+\item[Return] Return to the file being viewed.
+\item[Viewer Options] Change settings for the current file.
\begin{description}
- \item[Encoding]
- sets the codepage in the text viewer.
+ \item[Encoding] Set the codepage in the text viewer.
% ToDo: wrap some of the following settings into a \opt{lcd_bitmap} to exlude
% ones that don't work on charcell - as soon as the plugin itself does
Available settings:
@@ -183,91 +182,99 @@ and it can jump the page where the bookmark is put.
\setting{UTF-8} (Unicode),
This setting only applies to the plugin and is independent from the
\setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}).
- \item[Word Wrap] toggles between Wrap and Chop.
+ \item[Word Wrap] Toggle word wrap mode.
\begin{description}
- \item[On] breaks lines at the maximum column limit.
- \item[Off (Chop Words)] breaks lines at white space or hyphen.
+ \item[On] Break lines at the maximum column limit.
+ \item[Off (Chop Words)] Break lines at white space or hyphen.
\end{description}
- \item[Line Mode] cycles through Normal, Join and Expand and Reflow Lines.
+ \item[Line Mode] Change how lines are displayed.
\begin{description}
- \item[Normal] breaks lines at newline characters.
- \item[Join] joins lines. Useful for adopting the orphans that
- occur with e{}-mail style (i.e. pre{}-wrapped) text files.
- \item[Expand] adds a blank line. Useful for making the paragraphs
+ \item[Normal] Break lines at newline characters.
+ \item[Join] Join lines together.
+ \item[Expand] Add a blank line at newlines. Useful for making paragraphs
clearer in some book style text files.
\opt{lcd_bitmap}{
- \item[Reflow Lines] justifies the text fully.
+ \item[Reflow Lines] Justify the text.
}
\end{description}
- \item[Wide View] toggles between Narrow and Wide.
+ \item[Wide View] Set the viewmode.
\begin{description}
- \item[No (Narrow)] sets maximum column to the screen width.
- \item[Yes] sets maximum column to 114. Useful for navigating large files.
- (Currently, Wide and Join cannot be selected together.)
+ \item[No (Narrow)] Set the maximum column width to the screen width.
+ \item[Yes] Set the maximum column width to 114 pixels.
+ (Currently, \setting{Wide} and \setting{Join} cannot be selected together.)
\end{description}
\opt{lcd_bitmap}{
- \item[Show Scrollbar] toggles scrollbar for the current View mode. If the
+ \item[Show Scrollbar] Toggle the scrollbar for the current mode. If the
file fits on one screen, there is no scrollbar and toggling this setting
has no effect.
\begin{description}
- \item[Off] has no scrollbar by default, until toggled.
- \item[On] has a scrollbar by default, until toggled.
+ \item[Off] Turn the scrollbar off.
+ \item[On] Turn the scrollbar on.
\end{description}
- \item[Overlap Pages] toggles between Normal and Overlap.
+ \item[Overlap Pages] Set whether the last line from the previous screen is
+ retained when scrolling pages.
\begin{description}
- \item[No] sets page{}-down/page{}-up to one full screen.
- \item[Yes] tells page{}-down/page{}-up to retain one line from previous screen.
+ \item[No] Set page{}-down/page{}-up to one full screen.
+ \item[Yes] Set page{}-down/page{}-up to retain one line from the
+ previous screen.
\end{description}
}
\opt{lcd_bitmap}{
- \item[Show Header] selects whether or not the status bar and the reading file path.
+ \item[Show Header] Select whether to show the status bar and the current file path.
\begin{description}
- \item[None] do not display the status bar and the reading file path.
- \item[File Path] displays the reading file path. (the status bar does not display.)
- \item[Status bar] displays the status bar. (the reading file path does not display.)
- \item[Both] display the status bar and the reading file path.
+ \item[None] Do not display the status bar or the current file path.
+ \item[File Path] Display only the current file path.
+ \item[Status bar] Display only the status bar.
+ \item[Both] Display both the status bar and the current file path.
\end{description}
- \note{If the position of the status bar is not top, then \setting{Status bar} and \setting{Both} are not displayed.}
+ \note{If the status bar position is not set to the top of the screen then
+ \setting{Status bar} and \setting{Both} are not available.}
- \item[Show Footer] selects whether or not the status bar and the page number.
+ \item[Show Footer] Select whether to show the status bar and the page number.
\begin{description}
- \item[None] do not display the status bar and the page number.
- \item[Page Num] displays the page number. (the status bar does not display.)
- \item[Status bar] s the status bar. (the page number does not display.)
- \item[Both] display the status bar and the page number.
+ \item[None] Do not display the status bar or the page number.
+ \item[Page Num] Display only the page number.
+ \item[Status bar] Display only the status bar.
+ \item[Both] Display both the status bar and the page number.
\end{description}
- \note{If the position of the status bar is not bottom, then \setting{Status bar} and \setting{Both} are not displayed.}
+ \note{If the status bar position is not set to the bottom of the screen then
+ \setting{Status bar} and \setting{Both} are not available.}
- \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}).
+ \item[Font] Select the font to be used by the Text Viewer.
}
- \item[Scroll Mode] controls the function of the ``Scroll-up'' and
+ \item[Scroll Mode] Change the function of the ``Scroll-up'' and
``Scroll-down'' buttons.
\begin{description}
\item[Scroll by Page]
\item[Scroll by Line]
\end{description}
- \item[Auto-scroll Speed]
- controls the speed of auto-scrolling in number of lines per scroll step,
- available options are \setting{1} to \setting{10} lines. As an example,
- a setting of \setting{4} will scroll up the text four lines per second.
+ \item[Auto-scroll Speed] Control the speed of auto-scrolling in number
+ of lines per second. Available options are \setting{1} to
+ \setting{10} lines per second. As an example,
+ \setting{4} will scroll the text at four lines per second.
\end{description}
- \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.}
-\item[Show Playback Menu] controls the playback of the currently loaded playlist
-and change the volume of your \dap{} without leaving the plugin.
-\item[Select Bookmark] selects the bookmark which is registered and jump to the corresponding page.
-In the figure below, the line where '*' is displayed at the head shows the page which is running now.
-If you do not select any bookmarks, the text viewer displays the page which is reading now.
+\item[Show Playback Menu] Display the playback menu to allow control of the
+currently playing music without leaving the plugin.
+\item[Select Bookmark] Select a saved bookmark. In the screenshot below, the
+``*'' denotes the current page.
-\screenshot{plugins/images/ss-text_viewer-sel_bk_menu}{select bookmark menu}{img:text_viewer-sel_bk}
+\screenshot{plugins/images/ss-text_viewer-sel_bk_menu}{The select bookmark menu}{img:text_viewer-sel_bk}
-\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}.
-\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}.
+\item[Global Settings] Set the default settings for the text viewer.
+The setting items are the same as \setting{Viewer Options}. The global
+settings are stored in
+\fname{.rockbox/rocks/viewers/viewer.dat}.
+
+\item[Quit] Exits the plugin. The text viewer automatically
+stores its settings, the current position and bookmarks in
+\fname{.rockbox/rocks/viewers/viewer\_file.dat}.
\end{description}
\subsubsection{Bookmarks}
- When you press the \opt{PLAYER_PAD}{\ButtonOn}\opt{RECORDER_PAD}{\ButtonFTwo}%
+ To add a bookmark, press
+ \opt{PLAYER_PAD}{\ButtonOn}\opt{RECORDER_PAD}{\ButtonFTwo}%
\opt{ONDIO_PAD}{\ButtonMenu+\ButtonOff}%
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonSelect}%
\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
\opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonDown+\ButtonSelect}%
\opt{COWON_D2_PAD}{\ButtonMenu+\ButtonPlus}%
\opt{SANSA_FUZE_PAD}{\ButtonUp+\ButtonSelect}%
- \opt{IAUDIO_M3_PAD}{\ButtonRCPlay+\ButtonRCMode} button, the bookmark is added to the first
- line on this page and
- \opt{PLAYER_PAD}{the bookmark symbol adds the first line}%
- \nopt{PLAYER_PAD}{the first line reverses} as shown in the figure below.
- And when you press this button again, this bookmark is deleted, and returns to the original
- screen.
+ \opt{IAUDIO_M3_PAD}{\ButtonRCPlay+\ButtonRCMode}.
+ The bookmark will be displayed as shown below. To delete the bookmark
+ press the same button again.
-\screenshot{plugins/images/ss-text_viewer-bookmark}{bookmark}{img:text_viewer-bookmark}
+\screenshot{plugins/images/ss-text_viewer-bookmark}{A bookmark}{img:text_viewer-bookmark}
\subsubsection{Limitations}
\begin{itemize}
-\item The display of the menu is English regardless of the codepgae.
-\item Does not currently support right{}-to{}-left languages.
+\item The Text Viewer does not currently support right{}-to{}-left languages.
\end{itemize}