Skip to content

Метаданные публикации

Дмитрий Седых edited this page Sep 1, 2014 · 5 revisions

Если вы хотите создать хорошую книжку, то крайне желательно заполнить для нее описание метаданных. Такое описание хранится в файла с именем metadata.yaml или metadata.yml и должно размещаться в корневом каталоге публикации.

Формат описания метаданных (YAML) достаточно простой и может быть создан в любом текстовом редакторе. В текущей версии приложения поддерживается следующая информация:

  • lang — описывает язык публикации
  • title — название публикации
  • subtitle — подзаголовок
  • collection — название серии публикаций
  • sequence — порядковый номер в серии (только, если указано название серии)
  • edition — редакция (например: "Вторая редакция")
  • fulltitle — полное название публикации, включая серию и номер, если необходимо
  • author — список авторов публикации
  • contributor — список второстепенных авторов (например: иллюстраторов)
  • publisher — издатель
  • uuid, id, identifier, doi, isbn, issn — уникальные идентификаторы публикации в разных форматах (можно использовать несколько)
  • date — дата создания в формате YYYY-MM-DD (день и месяц можно при желании опустить)
  • description — краткое описание публикации
  • keywords — список ключевых слов разделенных запятыми
  • coverage — описание времени действия, эпохи, окружения и прочее
  • copyright, rights — строка с описанием авторских прав

Пример описания метаданных публикации

title: Небесные Колокольцы
author: 
 - Максим Макаренков
 - Ольга Мареичева
lang: ru
uuid: 2FF0973E-BB00-4F60-9782-0CA8D5B89031
isbn: 978-5-9922-0567-1 
id: 169576
publisher: Альфа-книга
date: 2010-10
description: >
  Кто-то проводит жуткий кровавый ритуал в тихом купеческом Синегорске. 
  Такого кошмара город не знал со времен войны. Кому и зачем 
  потребовалось тревожить зловещие тени прошлого? Искать разгадку 
  приходится не только инквизиторам республики, но и отставному 
  армейскому магу Владиславу Воронцову со своим учеником.
keywords: боевая фантастика, фантастика
rights: (c) 2010 Максим Макаренков и Ольга Мареичева

Если описание метаданных публикации не найдено, то будет сгенерировано описание по умолчанию. Оно включает в себя следующие данные:

title: Untitled
lang: en
uuid: {автоматически сгенерированный случайный идентификатор}