source: branches/release-0.3.0-rc1/doc/app/manual/latex/mediadb.tex @ 211

Last change on this file since 211 was 211, checked in by Joachim Langenbach, 11 years ago
  • refs #84
  • manual2html
    • Introduced some commandline options
    • indexes can be build now
  • HelpCenter?
    • showDocumentation now uses keywords if the page starts with keyword:
  • SearchPlugin?
    • added signal showHelp(QString)
  • MediaPlugin?
    • added signal showHelp(QString)
  • Many small other changes
File size: 4.3 KB
Line 
1\documentclass[a4paper,10pt]{article}
2\usepackage[english]{babel}
3% \usepackage[english, plain]{fancyref}
4\usepackage[utf8]{inputenc}
5% \usepackage[acronym, nonumberlist,toc,section]{glossaries}
6\usepackage{booktabs}
7
8% \usepackage{html,makeidx}
9% \usepackage{fancyref}
10
11% \pagestyle{empty}
12
13\newcommand{\appName}{MediaDB}
14\newcommand{\mirror}{http://server/pbmirror}
15\newcommand{\tabHead}[1]{\textbf{#1}}
16
17\title{User Manual \appName}
18\author{Joachim Langenbach}
19\date{\today}
20
21% \makeglossaries
22% \newacronym{MIN}{MIN}{Medium Identification Number (can be ISBN, EAN, UPC, $\cdots$)}
23
24\begin{document}
25
26\maketitle
27\newpage
28
29\tableofcontents
30\newpage
31
32% \printglossary[type=\acronymtype, style=long]
33% \newpage
34
35\section{About}
36
37\appName helps you to organize your medias like books, cds, ....
38
39\section{Installation and Configuration}
40
41To get \appName, their are two ways.
42The preferred way is to use a provided package for your platform.
43The second way is to compile it for your own.
44But be aware, that you need an AWS Account to use Amazon if your are building \appName from source.
45
46\subsection{Install \appName-Package}
47
48\subsubsection{Linux}
49
50\paragraph{Adding the mirror}$\;$ \\[0.2cm]
51
52The packages are located at
53
54\mirror/YOUR-DISTRIBUTION/YOUR-VERSION\\
55(Example Ubuntu Lucid (10.04): \mirror/ubuntu/10.04).
56
57If you have an DEB-based distribtion like Debian, Ubuntu, ... you should copy your choosen list-file to ....
58
59If you have an RPM-based distribution like Fedora, OpenSUSE, ... you should copy your choosen repo-file to ....
60
61\subsubsection{Mac}
62
63Mac platform is not supported with packages right now.
64
65\subsubsection{Windows}
66
67Download the windows installer (link), execute it and follow the instructions.
68If you want to setup an MySQL-Server on that machine, skip to \ref{sec:installDatabaseWin}, if not, go on to \ref{sec:configureApp}.
69
70\subsubsection{Building from Sources}
71
72Download the source package from \mirror/src. To get all dependencies, look into each directory under the src directory. If there is a dependencies.xml file, open it and make sure, all listed dependencies are present on your system. Further on you need cmake to configure the package.
73
74\subsection{Install and configure the database}
75\label{sec:installDatabase}
76
77\subsection{Linux}
78\label{sec:installDatabaseLinux}
79
80\subsubsection{Mac}
81\label{sec:installDatabaseMac}
82
83\subsubsection{Windows}
84\label{sec:installDatabaseWin}
85
86
87\subsection{Configure \appName}
88\label{sec:configureApp}
89
90\section{Basics and philsophies}
91
92\subsection{About Plugins}
93
94\subsubsection{Plugins providing Medias}
95
96\subsubsection{Plugins providing Searchproviders and Shops}
97
98\subsection{Medium Identification Number}
99
100The MIN is used to identify an medium (s. \ref{tab:MINOverview}). But many types of medias have different types of numbers. Even the same media type can have different numbers in different regions, also some medias have more than one type of numbers.
101
102If you change the MIN of a medium, the system tries to detect the type of the number and set it accordingly. But it can be, that the type you want to use, is not supported by default. So you can add a new type and you must than manualy select this type. If the system knows, which type you entered, it also tries to validate your entered number.
103
104\begin{table}
105        \caption{Overview over different MIN's}
106        \label{tab:MINOverview}
107        \begin{tabular}{lp{4cm}lp{4cm}}
108                \tabHead{Type}  & \tabHead{Description}                                                         & \tabHead{Medias}      & \tabHead{Convertible} \\
109                \toprule
110                EAN                                                     & European Article Number                                               & Any                                                           & ISBN-13, UPC                                  \\
111                ISBN-13                                 & International Standard Book Number    & Books                                                 & ISBN-10                                                               \\
112                ISBN-10                                 & International Standard Book Number    & Books                                                 &                                                                                       \\
113                UPC                                                     & Universal Product Code                                                        &       CD's, Movies, DVD       &                                                                                       \\
114        \end{tabular}
115\end{table}
116
117\section{Usage}
118
119\subsection{Search for Medias}
120
121\subsubsection{Export List of Medias}
122
123\subsection{Add new Medias}
124
125\subsection{Edit Medias}
126
127\subsubsection{Add other Mediums to current Medium}
128
129\subsection{Handling of virtual Medias}
130
131\subsubsection{Whishes}
132
133\subsubsection{Gift ideas}
134
135\subsubsection{Literature}
136
137\subsection{Buying Medias}
138
139\subsection{Edit Stuff around Medias}
140
141\subsubsection{Persons and Roles}
142
143\subsubsection{Manufacturers}
144
145\subsubsection{Genre}
146
147\subsection{Handling of external MimeTypes}
148
149
150
151\end{document}
Note: See TracBrowser for help on using the repository browser.