[PDF] Projet Patacrep 9 juin 2016 Le projet

View - Download Projet Patacrep

Previous PDF

Next PDF

Projet Patacrep

Version 5.0.0

L"équipe Patacrep

09 June 2016

Table des matières

1 Documentation3

1.1 Installation

3

1.2 Création d"un carnet

6

1.3 Écriture des chansons

16

1.4 Programmesongbook. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

1.5 Aller plus loin

25

2 Liens externes31

3 Projets liés33

3.1 patacrep

33

3.2 patadata

33

3.3 patanet

33

3.4 Outils non maintenus

33

4 Outils externes35

4.1 LaTeX

35

4.2 Songs

35

4.3 Lilypond

35

4.4 Python

35

4.5 jinja2

36 i
ii

Projet Patacrep, Version 5.0.0

Le projetPatacrepfournit des outils pour compiler un carnet de chants en LaTeX (en utilisant lepaquet songs 1).

Les chansons sont écrites, au choix, en utilisant le langage chordpro

2(auquel cas elles seront converties en LaTeX

lors de la compilation du carnet), ou en utilisant directement LaTeX.1. http ://songs.sourceforge.net/

2. http ://www.chordpro.org/Table des matières1

Projet Patacrep, Version 5.0.0

2Table des matières

CHAPITRE1Documentation

1.1

Installation

1.1.1

Dépendances

Patacrepest un projet reposant sur beaucoup de techniques, il a donc un certain nombre de dépendances à installer

pour le faire fonctionner. Ces dépendances sont les mêmes pour tous les systèmes d"exploitation, mais la méthode

d"installation diffère. Ces dépendances sont les suivantes : Python 3.3 ou plus récent. Python 2 n"est pas supporté;

LaT eX,et en particulier lualatex;

Patacrepa aussi des dépendances optionnelles, qui peuvent ajouter des fonctionnalités, mais ne sont pas obliga-

toires :

Lilypond, pour compiler des partitions.

GNU/Linux

Il n"existe pas (pour le moment?) de paquet pour les différentes distributions. En attendant,patacreppeut être

installé en utilisant pip (éventuellement dans un virtualen v

3, pour garder un environnement d"installation propre).

Voir lasection suivantepour les instructions.

Voici quelques informations supplémentaires pour certaines distributions.

Debian

Il n"existe pas (encore?) de paquet debian pourpatacrep. Les paquets à installer sous Debian (et ses dérivées

comme Ubuntu) sont :

Python 3.4

Installer les paquets nécessaires (pour une installation de patacrepsansvirtualenv) :apt-get install python3.4 python3-pip

Installer les paquets nécessaires (pour une installation de patacrepavecvirtualenv) :apt-get install python3-virtualenv

LaT eX:

Nécessaires : texlive texlive-latex-base texlive-latex-recommended texlive-latex-extra Optionnel pour patacrep, nécessaire pourpatadata:texlive-lang-english texlive-lang-french texlive-lang-portuguese texlive-lang-spanish texlive-fonts-extra Lilypond (optionnel) : lilypond3. http ://virtualenv.readthedocs.org 3

Projet Patacrep, Version 5.0.0

Il est aussi possible, en utilisant

stdeb

4, de créer un paquet.debà la volée :python setup.py --command-packages=stdeb.command bdist_deb

sudo dpkg -i deb_dist/python3-patacrep_5.0.0-1_all.debCentOS 6.5

Sur CentOS 6.5, un certain nombre de logiciels par défaut sont trop anciens pour faire fonctionner Patacrep

correctement. En particulier, vous devriez utiliser une version récente de TeXLive, et installer ghostscript en

version 9.

MacOSX

Vous devrez installer les dépendaces suivantes :

Python 3

5;

LaT eX.La distrib ution

MacT eX

6est la plus simple à installer. Une installation personnalisée de TeX-

Live fonctionnera aussi si vous savez ce que vous faites.

Lilypond peut être utile si v oussouhaitez compil erles partitions dans les chansons. Ce n"est toutefois

