Commit 380929d4 authored by Denis Salem's avatar Denis Salem
Browse files

WIP documentation: complete chapter 4.2

parent 4086307e
......@@ -10,46 +10,209 @@ __blog_configuration.yaml__ est un document Yaml à la racine du projet définis
Immédiatement après avoir créé votre blog, il s'agira sans doute du premier fichier que vous éditerez. Après avoir rempli ces champs dont l'usage est détaillé ci-dessous, vous n'aurez normalement plus besoin d'y retoucher.
- __.:DisableMarkup::blog_name:.__ : Sans surprise, il s'agit du titre de votre blog.
- __.:DisableMarkup::disable_threads:.__ : Empêche VenC de générer les fils de publications spécifiés dans une liste. Les noms de fils peuvent appartenir à des catégories ou à des archives. Ces noms sont listé en étant séparés par une virgule.
- __.:DisableMarkup::disable_archives:.__ : Empêche VenC de générer les fils publications des archives. Ce champ est un booléen, fixé à *False* par défaut.
- __.:DisableMarkup::disable_chapters:.__ : Empêche VenC de générer les chapitres. Ce champ est un booléen, fixé à *True* par défaut.
- __.:DisableMarkup::disable_categories:.__ : Empêche VenC de générer les fils publications des catégories. Ce champ est un booléen, fixé à *False* par défaut.
- __.:DisableMarkup::disable_single_entries:.__ : Empêche VenC de générer les pages des publications individuelles. Ce champ est un booléen, fixé à *False* par défaut.
- __.:DisableMarkup::disable_main_thread:.__ : Empêche VenC de générer le fil principal de publication. Ce champ est un booléen, fixé à *False* par défaut.
- __.:DisableMarkup::disable_rss_feed:.__ : Empêche VenC de générer un flux Atom. Ce champ est un booléen, fixé à *False* par défaut.
- __.:DisableMarkup::disable_atom_feed:.__ : Empêche VenC de générer un flux Atom. Ce champ est un booléen, fixé à *False* par défaut.
- __.:DisableMarkup::text_editor:.__ : L'éditeur de texte choisi pour éditer une nouvelle publication du blog.
- __.:DisableMarkup::date_format:.__ : "%A %d. %B %Y" par défaut. Définit le format de date utilisé à l'intérieur du blog. Le format des dates est en fait le même que celui utilisé par python. Pour en savoir plus sur ce format rendez vous [ici](http://strftime.org).
- __.:DisableMarkup::author_name:.__: Le nom de l'administrateur ou l'auteur du blog.
- __.:DisableMarkup::blog_description:.__ : Un très court résumé de ce dont parle votre site.
- __.:DisableMarkup::blog_keywords:.__ : Les mots clefs associés au site.
- __.:DisableMarkup::author_description:.__ : Un court texte à propos de l'auteur du blog.
- __license__ : La licence appliquée au contenu de votre site.
- __.:DisableMarkup::blog_url:.__ : L'url du blog. Peut être laissée vide, selon le thème utilisé.
- __.:DisableMarkup::ftp_host:.__ : Le nom d'hôte de votre serveur FTP.
- __.:DisableMarkup::blog_language:.__ : Définit la langue du site.
- __.:DisableMarkup::author_email:.__ : Votre adresse e-mail.
- __.:DisableMarkup::code_highlight_css_override:.__ :
- __path__ : Il s'agit d'une variable contenant différents chemins, vous ne devriez normalement pas avoir besoin d'y toucher. La liste de ces chemins est détaillé ci-dessous
- __ftp__ : Le chemin absolu du répertoire de destination sur votre serveur ftp.
- __.:DisableMarkup::entries_sub_folders:.__ :
- __.:DisableMarkup::categories_sub_folders:.__ :
- __.:DisableMarkup::archives_sub_folders:.__ :
- __.:DisableMarkup::index_file_name:.__ : "index{page_number}.html" par défaut. Le nom de fichier formaté des pages du fil principal de publications. Devrait toujours contenir la variable {page_number}.
- __.:DisableMarkup::category_directory_name:.__ : "{category}" par défaut. Définit le répertoire où sera exporté un fil de publication spécifique à une catégorie de publication. Ce champ devrait donc toujours contenir la variable {category}.
- __.:DisableMarkup::chapter_directory_name:.__ :
- __.:DisableMarkup::archives_directory_name:.__ : "%Y-%m" par défaut. Définit le format de date utilisé pour les noms de répertoires de fils de publications associés à des dates. Le format des dates est en fait le même que celui utilisé par python. Pour en savoir plus sur ce format rendez vous [ici](http://strftime.org).
- __.:DisableMarkup::entry_file_name:.__ : "entry{entry_id}.html" par défaut. Définit le nom de fichier d'une publication unique. Ce champ devrait toujours contenir la variable {entry_id}.
- __.:DisableMarkup::rss_file_name:.__ : "rss.xml" par défaut. Définit le nom de fichier du flux rss.
- __.:DisableMarkup::atom_file_name:.__ : "atom.xml" par défaut. Définit le nom de fichier du flux atom.
- __.:DisableMarkup::entries_per_pages:.__ : *10* par défaut. Définit le nombre de publications par page.
- __columns__ : 1 par défaut. Ce champ définit le nombre de colonnes dans une page.
- __.:DisableMarkup::feed_lenght:.__ : *5* par défaut. Définit le nombre de publications à afficher dans le flux RSS.
- __.:DisableMarkup::reverse_thread_order:.__ : Définit l'ordre de publication. Du plus récent au plus anciens, ou l'inverse. Ce champ est un booléen, fixé à *True* par défaut.
- __.:DisableMarkup::markup_language:.__ :
- __.:DisableMarkup::path_encoding:.__ :
- __.:DisableMarkup::server_port:.__ :
- __.:DisableMarkup::sort_by:.__ :
- __.:DisableMarkup::enable_jsonld:.__ :
- __.:DisableMarkup::enable_jsonp:.__ :
## .:DisableMarkup::blog_name:.
Sans surprise, il s'agit du titre de votre blog.
## .:DisableMarkup::disable_threads:.
Empêche VenC de générer les fils de publications spécifiés dans une liste. Les noms de fils peuvent appartenir à des catégories ou à des archives. Ces noms sont listé en étant séparés par une virgule.
## .:DisableMarkup::disable_archives:. ##
Empêche VenC de générer les fils de publications des archives. Ce champ est un booléen, fixé à *False* par défaut.
## .:DisableMarkup::disable_chapters:.
Empêche VenC de générer les chapitres. Ce champ est un booléen, fixé à *True* par défaut.
## .:DisableMarkup::disable_categories:.
Empêche VenC de générer les fils de publications des catégories. Ce champ est un booléen, fixé à *False* par défaut.
## .:DisableMarkup::disable_single_entries:.
Empêche VenC de générer les publications individuelles. Ce champ est un booléen, fixé à *False* par défaut.
## .:DisableMarkup::disable_main_thread:.
Empêche VenC de générer le fil principal de publication. Ce champ est un booléen, fixé à *False* par défaut.
## .:DisableMarkup::disable_rss_feed:.
Empêche VenC de générer un flux RSS. Ce champ est un booléen, fixé à *False* par défaut.
## .:DisableMarkup::disable_atom_feed:.
Empêche VenC de générer un flux Atom. Ce champ est un booléen, fixé à *False* par défaut.
## .:DisableMarkup::text_editor:.
L'éditeur de texte choisi pour éditer une nouvelle publication du blog.
## .:DisableMarkup::date_format:.
"%A %d. %B %Y" par défaut. Définit le format de date utilisé à l'intérieur du blog. Le format des dates est en fait le même que celui utilisé par python. Pour en savoir plus sur ce format rendez vous [ici](http://strftime.org).
## .:DisableMarkup::author_name:.
Le nom de l'administrateur ou l'auteur du blog.
## .:DisableMarkup::blog_description:.
Un très court résumé de ce dont parle votre site.
## .:DisableMarkup::blog_keywords:.
Les mots clefs associés au site, séparés par une virgule.
## .:DisableMarkup::author_description:.
Un court texte à propos de l'auteur du blog.
## license
La licence appliquée au contenu de votre site.
## .:DisableMarkup::blog_url:.
L'url du blog. Peut être laissée vide, selon le thème utilisé.
## .:DisableMarkup::ftp_host:.
Optionel. Il s'agit du nom d'hôte de votre serveur FTP s'il existe.
## .:DisableMarkup::blog_language:.
Définit la langue du site.
## .:DisableMarkup::author_email:.
Votre adresse e-mail.
## .:DisableMarkup::code_highlight_css_override:.
Régénère le code CSS crée par le module pygmentize. Ce champ est un booléen,
fixé à *False* par défaut. Attention, si ce champ est fixé à *True*, à chaque exportation
de votre blog les anciens codes CSS crée par pygmentize seront écrasés.
## path
Il s'agit d'une variable contenant différents chemins,
vous ne devriez normalement pas avoir besoin d'y toucher.
La liste de ces chemins est détaillé ci-dessous
.:DisableMarkup::<div style="padding-left: 2em;">:.
### ftp
Le chemin absolu du répertoire de destination sur votre serveur ftp.
### .:DisableMarkup::entries_sub_folders:.
Le nom de sous répertoire qui contiendras les publications individuelle.
### .:DisableMarkup::categories_sub_folders:.
Le nom de sous répertoire qui contiendras les categories
### .:DisableMarkup::index_file_name:.
"index{page_number}.html" par défaut. Spécifie le nom de fichier des pages d'un fil de publication. Devrait toujours contenir la variable {page_number}.
### .:DisableMarkup::category_directory_name:.
"{category}" par défaut. Définit le répertoire où sera exporté le fil de publication de la categorie courante. Ce champ devrait donc toujours contenir la variable {category}.
### .:DisableMarkup::chapter_directory_name:.
"{chapter_name} par défaut. Définit les noms de répertoire où serons
exportés les chapitres, s'il en existe. Ce champ devrait donc toujours
contenir la variable {chapter_name}.
### .:DisableMarkup::archives_directory_name:.
"%Y-%m" par défaut. Définit le format de date utilisé pour les noms de
répertoires des archives. Le format des dates est en fait le même que
celui utilisé par python. Pour en savoir plus sur ce format rendez vous
[ici](http://strftime.org).
### .:DisableMarkup::entry_file_name:.
"entry{.:DisableMarkup::entry_id:.}.html" par défaut. Définit le nom de fichier d'une publication unique.
### .:DisableMarkup::rss_file_name:.
"rss.xml" par défaut. Définit le nom de fichier du flux rss.
### .:DisableMarkup::atom_file_name:.
"atom.xml" par défaut. Définit le nom de fichier du flux atom.
.:DisableMarkup::</div>:.
## .:DisableMarkup::entries_per_pages:.
*10* par défaut. Définit le nombre de publications par page.
## columns
1 par défaut. Ce champ définit le nombre de colonnes dans une page.
## .:DisableMarkup::feed_lenght:.
*5* par défaut. Définit le nombre de publications à afficher dans le flux RSS.
## .:DisableMarkup::reverse_thread_order:.
Ce champ est un booléen, fixé à *True* par défaut. Définit l'ordre de publication. Du plus récent au plus anciens (*True*), ou l'inverse (*False*).
## .:DisableMarkup::markup_language:.
Ce champ spécifie le langage de balisage par défaut utilisé dans toutes
les publications. Cette valeur peut cependant être localement écrasé
dans l'entête d'une [publication]().
Les valeurs possible de ce champ sont
- Markdown
- reStructuredText
- none
# .:DisableMarkup::path_encoding:.
Permet de spécifier l'encodage des chemins généré par VenC.
Utile dans certains cas, quand un ou plusieur liens interne contienne
des accents ou des caractères speciaux mal supportés par le serveur hôte.
Ce champ n'a pas de valeur par défaut.
## .:DisableMarkup::server_port:.
Spécifie le port du server http local. Ce champ est fixé à *8888* par défaut.
## .:DisableMarkup::sort_by:.
Pour être ordonnées, les publications sont généralement évalués selon
la valeur de leur identifiant. C'est pourquoi la valeur de ce champ est
'id' par défaut. Il est possible de spécifié le nom d'une autre propriété
pour les publications.
.:SetColor::TODO: Completes fields::red:.
## .:DisableMarkup::enable_jsonld:.
Active la création de fichier jsonld pour le référencement à l'aide des
technique du web sémantique.
Ce champ est un booléen qui vaut *False* par défaut. Selon la taille de
votre blog, ces fichiers peuvent vite prendre de la place.
## .:DisableMarkup::enable_jsonp:.
Active la création de fichier jsonp contenant des données jsonld pour le
moteur de recherche décentralisé côté client. Il s'agit d'une fonctionnalité expérimental.
Ce champ est un booléen qui vaut *False* par défaut. Selon la taille de
votre blog, ces fichiers peuvent vite prendre de la place.
......@@ -77,7 +77,8 @@ setup(
'markdown2',
'pyyaml',
'Pygments',
"requests"
'requests',
'unidecode'
],
scripts=['venc','venc-blog-migration'],
data_files = extra_files
......
......@@ -478,7 +478,11 @@ class DataStore:
def sort(self, entry):
try:
return str(getattr(entry, self.sort_by))
value = str(getattr(entry, self.sort_by))
if self.sort_by == 'id':
return int(value)
return value
except AttributeError:
return ''
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment