Csound Reference Manual (French)
Python Makefile CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
STKopcodes Updated Jun 25, 2015
command Updated Nov 1, 2016
control Added refs to while opcode Nov 6, 2014
csbeats Initial commit Mar 17, 2013
cscore Initial commit Mar 17, 2013
csound5 Updated May 2, 2016
deprecated Updated Apr 21, 2015
examples Initial commit Jan 31, 2017
experimental Updated May 1, 2014
imageopcodes Initial commit Mar 17, 2013
images Initial commit Sep 29, 2016
math Version 6.00.1 Aug 6, 2013
midi Updated Apr 18, 2016
misc Updated Jan 31, 2017
miscopcodes Initial commit Mar 17, 2013
opcodes Updated Feb 25, 2017
orch Updated Oct 22, 2016
oscnetwork Updated Jan 14, 2017
overview
pitch Cosmetic changes Aug 2, 2014
plugin Initial commit Mar 17, 2013
preface Updated Nov 4, 2016
score Updated Oct 22, 2016
scoregens Updated Nov 4, 2016
siggen Updated Jan 31, 2017
sigio Updated Jun 16, 2015
sigmod Updated Jan 31, 2017
spectral Updated May 23, 2015
strings Minor fix Nov 8, 2016
table Cosmetic changes Aug 2, 2014
utility Updated Nov 26, 2015
vectorial
xsl Updated for syntax highlighting with Pygments Jan 19, 2017
zak
.gitignore Updated Jan 31, 2017
.travis.yml Updated for syntax highlighting with Pygments Jan 19, 2017
Makefile Use of syntax-highlighting.css for all html type targets Jan 20, 2017
README.md Updated Jan 19, 2017
categories.py Updated Jan 14, 2017
copying.txt Initial commit Mar 17, 2013
csd2docbook.py Updated Jan 31, 2017
csound.css Initial commit Mar 17, 2013
makeframes-fr.py Updated Oct 5, 2013
manpages.xml Initial commit May 2, 2016
manual.xml Updated Jan 31, 2017
opcodeparser.py Initial commit Mar 17, 2013
opcodes.xml Updated Aug 11, 2015
opcodes1.xml Updated Apr 19, 2016
quickref-fr.py
syntax-highlighting.css Updated for syntax highlighting with Pygments Jan 19, 2017

README.md

Le manuel de référence canonique de Csound

Build status

Le manual de référence de Csound est écrit en DocBook v4. Pour apprendre à utiliser Docbook aller sur docbook.org.

Si vous rencontrez des problèmes ou si vous avez des suggestions, ouvrez un ticket, ou faites un fork de cet entrepôt et un pull request.

Outils nécessaires

En plus d'autres outils spécifiques à ce qu'on construit, on a besoin de Docbook, Python avec Pygments; et xsltproc.

Linux

Pour installer DocBook et xsltproc, exécuter

sudo apt-get install -y docbook xsltproc

Python et Pygments sont préinstallés sur la plupart des distributions Linux. Si l'on a pas Python, aller sur https://docs.python.org/2/using/unix.html pour apprendre comment installer Python ou le construire à partir des sources.

Aller sur http://pygments.org/download/ pour apprendre comment installer Pygments.

MacOS

La manière la plus simple d'installer DocBook est sans doute via Homebrew. Pour installer Homebrew, suivre les instructions sur brew.sh. Puis taper brew install docbook dans un terminal.

Pour installer Pygments, taper dans un terminal sudo easy_install pygments. Si une ancienne version de Pygments est déjà installée, il peut y avoir un message d'erreur indiquant que CsoundDocumentLexer est introuvable. Si c'est le cas, on peut mettre à jour cette version de Pygments avec easy_install —upgrade pygments.

Python et xsltproc sont préinstallés sur macOS.

Windows

La manière la plus simple d'installer DocBook est sans doute via Cygwin. Pour installer Cygwin aller sur https://www.cygwin.com et télécharger et exécuter un installeur pour la dernière version de Cygwin.

Pour installer Python, aller sur https://www.python.org/downloads/windows/ et télécharger et exécuter un installeur de Python 2.7. Ne pas oublier d'ajouter python.exe dans le path de Windows.

Aller sur http://pygments.org/download/ pour apprendre comment installer Pygments.