pas une dépendance obligatoire. Vous pouvez le télécharger à cette adresse

7. Décompressez l"archive,

puis placez-la dans/Applications. Vous devrez ajouter un lien vers lilypond pour quesongbook

puisse le trouver en lançant les commandes suivantes dans un Terminal :sudo ln -s /Applications/LilyPond.app/Contents/Resources/bin/lilypond /usr/local/bin/lilypond

echo "export PATH=$PATH:\usr\local\bin" >> ~/.bashrcLa première commande va vous demander votre mot de passe administrateur.

Windows

Voici où vous pourez trouver les dépendances nécessaires :

Python 3

8;

MikT eX

9pour avoir accès a LaTeX;

Lilypond

10. 1.1.2

Installation depuis PyPi

Une fois les dépendances installées, vous pouvez vérifier que tout s"est bien passé en lançant les commandespython- -version

lualatex version # Uniquement si vous avez installé lilypond lilypond

versionSi le numéro de version s"affiche, tout va bien, si vous avez une erreurcommand not found, il y a un pro-

blème.

Pour la suite, la bibliothèquePatacrepet le programmesongbooksont disponibles sur lePython P ackages

Index

11, vous pouvez donc les installer avecpip.4. http ://github.com/astraw/stdeb

5. https ://www.python.org/download/

6. https ://tug.org/mactex/

7. http ://www.lilypond.org/download.fr.html

8. https ://www.python.org/download/

9. http ://miktex.org/download

10. http ://www.lilypond.org/windows.fr.html

11. http ://pypi.python.org/pypi/patacrep4 Chapitre 1. Documentation

Projet Patacrep, Version 5.0.0

Sans virtualenv

pip3 install patacrep

Puis pour tester si tout a bien fonctionné

songbook version

Avec virtualenv

Pour éviter de mélanger les installation système (parapt,yumou autre) et les installations depip, il est recom-

mandé d"installer l"application localement dans unvirtualenv:$ virtualenv -p python3 virtualenv

Already using interpreter /usr/bin/python3

Using base prefix

"/usr"

New python executable in virtualenv/bin/python3

Also creating executable in virtualenv/bin/python

Installing setuptools, pip...done.

$ . virtualenv/bin/activate virtualenv $ pip install patacrep $ songbook --version

...Si vous optez pour une installation dans unvirtualenv, il faudra lancer la commande. PATH_TO_VIRTUALENV/bin/activate

avant chaque utilisation desongbookou depatacrep.

Mac OS X

Si vous avez des erreurs lors de l"installation, deux cas sont possibles : erreur permission denied: vous n"avez pas de droits en écriture dans/usr/bin. Ajoutez sudodevant la commande fautive, et relancez-la (sudo pip3 install patacrep). Un mot de passe administrateur vous sera demandé. -songbook: command not found, c"est que/usr/local/binn"est pas dans votrePATH. Pour l"ajouter, exécutez la commandeecho "export PATH=$PATH:/usr/local/bin" >> ~/.bashrc 1.1.3

Installation de la ver sionde développement

Pour obtenir la version de développement, il est possible de télécharger les sources en utilisant

git

12:git clone https://github.com/patacrep/patacrep.git

cd patacrep pip3 install -r Requirements.txt python3 setup.py installPour mettre à jour la version de développement, utilisez simplement git pull pip3 install -r Requirements.txt python3 setup.py installDepuis le dossierpatacrep12. http ://git-scm.com

1.1. Installation5

Projet Patacrep, Version 5.0.0

1.1.4

Mise à jour

Pour effectuer une mise à jour dePatacrep, vérifiez que les dépendances sont à jour, puis lancez la commandepip3 install --upgrade patacrep

1.2

Création d"un carnet

Un carnet ou recueil de chant est décrit par un fichier.yamlqui peut être écrit manuellement. Les sections

suivantes expliquent lasyntaxede ces fichiers, ainsi que les options demises en pagedes carnets compilés. La

manière decompiler un receuilest aussi détaillée. 1.2.1

