English

Comment utiliser les boutis du Lab ?

Dotclear fournit un ensemble d'outils pour le développement d'extensions pour Dotclear :

• un SVN
• un wiki
• un trac

Cette page est destinée à vous aider à vous familiariser avec ces outils et l'environnement du Lab.

SVN

SVN est la contraction de  http://fr.wikipedia.org/wiki/Subversion_(logiciel)|Subversion. Subversion permet de conserver toutes les versions des sources d'un logiciel (ou pour ce qui nous concerne ici d'un thème ou d'un plugin).

Il vous faut tout d'abord installer un client subversion sur votre ordinateur :

• Pour Windows, ça peut être par exemple  tortoiseSVN ou  RapidSVN
• Pour Mac vous pouvez utiliser le Terminal et utiliser le subversion installé par défaut sur MacOSX en ligne de commande ou utiliser un client graphique comme  RapidSVN ou  ZigVersion
• Pour Linux, installez le package subversion puis utilisez les lignes de commande

Voici les principales commandes à connaître pour utiliser Subversion.

checkout

Permet de récupérer le « dépôt » (repository) et d'en faire une copie de travail (working copy)

# Pour récupérer tous les plugins
svn checkout https://svn.dotclear.net/lab/plugins

# Pour récupérer un plugin en particulier (ici acronyms)
svn checkout https://svn.dotclear.net/lab/plugins/acronyms 

update

Met à jour votre copie de travail avec la version la plus récente sur le dépôt. Le dépôt étant commun à tous il est important de mettre systématiquement à jour votre copie de travail avant d'y effectuer vos changements

# Mettre à jour votre copie de travail
svn update

commit

Permet d'envoyer sur le dépôt les modifications que vous avez apportées à votre copie de travail. Chaque envoie crée une nouvelle version du dépôt. Les autres utilisateurs récupéreront vos modifications lorsqu'ils mettront à jour leur propre copie.

# Envoyer tous ses changements au dépôt (pensez à mettre "un bref message" informant sur la nature de vos changements)
svn commit -m "message to annonce changes"

# Envoyer un changement sur un plugin ou un thème en particulier (pensez au "message")
svn commit -m "message to annonce changes" acronyms/

diff

Cette commande affichera les différences entre votre copie de travail et la versio la plus récente du dépôt

# Exemple pour comparer le fichier _define.php du plugin acronyms
svn diff plugin/acronyms/_define.php 

revert

Permet de rétablir votre copie de travail en l'état de la dernière version du dépôt (utile si vous pensez avoir fait des bêtises chez vous).

# Exemple pour rétablir le fichier _public.php du thème Noviny de votre copie de travail tel que sur le dépôt
svn revert themes/Noviny/_public.php

# Exemple sur tous les fichiers d'un thème ou d'un plugin (ici moreTpl)
svn revert -R plugin/moreTpl

add

Ajoutera un dossier ou un fichier au dépôt (et les élements du dossier si vous ajoutez un dossier). Puis après cette opération vous pourrez faire le commit.

# Exemple pour ajouter le fichier user.png au thème Noviny
svn add themes/Noviny/images/user.png

# Exemple pour ajouter un répertoire images et tout son contenu au thème Noviny
svn add /themes/Noviny/images

mkdir

Créera et ajoutera un nouveau répertoire dans un thème ou un plugin (comme pour le add vous devrez ensuite commiter).

fixme pas compris différence add/mkdir (Kozlika)

# Pour créer un nouveau répertoire de plugin 
svn mkdir plugins/myNewPlugin

move

Pour déplacer un fichier.

# Déplacer le fichier icon.png de acronyms vers myNewPlugin
svn move plugins/acronyms/icon.png plugin/myNewPlugin

copy

Pour copier le contenu d'un répertoire vers une autre destination.

# Exemple : copier le contenu du répertoire gallery/trunk vers gallery/tags/2.1
svn copy plugins/gallery/trunk plugin/gallery/tags/2.1

merge

Pour combiner/fusionner deux versions. Utile quand deux contributeurs bossent ensemble sur le même fichier

# To apply all changes made from $revision_number_start$ to $revision_number_start$ on plugin/gallery/branches to the destination plugin/gallery/trunk
svn merge -r $revision_number_start$:$revision_number_stop$ plugin/gallery/branches plugin/gallery/trunk

resolved

Résoudre les conflits éventuels générés par plusieurs commits concomittants sur le même fichier.

# Exemple pour le fichier _define.php d'acronym
svn resolved plugins/acronyms/_define.php

Note: si vous utilisez un client subversion graphique ces commandes se trouvent dans les menus de l'application ou par clic droit et menu contextuel subversion (selon le client que vous aurez choisi).

Wiki

Wiki is a tool to create page with many contributors. It provides a simplified syntax to edit them. You can check this on the page WikiFormatting

Create pages

First, go to the URL you want to create. The trac wiki supports "sub-categories" so choose very carrefully your URL because it make sense. When you arrive, it's blank page. If you have a sufficent rights, you shoudl have a button "Create this page".

Just click on it and decribe your page.

Edit pages

If you have a sufficient rights, on each wika page, you should have a button "Edit page". You can click on it to modify something inside.

For this both actions, before submitting changes, verify them by previewing your job and decribe what you done in field "change information". It will show on timeline after.

Trac groupware

License

Only code under  free software license ("free" as in "free speech," not as in "free beer") is authorized on Dotclear Lab : GPL v2 and v3, BSD, LGPL, MPL, etc.

Creactive Commons can be used for themes, but not for plugins (see  CC FAQ).