diff options
author | Nils Wallménius <nils@rockbox.org> | 2006-03-28 22:46:54 +0000 |
---|---|---|
committer | Nils Wallménius <nils@rockbox.org> | 2006-03-28 22:46:54 +0000 |
commit | 4a2fec924a03dc847ca0a92b1e5058c5a3e6e678 (patch) | |
tree | 26779d3c655bcd9b193fad3418919731daebbe1f /manual/plugins | |
parent | 29d5dbad0ddf7a31eea0bcfa962075393ac71155 (diff) | |
download | rockbox-4a2fec924a03dc847ca0a92b1e5058c5a3e6e678.tar.gz rockbox-4a2fec924a03dc847ca0a92b1e5058c5a3e6e678.zip |
Make textviewer manual page nicer by: (1) using button macros (2) rplace the ugly table and (3) include it for all targets
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9335 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/plugins')
-rw-r--r-- | manual/plugins/main.tex | 2 | ||||
-rw-r--r-- | manual/plugins/text_viewer.tex | 182 |
2 files changed, 95 insertions, 89 deletions
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex index 383e132fcf..cdac8c2549 100644 --- a/manual/plugins/main.tex +++ b/manual/plugins/main.tex | |||
@@ -112,7 +112,7 @@ the associated file. Viewers are stored in the | |||
112 | 112 | ||
113 | \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor}{\input{plugins/sudoku.tex}} | 113 | \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor}{\input{plugins/sudoku.tex}} |
114 | 114 | ||
115 | \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/text_viewer.tex}} | 115 | {\input{plugins/text_viewer.tex}} |
116 | 116 | ||
117 | \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/vbrfix.tex}} | 117 | \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/vbrfix.tex}} |
118 | 118 | ||
diff --git a/manual/plugins/text_viewer.tex b/manual/plugins/text_viewer.tex index 27eb844ff3..60ef396993 100644 --- a/manual/plugins/text_viewer.tex +++ b/manual/plugins/text_viewer.tex | |||
@@ -1,94 +1,102 @@ | |||
1 | \subsection{Text Viewer} | 1 | \subsection{Text Viewer} |
2 | This is a Viewer for text files with word wrap. Just press PLAY on a | 2 | This is a Viewer for text files with word wrap. Just open a .txt file to |
3 | .txt file to display it. Has controls to handle various styles of text | 3 | display it. The text vewer features controls to handle various styles of text |
4 | formatting. Has top{}-of{}-file and bottom{}-of{}-file buttons. You | 4 | formatting, has top{}-of{}-file and bottom{}-of{}-file buttons. You can view |
5 | can view files without a .txt extension by using \textbf{Open with ..} | 5 | files without a \fname{.txt} extension by using \textbf{Open with} from the |
6 | from the Play Screen menu | 6 | \textbf{File Menu} (see page \pageref{ref:Filemenu}). |
7 | 7 | ||
8 | \subsubsection{Controls} | 8 | \subsubsection{Mode settings} |
9 | 9 | ||
10 | \begin{itemize} | 10 | \begin{itemize} |
11 | \item \textbf{F1 (Recorder) / ON{}-MINUS (Player): } | 11 | \item\textbf{Word mode} toggles between Wrap and Chop. |
12 | toggles Word mode between Wrap and Chop: | 12 | \begin{itemize} |
13 | 13 | \item\textbf{Wrap} breaks lines at white space or hyphen. | |
14 | \begin{itemize} | 14 | \item\textbf{Chop} breaks lines at the maximum column limit. |
15 | \item Wrap breaks lines at white space or hyphen. | 15 | \end{itemize} |
16 | \item Chop breaks lines at the maximum column limit. | 16 | \item\textbf{Line mode} cycles through Normal, Join and Expand. |
17 | \end{itemize} | 17 | \begin{itemize} |
18 | 18 | \item\textbf{Normal} breaks lines at newline characters. | |
19 | \item \textbf{F2 (Recorder) / ON{}-MENU{}-PLUS (Player): } | 19 | \item\textbf{Join} ignores unpaired newline characters (i.e., joins lines). Useful for adopting the orphans that occur with e{}-mail style (i.e.,pre{}-wrapped) text files. |
20 | cycles Line mode through Normal, Join and Expand: | 20 | \item\textbf{Expand} doubles unpaired newlines (i.e., adds a blank line). Useful for making the paragraphs clearer in some book style text files. |
21 | 21 | \end{itemize} | |
22 | \begin{itemize} | 22 | \item\textbf{View mode} toggles between Narrow and Wide. |
23 | \item Normal breaks lines at newline characters. | 23 | \begin{itemize} |
24 | \item Join ignores unpaired newline characters (i.e., joins lines). Useful for | 24 | \item\textbf{Narrow} sets maximum column to the screen width. |
25 | adopting the orphans that occur with e{}-mail style (i.e.,pre{}-wrapped) text files. | 25 | \item\textbf{Wide} sets maximum column to 114. Useful for navigating large files. (Currently, Wide and Join cannot be selected together.) |
26 | \item Expand doubles unpaired newlines (i.e., adds a blank line). Useful | 26 | \end{itemize} |
27 | for making the paragraphs clearer in some book style text files. | 27 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD}{ |
28 | \end{itemize} | 28 | \item\textbf{Page mode} toggles between Normal and Overlap. |
29 | 29 | \begin{itemize} | |
30 | \item \textbf{F3 (Recorder) / ON{}-PLUS (Player):} | 30 | \item\textbf{Normal} sets page{}-down/page{}-up to one full screen. |
31 | toggles View mode between Narrow and Wide: | 31 | \item\textbf{Overlap} tells page{}-down/page{}-up to retain one line from previous screen. |
32 | 32 | \end{itemize} | |
33 | \begin{itemize} | 33 | \item\textbf{Scrollbar mode} toggles scrollbar for the current View mode. |
34 | \item Narrow sets maximum column to the screen width. | 34 | \begin{itemize} |
35 | \item Wide sets maximum column to 114. Useful for navigating large | 35 | \item\textbf{Narrow mode} has no scrollbar by default, until toggled. |
36 | files. (Currently, Wide and Join cannot be selected together.) | 36 | \item\textbf{Wide mode} has a scrollbar by default, until toggled. |
37 | \end{itemize} | 37 | \end{itemize} |
38 | 38 | } | |
39 | \item \textbf{ON{}-F1 (Recorder):} | ||
40 | toggles Page mode between Normal and Overlap: | ||
41 | |||
42 | \begin{itemize} | ||
43 | \item Normal sets page{}-down/page{}-up to one full screen. | ||
44 | \item Overlap tells page{}-down/page{}-up to retain one line from | ||
45 | previous screen. | ||
46 | \end{itemize} | 39 | \end{itemize} |
47 | 40 | Settings are not remembered after the viewer has been exited. | |
48 | \item \textbf{ON{}-F3 (Recorder):} | 41 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD}{ |
49 | toggles Scrollbar mode, for the current View mode. | 42 | If file fits on one screen, there is no scrollbar and toggling Scrollbar mode has no effect.} |
50 | 43 | ||
51 | \begin{itemize} | 44 | \begin{table}[ht!] |
52 | \item Narrow mode has no scrollbar by default, until toggled. | 45 | \begin{center} |
53 | \item Wide mode has a scrollbar by default, until toggled. | 46 | \begin{tabular}{ll}\toprule |
54 | \item If file fits on one screen, there is no scrollbar and ON{}-F3 has | 47 | \textbf{Key} & \textbf{Action}\\\midrule |
55 | no effect. | 48 | \opt{PLAYER_PAD}{\ButtonLeft}\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD} |
56 | \end{itemize} | 49 | {\ButtonUp}\opt{IPOD_4G_PAD}{\ButtonScrollBack} & Page{}-up (one screen up)\\ |
57 | \end{itemize} | 50 | |
58 | 51 | \opt{PLAYER_PAD}{\ButtonRight}\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD} | |
59 | Settings are not remembered after the viewer has been exited. | 52 | {\ButtonDown}\opt{IPOD_4G_PAD}{\ButtonScrollFwd} & Page{}-down (one screen down)\\ |
60 | Keys are as follows: | 53 | |
61 | 54 | \opt{PLAYER_PAD}{\ButtonMenu+\ButtonLeft} | |
62 | \subsubsection{Recorder} | 55 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD} |
63 | 56 | {\ButtonLeft} & Top of file (Narrow mode) One screen left (Wide mode)\\ | |
64 | \begin{table}[h!] | 57 | |
65 | \begin{tabular}{|c|c|} | 58 | \opt{PLAYER_PAD}{\ButtonMenu+\ButtonRight} |
66 | \hline | 59 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD} |
67 | KEY & ACTION \\\hline | 60 | {\ButtonRight} & Bottom of file (Narrow mode) One screen right (Wide mode)\\ |
68 | UP & Page{}-up (one screen up) \\\hline | 61 | |
69 | DOWN & Page{}-down (one screen down) \\\hline | 62 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonUp & One line up\\} |
70 | LEFT & Top of file (Narrow mode) One screen left (Wide mode) \\\hline | 63 | |
71 | RIGHT & Bottom of file (Narrow mode) One screen right (Wide mode) \\\hline | 64 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonDown & One line down\\} |
72 | ON{}-UP & One line up \\\hline | 65 | |
73 | ON{}-DOWN & One line down \\\hline | 66 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonLeft & One column left\\} |
74 | ON{}-LEFT & One column left \\\hline | 67 | |
75 | ON{}-RIGHT & One column right \\\hline | 68 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonRight & One column right\\} |
76 | OFF & Exit text viewer \\\hline | 69 | |
77 | \end{tabular} | 70 | \opt{PLAYER_PAD}{\ButtonOn+\ButtonLeft}\opt{RECORDER_PAD}{\ButtonFOne} |
78 | \end{table} | 71 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft}\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec} |
79 | 72 | \opt{IPOD_4G_PAD}{\ButtonSelect+\ButtonLeft}\opt{IAUDIO_X5_PAD}{\ButtonPlay} | |
80 | \subsubsection{Player} | 73 | & Toggles Word mode\\ |
81 | 74 | ||
82 | \begin{table}[h!] | 75 | \opt{PLAYER_PAD}{\ButtonOn+\ButtonMenu+\ButtonRight}\opt{RECORDER_PAD}{\ButtonFTwo} |
83 | \begin{tabular}{|c|c|} | 76 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonUp}\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode} |
84 | \hline | 77 | \opt{IPOD_4G_PAD}{\ButtonSelect+\ButtonPlay}\opt{IAUDIO_X5_PAD}{Long press on \ButtonPlay} |
85 | KEY & ACTION \\\hline | 78 | & Cycles line mode\\ |
86 | MINUS & Page{}-up (one screen up) \\\hline | 79 | |
87 | PLUS & Page{}-down (one screen down) \\\hline | 80 | \opt{PLAYER_PAD}{\ButtonOn+\ButtonRight}\opt{RECORDER_PAD}{\ButtonFThree} |
88 | MENU MINUS & Top of file (Narrow mode) One screen left (Wide mode) \\\hline | 81 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight}\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonSelect} |
89 | MENU PLUS & Bottom of file (Narrow mode) One screen right (Wide mode) \\\hline | 82 | \opt{IPOD_4G_PAD}{\ButtonSelect+\ButtonRight} |
90 | STOP & Exit text viewer \\\hline | 83 | & Toggles view mode\\ |
91 | \end{tabular} | 84 | |
85 | \opt{RECORDER_PAD}{\ButtonOn+\ButtonFOne & Toggles page mode\\} | ||
86 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown & Toggles page mode\\} | ||
87 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonMode & Toggles page mode\\} | ||
88 | \opt{IPOD_4G_PAD}{\ButtonSelect+\ButtonMenu+\ButtonLeft & Toggles page mode\\} | ||
89 | |||
90 | \opt{RECORDER_PAD}{\ButtonOn+\ButtonFThree & Toggles scrollbar mode\\} | ||
91 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonOff & Toggles scrollbar mode\\} | ||
92 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonRec & Toggles scrollbar mode\\} | ||
93 | \opt{IPOD_4G_PAD}{\ButtonSelect+\ButtonLeft+\ButtonRight & Toggles scrollbar mode\\} | ||
94 | |||
95 | \opt{PLAYER_PAD}{\ButtonStop}\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD} | ||
96 | {\ButtonOff}\opt{IPOD_4G_PAD}{\ButtonMenu}\opt{IAUDIO_X5_PAD}{\ButtonPower} | ||
97 | & Exit text viewer\\\bottomrule | ||
98 | \end{tabular} | ||
99 | \end{center} | ||
92 | \end{table} | 100 | \end{table} |
93 | 101 | ||
94 | \subsubsection{Compatibility} | 102 | \subsubsection{Compatibility} |
@@ -102,5 +110,3 @@ pretends all characters are the width of a lower{}-case 'o'. | |||
102 | \item Currently messages are in English | 110 | \item Currently messages are in English |
103 | \item Does not currently support right{}-to{}-left languages. | 111 | \item Does not currently support right{}-to{}-left languages. |
104 | \end{itemize} | 112 | \end{itemize} |
105 | |||
106 | |||