Intr oduction

Un carnet est un ensemble de chansons qui peut peut être accompagné de divers éléments : index des chansons ou

auteurs, page de titre, liste d"accords, préface, etc.

Un carnet est décrit par un fichier.yaml(détailléci-après). Il est généré parsongbooken assemblant des

fichiers de chansons.csg(ou.tsg), des templates.tex, des fichiers LaTeX.tex, des images, etc. Tout ce

contenu provient de dossiers de donnée appelésdatadir.

Un carnet fini, au format PDF, est l"intégration d"un contenu dans une mise en page particulière. Les options qui

gouvernent cette mise en page sont principalement décrites dans lestemplates. Les différentes manières d"ajouter

du contenu à un carnet sont décrites dans la sectionGestion du contenu.

Exemple de fichier.yaml

Un exemple de fichier.yamlest fournia vecle code source 13:content: - section:

Chants

Traditionnels

chevaliers_de_la_table_ronde.csg greensleeves.csg vent_frais.csg - section:

Exemples

exemple *.csg" book: lang: en encoding: utf-8 pictures: yes template: default.tex onesongperpage: no chords:# Options relatives aux accords show: yes diagramreminder: important diagrampage: yes repeatchords: yes lilypond: no tablatures: no instrument: guitar notation: alphascale authors:# Comment sont analysés les auteurs separators:

- and13. https ://github.com/patacrep/patacrep/blob/4b801c6b90a2c225668ead4b47442f344f94ab80/examples/example.yaml

6 Chapitre 1. Documentation

Projet Patacrep, Version 5.0.0

ignore: - unknown after: - by titles:# Comment sont analysés les titres prefix: - The - Le - La L" - A - Au - Ces - De - Des - El - Les - Ma - Mon - UnSyntaxe des fichiers.yaml

Un fichier.yamlest écrit au formatY AML14. Le format YAML est un type de fichier texte dans lequel on

représente des information de trois manières différentes :

les listes d"éléments ordonnés : chaque élément commence sur une nouv elleligne, précédé d"un tiret -.

Tous les élements d"une même liste doivent avoir la même indentation (décalage depuis le bord gauche).

les tableaux associatifs composés de multiples clef : valeur, les clefs étant la plupart du temps des chaînes,

et les valeurs pouvant être n"importe quel type (une liste, un autre tableau associatif, une donnée scalaire).

les données scalaires : chaînes de charactère (délimitées par des guillemets anglais "..."), nombre,

booléen (yes/no).

Le fichier.yamlcontient un tableau associatif, dont les clefs sont les noms d"options, et les valeurs associées

sont les valeurs de ces options. Le type des valeurs dépend de l"option considérée. Les sections sur lecontenu des

carnetset sur lamise en pagecontiennent les détails concernant les différentes options.

Compiler un fichier.yaml

Le fichiercarnet.yamlpeut être compilé (ietransformé en fichier PDF) en ligne de commande, avec la com-

mande suivante :songbook chemin/vers/carnet.yaml L"intégralité des options de la commandesongbooksont disponible dans lasection dédiée.

Ecrire ses propres fichiers.yaml

Le contenu d"un carnet est géré par le mot-clefcontentd"un fichier.yaml. Les différents types de contenus

disponibles sont décrits dans la sectionGestion du contenu.

Tous les autres mots-clefs des fichiers.yamlservent à faire la mise en page des carnets. Les options sont présen-

tées dans la sectionMise en page du carnet. 1.2.2

Gestion du conten u

Cette partie décrit comment choisir les chants à insérer dans un carnet.14. http ://yaml.org/

1.2. Création d"un carnet7

Projet Patacrep, Version 5.0.0

Introduction

Le contenu d"un carnet est défini avec l"optioncontentdu fichier.yaml, sous la forme d"une liste. Le type de

cette liste dépend du contenu à inclure. Voici un exemple de contenu.content: - tex: intro.tex - section:

Chansons

boire boire/ *.csg" - section:

Chansons

