chronicle2

• Домашняя страница:
  • https://steve.fi/software/chronicle/
• CPAN:
  • http://search.cpan.org/dist/app-chronicle/
• Git Repository:
  • http://github.com/skx/chronicle2

Проект: устарел

Обратите внимание, что этот проект в настоящее время не отстранен, он был заменен приложением на базе Golang, которое имеет полную особенность:

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

Хроника

Chronicle - это инструмент, который преобразует каталог простых текстовых файлов в статический HTML -блог (или блог, если вы предпочитаете).

Этот репозиторий содержит переписывание со сценой компилятора Staticle Staticle, которое представляет собой значительное обновление с точки зрения как скорости, так и гибкости.

Система намеренно проста, но она поддерживает:

• Вывод на основе шаблона.
• Поддержка RSS -каналов.
• Поддержка помечений.
• Необязательная поддержка комментариев.

Эта реализация значительно быстрее в генерации страниц, чем предыдущие выпуски, в первую очередь потому, что сообщения проанализированы и вставляются в базу данных SQLite, а не в том, чтобы каждый пост читал в ОЗУ.

После того, как сообщения в блоге были заполнены в базе данных SQLite, они вставлены в серию шаблонов, что в конечном итоге генерирует вывод.

Хотя мы предполагаем, что вы сохраняете базу данных SQLite вокруг, не имеет значения, если вы удалите ее. Акт пробора всех ваших записей по -прежнему очень быстрый процесс.

Установка

Клонировать репозиторий, затем установите, как и любой модуль CPAN:

 perl Makefile.PL
make test
su - make install

Формат блога

Формат блога очень прост, а следующий файл - образец:

 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.

Запись префиксируется небольшим заголовком, состоящим из нескольких псевдо-заголовок. Заголовок должен быть отделен от тела по крайней мере одной пустой линией.

Значения заголовков, которые неизвестны, игнорируются, и никакая часть заголовка не включена в вывод, который генерируется.

Распознаются следующие значения заголовка:

• Заголовок:
  • Это содержит название поста. («Субъект:» может использоваться в качестве синонима.) Если ни один «заголовок» или «субъект» присутствует, используется сама имя файла.
• Дата:
  • Дата этой записи была создана. Если нет, время создания файла используется.
• Теги:
  • Если какие -либо теги присутствуют, они будут использоваться для классификации записи.
• Формат:
  • Это позволяет вам указать, пишете ли вы в Markdown или текстиль. Если вы, то тело в блоге будет обработано правильно.

Могут быть вставлены дополнительные заголовки, которые будут проигнорированы по умолчанию, для доступа определенными плагинами. Например, плагин Chronicle::Plugin::SkipDrafts гарантирует, что записи в блоге игнорируются, если они все еще являются проектами - и включают draft:1 заголовок. Точно так же существует плагин под названием PostSpooler , который будет игнорировать сообщения до их должных данных, и который использует специальный заголовок publish , а не date по умолчанию.

Простое использование

Предполагая, что у вас есть каталог, содержащий ряд сообщений в блоге, вы сможете генерировать свой блог таким образом:

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

Это будет считывать path/to/input/*.txt и генерирует блог под каталогом /path/to/output/ создание этого каталога, если отсутствует.

База данных SQLite будет создана по ./blog.db по умолчанию.

Расширенное использование

Предыдущий пример показал основное использование, одно очевидное изменение, которое предпочитает большинство пользователей, было бы установить название блога и подзаголовок:

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

Если вы начнете установить несколько значений, вы предпочитаете использовать вместо этого файл конфигурации. Chronicle будет читать /etc/chronicle/config и ~/.chronicle/config до начала. Смущая это, вы можете указать собственный файл конфигурации Via --config=/path/to/conf .

Файл конфигурации точно соответствует аргументам командной строки, поэтому с учетом «--foo = bar» файл конфигурации позволит установить одно и то же через:

 foo = bar

Как мы ранее отмечали, генерация блога в основном происходит через серию плагинов. Например, боковая панель может показать список всех тегов, которые могут быстро стать громоздкими. Если вы хотите отключить, что вы можете сделать это через:

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

ПРИМЕЧАНИЕ . Плагины, которые генерируют выходные страницы, расположены под Chronicle::Plugin::Generate пространства имен. Плагины, которые генерируют фрагменты, доступные для всех страниц, расположены под Chronicle::Plugin::Snippets Space.

ПРИМЕЧАНИЕ . Поскольку фрагменты включены на каждую страницу, в темы по умолчанию мы добавили --force , чтобы убедиться, что выходные страницы обновляются.

Пользовательские изменения

В идеале вы сможете мигрировать из предыдущих выпусков хроники непосредственно в эту кодовую базу, так как цель и основная операция идентичны:

• Записи в блоге по -прежнему читаются из data/ , если вы не указаете другой путь через " --input ".
• Мы по -прежнему предполагаем *.txt -это записи в блоге, если вы не указали " --pattern=*.blog ".
• Записи в блоге все еще созданы из заголовка и записи.
• Записи все еще проанализированы в форматах HTML, Markdown и Textile.

Однако есть изменения, и они в значительной степени относятся к шаблонам, наряду с различиями в реализации.

Начиная с Chronicle 5 Основной сценарий анализирует любые аргументы командной строки и читает посты в блоге, но фактическое поколение вашего сайта полностью основано на плагинах. Плагины представляют собой стандартные модули Perl, расположенные под пространством имен Chronicle::Plugin , и хотя вам не нужно знать ни одну из деталей, которые они могут быть заказаны благодаря использованию Module :: Pluggable :: Заказано класс.

Изменения шаблона немного важнее, чем я хотел бы, но, к счастью, эти изменения в основном состоят из новых мест для вещей и дополнительных страниц.

Продление

Как уже упоминалось, код ядра довольно минимален, и все функциональность вывода выполняется плагинами.

Ядро будет называть следующие методы, если они присутствуют в плагинах:

• on_db_create
  • Это вызывается, если база данных SQLite не существует, и может использоваться для добавления новых столбцов или таблиц.
• on_db_open
  • Это вызывается при открытии базы данных, и мы используем ее для установки параметров памяти/синхронизации. Это может быть использовано, чтобы сделать больше.
• on_insert
  • Этот метод вызывается, когда запись в блоге читается на диск до того, как он будет вставлен в базу данных в первый раз - или когда элемент на диске был изменен и база данных должна быть обновлена.
  • Этот метод предназначен для обработки преобразования маркировки/текстиля и т. Д.
• on_initiate
  • Это называется до любой обработки, со ссылкой на параметры конфигурации и рукоятку базы данных, используемое для хранения.
  • Это хорошее место для вызова кода, которое генерирует общие фрагменты или населяет глобальные варибные.
• on_generate
  • Это вызвано для создания фактических выходных страниц. Не существует логической разницы между этим методом и on_initiate , за исключением того, что прежние методы плагина гарантированно были вызваны до вызова on_generate .
  • Вот где страницы выводятся.

Стив