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