Construire le manuel

Exécuter make ⟨cible⟩ pour construire une ⟨cible⟩. Par exemple, pour construire une collection de pages HTML, exécuter make html.

Si DocBook est installé de manière non conventionnelle, on peut voir cette erreur : “La variable XSL_BASE_PATH doit renseigner le répertoire d'installation des feuilles de style XSL.” Pour indiquer à make où trouver DocBook, exécuter

make XSL_BASE_PATH=path/to/docbook/stylesheets ⟨cible⟩

au lieu de make ⟨cible⟩.

HTML

Exécuter make html (ou seulement make) pour créer un répertoire nommé html contenant une collection de fichiers HTML.

PDF

En plus des outils nécessaires, la construction des fichiers PDF nécessitent FOP d'Apache. Il peut être aussi nécessaire de télécharger et d'installer un Java Runtime Environment.

Pour installer FOP sur Linux, exécuter

sudo apt-get install -y fop

Pour installer FOP sur macOS avec Homebrew, exécuter

brew install fop

Exécuter make pdf pour créer un fichier PDF adapté à l'impression sur du papier letter.

Exécuter make pdfA4 pour créer un fichier PDF adapté à l'impression sur du papier A4.

Aide HTML compilée

On peut construire une aide HTML compilée sur Windows. En plus des outils nécessaires il faut utiliser le HTML Help Workshop. Pour installer le HTML Help Workshop, aller sur https://go.microsoft.com/fwlink/?LinkId=14188 pour télécharger htmlhelp.exe et double-cliquer ensuite sur htmlhelp.exe.

Exécuter make htmlhelp pour créer un fichier d'aide HTML compilée (.chm).

Editer le manuel

DocBook est en XML. Lorsque l'on écrit du XML, il ne faut pas oublier de fermer les balises. Voici du XML valide :

<para>texte</para>

alors que celui-ci ne l'est pas :

<para>texte</ERROR>

DocBook v4 a une définition de type de document (DTD) qui décrit les éléments valides de DocBook et leurs attributs. Voir DocBook: The Definitive Guide pour en savoir plus.

Ajouter une entrée d'opcode

En général, une entrée pour un nouvel opcode nommé newopcodename sera un fichier XML nommé newopcodename.xml contenant

<refentry id="newopcodename">
    <!-- More mark-up… -->
</refentry>

On peut commencer à documenter un opcode en prenant une entrée existante comme modèle. Toutes les entrées des opcodes sont dans le répertoire opcodes. On peut aussi utiliser opcodes/templates.xml comme point de départ.

Pour incorporer une nouvelle entrée dans le manuel :

  1. Ajouter l'entrée comme une entité dans manual.xml. Par exemple, si l'on dépose newopcodename.xml dans le répertoire opcodes, il faut ajouter cette entité dans manual.xml :

    <!ENTITY opcodesnewopcodename SYSTEM "opcodes/newopcodename.xml">
  2. Utiliser l'entité pour ajouter l'entrée de l'opcode à opcodes/top.xml. Les entrées des opcodes y étant rangées par ordre alphabétique, trouver où insérer l'opcode dans la liste et ajouter :

    &opcodesnewopcodename;
  3. Faire un lien vers cet opcode depuis une section appropriée du manuel. Par exemple, si newopcodename doit être inclus avec les opcodes de traitement spectral en temps réel, ajouter un élément link à spectral/realtime.xml, like this:

    <link linkend="newopcodename"><citetitle>newopcodename</citetitle></link>

    Répéter cette étape pour chaque section dans laquelle votre opcode devrait être inclus.

  4. On peut aussi utiliser un élément refentryinfo pour que l'opcode soit correctement référencé dans la référence rapide. Utiliser une des catégories dans categories.py. Si l'on omet l'élément refentryinfo, l'opcode sera référencé dans la catégorie Divers.)

5.Si possible, ajouter un élément link à l'opcode dans la section appropriée de Opcodes Overview.

Maintenance

Il y a plusieurs cibles pour préparer les fichiers d'une distribution. Bien mettre à jour le numéro de version dans manual.xml et dans Makefile afin que les fichiers soient générés avec ce numéro. Il est aussi utile de mettre à jour la section Les nouveautés … pour chaque distribution.