Commit 5e1c2e5c authored by Denis Salem's avatar Denis Salem
Browse files

fix typo in print_help, work in progress on documentation

parent 9d8b62d3
......@@ -10,7 +10,7 @@ columns: 1
date_format: '%A %d. %B %Y'
entries_per_pages: 10
ftp_host: Nom d'hôte FTP
license: CC By-SA
license: CC-By-SA
code_highlight_css_override: true
markup_language: 'Markdown'
path:
......@@ -35,7 +35,7 @@ disable_main_thread: true
disable_threads: ""
disable_archives: true
disable_chapters: false
disable_categories: true
disable_categories: false
disable_single_entries: true
banner: 'https://download.tuxfamily.org/dsalem/img/2017_-_Denis_Salem_-_CC_By_SA_-_VenC-logo.svg'
path_encoding: ''
......
......@@ -6,10 +6,10 @@ title: Configuration d'un thème
---VENC-BEGIN-PREVIEW---
---VENC-END-PREVIEW---
Il s'agit d'un fichier de configuration au format yaml qui accompagne
Il s'agit d'un fichier de configuration au format [Yaml](https://yaml.org/) qui accompagne
chaque thème installable dans le blog avec la commande
> .:SetColor::jeanrochefort@anonymous::green:. .:SetColor::~ $::cyan:. venc --remote-copy
> .:SetColor::jeanrochefort@anonymous::green:. .:SetColor::~ $::cyan:. venc --intall-theme
Ce fichier est structuré de la façon suivante
......
......@@ -64,13 +64,12 @@ caractère à formater avec la variable contextuelle __{value}__ contenant le mo
Le second paramètre est une chaine de caractère servant de séparateur.
## .:ForEntryMetadata::variable_name::{value}::,:.
## .:Escape:: .:ForEntryMetadata::variable_name::string::separator:. ::EndEscape:.
Il est possible de définir des métadonnées sous la forme de listes. Qu'il est
Retourne la liste des mots clefs de la publication.
Il est possible de définir des [métadonnées](.:GetRelativeOrigin:.Metadonnee) sous la forme de listes.
Le premier argument est une chaine de
caractère à formater avec la variable contextuelle __{value}__ contenant le mot clef courant.
Le premier argument est une chaine de caractère à formater avec la
variable contextuelle __{value}__ contenant l'élément courant de la liste.
Le second paramètre est une chaine de caractère servant de séparateur.
......@@ -107,3 +106,39 @@ Un cas d'usage typique serait de modifier le style de la publications en attribu
Si la variable référencée n'est pas définit VenC ignore le motif et le supprime.
Si le second argument n'est pas définit l'accesseur renvoie directement la variable référencée, si elle existe.
## .:Escape:: .:LeavesForEntryCategories::string::separator:. ::EndEscape:.
Les categories sont organisées sous la forme d'un arbre. Il est
possible de ne récupérer que les "feuilles" de cet arbres, c'est à dire
les catégories qui n'ont pas de filles.
Par exemple si la publication courante se trouve dans les catégories suivantes:
.:CodeHighlight::Yaml::False::categories: 'moo, foo > bar, boo > loo > poo':.
le motif
> .:Escape:: .:LeavesForEntryCategories::{value}::,:. ::EndEscape:.
retournera
> moo,bar,poo
LeavesForEntryCategories possède les variables contextuelles suivante:
- __{value}__ : Contient le nom de la catégorie courante.
- __{path}__ : Contient le chemin relatif de la catégorie courante.
- __{branch}__ : Contient la branche complète de la catégorie, de la racine de l'arbre, jusqu-à la feuille.
Ce motif est ignoré et supprimé si la génération des catégories est désactivé dans le fichier de configuration principal.
## .:Escape:: .:TreeForBlogCategories::open_node::open_branch::close_branch::close_node:. ::EndEscape:.
Les categories sont organisées sous la forme d'un arbre. Il est
possible de récupérer l'arbre entier afin typiquement de générer un menu ou une liste de catégories et de sous catégories.
- __open_node__ : Contient la chaine de caractère d'ouverture pour la categorie parente.
- __open_branch__ : Contient la chaine de caractère d'ouverture de la categorie courante.
- __close_branch__ : Contient la chaine de caractère de fermeture de la categorie courante.
- __close_node__ : Contient la chaine de caractère de fermeture de la categorie parente.
......@@ -38,4 +38,4 @@ def print_help(argv=None):
print("-xftp\t--export-via-ftp")
print("-rc\t--remote-copy")
print("-h\t--help")
print("-it\t--install-themes <"+messages.theme_name+">")
print("-it\t--install-theme <"+messages.theme_name+">")
......@@ -180,7 +180,7 @@ class Entry:
self.categories_leaves.append({
"value": category_leaf,
"path": category_leaf_path,
"raw" : category
"branch" : category
})
except IndexError : # when list is empty
......
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