chronicle2

• Page d'accueil:
  • https://steve.fi/software/chronicle/
• CPAN:
  • http://search.cpan.org/dist/app-chronicle/
• Référentiel GIT:
  • http://github.com/skx/chronicle2

Projet: obsolète

Remarque Ce projet est actuellement sans rapport, il a été remplacé par une application basée à Golang qui a une parité complète:

• https://github.com/skx/ephemeris

chronique

Chronicle est un outil qui convertira un répertoire de fichiers texte simples en un blog HTML statique, (ou blog si vous préférez).

Ce référentiel contient une réécriture à partir de Scratch du compilateur Chronicle Static Blog, qui représente une mise à niveau significative en termes de vitesse et de flexibilité.

Le système est intentionnellement simple, mais il supporte:

• Sortie basée sur le modèle.
• Prise en charge des flux RSS.
• Prise en charge des entrées marquées.
• Prise en charge facultative pour les commentaires.

Cette implémentation est considérablement plus rapide à la génération de pages que les versions précédentes, principalement parce que les publications sont analysées et insérées dans une base de données SQLite, plutôt que de lire chaque message dans RAM.

Une fois que les articles de blog ont été remplis dans la base de données SQLite, ils sont insérés dans une série de modèles, ce qui génère finalement la sortie.

Bien que nous supposions que vous gardez la base de données SQLite autour, peu importe si vous le supprimez. L'acte d'analyse de toutes vos entrées est toujours un processus très rapide.

Installation

Clone le référentiel puis installez-vous comme vous le feriez pour n'importe quel module CPAN:

 perl Makefile.PL
make test
su - make install

Format de blog

Le format de blog est très simple et le fichier suivant est un échantillon:

 title: The title of my post
date: 12 August 2007
tags: foo, bar, baz

The text of the actual entry goes here.

However much there is of it.

L'entrée est préfixée par un petit en-tête, composé de plusieurs champs de pseudo-tête. L'en-tête doit être séparé du corps par au moins une ligne vide.

Les valeurs d'en-tête inconnues sont ignorées et aucune partie de l'en-tête n'est incluse dans la sortie générée.

Les valeurs d'en-tête suivantes sont reconnues:

• Titre:
  • Cela tient le nom du post. ("Sujet:" Peut être utilisé comme synonyme.) Si ni "titre" ou "sujet" ne sont présents, le nom de fichier lui-même n'est utilisé.
• Date:
  • La date à laquelle cette entrée a été créée. Si cela n'est pas présent, le temps de création du fichier est utilisé.
• Tags:
  • Si des balises sont présentes, elles seront utilisées pour classer l'entrée.
• Format:
  • Cela vous permet de spécifier si vous écrivez dans Markdown ou Textile. Si vous êtes, le blog-corps sera traité correctement.

Les en-têtes supplémentaires peuvent être insérés, qui seront ignorés par défaut, pour l'accès par des plugins particuliers. Par exemple, le plugin Chronicle::Plugin::SkipDrafts s'assurera que les entrées de blog sont ignorées s'ils sont toujours des brouillons - et incluent un en-tête draft:1 . De même, il existe un plugin appelé PostSpooler qui ignorera les publications jusqu'à leurs données dues, et qui utilise l'en-tête publish spéciale - plutôt que la date par défaut.

Utilisation simple

En supposant que vous disposez d'un répertoire contenant un certain nombre de articles de blog, vous devriez pouvoir générer votre blog comme ça:

 chronicle --input=path/to/input --output=/path/to/output 
   --theme=blog.steve.org.uk

