manual/plugins/text_viewer.tex

   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.
   9
  10 \subsubsection{Default keys}
  11 \begin{btnmap}
  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{} / \TouchTopMiddle}
  20     \opt{PBELL_VIBE500_PAD}{\ButtonOK}
  21     \opt{HAVEREMOTEKEYMAP}{&
  22         \opt{IAUDIO_M3_PAD}{\ButtonRCUp}
  23     }
  24         & Scroll{}-up\\
  25
  26     \opt{PLAYER_PAD}{\ButtonRight}
  27     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
  28         ,SANSA_E200_PAD,SANSA_FUZE_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonDown}
  29     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd}
  30     \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
  31     \opt{SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonVolDown}
  32     \opt{GIGABEAT_S_PAD}{\ButtonNext}
  33     \opt{COWON_D2_PAD}{\ButtonPlus{} / \TouchBottomMiddle}
  34     \opt{PBELL_VIBE500_PAD}{\ButtonCancel}
  35     \opt{HAVEREMOTEKEYMAP}{&
  36         \opt{IAUDIO_M3_PAD}{\ButtonRCDown}
  37     }
  38         & Scroll{}-down\\
  39
  40     \opt{PLAYER_PAD}{\ButtonMenu+\ButtonLeft}
  41     \opt{GIGABEAT_S_PAD}{\ButtonPlay+\ButtonLeft}
  42     \opt{COWON_D2_PAD}{\TouchMidLeft}
  43     \nopt{PLAYER_PAD,GIGABEAT_S_PAD,COWON_D2_PAD,IAUDIO_M3_PAD}{\ButtonLeft}
  44     \opt{HAVEREMOTEKEYMAP}{&
  45         \opt{IAUDIO_M3_PAD}{\ButtonRCLeft}
  46     }
  47         & Top of file (Narrow mode) /
  48         One screen left (Wide mode)\\
  49
  50     \opt{PLAYER_PAD}{\ButtonMenu+\ButtonRight}
  51     \opt{GIGABEAT_S_PAD}{\ButtonPlay+\ButtonRight}
  52     \opt{COWON_D2_PAD}{\TouchMidRight}
  53     \nopt{PLAYER_PAD,GIGABEAT_S_PAD,COWON_D2_PAD,IAUDIO_M3_PAD}{\ButtonRight}
  54     \opt{HAVEREMOTEKEYMAP}{&
  55         \opt{IAUDIO_M3_PAD}{\ButtonRCRight}
  56     }
  57         & Bottom of file (Narrow mode) /
  58         One screen right (Wide mode)\\
  59
  60     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,SANSA_E200_PAD%
  61         ,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,GIGABEAT_S_PAD%
  62         ,PBELL_VIBE500_PAD}{%
  63         \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonUp}
  64         \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollBack}
  65         \opt{SANSA_C200_PAD,SANSA_CLIP_PAD,GIGABEAT_S_PAD,PBELL_VIBE500_PAD}{\ButtonUp}
  66     \opt{HAVEREMOTEKEYMAP}{& }
  67         & One line up\\
  68     }
  69
  70     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,SANSA_E200_PAD%
  71         ,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,GIGABEAT_S_PAD%
  72         ,PBELL_VIBE500_PAD}{%
  73         \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonDown}
  74         \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
  75         \opt{SANSA_C200_PAD,SANSA_CLIP_PAD,GIGABEAT_S_PAD,PBELL_VIBE500_PAD}{\ButtonDown}
  76     \opt{HAVEREMOTEKEYMAP}{& }
  77         & One line down\\
  78     }
  79
  80     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_S_PAD}{
  81         \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonLeft}
  82         \opt{GIGABEAT_S_PAD}{\ButtonLeft}
  83     \opt{HAVEREMOTEKEYMAP}{& }
  84         & One column left\\
  85     }
  86
  87     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_S_PAD}{
  88         \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonRight}
  89         \opt{GIGABEAT_S_PAD}{\ButtonRight}
  90     \opt{HAVEREMOTEKEYMAP}{& }
  91         & One column right\\
  92     }
  93
  94     \opt{RECORDER_PAD,PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD%
  95         ,IRIVER_H10_PAD,GIGABEAT_S_PAD,PBELL_VIBE500_PAD}{\ButtonPlay}
  96     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
  97     \opt{ONDIO_PAD}{\ButtonMenu}
  98     \opt{GIGABEAT_PAD}{\ButtonA}
  99     \opt{SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonRec}
 100     \opt{SANSA_CLIP_PAD}{\ButtonHome}
 101     \opt{SANSA_FUZE_PAD}{\ButtonDown+\ButtonSelect}
 102     \opt{MROBE100_PAD}{\ButtonDisplay}
 103     \opt{COWON_D2_PAD}{\TouchCenter}
 104     \opt{HAVEREMOTEKEYMAP}{&
 105         \opt{IAUDIO_M3_PAD}{\ButtonRCMode}
 106     }
 107         & Toggle autoscroll\\
 108
 109     \opt{PLAYER_PAD}{\ButtonOn}
 110     \opt{RECORDER_PAD}{\ButtonFTwo}
 111     \opt{ONDIO_PAD}{\ButtonMenu+\ButtonOff}
 112     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonSelect}
 113     \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonSelect}
 114     \opt{IRIVER_H10_PAD}{\ButtonFF}
 115     \opt{IAUDIO_X5_PAD}{\ButtonRec}
 116     \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonDown+\ButtonSelect}
 117     \opt{COWON_D2_PAD}{\ButtonMenu+\ButtonPlus}
 118     \opt{SANSA_FUZE_PAD}{\ButtonUp+\ButtonSelect}
 119     \opt{PBELL_VIBE500_PAD}{\ButtonPower}
 120     \opt{HAVEREMOTEKEYMAP}{&
 121         \opt{IAUDIO_M3_PAD}{\ButtonRCPlay+\ButtonRCMode}
 122     }
 123         & Set/Reset bookmarks\\
 124
 125     \opt{RECORDER_PAD}{\ButtonFOne}
 126     \opt{ONDIO_PAD}{Long \ButtonMenu}
 127     \opt{PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
 128         ,MROBE100_PAD,PBELL_VIBE500_PAD}{\ButtonMenu}
 129     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
 130     \opt{IAUDIO_X5_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,SANSA_E200_PAD}{\ButtonSelect}
 131     \opt{SANSA_FUZE_PAD}{Long \ButtonSelect}
 132     \opt{IRIVER_H10_PAD}{\ButtonRew}
 133     \opt{COWON_D2_PAD}{\ButtonMenu{} / \TouchTopRight}
 134     \opt{HAVEREMOTEKEYMAP}{&
 135         \opt{IAUDIO_M3_PAD}{\ButtonRCPlay}
 136     }
 137         & Enter menu\\
 138
 139     \opt{PLAYER_PAD}{\ButtonStop}
 140     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
 141     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonMenu}
 142     \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
 143         ,GIGABEAT_PAD,MROBE100_PAD}{\ButtonPower}
 144     \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
 145     \opt{GIGABEAT_S_PAD}{\ButtonBack}
 146     \opt{COWON_D2_PAD}{\ButtonPower{} / \TouchTopLeft}
 147     \opt{IAUDIO_M3_PAD,PBELL_VIBE500_PAD}{\ButtonRec}
 148     \opt{HAVEREMOTEKEYMAP}{&
 149         \opt{IAUDIO_M3_PAD}{\ButtonRCRec}
 150         \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop}
 151     }
 152         & Exit text viewer\\
 153
 154 \end{btnmap}
 155
 156 \subsubsection{Menu}
 157
 158 \begin{description}
 159 \item[Return] Return to the file being viewed.
 160 \item[Viewer Options] Change settings for the current file.
 161     \begin{description}
 162     \item[Encoding] Set the codepage in the text viewer.
 163 % ToDo: wrap some of the following settings into a \opt{lcd_bitmap} to exlude
 164 % ones that don't work on charcell - as soon as the plugin itself does
 165     Available settings:
 166     \setting{ISO-8859-1} (Latin 1).
 167     \setting{ISO-8859-7} (Greek),
 168     \opt{lcd_bitmap}{
 169         \setting{ISO-8859-8} (Hebrew),
 170     }
 171     \setting{CP1251} (Cyrillic),
 172     \opt{lcd_bitmap}{
 173         \setting{ISO-8859-11} (Thai),
 174         \setting{CP1256} (Arabic),
 175     }
 176     \setting{ISO-8859-9} (Turkish),
 177     \setting{ISO-8859-2} (Latin Extended),
 178     \setting{CP1250} (Central European),
 179     \opt{lcd_bitmap}{
 180         \setting{SJIS} (Japanese),
 181         \setting{GB-2312} (Simple Chinese),
 182         \setting{KSX-1001} (Korean),
 183         \setting{BIG5} (Traditional Chinese),
 184     }
 185     \setting{UTF-8} (Unicode),
 186     This setting only applies to the plugin and is independent from the
 187     \setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}).
 188     \item[Word Wrap] Toggle word wrap mode.
 189         \begin{description}
 190             \item[On] Break lines at the maximum column limit.
 191             \item[Off (Chop Words)] Break lines at white space or hyphen.
 192         \end{description}
 193     \item[Line Mode] Change how lines are displayed.
 194         \begin{description}
 195             \item[Normal] Break lines at newline characters.
 196             \item[Join] Join lines together.
 197             \item[Expand] Add a blank line at newlines. Useful for making paragraphs
 198             clearer in some book style text files.
 199             \opt{lcd_bitmap}{
 200             \item[Reflow Lines] Justify the text.
 201             }
 202         \end{description}
 203     \item[Wide View] Set the viewmode.
 204         \begin{description}
 205             \item[No (Narrow)] Set the maximum column width to the screen width.
 206             \item[Yes] Set the maximum column width to 114 pixels.
 207             (Currently, \setting{Wide} and \setting{Join} cannot be selected together.)
 208         \end{description}
 209     \opt{lcd_bitmap}{
 210     \item[Alignment] Set the text alignment.
 211         \begin{description}
 212             \item[Right] Set the text alignment to the right.
 213             (Useful for displaying right-to-left languages, such as Arabic or Hebrew)
 214             \item[Left] Set the text alignment to the left.
 215         \end{description}
 216     \item[Show Scrollbar] Toggle the scrollbar for the current mode. If the
 217     file fits on one screen, there is no scrollbar and toggling this setting
 218     has no effect.
 219         \begin{description}
 220             \item[Off] Turn the scrollbar off.
 221             \item[On] Turn the scrollbar on.
 222         \end{description}
 223     \item[Overlap Pages] Set whether the last line from the previous screen is
 224           retained when scrolling pages.
 225         \begin{description}
 226             \item[No] Set page{}-down/page{}-up to one full screen.
 227             \item[Yes] Set page{}-down/page{}-up to retain one line from the
 228             previous screen.
 229         \end{description}
 230     }
 231     \opt{lcd_bitmap}{
 232     \item[Show Header] Select whether to show the status bar and the current file path.
 233         \begin{description}
 234             \item[None] Do not display the status bar or the current file path.
 235             \item[File Path] Display only the current file path.
 236             \item[Status bar] Display only the status bar.
 237             \item[Both] Display both the status bar and the current file path.
 238         \end{description}
 239         \note{If the status bar position is not set to the top of the screen then
 240           \setting{Status bar} and \setting{Both} are not available.}
 241
 242     \item[Show Footer] Select whether to show the status bar and the page number.
 243         \begin{description}
 244             \item[None] Do not display the status bar or the page number.
 245             \item[Page Num] Display only the page number.
 246             \item[Status bar] Display only the status bar.
 247             \item[Both] Display both the status bar and the page number.
 248         \end{description}
 249         \note{If the status bar position is not set to the bottom of the screen then
 250           \setting{Status bar} and \setting{Both} are not available.}
 251
 252     \item[Font] Select the font to be used by the Text Viewer.
 253     }
 254     \item[Scroll Mode] Change the function of the ``Scroll-up'' and
 255     ``Scroll-down'' buttons.
 256         \begin{description}
 257             \item[Scroll by Page]
 258             \item[Scroll by Line]
 259         \end{description}
 260     \item[Auto-scroll Speed] Control the speed of auto-scrolling in number
 261       of lines per second.  Available options are \setting{1} to
 262       \setting{10} lines per second. As an example,
 263       \setting{4} will scroll the text at four lines per second.
 264     \end{description}
 265
 266 \item[Show Playback Menu] Display the playback menu to allow control of the
 267 currently playing music without leaving the plugin.
 268
 269 \item[Select Bookmark] Select a saved bookmark. In the screenshot below, the
 270 ``*'' denotes the current page.
 271
 272 \screenshot{plugins/images/ss-text_viewer-sel_bk_menu}{The select bookmark menu}{img:text_viewer-sel_bk}
 273
 274 \item[Global Settings] Set the default settings for the text viewer.
 275 The setting items are the same as \setting{Viewer Options}. The global
 276 settings are stored in
 277 \fname{.rockbox/rocks/viewers/viewer.dat}.
 278
 279 \item[Quit] Exits the plugin. The text viewer automatically
 280 stores its settings, the current position and bookmarks in
 281 \fname{.rockbox/rocks/viewers/viewer\_file.dat}.
 282 \end{description}
 283
 284 \subsubsection{Bookmarks}
 285     To add a bookmark, press
 286     \opt{PLAYER_PAD}{\ButtonOn}\opt{RECORDER_PAD}{\ButtonFTwo}%
 287     \opt{ONDIO_PAD}{\ButtonMenu+\ButtonOff}%
 288     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonSelect}%
 289     \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonSelect}%
 290     \opt{IRIVER_H10_PAD}{\ButtonFF}\opt{IAUDIO_X5_PAD}{\ButtonRec}%
 291     \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonDown+\ButtonSelect}%
 292     \opt{COWON_D2_PAD}{\ButtonMenu+\ButtonPlus}%
 293     \opt{SANSA_FUZE_PAD}{\ButtonUp+\ButtonSelect}%
 294     \opt{IAUDIO_M3_PAD}{\ButtonRCPlay+\ButtonRCMode}.
 295     The bookmark will be displayed as shown below. To delete the bookmark
 296     press the same button again.
 297
 298 \screenshot{plugins/images/ss-text_viewer-bookmark}{A bookmark}{img:text_viewer-bookmark}
 299