d"amour - sorted: key: [ by title content: amour/ *.csg" love/

*.csg"Comme nous pouvons le voir, la valeur decontentest une liste de tableaux associatifs ou de chaînes de

caractères. Une chaîne de caractères est automatiquement transformé en tableau avec une clésong. Ainsi

"boire/ *.csg"etsong: "boire/*.csg"sont équivalents. Lacléd"un tableau associatif (avant le:)

est une chaîne indiquant letype de contenuconsidéré : par exemplesection: "Chansons à boire"va

créer une section ayant pour titreChansons à boire, tandis que- sorted: key: [ by title content: amour/ *.csg" love/

*.csg"va inclure toutes les chansons des répertoiresamour/*.csgetlove/*.csg, triées par auteur (by), puis par

titre (title).

Lorsqu"un tableau de typecontentn"a pas de contenu, cela va inclure toutes les chansons du répertoiresongs:content:

Ou alors pour inclure toutes ces chansons, triées pas auteur, album puis titre (c"est le tri par défaut) :

content: sorted:Types de contenus disponibles

Les types de contenus gérés parpatacrepsont fournis par des extensions (ou plugins). Un certain nombre

(décrits ci-après) sont proposés par défaut, et il est possible d"en écrire d"autres.

song[liste de chansons] Ce plugin, utilisé par défaut en l"absence de mot-clé, permet d"inclure une liste de

chansons, triées par ordre alphabétique du nom de fichier. Il est suivi d"une ou plusieurs expressions ra-

tionnelles correspondant aux noms de fichiers à inclure. La syntaxe précise de ces expressions est décrite

dans la documentation du module glob

15; le minimum à savoir est que/est utilisé pour parcourir les

répertoires,..correspond au répertoire parent, et*à n"importe quelle chaîne de caractères.content:

song: premiere.csg boire/ *.tsg"Est équivalent à (mot-clésongautomatique) :content: premiere.csg boire/ *.tsg"15. https ://docs.python.org/3.4/library/glob.html

8 Chapitre 1. Documentation

Projet Patacrep, Version 5.0.0

Les fichiers sont recherchés successivement dans les datadirs associés à un carnet :songcommence par

chercher dans le repertoiresongsdu premier datadir et si au moins un fichier correspond à l"expression

rationnelle, stoppe la recherche et passe à l"expression suivante. Sinon, il cherche dans le datadir suivant,

et ainsi de suite jusqu"à la fin de la liste.

sorted[liste triée de chansons] Ce plugin permet l"inclusion de chansons, triées selon un certain ordre. Il

prend deux arguments (facultatifs) :keypour la liste des champs selon lesquels les chansons de l"ar- gumentcontentdoivent être triées. Ces champs correspondent auxkeyvalsde l"environnementsong documentation

16), à ceux ajoutés parpatacrep, ainsi que ceux éventuellement ajoutés par le template

courant, et à des champs spéciaux. cela donne finalement :quotesdbs_dbs23.pdfusesText_29

[PDF] How old are you? - Primlangues

[PDF] Cahier de chants scouts

[PDF] Cahier de chants scouts

[PDF] Paroles de la chanson Ulysse Ridan Heureux qui, comme Ulysse, a

[PDF] La comptine ? l 'école maternelle - IEN Illfurth

[PDF] carnet de chants - Paroisse Saint-Pothin

[PDF] livret chant pour le temps ordinaire - Eglise Catholique Saint

[PDF] livret chants Esprit-Saint - Diocèse d 'Amiens

[PDF] Chants ? l 'Esprit Saint - Diocèse de Versailles

[PDF] carnet de chants - Paroisse Saint-Pothin

[PDF] Cahier de chants scouts

[PDF] Opéra: les chanteurs lyriques français se sentent mal aimés - La Croix

[PDF] La Haute Contre - Forum Opéra

[PDF] Jazz ladies » : les chanteuses de jazz - Portail des médiathèques de

[PDF] les ateliers et chantiers d 'insertion (aci) - Avise