From 1de1f5b141d5fdc0427877425928c77a9006e027 Mon Sep 17 00:00:00 2001
From: Dominik Riebeling <Dominik.Riebeling@gmail.com>
Date: Wed, 5 Apr 2006 18:32:07 +0000
Subject: 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
---
 manual/plugins/main.tex        |  4 +++-
 manual/plugins/text_editor.tex | 38 ++++++++++++++++++++++++++++++++++++++
 manual/plugins/wormlet.tex     |  2 +-
 3 files changed, 42 insertions(+), 2 deletions(-)
 create mode 100644 manual/plugins/text_editor.tex

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 @@
 Plugins are little programs that Rockbox can load and run. Plugins have
 the file extension .rock.  Most of them can be started from the main
 menu if you put them in the \textbf{/.rockbox/rocks} directory. Press
-PLAY on them to start them. 
+PLAY on them to start them.
 
 Viewer plugins get started automatically by
 ``playing'' an associated file (i.e. text
@@ -149,3 +149,5 @@ the associated file.  Viewers are stored in the
 {\input{plugins/stats.tex}}
 
 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/stopwatch.tex}}
+
+\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 @@
+\subsection{Text Editor}
+This plugin allows you to view and edit simple text documents on your DAP.
+You can view files by using \textbf{Open with} from the
+\textbf{File Menu} (see page \pageref{ref:Filemenu}).
+
+\subsubsection{Usage}
+If you start the Text Editor from the plugin browser you will be greeted with
+a blank screen. When started from the \textbf{Open with} menu item your file 
+should be shown on the screen. You can now edit the file.
+The Text Editor is line base. This means you can edit one line at a time using
+the virtual keyboard.
+
+\begin{itemize}
+  \item Move the selection bar to the line you want to edit.
+  \item Edit the highlighted text line or insert a new one using the Item Menu.
+  \item When finished editing exit the Text Editor. You'll be shown a list of
+        save options. 
+\end{itemize}
+\note{When you haven't changed the file the Text Editor will quit immediately.}
+
+\begin{table}
+    \begin{btnmap}{}{}
+    \opt{RECORDER_PAD}{\ButtonPlay}\opt{ONDIO_PAD}{\ButtonMenu}
+    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD}{\ButtonSelect} 
+    & Edit Line / Select Character\\
+    \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
+    \opt{IPOD_4G_PAD}{\ButtonSelect+\ButtonMenu}\opt{IAUDIO_X5_PAD}{\ButtonPower} 
+    & Exit / Abort Editing\\
+    \opt{RECORDER_PAD}{\ButtonFOne}\opt{ONDIO_PAD}{Hold \ButtonMenu}
+    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}\opt{IPOD_4G_PAD}{\ButtonMenu}
+    \opt{IAUDIO_X5_PAD}{\ButtonPlay} 
+    & Show Item Menu / Accept Line\\
+    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
+    \opt{IPOD_4G_PAD}{\ButtonLeft}
+    & Delete Line / Delete Character\\
+    \end{btnmap}
+\end{table}
+
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:}
         \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}
             {\ButtonUp\ / \ButtonDown}
             \opt{IPOD_4G_PAD}{\ButtonMenu\ / \ButtonPlay} & Selects number of players\\
-        \ButtonFOne & Selects game mode.\\}\bottomrule
+        \ButtonFOne & Selects game mode.\\}
     \end{btnmap}
 \end{table}
 
-- 
cgit v1.2.3