summaryrefslogtreecommitdiffstats
path: root/manual/getting_started/main.tex
diff options
context:
space:
mode:
authorDominik Riebeling <Dominik.Riebeling@gmail.com>2006-07-19 16:25:15 +0000
committerDominik Riebeling <Dominik.Riebeling@gmail.com>2006-07-19 16:25:15 +0000
commit73c6c9d279c7f2c0e12710ad692bbfbc3a846c95 (patch)
tree0a1cdfdc3ab9fe1b227ec8c81e4d373c5a8b15f3 /manual/getting_started/main.tex
parent4ccc2cebd23f67cdebf5de82fff778fbad8e9737 (diff)
downloadrockbox-73c6c9d279c7f2c0e12710ad692bbfbc3a846c95.tar.gz
rockbox-73c6c9d279c7f2c0e12710ad692bbfbc3a846c95.tar.bz2
rockbox-73c6c9d279c7f2c0e12710ad692bbfbc3a846c95.zip
add a section about naming conventions and the icons used in the manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10251 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/getting_started/main.tex')
-rw-r--r--manual/getting_started/main.tex36
1 files changed, 35 insertions, 1 deletions
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
index 0e55fc162c..3e8e641516 100644
--- a/manual/getting_started/main.tex
+++ b/manual/getting_started/main.tex
@@ -32,6 +32,40 @@ software. There is, however, more help available. The Rockbox website at
written by members of the Rockbox community and this should be your first port
of call when looking for further help.
+\section{Naming conventions and marks}
+We have some conventions especially on naming that are intended to be
+consistent throughout this manual.
+
+Manufacturer and product names are formatted in accordance with the standard
+rules of English grammar, e.g. ``\playerman{} playback is currently
+unsupported''. Manufacturer and model names are proper nouns, and
+thus are written beginning with a capital letter.
+
+% write a bit more about names etc. here.
+\ifpdfoutput{
+This manual has some parts that are marked with icons on the margin to help
+you finding important parts or parts you could skip. The following icons
+are used:
+\note{This indicates a note. A note starts always with the text ``Note''.
+ For easier finding of notes we have put this an icon in the margin like
+ here. Notes are used to mark informations that could help you
+ or indicate a possible ``weirdness'' in rockbox that would be explained.
+}
+\warn{This is a warning. In contrast to notes as mentioned above a warning
+ should be taken more seriously. While ignoring notes won't cause any serious
+ damage ignoring warnings \emph{could} cause serious damage. If you're new to
+ rockbox you should really read the warnings before doing anything that is
+ warned about.
+}
+\blind{This icon marks a section that are intended especially for the blind
+ and visually impaired. As they can't
+ read the manual in the same way seeing people can do we've added some
+ additional descriptions. If you aren't blind or visually impaired you most
+ likely can completely skip these blocks. To make this easier, there is an
+ icon shown in the margin like here.
+}
+}{}% end ifpdfoutput
+
\section{Installing Rockbox}\label{sec:installing_rockbox}
\opt{MASCODEC}{
\subsection{Using the windows installer}
@@ -115,4 +149,4 @@ The latest release of the Rockbox software will always be available from
which works for all Jukebox models, but those wishing to install manually or
using a different operating system should choose the .zip archive containing
the firmware for their model of the Jukebox.
-} \ No newline at end of file
+}