manual/plugins/text_viewer.tex

   1 \subsection{Text Viewer}
   2 This is a Viewer for text files with word wrap. Just open a .txt file to
   3 display it. The text viewer features controls to handle various styles of text
   4 formatting, has top{}-of{}-file and bottom{}-of{}-file buttons. You can view
   5 files without a \fname{.txt} extension by using \emph{Open with} from the
   6 \emph{Context Menu} (see \reference{ref:Contextmenu}).
   7
   8
   9 \begin{table}
  10     \begin{btnmap}{}{}
  11     \opt{PLAYER_PAD}{\ButtonLeft}
  12     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
  13         ,SANSA_E200_PAD,SANSA_FUZE_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonUp}
  14     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack}
  15     \opt{IRIVER_H10_PAD}{\ButtonScrollUp}
  16     \opt{SANSA_C200_PAD}{\ButtonVolUp}
  17     \opt{GIGABEAT_S_PAD}{\ButtonPrev}
  18     \opt{COWON_D2_PAD}{\TouchTopMiddle}
  19   \opt{HAVEREMOTEKEYMAP}{& }
  20         & Scroll{}-up\\
  21
  22     \opt{PLAYER_PAD}{\ButtonRight}
  23     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
  24         ,SANSA_E200_PAD,SANSA_FUZE_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonDown}
  25     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd}
  26     \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
  27     \opt{SANSA_C200_PAD}{\ButtonVolDown}
  28     \opt{GIGABEAT_S_PAD}{\ButtonNext}
  29     \opt{COWON_D2_PAD}{\TouchBottomMiddle}
  30   \opt{HAVEREMOTEKEYMAP}{& }
  31         & Scroll{}-down\\
  32
  33     \opt{PLAYER_PAD}{\ButtonMenu+\ButtonLeft}
  34     \opt{GIGABEAT_S_PAD}{\ButtonPlay+\ButtonLeft}
  35     \opt{COWON_D2_PAD}{\TouchMidLeft}
  36     \nopt{PLAYER_PAD,GIGABEAT_S_PAD,COWON_D2_PAD}{\ButtonLeft}
  37   \opt{HAVEREMOTEKEYMAP}{& }
  38         & Top of file (Narrow mode) /
  39         One screen left (Wide mode)\\
  40
  41     \opt{PLAYER_PAD}{\ButtonMenu+\ButtonRight}
  42     \opt{GIGABEAT_S_PAD}{\ButtonPlay+\ButtonRight}
  43     \opt{COWON_D2_PAD}{\TouchMidRight}
  44     \nopt{PLAYER_PAD,GIGABEAT_S_PAD,COWON_D2_PAD}{\ButtonRight}
  45   \opt{HAVEREMOTEKEYMAP}{& }
  46         & Bottom of file (Narrow mode) /
  47         One screen right (Wide mode)\\
  48
  49     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,SANSA_E200_PAD%
  50       ,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_S_PAD}{%
  51         \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonUp}
  52         \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollBack}
  53         \opt{SANSA_C200_PAD}{\ButtonUp}
  54         \opt{GIGABEAT_S_PAD}{\ButtonUp}
  55   \opt{HAVEREMOTEKEYMAP}{& }
  56         & One line up\\
  57     }
  58
  59     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,SANSA_E200_PAD%
  60       ,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_S_PAD}{%
  61         \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonDown}
  62         \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
  63         \opt{SANSA_C200_PAD}{\ButtonDown}
  64         \opt{GIGABEAT_S_PAD}{\ButtonDown}
  65   \opt{HAVEREMOTEKEYMAP}{& }
  66         & One line down\\
  67     }
  68
  69     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_S_PAD}{
  70         \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonLeft}
  71         \opt{GIGABEAT_S_PAD}{\ButtonLeft}
  72   \opt{HAVEREMOTEKEYMAP}{& }
  73         & One column left\\
  74     }
  75
  76     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_S_PAD}{
  77         \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonRight}
  78         \opt{GIGABEAT_S_PAD}{\ButtonRight}
  79   \opt{HAVEREMOTEKEYMAP}{& }
  80         & One column right\\
  81     }
  82
  83     \opt{RECORDER_PAD,PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD%
  84         ,IRIVER_H10_PAD,GIGABEAT_S_PAD}{\ButtonPlay}
  85     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
  86     \opt{ONDIO_PAD}{\ButtonMenu}
  87     \opt{GIGABEAT_PAD}{\ButtonA}
  88     \opt{SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonRec}
  89     \opt{SANSA_FUZE_PAD}{\ButtonSelect+\ButtonDown}
  90     \opt{MROBE100_PAD}{\ButtonDisplay}
  91     \opt{COWON_D2_PAD}{\TouchCenter}
  92   \opt{HAVEREMOTEKEYMAP}{& }
  93         & Toggle autoscroll\\
  94
  95     \opt{RECORDER_PAD}{\ButtonFOne}
  96     \opt{ONDIO_PAD}{Long \ButtonMenu}
  97     \opt{PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
  98       ,MROBE100_PAD,COWOND_D2_PAD}{\ButtonMenu}
  99     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
 100     \opt{IAUDIO_X5_PAD,SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonSelect}
 101     \opt{SANSA_FUZE_PAD}{Long \ButtonSelect}
 102     \opt{IRIVER_H10_PAD}{\ButtonRew}
 103   \opt{HAVEREMOTEKEYMAP}{& }
 104         & Enter menu\\
 105
 106     \opt{PLAYER_PAD}{\ButtonStop}
 107     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
 108     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu}
 109     \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
 110         ,MROBE100_PAD,COWON_D2_PAD}{\ButtonPower}
 111     \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
 112     \opt{GIGABEAT_S_PAD}{\ButtonBack}
 113   \opt{HAVEREMOTEKEYMAP}{&
 114           \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop}
 115   }
 116         & Exit text viewer\\
 117
 118     \end{btnmap}
 119 \end{table}
 120
 121 \subsubsection{The Viewer's Menu}
 122
 123 \begin{description}
 124 \item[Quit] Exits the plugin.
 125 \item[Viewer Options]
 126     \begin{description}
 127     \item[Encoding]
 128     sets the codepage in the text viewer.
 129 % ToDo: wrap some of the following settings into a \opt{lcd_bitmap} to exlude
 130 % ones that don't work on charcell - as soon as the plugin itself does
 131     Available settings:
 132     \setting{UTF-8} (Unicode),
 133     \setting{BIG5} (Traditional Chinese),
 134     \setting{KSX-1001} (Korean),
 135     \setting{GB-2312} (Simple Chinese),
 136     \setting{SJIS} (Japanese),
 137     \setting{CP1250} (Central European),
 138     \setting{ISO-8859-2} (Latin Extended),
 139     \setting{ISO-8859-9} (Turkish),
 140     \setting{ISO-8859-6} (Arabic),
 141     \setting{ISO-8859-11} (Thai),
 142     \setting{CP1251} (Cyrillic),
 143     \setting{ISO-8859-8} (Hebrew),
 144     \setting{ISO-8859-7} (Greek),
 145     \setting{ISO-8859-1} (Latin 1).
 146     This setting only applies to the plugin and is independent from the
 147     \setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}).
 148     \item[Word Wrap] toggles between Wrap and Chop.
 149         \begin{description}
 150             \item[Off (Chop Words)] breaks lines at white space or hyphen.
 151             \item[On] breaks lines at the maximum column limit.
 152         \end{description}
 153     \item[Line Mode] cycles through Normal, Join and Expand and Reflow Lines.
 154         \begin{description}
 155             \opt{lcd_bitmap}{
 156             \item[Reflow Lines] justifies the text fully.
 157             }
 158             \item[Expand] adds a blank line. Useful for making the paragraphs
 159             clearer in some book style text files.
 160             \item[Join] joins lines. Useful for adopting the orphans that
 161             occur with e{}-mail style (i.e. pre{}-wrapped) text files.
 162             \item[Normal] breaks lines at newline characters.
 163         \end{description}
 164     \item[Wide View] toggles between Narrow and Wide.
 165         \begin{description}
 166             \item[Yes] sets maximum column to 114. Useful for navigating large files.
 167             (Currently, Wide and Join cannot be selected together.)
 168             \item[No (Narrow)] sets maximum column to the screen width.
 169         \end{description}
 170     \opt{lcd_bitmap}{
 171     \item[Show Scrollbar] toggles scrollbar for the current View mode. If the
 172     file fits on one screen, there is no scrollbar and toggling this setting
 173     has no effect.
 174         \begin{description}
 175             \item[On] has a scrollbar by default, until toggled.
 176             \item[Off] has no scrollbar by default, until toggled.
 177         \end{description}
 178     \item[Overlap Pages] toggles between Normal and Overlap.
 179         \begin{description}
 180             \item[Yes] tells page{}-down/page{}-up to retain one line from previous screen.
 181             \item[No] sets page{}-down/page{}-up to one full screen.
 182         \end{description}
 183     }
 184     \item[Scroll Mode] controls the function of the ``Scroll-up'' and
 185     ``Scroll-down'' buttons.
 186         \begin{description}
 187             \item[Scroll by Line]
 188             \item[Scroll by Page]
 189         \end{description}
 190     \item[Auto-scroll Speed]
 191     controls the speed of auto-scrolling in number of lines per scroll step,
 192     available options are \setting{1} to \setting{10} lines. As an example,
 193     a setting of \setting{4} will scroll up the text four lines per second.
 194     \end{description}
 195
 196 \item[Show Playback Menu] controls the playback of the currently loaded playlist
 197 and change the volume of your \dap{} without leaving the plugin.
 198 \item[Return] to the text view.
 199 \end{description}
 200
 201 \note{The text viewer automatically saves its settings and also stores the
 202 current position in the viewed text files (up to the last 46 files).}
 203
 204 \subsubsection{Compatibility}
 205
 206 \begin{itemize}
 207 \item Currently messages are in English
 208 \item Does not currently support right{}-to{}-left languages.
 209 \end{itemize}