Commit 10cc6be1 authored by Denis Salem's avatar Denis Salem
Browse files

WIP: Entry and Global patterns documentation

parent b707a033
......@@ -19,7 +19,7 @@ Ce fichier est structuré de la façon suivante
- __description__ : Il s'agit d'un cours texte présentant le thème.
- __version__ : Optionnel. Indique la version du thème.
- __author__ : Optionnel. Indique le ou les auteurs du thème.
- __override__ : Ce champ contient une les propriétés remplaçant ou s'ajoutant au fichier de configuration principal. Typiquement, un thème qui fonctionne avec trois colones, par exemple, devra inclure le champ 'columns' ayant la valeur 3.
- __override__ : Ce champ contient les propriétés remplaçant ou s'ajoutant au fichier de configuration principal. Typiquement, un thème qui fonctionne avec trois colones, par exemple, devra inclure le champ 'columns' ayant la valeur 3.
- __.:DisableMarkup::assets_dependencies:.__ : Il s'agit d'une liste contenant les assets (images, feuilles de styles, scripts) contenu dans .:DisableMarkup::~/.local/share/VenC/themes_assets:.. C'est notamment utile pour inclure des modules VenC javascript.
- __.:DisableMarkup::includes_dependencies:.__ : Comme pour le champ précédent, il s'agit d'une liste contenant des noms de ficher. Il s'agit de fichiers HTMLs à inclure avec __.:Escape:: .:IncludeFile:: ... :. ::EndEscape:.__. Ces fichiers sont installés par défaut avec VenC et se trouve dans .:DisableMarkup::~/.local/share/VenC/themes_includes:..
......@@ -11,13 +11,28 @@ des fichiers __entry.html__, __rssEntry.xml__ et __atomEntry.xml__ et de la publ
Il est aussi possible d'utiliser ceux là dans des templates. Pour en savoir plus sur les templates, rendez vous [ici](.:GetRelativeOrigin:.Les-templates)
- __.:Escape:: .:GetEntryID:. ::EndEscape:.__ : Retourne l'identifiant unique de la publication.
- __.:Escape:: .:GetEntryTitle:. ::EndEscape:.__ : Retourne le nom de la publication.
- __.:Escape:: .:GetEntryMonth:. ::EndEscape:.__ : Retourne le mois de création de la publication.
- __.:Escape:: .:GetEntryYear:. ::EndEscape:.__ : Retourne l'année de création de la publication.
- __.:Escape:: .:GetEntryDay:. ::EndEscape:.__ : Retourne le jour de création de la publication.
- __.:Escape:: .:GetEntryHour:. ::EndEscape:.__ : Retourne l'heure de création de la publication.
- __.:Escape:: .:GetEntryMinute:. ::EndEscape:.__ : Retourne la minute de création de la publication.
## .:Escape:: .:GetEntryID:. ::EndEscape:.
Retourne l'identifiant unique de la publication.
## .:Escape:: .:GetEntryTitle:. ::EndEscape:.
Retourne le nom de la publication.
## .:Escape:: .:GetEntryMonth:. ::EndEscape:.
Retourne le mois de création de la publication.
## .:Escape:: .:GetEntryYear:. ::EndEscape:.
Retourne l'année de création de la publication.
## .:Escape:: .:GetEntryDay:. ::EndEscape:.
Retourne le jour de création de la publication.
## .:Escape:: . :GetEntryHour:. ::EndEscape:.
Retourne l'heure de création de la publication.
## .:Escape:: .:GetEntryMinute:. ::EndEscape:.
Retourne la minute de création de la publication.
## .:Escape:: .:GetEntryMetadata::variable_name:. ::EndEscape:.
Il est possible de définir ses propres variable dans les métadonnées de la publication ou du template.
......@@ -31,3 +46,22 @@ Pour accéder à celle-ci on utilisera le motif GetEntryMetadata de la façon su
Si la variable ainsi référencée n'existe pas VenC générera une
erreur et vous indiquera où en est l'origine.
## .:Escape:: .:GetEntryMetadataIfExists::variable_name[::string]:. ::EndEscape:.
De façon similaire, il est possible d'essayer d'accéder à une variable,
sans garantie que celle-ci existe. Si la variable existe, il est possible
alors de formater du texte pour y inclure notre variable.
Le formatage du texte se fait en utilisant des variables contextuelles propre à la fonction:
- __{value}__ : La valeur de la variable qu'on référence.
- __{relative_origin}__ : Le chemin relatif de la racine du blog.
Un cas d'usage typique serait de modifier le style de la publications en attribuant une classe CSS à l'élément HTML:
.:CodeHighlightInclude::Text::False::GetEntryMetadataIfExists_example:.
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.
......@@ -57,6 +57,20 @@ De façon similaire, il est possible d'essayer d'accéder à une variable,
sans garantie que celle-ci existe. Si la variable existe, il est possible
alors de formater du texte pour y inclure notre variable.
Un cas d'usage typique serait d'ajouter un bouton de réseau social:
Le formatage du texte se fait en utilisant des variables contextuelles propre à la fonction:
.:CodeHighlightInclude::C++::True::GetBlogMetadataIfExists_example:.
- __{value}__ : La valeur de la variable qu'on référence.
- __{relative_origin}__ : Le chemin relatif de la racine du blog.
Un cas d'usage typique serait d'ajouter un bouton de réseau social si
l'utilisateur définit un compte dans son fichier de configuration:
.:CodeHighlightInclude::html::False::GetBlogMetadataIfExists_example:.
Dans cet example, on suppose que l'image de l'icone du réseau social se trouve à la
racine du blog, on a donc besoin de préciser son chemin relatif avec la
variable contextuelle {relative_origin}.
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.
.:GetBlogMetadataIfExists::mastodon::
<a href="{value}" class="social-network-item">
<img src="{relative_origin}mastodon.png" alt="Mastodon" title="Mastodon"/>
</a>
:.
<div id="entry.:GetEntryID:." .:GetMetadataIfExists::alternate_style::class="{value}":. >
......@@ -38,7 +38,7 @@ aside ul
blockquote,
.venc_source_Yaml,
.venc_source_Text,
.venc_source_html,
.venc_source_html
{background-color: rgba(0,0,0,0.5);
color: #FFF;
font-size: 0.8em;
......
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