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