summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorDominik Riebeling <Dominik.Riebeling@gmail.com>2006-04-05 18:32:07 +0000
committerDominik Riebeling <Dominik.Riebeling@gmail.com>2006-04-05 18:32:07 +0000
commit1de1f5b141d5fdc0427877425928c77a9006e027 (patch)
tree0dd64a1f3f7c43a8bd8661d4a92f8cfa5a9d2b78 /manual
parent686fc085f1b30576cb866e1ecb567fe75568d741 (diff)
downloadrockbox-1de1f5b141d5fdc0427877425928c77a9006e027.tar.gz
rockbox-1de1f5b141d5fdc0427877425928c77a9006e027.zip
Initial manpage for Text Editor plugin by Jonathan Gordon (FS#5040) with additions by me. Fix a table rule in the Wormlet plugin.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9522 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/plugins/main.tex4
-rw-r--r--manual/plugins/text_editor.tex38
-rw-r--r--manual/plugins/wormlet.tex2
3 files changed, 42 insertions, 2 deletions
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 1a55e7ddaa..84e25481aa 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -2,7 +2,7 @@
2Plugins are little programs that Rockbox can load and run. Plugins have 2Plugins are little programs that Rockbox can load and run. Plugins have
3the file extension .rock. Most of them can be started from the main 3the file extension .rock. Most of them can be started from the main
4menu if you put them in the \textbf{/.rockbox/rocks} directory. Press 4menu if you put them in the \textbf{/.rockbox/rocks} directory. Press
5PLAY on them to start them. 5PLAY on them to start them.
6 6
7Viewer plugins get started automatically by 7Viewer plugins get started automatically by
8``playing'' an associated file (i.e. text 8``playing'' an associated file (i.e. text
@@ -149,3 +149,5 @@ the associated file. Viewers are stored in the
149{\input{plugins/stats.tex}} 149{\input{plugins/stats.tex}}
150 150
151\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/stopwatch.tex}} 151\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/stopwatch.tex}}
152
153\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor}{\input{plugins/text_editor.tex}}
diff --git a/manual/plugins/text_editor.tex b/manual/plugins/text_editor.tex
new file mode 100644
index 0000000000..2a9ed0b4cb
--- /dev/null
+++ b/manual/plugins/text_editor.tex
@@ -0,0 +1,38 @@
1\subsection{Text Editor}
2This plugin allows you to view and edit simple text documents on your DAP.
3You can view files by using \textbf{Open with} from the
4\textbf{File Menu} (see page \pageref{ref:Filemenu}).
5
6\subsubsection{Usage}
7If you start the Text Editor from the plugin browser you will be greeted with
8a blank screen. When started from the \textbf{Open with} menu item your file
9should be shown on the screen. You can now edit the file.
10The Text Editor is line base. This means you can edit one line at a time using
11the virtual keyboard.
12
13\begin{itemize}
14 \item Move the selection bar to the line you want to edit.
15 \item Edit the highlighted text line or insert a new one using the Item Menu.
16 \item When finished editing exit the Text Editor. You'll be shown a list of
17 save options.
18\end{itemize}
19\note{When you haven't changed the file the Text Editor will quit immediately.}
20
21\begin{table}
22 \begin{btnmap}{}{}
23 \opt{RECORDER_PAD}{\ButtonPlay}\opt{ONDIO_PAD}{\ButtonMenu}
24 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD}{\ButtonSelect}
25 & Edit Line / Select Character\\
26 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
27 \opt{IPOD_4G_PAD}{\ButtonSelect+\ButtonMenu}\opt{IAUDIO_X5_PAD}{\ButtonPower}
28 & Exit / Abort Editing\\
29 \opt{RECORDER_PAD}{\ButtonFOne}\opt{ONDIO_PAD}{Hold \ButtonMenu}
30 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}\opt{IPOD_4G_PAD}{\ButtonMenu}
31 \opt{IAUDIO_X5_PAD}{\ButtonPlay}
32 & Show Item Menu / Accept Line\\
33 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
34 \opt{IPOD_4G_PAD}{\ButtonLeft}
35 & Delete Line / Delete Character\\
36 \end{btnmap}
37\end{table}
38
diff --git a/manual/plugins/wormlet.tex b/manual/plugins/wormlet.tex
index ffdecdffd5..7a3953de60 100644
--- a/manual/plugins/wormlet.tex
+++ b/manual/plugins/wormlet.tex
@@ -22,7 +22,7 @@ Menu controls:}
22 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD} 22 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}
23 {\ButtonUp\ / \ButtonDown} 23 {\ButtonUp\ / \ButtonDown}
24 \opt{IPOD_4G_PAD}{\ButtonMenu\ / \ButtonPlay} & Selects number of players\\ 24 \opt{IPOD_4G_PAD}{\ButtonMenu\ / \ButtonPlay} & Selects number of players\\
25 \ButtonFOne & Selects game mode.\\}\bottomrule 25 \ButtonFOne & Selects game mode.\\}
26 \end{btnmap} 26 \end{btnmap}
27\end{table} 27\end{table}
28 28