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