Les publications

Une publication est un fichier dans lequel vous allez pouvoir rédiger votre contenu. Cela peut-être un billet d'humeur ou d'opinion, un article de fond, une galerie d'images, etc. Pour faciliter l'édition de votre blog avec VenC, vous êtes fortement encouragé à utiliser des templates.

Le nom de fichier d'une publication est formaté de la façon suivante :

<id>__<mois>-<jour>-<année>-<heure>-<minute>__<titre>

Une publication contient une première partie au format YAML contenant les métadonnées de la publication, puis une seconde au format Markdown qui contiendra la publication à proprement parler. Cette seconde partie est elle-même scindée en deux. L'une contiendra la prévisualisation de la publication, et l'autre son véritable contenu.

Une publication vierge se présente de la façon suivante:

authors: ''
categories: ''
tags: ''
title:
---VENC-BEGIN-PREVIEW---
---VENC-END-PREVIEW---

Métadonnées

Il y a donc quatre champs qu'il est possible de compléter.

authors

C'est la liste des auteurs de la publication, séparés par une virgule. Par exemple : Denis Salem, Benjamin Bayard, Richard Stallman.

categories

C'est la liste des catégories de la publication, séparées par une virgule. Vous pouvez également avoir des sous-catégories pour une publication qui définiront ensuite un arbre de catégories. Pour définir une sous-catégories il faut séparer la catégorie parente de la catégorie fille par ' > '. Ce procédé peut être répété autant de fois que nécessaire. Par exemple : Metal > Copper, Metal > Steel > Properties, Materials.

tags

C'est la liste des mots-clefs de la publication, séparés par une virgule. Par exemple : Libre, Open-source, Linux.

title

C'est le nom de votre publication, tel que vous l'avez définit au moment de créer la publication avec la commande : venc -ne .

Métadonnées optionnelles

Il est également possible de rajouter librement des champs optionnels. Il y a cependant deux champs réservés :

chapter

Indique à quel chapitre correspond la publication. La convention qu'utilise VenC pour reconnaître les chapitres est la suivante : chaque chapitre et chaque sous-partie sont numérotés, et séparés par un point. Quelques exemples pour aider à visualiser le truc.

  • '2' : indique que la publication correspond au chapitre deux.
  • '1.2' : indique que la publication correspond au premier chapitre, seconde sous-partie
  • '3.3.5' : indique que la publication correspond au troisième chapitre, troisième sous-partie, cinquième sous-partie de la partie parente.

Important : le champ chapter doit explicitement être une chaîne de caractères. Pour ce faire, l'index du chapitre doit être entre guillement.

markup_language

Il est possible de spécifier un langage de balisage qui sera utilisé pour la publication courante, en lieu et place du langage définit dans le fichier de configuration du blog.

VenC supporte deux langages de balisage :

  • Markdown : qui est le langage par défaut.
  • reStructuredText : un peu plus complet et puissant que Markdown.
  • none : Le langage de balisage est désactivé. Permet d'incorporer de l'HTML/CSS dans une publication.