/
client-fr.tex
235 lines (195 loc) · 8.65 KB
/
client-fr.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
%*******************************************************************************
%*******************************************************************************
\chapter{Songbook-Client}
\setcounter{chapter}{2}
\label{chap:songbook-client}
\minitoc
%*******************************************************************************
%*******************************************************************************
Le \client{} est interface graphique facilitant la création de
recueils de chansons
personnalisés\footnote{\url{http://www.ohloh.net/p/songbook-client},
\url{http://github.com/crep4ever/songbook-client}}.
\begin{nota}
Quel que soit votre système d'exploitation, il est nécessaire d'avoir
installé au préalable les dépendances du \recueil{} lui-même
(\refsec{sec:install}) afin de pouvoir produire un recueil \ext{pdf}.
\end{nota}
Les téléchargements suivant les différents systèmes d'exploitation
sont proposés sur \url{http://www.patacrep.com/static1/downloads}.
%*******************************************************************************
\section{Interface}
%*******************************************************************************
%-------------------------------------------------------------------------------
\subsection{Premier lancement}
%-------------------------------------------------------------------------------
\begin{figure}
\centering
\includegraphics[width=\textwidth]{start}
\caption{Premier lancement de l'application.}
\label{fig:start}
\end{figure}
Par défaut, l'interface est vide (\reffig{fig:start}). Le
\client{} doit être lié à un \recueil{} existant. Vous avez
deux solutions~:
\begin{enumerate}
\item Vous pouvez indiquer le chemin d'un répertoire
\directory{songbook} existant depuis le menu
\menu{Édition}{Préférences} (\reffig{fig:solution-a}).
\item Vous pouvez télécharger la dernière version depuis internet
depuis le menu \menu{Bibliothèque}{Télécharger}
(\reffig{fig:solution-b}).
\end{enumerate}
Après avoir indiqué ou téléchargé un \recueil{}, le \client{} génère la
\emph{bibliothèque des chansons} trouvées dans le sous-répertoire
\directory{songs} du \recueil{}.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{figure}
\centering
%% -- subfigures --
\subfigure[]{
\label{fig:solution-a}
\includegraphics[width=0.45\textwidth]{preferences}%
}%
\hspace{0.1cm}%
\subfigure[]{%
\label{fig:solution-b}%
\includegraphics[width=0.45\textwidth]{download}%
}%
%% -- subfigures --
\caption{%
Deux solutions permettent de lier le \emph{Songbook-Client} à un \recueil{}.
\subref{fig:solution-a}~Indiquer le chemin d'un répertoire existant~;%
\subref{fig:solution-b}~Télécharger depuis internet.%
}%
\label{fig:solutions}
\end{figure}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%-------------------------------------------------------------------------------
\subsection{La bibliothèque des chansons}
%-------------------------------------------------------------------------------
\begin{figure}
\centering
\includegraphics[width=.7\textwidth]{library}
\caption{La bibliothèque des chansons.}
\label{fig:library}
\end{figure}
L'ensemble des chansons \ext{sg} trouvées dans le sous-répertoire
\directory{songs} est présenté sous la forme d'une liste. Les
différentes colonnes peuvent être affichées/masquées dans l'onglet
\command{Affichage} du menu \menu{Édition}{Préférences}. Par défaut,
seules les colonnes \command{Titre}, \command{Artiste} et
\command{Album} sont visibles.
Les chansons de la bibliothèque sont sélectionnables par simple clic.
Une chanson sélectionnée est affichée en surbrillance. Cliquez sur une
chanson sélectionnée pour la dé-sélectionner.
%*******************************************************************************
\section{Ajouter une chanson}
%*******************************************************************************
Le menu \menu{Bibliothèque}{Nouvelle chanson} permet d'ajouter une
nouvelle chanson à la bibliothèque (\reffig{fig:new-song-a}). La boîte
de dialogue permet de renseigner les méta-données de la chanson comme
son titre, son compositeur etc. Ces différents champs permettent de
générer le squelette du nouveau fichier \ext{sg} correspondant à la
chanson (\reffig{fig:new-song-b}). La troisième étape
(\reffig{fig:new-song-c}) consiste à écrire la tablature. Enfin, la
chanson peut être sélectionnée dans la bibliothèque pour en obtenir le
rendu au format pdf depuis le menu \menu{Recueil}{Générer PDF}
(\reffig{fig:new-song-d}).
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{figure}
\centering
%% -- subfigures --
\subfigure[]{
\label{fig:new-song-a}
\includegraphics[width=0.35\textwidth]{new-song}%
}%
\hspace{0.1cm}%
\subfigure[]{%
\label{fig:new-song-b}%
\includegraphics[width=0.6\textwidth]{song-editor-1}%
}%
\hspace{0.1cm}%
\subfigure[]{%
\label{fig:new-song-c}%
\includegraphics[width=0.6\textwidth]{song-editor-2}%
}%
\hspace{0.1cm}%
\subfigure[]{%
\label{fig:new-song-d}%
\includegraphics[width=0.35\textwidth]{result}%
}%
%% -- subfigures --
\caption{%
Ajout d'une nouvelle chanson.
\subref{fig:new-song-a}~Renseignement des méta-données~; %
\subref{fig:new-song-b}~Génération automatique du squelette \ext{sg}~; %
\subref{fig:new-song-c}~Écriture de la tablature~; %
\subref{fig:new-song-d}~Génération du pdf.%
}%
\label{fig:new-song}
\end{figure}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%*******************************************************************************
\section{Création d'un recueil personnalisé}
%*******************************************************************************
\paragraph{Enregistrement/Ouverture}
Le format de fichier \ext{sb} enregistre la liste des chansons
sélectionnées ainsi que son style et ses options
(voir~\refsec{sec:create-songbook}).
\paragraph{Style et options d'un recueil}
Une boîte de dialogue permet de rapidement sélectionner le style du
recueil pdf ainsi que les différentes éléments à afficher
(\reffig{fig:new-songbook}).
\begin{figure}
\centering
\includegraphics[width=\textwidth]{new-songbook}
\caption{Personnalisation d'un recueil.}
\label{fig:new-songbook}
\end{figure}
%*******************************************************************************
\section{Compilation depuis les sources}
%*******************************************************************************
%-------------------------------------------------------------------------------
\subsection{\linux}
%-------------------------------------------------------------------------------
\paragraph{Dépendances}
\begin{unix}
sudo apt-get install build-essential cmake libarchive-dev libhunspell-dev
sudo apt-get install qt4-qmake qt4-dev-tools libqt4-sql-sqlite
\end{unix}
\paragraph{Téléchargement}
\begin{unix}
git clone git://github.com/crep4ever/songbook-client.git
\end{unix}
\paragraph{Compilation/Exécution}
\begin{unix}
cd songbook-client
make && sudo make install
\end{unix}
%-------------------------------------------------------------------------------
\subsection{\windows}
%-------------------------------------------------------------------------------
%*******************************************************************************
\section{FAQ}
%*******************************************************************************
\paragraph{Comment signaler un bug ?}
Directement sur
Github\footnote{\url{http://github.com/crep4ever/songbook-client/issues}}
ou via le forum \footnote{\url{http://www.patacrep.com/forum/}}.
\paragraph{Les partitions de solfège n'apparaissent pas}
Si la compilation de votre recueil de chansons n'intègre pas les
partitions malgré l'option \emph{Lilypond} correctement cochée dans
les préférences, vérifiez que Lilypond est bien installé sur votre
système. Sous MacOs et Windows, il est nécessaire de générer soi-même
les pdf correspondants aux partitions, le processus n'étant pas
automatisé par le makefile.
\paragraph{La bibliothèque des chansons est vide}
Vérifiez que le chemin d'accès au \recueil{} est correctement
renseigné dans \menu{Édition}{Préférences}. Le chemin indiqué doit contenir
impérativement le makefile et le répertoire \directory{songs/}.
\paragraph{Erreurs après renommage/suppression d'une chanson}
Un \command{make clean} ou, depuis l'interface, \menu{Recueil}{Nettoyer} devrait
régler le problème. S'il persiste encore, une solution radicale
consiste à supprimer manuellement tous les fichiers \ext{d} présents
dans \directory{$\sim$/songbook}.