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{File Menu} (see \reference{ref:Filemenu}).
   7
   8 \subsubsection{Mode settings}
   9
  10 \begin{description}
  11 \item[Word mode] toggles between Wrap and Chop.
  12     \begin{description}
  13         \item[Wrap] breaks lines at white space or hyphen.
  14         \item[Chop] breaks lines at the maximum column limit.
  15     \end{description}
  16 \item[Line mode] cycles through Normal, Join and Expand.
  17     \begin{description}
  18         \item[Normal] breaks lines at newline characters.
  19         \item[Join] ignores unpaired newline characters (i.e., joins lines).
  20         Useful for adopting the orphans that occur with e{}-mail style
  21         (i.e.,pre{}-wrapped) text files.
  22         \item[Expand] doubles unpaired newlines (i.e., adds a blank line).
  23         Useful for making the paragraphs clearer in some book style text files.
  24     \end{description}
  25 \item[View mode] toggles between Narrow and Wide.
  26     \begin{description}
  27         \item[Narrow] sets maximum column to the screen width.
  28         \item[Wide] sets maximum column to 114. Useful for navigating large files. (Currently, Wide and Join cannot be selected together.)
  29     \end{description}
  30 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,SANSA_E200_PAD}{
  31 \item[Page mode] toggles between Normal and Overlap.
  32     \begin{description}
  33         \item[Normal] sets page{}-down/page{}-up to one full screen.
  34         \item[Overlap] tells page{}-down/page{}-up to retain one line from previous screen.
  35     \end{description}
  36 \item[Scrollbar mode] toggles scrollbar for the current View mode.
  37     \begin{description}
  38         \item[Narrow mode] has no scrollbar by default, until toggled.
  39         \item[Wide mode] has a scrollbar by default, until toggled.
  40     \end{description}
  41 }
  42 \end{description}
  43 Settings are not remembered after the viewer has been exited.
  44 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,ANSA_E200_PAD}{
  45 If file fits on one screen, there is no scrollbar and toggling Scrollbar mode has no effect.}
  46
  47 \begin{table}
  48     \begin{btnmap}{}{}
  49     \opt{PLAYER_PAD}{\ButtonLeft}
  50     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD}{\ButtonUp}
  51     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack}
  52     \opt{IRIVER_H10_PAD}{\ButtonScrollUp}
  53         & Page{}-up (one screen up)\\
  54
  55     \opt{PLAYER_PAD}{\ButtonRight}
  56     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD}{\ButtonDown}
  57     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd}
  58     \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
  59     & Page{}-down (one screen down)\\
  60
  61     \opt{PLAYER_PAD}{\ButtonMenu+\ButtonLeft}
  62     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD}{\ButtonLeft}
  63     & Top of file (Narrow mode) One screen left (Wide mode)\\
  64
  65     \opt{PLAYER_PAD}{\ButtonMenu+\ButtonRight}
  66     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD}
  67         {\ButtonRight}
  68     & Bottom of file (Narrow mode) One screen right (Wide mode)\\
  69
  70     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}
  71        {\ButtonOn+\ButtonUp & One line up\\}
  72
  73     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}
  74        {\ButtonOn+\ButtonDown & One line down\\}
  75
  76     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}
  77        {\ButtonOn+\ButtonLeft & One column left\\}
  78
  79     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}
  80        {\ButtonOn+\ButtonRight & One column right\\}
  81
  82     \opt{PLAYER_PAD}{\ButtonOn+\ButtonLeft}
  83     \opt{RECORDER_PAD}{\ButtonFOne}
  84     \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft}
  85     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
  86     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonLeft}
  87     \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPlay}
  88     \opt{SANSA_E200_PAD}{\ButtonScrollUp}
  89         & Toggles Word mode\\
  90
  91     \opt{PLAYER_PAD}{\ButtonOn+\ButtonMenu+\ButtonRight}
  92     \opt{RECORDER_PAD}{\ButtonFTwo}
  93     \opt{ONDIO_PAD}{\ButtonMenu+\ButtonUp}
  94     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
  95     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonPlay}
  96     \opt{IAUDIO_X5_PAD}{Long press on \ButtonPlay}
  97     \opt{IRIVER_H10_PAD,SANSA_E200_PAD}{n/a}
  98         & Cycles line mode\\
  99
 100     \opt{PLAYER_PAD}{\ButtonOn+\ButtonRight}
 101     \opt{RECORDER_PAD}{\ButtonFThree}
 102     \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight}
 103     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonSelect}
 104     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonRight}
 105     \opt{IRIVER_H10_PAD,SANSA_E200_PAD}{n/a}
 106         & Toggles view mode\\
 107
 108     \opt{RECORDER_PAD}{\ButtonOn+\ButtonFOne & Toggles page mode\\}
 109     \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown & Toggles page mode\\}
 110     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}
 111         {\ButtonOn+\ButtonMode & Toggles page mode\\}
 112     \opt{IPOD_4G_PAD,IPOD_3G_PAD}
 113         {\ButtonSelect+\ButtonMenu+\ButtonLeft & Toggles page mode\\}
 114
 115     \opt{RECORDER_PAD}{\ButtonOn+\ButtonFThree & Toggles scrollbar mode\\}
 116     \opt{ONDIO_PAD}{\ButtonMenu+\ButtonOff & Toggles scrollbar mode\\}
 117     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}
 118         {\ButtonOn+\ButtonRec & Toggles scrollbar mode\\}
 119     \opt{IPOD_4G_PAD,IPOD_3G_PAD}
 120         {\ButtonSelect+\ButtonLeft+\ButtonRight & Toggles scrollbar mode\\}
 121
 122     \opt{PLAYER_PAD}{\ButtonStop}
 123     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
 124     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu}
 125     \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD}{\ButtonPower}
 126         & Exit text viewer\\
 127     \end{btnmap}
 128 \end{table}
 129
 130 \subsubsection{Compatibility}
 131
 132 \begin{itemize}
 133 \item Correctly reads plain text files in Unix, Win/DOS, or Macintosh
 134 format. Latin{}-alphabet Unicode files are  \emph{almost} readable.
 135 \item Currently prefers fixed{}-width fonts. With proportional fonts,
 136 pretends all characters are the width of a lower{}-case `o'.
 137 \item Currently messages are in English
 138 \item Does not currently support right{}-to{}-left languages.
 139 \end{itemize}