Les modules personnalisables
- Principes des modules
- Le module des balises
<meta>
- Le module du menu
- Le module de la barre latérale
- Le module du pied de page
Principes des modules
Les modules de Tyto - Littérateur sont des fichiers externes que le webmestre
peut configurer pour personnaliser certaines parties du site web,
comme le menu, la barre latérale, le pied de page ou
encore les balises <meta ...>
et <link ...>
Les fichiers de configuration commentés se trouvent dans le dossier
_configs/ Les modules metas
et footer
doivent contenir du
code HTML, tandis que les modules sidebar
et navbar
doivent
contenir des URIs. Seuls ces 2 modules n'ont pas de contenus par
défaut.
Le module des balises <meta>
Le fichier de configuration est tyto.metas.html. Avec la
commande tyto wip metas
, Tyto - Littérateur crée le fichier
wip/template/metas.html
Le webmestre peut ajouter les balises <meta ...>
et <link ...>
uniquement. Une liste des balises déjà utilisées lors de la
convertion d'un article est présente. Une configuration par défaut
est installée.
Le module du menu
Le fichier de configuration est tyto.navbar. Ce module permet
de choisir un dossier du domaine que Tyto - Littérateur transforme en lien
pour accéder directement à la page [dossier]/index.html. Avec la
commande tyto publish navbar
, Tyto - Littérateur crée le fichier
www/template/navbar.html.
Le fichier est commenté. Il est recommandé, après l'URI du dossier
(depuis le dossier articles/) de définir un titre au lien en
l'ajoutant sous forme de commentaire sur la même ligne. Ce titre
est utilisé dans la balise HTML title=""
.
Le module de la barre latérale
Le fichier de configuration est tyto.sidebar. Ce module permet
de créer une liste d'articles à lire du domaine (maximum 16 !). le
fichier est commenté. L'URI du fichier-article commence depuis le
dossier articles/ L'ordre est respecté. Avec la commande
tyto wip sidebar
, Tyto - Littérateur crée le fichier
wip/template/sidebar.html
Le fichier est commenté. La sortie HTML contient la liste des
articles avec le titre, la date, l'auteur, et la métadonnée
about:
de l'article. Il est possible aussi de changer le titre du
module dans le fichier de configuration avec : Titre à afficher
.
Le module du pied de page
Le fichier de configuration est tyto.footer.html. Avec la commande
tyto wip footer
Tyto - Littérateur crée le fichier wip/template/footer.html
Avec la commande tyto new footer
, le fichier de configuration
est réinitialisé
Vous pouvez personnaliser le fichier de configuration avec la commande
tyto edit footer
. Mettez dedans le code HTML que vous souhaitez.
Notes à propos de l'option --static
Ces modules, une fois configurés, et installés avec l'action 'wip',
sont, par défaut chargés par appel include virtual=""
dans les
pages web. La configuration du serveur nginx, via son module ssi on
doit être ajoutée.
tyto wip index.tyto --static
Il est possible de figer une page web et d'intégrer le contenu des
modules HTML afin de créer une page statique complète. Pour cela,
ajouter l'option --static
à l'action wip
(uniquement) sur
un article ou en traitement de masse.
Pour pouvoir prévisualiser localement ces modules, utiliser l'option
--static
(par exemple, sur un article tests.tyto). Il est possible
d'utiliser cette option en traitement de masse avec wip
. Utiliser la
commande publish
après avoir utilisé l'option wip [file] --static
publiera la page statique complète. Pour revenir à l'article "semi-statique",
utiliser la commande wip sans l'option --static, avant la commande publish
...
<!--# include virtual="/template/[mod].html"-->
...
Rappels
tyto new [module]
Réinitialise la configuration du module (confirmation).
tyto wip/publish [module]
Installer un module configuré sur le serveur