Commit e293beaa authored by Denis Salem's avatar Denis Salem
Browse files

WIP on documentation, few chapters on themes

parent 1aa058ea
authors: 'Denis Salem'
categories: ''
tags: ''
title: Mettre en ligne
chapter: 3.4
---VENC-BEGIN-PREVIEW---
---VENC-END-PREVIEW---
Maintenant que votre blog vous plait, il est temps de le mettre en ligne
et d'en faire profiter les internautes!
Il y a plusieurs façon de faire. La première approche consiste à copier
manuellement le contenu du répertoire _blog_ vers le serveur en ligne.
Mais ce peut-être un peu fastidieux quand on sait que VenC prend peut
prendre en charge le transfert de votre blog.
Pour que VenC puisse mettre en ligne votre blog, vous devez lui fournir
quelques informations dans le fichier _blog_configuration.yaml_. Pour
cela renseignez le champ _.:DisableMarkup::ftp_host:._ avec l'adresse
du serveur FTP de destination. Renseignez également le sous-champ
_ftp_ du champ _path_ en indiquant le chemin de destination où sera
copié le contenu de votre blog, sur le serveur en ligne.
__Attention: Soyez vigilant en renseignant le champ _ftp_ qui détermine
le chemin de destination. Au moment de l'exporation en ligne, VenC
efface le contenu de ce répertoire! Assurez de savoir ce que vous
faite!__
Après avoir fournis les informations dont VenC a besoin, vous pouvez
copier votre blog sur le serveur de destination:
> .:SetColor::jeanrochefort@anonymous::green:. .:SetColor::~ $::cyan:. venc --remote-copy
De cette façon, VenC vous demandera de vous authentifier auprès du serveur.
C'est seulement après vous être authentifié que le transfert commencera.
Vous pouvez allers vous chercher un café, ou un jus de tomate.
Perso, je préfère le jus de tomate. Avec du parmesant et du tabasco.
Une autre façon de faire est de compiler le blog et de l'exporter en
ligne en une seule commande
> .:SetColor::jeanrochefort@anonymous::green:. .:SetColor::~ $::cyan:. venc --export-via-ftp [thème à préciser en option]
Comme pour la commande précédente, vous devrez vous authentifier.
Vous pouvez également préciser un nom de thème avec lequel vous voulez
compiler votre blog.
Voilà, c'est tout! Normalement, votre blog devrait être en ligne avec
ça!
authors: 'Denis Salem'
categories: ''
tags: ''
title: Les Thèmes
chapter: 4.5
---VENC-BEGIN-PREVIEW---
---VENC-END-PREVIEW---
Un thème est l'ensemble des fragments qui seront assemblés et
interprétés par VenC pour former votre blog, c'est dans un thème que
sera définie la mise en page de votre site. Typiquement, un thème est un
repertoire contenant au moins le dossier __chunks__ et un autre,
optionel __assets__.
- __assets__ : Contient des ressources nécessaires à la mise en page ou
au fonctionnement du blog. Cela peut-être des images, des feuilles de
style CSS ou des script JS. Vous pouvez également y entreposer des
librairies comme JQuery ou bootstrap.
- __chunks__ : Doit contenir les fichiers suivant
- header.html
- entry.html
- footer.html
- rssHeader.html
- rssEntry.html
- rssFooter.html
- __config.yaml__ : Un fichier de configuration yaml permettant
d'indiquer les dépendances du thème, supplanter des options de
configuration et décrire le thème. Plus d'infos plus bas dans ce
chapitre.
Comme vous l'avez sans doute compris VenC met bout à bout les morceaux
de votre blog en formattant l'entête (header.html) et en répétant un
certain nombre de fois l'operation qui consiste à formater le morceau
qui définit une publication (entry.html) pour la publication courante.
La page courante est alors terminée en y ajoutant le morceau pied de
page (footer.html) également formatté.
C'est exactement le même principe pour le flux RSS qui est construit de
façon identique.
Il n'est pas forcément évident de créer un thème de toute pièce et vous
n'avez peut-être pas envie de perdre trop de temps à tester le
fonctionnement de tout ça. Le meilleur moyen de créer un thème soi même
c'est de jeter un oeil au thème __dummy__ normalement installé avec VenC
dans:
> ~/.local/share/VenC/themes/dummy
Ce thème en l'état n'est pas utilisable, mais c'est une solide base pour
créer le votre. Le style CSS reste à définir, et vous pourriez vouloir
réorganiser les éléments de la page.
Une autre approche est de regarder comment sont construits d'autres
thèmes. Ceux là seront ajoutés au fur et à mesure sur les repositories
git de VenC.
Vous pouvez également vous aider de la partie [Tutoriels](.:GetRelativeOrigin:.Tutoriels)
dans laquelle sont décrites des techniques pour réaliser des mises en
pages très spécifiques et pour lesquelles l'utilisation du langage de
balisage interne de VenC sera illustrée.
authors: 'Denis Salem'
categories: ''
tags: ''
chapter: 4.5.1
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
chaque thème installable dans le blog avec la commande
> .:SetColor::jeanrochefort@anonymous::green:. .:SetColor::~ $::cyan:. venc --remote-copy
Ce fichier est structuré de la façon suivante
.:CodeHighlightInclude::Yaml::false::theme-configuration-example:.
- __info__ : Ce champ contient les métadonnées du thème.
- __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.
- __.: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:..
info:
description : ''
override:
whatever_field_1: 'whatever_value'
whatever_field_2: 'whatever_value2'
...
assets_dependencies: ['awesome.css','not_so_shitty_script.js',]
includes_dependencies: ['source_code.example','whatever_you_want.file']
info:
description : 'theme_description_dummy'
description : ''
override:
columns: 1
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