mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Fix #1335 remove old and unmaintained French docs
Unfortunately nobody keeps them up to date, they would just spread confusion.
This commit is contained in:
Ondrej Grover
parent
5bad061c19
commit
cd40105c40
11 changed files with 0 additions and 876 deletions
|
|
@ -1,20 +0,0 @@
|
||||||
Trucs et astuces pour Pelican
|
|
||||||
#############################
|
|
||||||
|
|
||||||
Personnaliser l'url d'un article pour Pelican
|
|
||||||
=============================================
|
|
||||||
|
|
||||||
Par défaut, quand vous créez un article ayant pour titre *Mon article pour Pelican*,
|
|
||||||
l'url par défaut devient *mon-article-pour-pelican.html*. Cependant, il est possible
|
|
||||||
de modifier cela en utilisant la technique utilisée pour les traductions d'article,
|
|
||||||
c'est à dire le paramètre *:slug:* ::
|
|
||||||
|
|
||||||
Mon article pour Pelican
|
|
||||||
########################
|
|
||||||
|
|
||||||
:date: 2011-01-31 11:05
|
|
||||||
:slug: super-article-pour-pelican
|
|
||||||
|
|
||||||
bla, bla, bla …
|
|
||||||
|
|
||||||
En prenant cet exemple ci dessus, votre url deviendra *super-article-pour-pelican.html*
|
|
||||||
|
|
@ -1,58 +0,0 @@
|
||||||
Les bases de Pelican
|
|
||||||
####################
|
|
||||||
|
|
||||||
Créer son premier article
|
|
||||||
=========================
|
|
||||||
|
|
||||||
Pour créer notre premier article, nous allons éditer un fichier, par exemple premier_article.rst ::
|
|
||||||
|
|
||||||
Premier article pour Pelican
|
|
||||||
############################
|
|
||||||
:author: Guillaume
|
|
||||||
:date: 2011-01-08 10:20
|
|
||||||
:category: GNU-Linux
|
|
||||||
:tags: tutoriel, git
|
|
||||||
Ceci est un tutoriel pour configurer git.
|
|
||||||
Bla, bla, bla ....
|
|
||||||
|
|
||||||
Maintenant que ce fichier est créé, on va lancer la création du blog ::
|
|
||||||
|
|
||||||
pelican .
|
|
||||||
|
|
||||||
Vous aller obtenir une sortie comme celle ci — $PATH représente le dossier où vous
|
|
||||||
avez créé votre article ::
|
|
||||||
|
|
||||||
[ok] writing $PATH/output/feeds/all.atom.xml
|
|
||||||
[ok] writing $PATH/output/feeds/GNU/Linux.atom.xml
|
|
||||||
[ok] writing $PATH/output/feeds/all-en.atom.xml
|
|
||||||
[ok] writing $PATH/output/premier-article-pour-pelican.html
|
|
||||||
[ok] writing $PATH/output/index.html
|
|
||||||
[ok] writing $PATH/output/tags.html
|
|
||||||
[ok] writing $PATH/output/categories.html
|
|
||||||
[ok] writing $PATH/output/archives.html
|
|
||||||
[ok] writing $PATH/output/tag/tutoriel.html
|
|
||||||
[ok] writing $PATH/output/tag/git.html
|
|
||||||
[ok] writing $PATH/output/category/GNU-Linux.html
|
|
||||||
|
|
||||||
|
|
||||||
Première analyse
|
|
||||||
================
|
|
||||||
|
|
||||||
Nous allons décortiquer un peu tout ça ensemble.
|
|
||||||
|
|
||||||
* Un dossier output/ a été créé pour y mettre le fichiers xml et html du blog.
|
|
||||||
* Dans le dossier feeds/, nous retrouvons les différents flux de syndication.
|
|
||||||
* Le fichier de l’article et la page principale du blog a été généré.
|
|
||||||
* Le répertoire tag/ propose une page par tag.
|
|
||||||
* La page correspondant à la catégorie est générée dans le répertoire category/
|
|
||||||
|
|
||||||
Si vous ouvrez le fichier index.html — ou un autre — avec votre navigateur, vous
|
|
||||||
remarquerez que :
|
|
||||||
|
|
||||||
* Le thème utilisé par défaut est notmyidea
|
|
||||||
* Le nom du blog est A Pelican Blog.
|
|
||||||
|
|
||||||
Bien évidemment, il y a des paramètres de base que l’on peut modifier pour mettre
|
|
||||||
un peu tout ça à sa sauce. C’est ce que nous allons voir au travers du fichier de configuration.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,165 +0,0 @@
|
||||||
Fichier de configuration
|
|
||||||
************************
|
|
||||||
|
|
||||||
On va créer un fichier de configuration que l’on va appeler **settings.py**. On peut
|
|
||||||
utiliser Pelican sans faire ce fichier, mais il faudrait à chaque fois passer les paramètres
|
|
||||||
en ligne de commande. Et comme il va nous servir à faire d’autres choses bien utile,
|
|
||||||
autant l’appréhender de suite. Cependant, nous n’allons voir que la base pour l’instant.
|
|
||||||
|
|
||||||
Paramètres de base
|
|
||||||
==================
|
|
||||||
|
|
||||||
AUTHOR :
|
|
||||||
Désigne l’auteur par défaut ;
|
|
||||||
|
|
||||||
DEFAULT_CATEGORY :
|
|
||||||
La catégorie par défaut des articles. Si ce paramètre n’est
|
|
||||||
pas documenté, il prendra la valeur misc — pour miscellaneous (divers en français) ;
|
|
||||||
|
|
||||||
SITENAME :
|
|
||||||
Le nom de votre site ;
|
|
||||||
|
|
||||||
OUTPUT_PATH :
|
|
||||||
Le répertoire de sortie du blog.
|
|
||||||
|
|
||||||
Quand je dis qu’on va faire simple, on fait simple !
|
|
||||||
Passons donc à ce quoi doit ressembler le fichier de configuration ::
|
|
||||||
|
|
||||||
# -*- coding: utf-8 -*-
|
|
||||||
AUTHOR = "Guillaume"
|
|
||||||
DEFAULT_CATEGORY = "GNU-Linux"
|
|
||||||
SITENAME = "Free Culture"
|
|
||||||
|
|
||||||
|
|
||||||
Si vous avez un serveur comme Apache de configuré pour votre machine, vous
|
|
||||||
pouvez paramétrer le répertoire de sortie vers **/var/www/blog** par exemple ::
|
|
||||||
|
|
||||||
OUTPUT_PATH = "/var/www/blog"
|
|
||||||
|
|
||||||
Une remarque importante. Si vous avez besoin de passer un caractère accentué, il
|
|
||||||
faut le préciser que la chaine est en unicode en faisant par exemple
|
|
||||||
*AUTHOR = u"Guillaume LAMÉ"*
|
|
||||||
|
|
||||||
Pour bien vérifier que les paramètres sont bien pris en compte, nous allons enlever les lignes *:author: Guillaume* et *:category: GNU-Linux* de notre fichier
|
|
||||||
**premier_article.rst** et regénérer le blog.
|
|
||||||
|
|
||||||
Rafraichissez votre page, ce devrait être bon.
|
|
||||||
|
|
||||||
Nous allons maintenant passer en revue les différents paramètres de Pelican. Je les
|
|
||||||
ai regroupé par thème. Cependant, c’est surtout un listing avant de rentrer dans les
|
|
||||||
détails au prochain chapitre.
|
|
||||||
|
|
||||||
Flux de syndication
|
|
||||||
===================
|
|
||||||
|
|
||||||
CATEGORY_FEED_ATOM :
|
|
||||||
Chemin d’écriture des flux Atom liés aux catégories ;
|
|
||||||
|
|
||||||
CATEGORY_FEED_RSS :
|
|
||||||
Idem pour les flux rss (Optionnel);
|
|
||||||
|
|
||||||
FEED_ATOM :
|
|
||||||
Chemin du flux Atom global;
|
|
||||||
|
|
||||||
FEED_RSS :
|
|
||||||
Chemin du flux Rss global (Optionnel);
|
|
||||||
|
|
||||||
FEED_ALL_ATOM :
|
|
||||||
Chemin du flux Atom global qui inclut la totalité des posts, indépendamment de la langue;
|
|
||||||
|
|
||||||
FEED_ALL_RSS :
|
|
||||||
Chemin du flux Rss global qui inclut la totalité des posts, indépendamment de la langue (Optionnel);
|
|
||||||
|
|
||||||
TAG_FEED_ATOM :
|
|
||||||
Chemin des flux Atom pour les tags (Optionnel);
|
|
||||||
|
|
||||||
TAG_FEED_RSS :
|
|
||||||
Chemin des flux Rss pour les tags (Optionnel).
|
|
||||||
|
|
||||||
|
|
||||||
Traductions
|
|
||||||
===========
|
|
||||||
|
|
||||||
DEFAULT_LANG :
|
|
||||||
Le langage par défaut à utiliser. «*en*» par défaut ;
|
|
||||||
|
|
||||||
TRANSLATION_FEED_ATOM :
|
|
||||||
Chemin du flux Atom pour les traductions.
|
|
||||||
|
|
||||||
TRANSLATION_FEED_RSS :
|
|
||||||
Chemin du flux RSS pour les traductions.
|
|
||||||
|
|
||||||
|
|
||||||
Thèmes
|
|
||||||
======
|
|
||||||
|
|
||||||
CSS_FILE :
|
|
||||||
Fichier css à utiliser si celui-ci est différent du fichier par défaut (*main.css*) ;
|
|
||||||
|
|
||||||
DISPLAY_PAGES_ON_MENU :
|
|
||||||
Affiche ou non les pages statiques sur le menu du thème ;
|
|
||||||
|
|
||||||
DISQUS_SITENAME :
|
|
||||||
Indiquer le nom du site spécifié sur Disqus ;
|
|
||||||
|
|
||||||
GITHUB_URL :
|
|
||||||
Indiquez votre url Github ;
|
|
||||||
|
|
||||||
GOOGLE_ANALYTICS :
|
|
||||||
'UA-XXXX-YYYY' pour activer Google analytics ;
|
|
||||||
|
|
||||||
GOSQUARED_SITENAME :
|
|
||||||
'XXX-YYYYYY-X' pour activer GoSquared ;
|
|
||||||
|
|
||||||
JINJA_EXTENSIONS :
|
|
||||||
Liste d'extension Jinja2 que vous souhaitez utiliser ;
|
|
||||||
|
|
||||||
LINKS :
|
|
||||||
Une liste de tuples (Titre, url) pour afficher la liste de lien ;
|
|
||||||
|
|
||||||
PDF_PROCESSOR :
|
|
||||||
Génère ou non les articles et pages au format pdf ;
|
|
||||||
|
|
||||||
NEWEST_FIRST_ARCHIVES :
|
|
||||||
Met les articles plus récent en tête de l'archive ;
|
|
||||||
|
|
||||||
SOCIAL :
|
|
||||||
Une liste de tuples (Titre, url) pour afficher la liste de lien dans la section "Social" ;
|
|
||||||
|
|
||||||
STATIC_THEME_PATHS :
|
|
||||||
Répertoire du thème que vous souhaitez importer dans l'arborescence finale ;
|
|
||||||
|
|
||||||
THEME :
|
|
||||||
Thème à utiliser:
|
|
||||||
|
|
||||||
TWITTER_USERNAME :
|
|
||||||
Permet d'afficher un bouton permettant le tweet des articles.
|
|
||||||
|
|
||||||
Pelican est fournit avec :doc:`pelican-themes`, un script permettant de gérer les thèmes
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Paramètres divers
|
|
||||||
=================
|
|
||||||
|
|
||||||
DEFAULT_DATE:
|
|
||||||
Date par défaut à utiliser si l'information de date n'est pas spécifiée
|
|
||||||
dans les metadonnées de l'article.
|
|
||||||
Si 'fs', Pelican se basera sur le *mtime* du fichier.
|
|
||||||
Si c'est un tuple, il sera passé au constructeur datetime.datetime pour
|
|
||||||
générer l'objet datetime utilisé par défaut.
|
|
||||||
|
|
||||||
KEEP_OUTPUT DIRECTORY :
|
|
||||||
Ne génère que les fichiers modifiés et n'efface pas le repertoire de sortie ;
|
|
||||||
|
|
||||||
MARKUP :
|
|
||||||
Langage de balisage à utiliser ;
|
|
||||||
|
|
||||||
PATH :
|
|
||||||
Répertoire à suivre pour les fichiers inclus ;
|
|
||||||
|
|
||||||
SITEURL :
|
|
||||||
URL de base de votre site ;
|
|
||||||
|
|
||||||
STATIC_PATHS :
|
|
||||||
Les chemins statiques que vous voulez avoir accès sur le chemin de sortie "statique" ;
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
Conventions
|
|
||||||
###########
|
|
||||||
|
|
||||||
Environnement de test
|
|
||||||
=====================
|
|
||||||
|
|
||||||
Les exemples sont basées sur une distribution Debian. Pour les autres distributions,
|
|
||||||
il y aura des ajustements à faire, notamment pour l’installation de Pelican. Les
|
|
||||||
noms des paquets peuvent changer.
|
|
||||||
|
|
||||||
Conventions typographiques
|
|
||||||
==========================
|
|
||||||
|
|
||||||
Un petit rappel concernant les codes sources.
|
|
||||||
|
|
||||||
* $ correspond à une ligne à exécuter en tant qu’utilisateur courant du systême ;
|
|
||||||
* # correspond à une ligne à exécuter en tant que root ;
|
|
||||||
* **settings.py** : Les noms des répertoires et fichiers sont en gras.
|
|
||||||
|
|
@ -1,40 +0,0 @@
|
||||||
Foire aux questions (FAQ)
|
|
||||||
#########################
|
|
||||||
|
|
||||||
Voici un résumé des questions fréquemment posées pour pelican.
|
|
||||||
|
|
||||||
Est-il obligatoire d'avoir un fichier de configuration ?
|
|
||||||
========================================================
|
|
||||||
|
|
||||||
Non. Les fichiers de configuration sont juste un moyen facile de configurer
|
|
||||||
pelican. Pour les opérations de base, il est possible de spécifier des
|
|
||||||
options
|
|
||||||
en invoquant pelican avec la ligne de commande (voir pelican --help pour
|
|
||||||
plus
|
|
||||||
d'informations à ce sujet)
|
|
||||||
|
|
||||||
Je crée mon propre thème, comment utiliser pygments?
|
|
||||||
====================================================
|
|
||||||
|
|
||||||
Pygment ajoute quelques classes au contenu généré, de sorte qua colorisation
|
|
||||||
de votre thème se fait grâce à un fichier css. Vous pouvez jeter un oeil à
|
|
||||||
celui proposé par`sur le site du projet <http://pygments.org/demo/15101/>`_
|
|
||||||
|
|
||||||
Comment puis-je créer mon propre thèm
|
|
||||||
=====================================
|
|
||||||
|
|
||||||
Vueillez vous référer à :ref:`theming-pelican-fr`.
|
|
||||||
|
|
||||||
Comment puis-je aider?
|
|
||||||
======================
|
|
||||||
|
|
||||||
Vous avez plusieurs options pour aider. Tout d'abord, vous pouvez utiliser
|
|
||||||
le
|
|
||||||
pélican, et signaler toute idée ou problème que vous avez sur le bugtracker
|
|
||||||
.
|
|
||||||
|
|
||||||
Si vous voulez contribuer, jeter un oeil au dépôt git , ajoutez vos
|
|
||||||
modifications et faites une demande, je les regarderai dès que possible
|
|
||||||
|
|
||||||
Vous pouvez aussi contribuer en créant des thèmes, et/ou compléter la
|
|
||||||
documentation.
|
|
||||||
|
|
@ -1,57 +0,0 @@
|
||||||
Pelican
|
|
||||||
#######
|
|
||||||
|
|
||||||
Pelican est un generateur de blog simple codé en python
|
|
||||||
|
|
||||||
* Écrivez vos articles directement dans votre éditeur favori (vim !) et
|
|
||||||
directement en syntaxe reStructuredText ou Markdown ;
|
|
||||||
* Un outil simple en ligne de conmmande pour (re)générer le blog ;
|
|
||||||
* Sortie complètement statique, facile pour l'héberger n'importe où ;
|
|
||||||
|
|
||||||
Fonctionnalités
|
|
||||||
===============
|
|
||||||
|
|
||||||
Pelican supporte actuellement :
|
|
||||||
|
|
||||||
* des articles de blog ;
|
|
||||||
* des pages statiques ;
|
|
||||||
* les commentaires via un service externe (`disqus <http://disqus.com>`_)
|
|
||||||
Notez qu'étant bien un service externe assez pratique, vous ne gérez pas
|
|
||||||
vous même les commentaires. Ce qui pourrait occasionner une perte de vos données;
|
|
||||||
* support de template (les templates sont crées avec `jinja2 <http://jinjna.pocoo.org>`_) ;
|
|
||||||
* génération optionnelle de vos pages et articles en pdf.
|
|
||||||
|
|
||||||
Pourquoi le nom "Pelican" ?
|
|
||||||
============================
|
|
||||||
|
|
||||||
Vous n'avez pas remarqué ? "Pelican" est un anagramme pour "Calepin" ;)
|
|
||||||
|
|
||||||
Code source
|
|
||||||
===========
|
|
||||||
|
|
||||||
Vous pouvez accéder au code source via git à l'adresse
|
|
||||||
http://github.com/getpelican/pelican/
|
|
||||||
|
|
||||||
Feedback !
|
|
||||||
==========
|
|
||||||
|
|
||||||
Si vous voulez de nouvelles fonctionnalitées pour Pelican, n'hésitez pas à nous le dire,
|
|
||||||
à cloner le dépôt, etc … C'est open source !!!
|
|
||||||
|
|
||||||
Contactez Alexis à "alexis at notmyidea dot org" pour quelques requêtes ou retour d'expérience que ce soi !
|
|
||||||
|
|
||||||
Documentation
|
|
||||||
=============
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
conventions
|
|
||||||
installation
|
|
||||||
bases
|
|
||||||
configuration
|
|
||||||
themes
|
|
||||||
parametres_article
|
|
||||||
astuces
|
|
||||||
faq
|
|
||||||
pelican-themes
|
|
||||||
|
|
@ -1,67 +0,0 @@
|
||||||
Installation et mise à jour de Pelican
|
|
||||||
######################################
|
|
||||||
|
|
||||||
Installation
|
|
||||||
============
|
|
||||||
|
|
||||||
Il y a deux façons d’installer Pelican sur son système. La première est via l’utilitaire
|
|
||||||
pip, l’autre façon est de télécharger Pelican via Github. Ici nous allons voir les deux
|
|
||||||
façons de procéder.
|
|
||||||
|
|
||||||
Via pip
|
|
||||||
-------
|
|
||||||
|
|
||||||
Pour installer Pelican via pip, vous aurez besoin du paquet python-pip. puis installez Pelican ::
|
|
||||||
|
|
||||||
# apt-get install python-pip
|
|
||||||
# pip install pelican
|
|
||||||
|
|
||||||
|
|
||||||
Via Github
|
|
||||||
----------
|
|
||||||
|
|
||||||
Pour installer Pelican en reprenant le code via Github, nous aurons besoin du paquet
|
|
||||||
git-core pour récupérez les sources de Pelican. Puis nous procédons à l’installation ::
|
|
||||||
|
|
||||||
# apt-get install git-core
|
|
||||||
$ git clone https://github.com/getpelican/pelican.git
|
|
||||||
$ cd pelican
|
|
||||||
# python setup.py install
|
|
||||||
|
|
||||||
Mises à jour
|
|
||||||
============
|
|
||||||
|
|
||||||
Via pip
|
|
||||||
-------
|
|
||||||
|
|
||||||
Rien de bien compliqué pour mettre à jour via pip ::
|
|
||||||
|
|
||||||
$ cd votreRepertoireSource
|
|
||||||
$ pip install --upgrade pelican
|
|
||||||
|
|
||||||
|
|
||||||
Via Github
|
|
||||||
----------
|
|
||||||
|
|
||||||
C'est un peu plus long avec Github par contre ::
|
|
||||||
|
|
||||||
$ cd votreRepertoireSource
|
|
||||||
$ git pull origin master
|
|
||||||
$ cd pelican
|
|
||||||
# python setup.py install
|
|
||||||
|
|
||||||
Vous aurez un message d’erreur si le module setuptools de python n’est pas installé.
|
|
||||||
La manipulation est la suivante ::
|
|
||||||
|
|
||||||
# apt-get install python-setuptools
|
|
||||||
|
|
||||||
Alors, quelle méthode choisir ?
|
|
||||||
===============================
|
|
||||||
|
|
||||||
Vous avez le choix entre deux méthodes, mais aussi entre deux concepts. La méthode
|
|
||||||
de Github est la version de développement, où les modifications arrivent assez
|
|
||||||
fréquemment sans être testées à fond. La version de pip est une version arrêtée avec un
|
|
||||||
numéro de version dans laquelle vous aurez moins de bug. N’oubliez cependant pas
|
|
||||||
que le projet est très jeune et manque donc de maturité. Si vous aimez avoir les toutes
|
|
||||||
dernières versions utilisez Github, sinon penchez vous sur pip.
|
|
||||||
|
|
||||||
|
|
@ -1,106 +0,0 @@
|
||||||
Les paramètres des articles dans Pelican
|
|
||||||
########################################
|
|
||||||
|
|
||||||
Les catégories
|
|
||||||
==============
|
|
||||||
|
|
||||||
Nous avons vu que pour affecter un article à une catégorie, nous avions le paramètre *:category:*.
|
|
||||||
Il y a cependant plus simple, affecter un répertoire à une catégorie.
|
|
||||||
|
|
||||||
Dans le répertoire ou vous avez vos articles, créez le repertoire **GNU-Linux** et déplacez y le fichier
|
|
||||||
**premier_article.rst**. Bien évidemment nous ne verront pas la différence, car jusqu'ici *GNU-Linux*
|
|
||||||
est notre catégorie par défaut.
|
|
||||||
|
|
||||||
Nous allons faire un autre exemple d'article avec la catégorie Pelican. Créez le répertoire **Pelican**
|
|
||||||
et collez cette exemple d'article ::
|
|
||||||
|
|
||||||
Préparation de la documentation
|
|
||||||
###############################
|
|
||||||
|
|
||||||
:date: 2011-01-27 15:28
|
|
||||||
:tags: documentation
|
|
||||||
|
|
||||||
Il y a quand même pas mal de boulot pour faire une documentation !
|
|
||||||
|
|
||||||
Et lancez la compilation du blog. Vous voyez que la catégorie est affectée automatiquement.
|
|
||||||
|
|
||||||
Les tags
|
|
||||||
========
|
|
||||||
|
|
||||||
Pour les tags, il n'y a rien de compliqué. il suffit de mettre le(s) tags séparés si besoin d'une virgule. ::
|
|
||||||
|
|
||||||
Préparation de la documentation
|
|
||||||
###############################
|
|
||||||
|
|
||||||
:date: 2011-01-27 15:28
|
|
||||||
:tags: documentation, pelican
|
|
||||||
|
|
||||||
Par contre, par soucis de clarté au niveau des url je vous conseille de mettre les expression de plusieurs
|
|
||||||
mots séparées par des tirets ::
|
|
||||||
|
|
||||||
:tags: mise-a-jour
|
|
||||||
|
|
||||||
et non ::
|
|
||||||
|
|
||||||
:tags: mise a jour
|
|
||||||
|
|
||||||
|
|
||||||
Les auteurs
|
|
||||||
===========
|
|
||||||
|
|
||||||
Par défaut, vous pouvez indiqué votre nom en tant qu'auteur dans le fichier de configuration.
|
|
||||||
S'il y a plusieurs auteurs pour le site, vous pouvez le définir manuellement dans
|
|
||||||
l'article avec la méta-donnée ::
|
|
||||||
|
|
||||||
:author: Guillaume
|
|
||||||
|
|
||||||
La date
|
|
||||||
=======
|
|
||||||
|
|
||||||
La date se met au format anglophone : **YYYY-MM-DD hh:mm** ::
|
|
||||||
|
|
||||||
:date: 2011-01-31 14:12
|
|
||||||
|
|
||||||
|
|
||||||
Les traductions
|
|
||||||
===============
|
|
||||||
|
|
||||||
Pelican permet de générer un blog multilingue assez facilement. Pour cela nous devons :
|
|
||||||
|
|
||||||
* Définir la langue de base du blog ;
|
|
||||||
* Donner une référence à l'article initial ;
|
|
||||||
* Définir la langue du fichier traduit et y reporter la référence.
|
|
||||||
|
|
||||||
Pour définir la langue de base nous allons modifier le fichier **settings.py** et y rajouter la ligne suivante ::
|
|
||||||
|
|
||||||
DEFAULT_LANG = "fr"
|
|
||||||
|
|
||||||
Puis ajouter la référence dans notre article d'origine qui deviendra ::
|
|
||||||
|
|
||||||
Préparation de la documentation
|
|
||||||
###############################
|
|
||||||
|
|
||||||
:date: 2011-01-27 15:28
|
|
||||||
:tags: documentation
|
|
||||||
:slug: preparation-de-la-documentation
|
|
||||||
|
|
||||||
Il y a quand même pas mal de boulot pour faire une documentation !
|
|
||||||
|
|
||||||
Nous n'avons plus qu'à créer l'article en anglais ::
|
|
||||||
|
|
||||||
Start of documentation
|
|
||||||
######################
|
|
||||||
|
|
||||||
:slug: preparation-de-la-documention
|
|
||||||
:lang: en
|
|
||||||
|
|
||||||
There are still a lot of work to documentation !
|
|
||||||
|
|
||||||
**Il est important de comprendre que la valeur de :slug: deviendra votre url. Ne mettez donc pas un diminutif pour
|
|
||||||
identifier l'article**
|
|
||||||
|
|
||||||
Rien de plus à savoir pour traduire efficacement des articles.
|
|
||||||
|
|
||||||
|
|
||||||
Maintenant que vous avez toutes les clés en main pour créer un article, nous allons passer à la personnalisation
|
|
||||||
du fichier de configuration.
|
|
||||||
|
|
@ -1,172 +0,0 @@
|
||||||
pelican-themes
|
|
||||||
##############
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Description
|
|
||||||
===========
|
|
||||||
|
|
||||||
``pelican-themes`` est un outil en lignes de commandes pour gérer les thèmes de Pelican.
|
|
||||||
|
|
||||||
|
|
||||||
Utilisation:
|
|
||||||
""""""""""""
|
|
||||||
|
|
||||||
| pelican-themes [-h] [-l] [-i *chemin d'un thème* [*chemin d'un thème* ...]]
|
|
||||||
| [-r *nom d'un thème* [*nom d'un thème* ...]]
|
|
||||||
| [-s *chemin d'un thème* [*chemin d'un thème* ...]] [-v] [--version]
|
|
||||||
|
|
||||||
Arguments:
|
|
||||||
""""""""""
|
|
||||||
|
|
||||||
|
|
||||||
-h, --help Afficher l'aide et quitter
|
|
||||||
|
|
||||||
-l, --list Montrer les thèmes installés
|
|
||||||
|
|
||||||
-i chemin, --install chemin Chemin(s) d'accès d'un ou plusieurs thème à installer
|
|
||||||
|
|
||||||
-r nom, --remove nom Noms d'un ou plusieurs thèmes à installer
|
|
||||||
|
|
||||||
-s chemin, --symlink chemin Fonctionne de la même façon que l'option ``--install``, mais crée un lien symbolique au lieu d'effectuer une copie du thème vers le répertoire des thèmes.
|
|
||||||
Utile pour le développement de thèmes.
|
|
||||||
|
|
||||||
-v, --verbose Sortie détaillée
|
|
||||||
|
|
||||||
--version Affiche la version du script et quitte
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Exemples
|
|
||||||
========
|
|
||||||
|
|
||||||
|
|
||||||
Lister les thèmes installés
|
|
||||||
"""""""""""""""""""""""""""
|
|
||||||
|
|
||||||
``pelican-themes`` peut afficher les thèmes disponibles.
|
|
||||||
|
|
||||||
Pour cela, vous pouvez utiliser l'option ``-l`` ou ``--list``, comme ceci:
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ pelican-themes -l
|
|
||||||
notmyidea
|
|
||||||
two-column@
|
|
||||||
simple
|
|
||||||
$ pelican-themes --list
|
|
||||||
notmyidea
|
|
||||||
two-column@
|
|
||||||
simple
|
|
||||||
|
|
||||||
Dans cet exemple, nous voyons qu'il y a trois thèmes d'installés: ``notmyidea``, ``simple`` and ``two-column``.
|
|
||||||
|
|
||||||
``two-column`` est suivi d'un ``@`` par ce que c'est un lien symbolique (voir `Créer des liens symboliques`_).
|
|
||||||
|
|
||||||
Notez que vous pouvez combiner l'option ``--list`` avec l'option ``--verbose``, pour afficher plus de détails:
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ pelican-themes -v -l
|
|
||||||
/usr/local/lib/python2.6/dist-packages/pelican-2.6.0-py2.6.egg/pelican/themes/notmyidea
|
|
||||||
/usr/local/lib/python2.6/dist-packages/pelican-2.6.0-py2.6.egg/pelican/themes/two-column (symbolic link to `/home/skami/Dev/Python/pelican-themes/two-column')
|
|
||||||
/usr/local/lib/python2.6/dist-packages/pelican-2.6.0-py2.6.egg/pelican/themes/simple
|
|
||||||
|
|
||||||
|
|
||||||
Installer des thèmes
|
|
||||||
""""""""""""""""""""
|
|
||||||
|
|
||||||
Vous pouvez installer un ou plusieurs thèmes en utilisant l'option ``-i`` ou ``--install``.
|
|
||||||
|
|
||||||
Cette option prends en argument le(s) chemin(s) d'accès du ou des thème(s) que vous voulez installer, et peut se combiner avec l'option ``--verbose``:
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
# pelican-themes --install ~/Dev/Python/pelican-themes/notmyidea-cms --verbose
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
# pelican-themes --install ~/Dev/Python/pelican-themes/notmyidea-cms\
|
|
||||||
~/Dev/Python/pelican-themes/martyalchin \
|
|
||||||
--verbose
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
# pelican-themes -vi ~/Dev/Python/pelican-themes/two-column
|
|
||||||
|
|
||||||
|
|
||||||
Supprimer des thèmes
|
|
||||||
""""""""""""""""""""
|
|
||||||
|
|
||||||
``pelican-themes`` peut aussi supprimer des thèmes précédemment installés grâce à l'option ``-r`` ou ``--remove``.
|
|
||||||
|
|
||||||
Cette option prends en argument le ou les nom(s) des thèmes que vous voulez installer, et peux se combiner avec l'option ``--verbose``:
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
# pelican-themes --remove two-column
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
# pelican-themes -r martyachin notmyidea-cmd -v
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Créer des liens symboliques
|
|
||||||
"""""""""""""""""""""""""""
|
|
||||||
|
|
||||||
|
|
||||||
L'option ``-s`` ou ``--symlink`` de ``pelican-themes`` permet de lier symboliquement un thème.
|
|
||||||
|
|
||||||
Cette option s'utilise exactement comme l'option ``--install``:
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
# pelican-themes --symlink ~/Dev/Python/pelican-themes/two-column
|
|
||||||
|
|
||||||
Dans l'exemple ci dessus, un lien symbolique pointant vers le thème ``two-column`` a été installé dans le répertoire des thèmes de Pelican, toute modification sur le thème ``two-column`` prendra donc effet immédiatement.
|
|
||||||
|
|
||||||
Cela peut être pratique pour le développement de thèmes
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ sudo pelican-themes -s ~/Dev/Python/pelican-themes/two-column
|
|
||||||
$ pelican ~/Blog/content -o /tmp/out -t two-column
|
|
||||||
$ firefox /tmp/out/index.html
|
|
||||||
$ vim ~/Dev/Pelican/pelican-themes/two-coumn/static/css/main.css
|
|
||||||
$ pelican ~/Blog/content -o /tmp/out -t two-column
|
|
||||||
$ cp /tmp/bg.png ~/Dev/Pelican/pelican-themes/two-coumn/static/img/bg.png
|
|
||||||
$ pelican ~/Blog/content -o /tmp/out -t two-column
|
|
||||||
$ vim ~/Dev/Pelican/pelican-themes/two-coumn/templates/index.html
|
|
||||||
$ pelican ~/Blog/content -o /tmp/out -t two-column
|
|
||||||
|
|
||||||
|
|
||||||
Notez que cette fonctionnalité nécessite d'avoir un système d'exploitation et un système de fichiers supportant les liens symboliques, elle n'est donc pas disponible sous Micro$oft®©™ Fenêtre®©™.
|
|
||||||
|
|
||||||
Faire plusieurs choses à la fois
|
|
||||||
""""""""""""""""""""""""""""""""
|
|
||||||
|
|
||||||
|
|
||||||
Les options ``--install``, ``--remove`` et ``--symlink`` peuvent être employées en même temps, ce qui permets de réaliser plusieurs opérations en même temps:
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
# pelican-themes --remove notmyidea-cms two-column \
|
|
||||||
--install ~/Dev/Python/pelican-themes/notmyidea-cms-fr \
|
|
||||||
--symlink ~/Dev/Python/pelican-themes/two-column \
|
|
||||||
--verbose
|
|
||||||
|
|
||||||
Dans cette exemple, le thème ``notmyidea-cms`` sera remplacé par le thème ``notmyidea-cms-fr`` et le thème ``two-column`` sera lié symboliquement...
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
À voir également
|
|
||||||
================
|
|
||||||
|
|
||||||
- http://docs.notmyidea.org/alexis/pelican/
|
|
||||||
- ``/usr/share/doc/pelican/`` si vous avez installé Pelican par le `dépôt APT <http://skami18.github.com/pelican-packages/>`_
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,171 +0,0 @@
|
||||||
.. _theming-pelican:
|
|
||||||
|
|
||||||
Cette page est une traduction de la documentation originale, en anglais et
|
|
||||||
disponible `ici <../themes.html>`_.
|
|
||||||
|
|
||||||
Comment créer des thèmes pour Pelican
|
|
||||||
#####################################
|
|
||||||
|
|
||||||
Pelican utlise le très bon moteur de template `jinja2 <http://jinja.pocoo.org>`_
|
|
||||||
pour produire de l'HTML. La syntaxe de jinja2 est vraiment très simple. Si vous
|
|
||||||
voulez créer votre propre thème, soyez libre de prendre inspiration sur le theme
|
|
||||||
"simple" qui est disponible `ici
|
|
||||||
<https://github.com/getpelican/pelican/tree/master/pelican/themes/simple/templates>`_
|
|
||||||
|
|
||||||
Structure
|
|
||||||
=========
|
|
||||||
|
|
||||||
Pour réaliser votre propre thème vous devez respecter la structure suivante ::
|
|
||||||
|
|
||||||
├── static
|
|
||||||
│ ├── css
|
|
||||||
│ └── images
|
|
||||||
└── templates
|
|
||||||
├── archives.html // pour afficher les archives
|
|
||||||
├── article.html // généré pour chaque article
|
|
||||||
├── categories.html // doit lister toutes les catégories
|
|
||||||
├── category.html // généré pour chaque catégorie
|
|
||||||
├── index.html // la page d'index, affiche tous les articles
|
|
||||||
├── page.html // généré pour chaque page
|
|
||||||
├── tag.html // généré pour chaque tag
|
|
||||||
└── tags.html // doit lister tous les tags. Peut être un nuage de tag.
|
|
||||||
|
|
||||||
|
|
||||||
* `static` contient tout le contenu statique. Il sera copié dans le dossier
|
|
||||||
`theme/static`. J'ai mis un dossier css et un image, mais ce sont juste des
|
|
||||||
exemples. Mettez ce dont vous avez besoin ici.
|
|
||||||
|
|
||||||
* `templates` contient tous les templates qui vont être utiliser pour générer les
|
|
||||||
pages. J'ai juste mis les templates obligatoires ici, vous pouvez définir les
|
|
||||||
vôtres si cela vous aide à vous organiser pendant que vous réaliser le thème.
|
|
||||||
Vous pouvez par exemple utiliser les directives {% include %} et {% extends %}
|
|
||||||
de jinja2.
|
|
||||||
|
|
||||||
Templates et variables
|
|
||||||
======================
|
|
||||||
|
|
||||||
Cela utilise une syntaxe simple, que vous pouvez insérer dans vos pages HTML.
|
|
||||||
Ce document décrit les templates qui doivent exister dans un thème, et quelles
|
|
||||||
variables seront passées à chaque template, au moment de le générer.
|
|
||||||
|
|
||||||
Tous les templates recevront les variables définies dans votre fichier de
|
|
||||||
configuration, si elles sont en capitales. Vous pouvez y accéder directement.
|
|
||||||
|
|
||||||
Variables communes
|
|
||||||
------------------
|
|
||||||
|
|
||||||
Toutes ces variables seront passées à chaque template.
|
|
||||||
|
|
||||||
============= ===================================================
|
|
||||||
Variable Description
|
|
||||||
============= ===================================================
|
|
||||||
articles C'est la liste des articles, ordonnée décroissante
|
|
||||||
par date. Tous les éléments de la liste sont des
|
|
||||||
objets `Article`, vous pouvez donc accéder à leurs
|
|
||||||
propriétés (exemple : title, summary, author, etc).
|
|
||||||
dates La même liste d'articles, ordonnée croissante par
|
|
||||||
date.
|
|
||||||
tags Un dictionnaire contenant tous les tags (clés), et
|
|
||||||
la liste des articles correspondants à chacun
|
|
||||||
d'entre eux (valeur).
|
|
||||||
categories Un dictionnaire contenant toutes les catégories
|
|
||||||
(clés), et la liste des articles correspondants à
|
|
||||||
chacune d'entre elles (valeur).
|
|
||||||
pages La liste des pages.
|
|
||||||
============= ===================================================
|
|
||||||
|
|
||||||
index.html
|
|
||||||
----------
|
|
||||||
|
|
||||||
La page d'accueil de votre blog, sera générée dans output/index.html.
|
|
||||||
|
|
||||||
Si la pagination est activée, les pages suivantes seront à l'adresse
|
|
||||||
output/index`n`.html.
|
|
||||||
|
|
||||||
=================== ===================================================
|
|
||||||
Variable Description
|
|
||||||
=================== ===================================================
|
|
||||||
articles_paginator Un objet paginator de la liste d'articles.
|
|
||||||
articles_page La page actuelle d'articles.
|
|
||||||
dates_paginator Un objet paginator de la liste d'articles, ordonné
|
|
||||||
par date croissante.
|
|
||||||
dates_pages La page actuelle d'articles, ordonnée par date
|
|
||||||
croissante.
|
|
||||||
page_name 'index'.
|
|
||||||
=================== ===================================================
|
|
||||||
|
|
||||||
category.html
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Ce template sera généré pour chaque catégorie existante, et se retrouvera
|
|
||||||
finalement à output/category/`nom de la catégorie`.html.
|
|
||||||
|
|
||||||
Si la pagination est activée, les pages suivantes seront disponibles à
|
|
||||||
l'adresse output/category/`nom de la catégorie``n`.html.
|
|
||||||
|
|
||||||
=================== ===================================================
|
|
||||||
Variable Description
|
|
||||||
=================== ===================================================
|
|
||||||
category La catégorie qui est en train d'être générée.
|
|
||||||
articles Les articles dans cette catégorie.
|
|
||||||
dates Les articles dans cette catégorie, ordonnés par
|
|
||||||
date croissante.
|
|
||||||
articles_paginator Un objet paginator de la liste d'articles.
|
|
||||||
articles_page La page actuelle d'articles.
|
|
||||||
dates_paginator Un objet paginator de la liste d'articles, ordonné
|
|
||||||
par date croissante.
|
|
||||||
dates_pages La page actuelle d'articles, ordonnée par date
|
|
||||||
croissante.
|
|
||||||
page_name 'category/`nom de la catégorie`'.
|
|
||||||
=================== ===================================================
|
|
||||||
|
|
||||||
article.html
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Ce template sera généré pour chaque article. Les fichiers .html seront
|
|
||||||
disponibles à output/`nom de l'article`.html.
|
|
||||||
|
|
||||||
============= ===================================================
|
|
||||||
Variable Description
|
|
||||||
============= ===================================================
|
|
||||||
article L'objet article à afficher.
|
|
||||||
category Le nom de la catégorie de l'article actuel.
|
|
||||||
============= ===================================================
|
|
||||||
|
|
||||||
page.html
|
|
||||||
---------
|
|
||||||
|
|
||||||
Pour chaque page ce template sera généré à l'adresse
|
|
||||||
output/`nom de la page`.html
|
|
||||||
|
|
||||||
============= ===================================================
|
|
||||||
Variable Description
|
|
||||||
============= ===================================================
|
|
||||||
page L'objet page à afficher. Vous pouvez accéder à son
|
|
||||||
titre (title), slug, et son contenu (content).
|
|
||||||
============= ===================================================
|
|
||||||
|
|
||||||
tag.html
|
|
||||||
--------
|
|
||||||
|
|
||||||
Ce template sera généré pour chaque tag. Cela créera des fichiers .html à
|
|
||||||
l'adresse output/tag/`nom du tag`.html.
|
|
||||||
|
|
||||||
Si la pagination est activée, les pages suivantes seront disponibles à
|
|
||||||
l'adresse output/tag/`nom du tag``n`.html
|
|
||||||
|
|
||||||
=================== ===================================================
|
|
||||||
Variable Description
|
|
||||||
=================== ===================================================
|
|
||||||
tag Nom du tag à afficher.
|
|
||||||
articles Une liste des articles contenant ce tag.
|
|
||||||
dates Une liste des articles contenant ce tag, ordonnée
|
|
||||||
par date croissante.
|
|
||||||
articles_paginator Un objet paginator de la liste d'articles.
|
|
||||||
articles_page La page actuelle d'articles.
|
|
||||||
dates_paginator Un objet paginator de la liste d'articles, ordonné
|
|
||||||
par date croissante.
|
|
||||||
dates_pages La page actuelle d'articles, ordonnée par date
|
|
||||||
croissante.
|
|
||||||
page_name 'tag/`nom du tag`'.
|
|
||||||
=================== ===================================================
|
|
||||||
|
|
@ -63,8 +63,6 @@ someone will almost always respond to your inquiry.
|
||||||
Documentation
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
A French version of the documentation is available at :doc:`fr/index`.
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue