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