Cela lira path/to/input/*.txt et générera le blog sous le répertoire /path/to/output/ créant ce répertoire en cas de manque.

La base de données SQLite sera créée sur ./blog.db par défaut, et si elle est supprimée, elle sera régénérée.

Utilisation avancée

L'exemple précédent a montré l'utilisation de base, un changement évident que la plupart des utilisateurs préféreraient consister à définir le titre du blog et le sous-titre:

 chronicle --title="Steve Kemp's Blog" --sub-title="Writings about cake" ..

Si vous commencez à définir plusieurs valeurs, vous préférez peut-être utiliser un fichier de configuration à la place. Chronicle lira /etc/chronicle/config , et ~/.chronicle/config avant de commencer. Échec que vous pouvez spécifier un fichier de configuration de votre propre via --config=/path/to/conf .

Le fichier de configuration correspond exactement aux arguments de la ligne de commande, donc étant donné "--foo = bar" Le fichier de configuration permettrait à la même chose d'être définie via:

 foo = bar

Comme nous l'avons déjà noté, la génération de blog se produit en grande partie via une série de plugins. Par exemple, la barre latérale peut afficher la liste de toutes les balises, ce qui peut devenir difficile à manier rapidement. Si vous vouliez désactiver que vous puissiez le faire via:

 chronicle --exclude-plugins=AllTags,RecentPosts --force ..

Remarque : Les plugins qui génèrent des pages de sortie sont situés sous le Chronicle::Plugin::Generate le nom de nom. Les plugins qui génèrent des extraits disponibles pour toutes les pages sont situés sous le Chronicle::Plugin::Snippets Name-espace.

Remarque : Parce que les extraits sont inclus dans chaque page, dans les thèmes par défaut, nous avons ajouté --force pour nous assurer que les pages de sortie sont mises à jour.

Modifications visibles utilisateur

Dans un idéal, vous devriez être en mesure de migrer des rejets de chronique précédents directement dans cette base de code, car l'objectif et le fonctionnement principal sont identiques:

• Les entrées de blog sont toujours lues à partir de data/ , sauf si vous spécifiez un chemin différent via " --input ".
• Nous supposons toujours *.txt sont les entrées de blog, sauf si vous spécifiez " --pattern=*.blog ".
• Les entrées de blog sont toujours construites d'un en-tête et de l'entrée.
• Les entrées sont toujours analysées dans des formats HTML, Markdown et Textile.

Cependant, il y a des changements, et ceux-ci sont largement liés aux modèles, ainsi que les différences de mise en œuvre.

À partir de Chronicle 5, le script principal analyse tous les arguments en ligne de commande et lit les articles de blog, mais la génération réelle de votre site est entièrement basée sur des plugins. Les plugins sont des modules Perl standard situés sous le Chronicle::Plugin , et bien que vous n'ayez pas besoin de connaître les détails, ils peuvent être commandés grâce à l'utilisation du module :: Pluggable :: Classe commandée.

Les changements de modèle sont un peu plus significatifs que je ne le souhaite, mais avec bonheur ces changements se composent en grande partie de nouveaux emplacements pour les choses et des pages supplémentaires.

Extension

Comme mentionné, le code central est assez minime et toutes les fonctionnalités de sortie sont effectuées par des plugins.

Le noyau appellera les méthodes suivantes si elle est présente dans les plugins:

• on_db_create
  • Ceci est appelé si la base de données SQLite n'existe pas et peut être utilisée pour ajouter de nouvelles colonnes ou tables.
• on_db_open
  • Ceci est appelé lorsque la base de données est ouverte et nous l'utilisons pour définir des options de mémoire / synchronisation. Il pourrait être utilisé pour faire plus.
• on_insert
  • Cette méthode est invoquée car une entrée de blog est lue sur le disque avant d'être insérée dans la base de données pour la première fois - ou lorsque l'élément sur le disque a été modifié et que la base de données doit être actualisée.
  • Cette méthode est conçue pour gérer la conversion de marque / textile, etc.
• on_initiate
  • Ceci est appelé avant tout traitement, avec une référence aux options de configuration et la poignée de la base de données utilisée pour le stockage.
  • C'est un bon endroit pour appeler le code qui génère des extraits communs ou remplit les variables mondiales.
• on_generate
  • Ceci est appelé pour générer les pages de sortie réelles. Il n'y a pas de différence logique entre cette méthode et on_initiate , sauf que les anciennes méthodes de plugin sont garanties pour avoir été appelée avant l'invoquer on_generate .
  • C'est là que les pages sont sorties.

Steve