Файли в цьому проекті можуть бути використані для побудови Довідника Користувача

для Друпал. Джерело використовує AsciiDoc формат, який може бути скомпільовано

в формат DocBook, який потому може бути зібрано в HTML, PDF та інші формати

електронних книжок. Модуль AsciiDoc Display (https://dgo.to/asciidoc_display)

може бути використано для відображення спеціального HTML виводу в рамках сайту,

побудованого на Друпал.

Ліцензія і Права на Копіювання

---------------------

Перегляньте файл ASSETS.yml в цій теці та файли на які він посилається, для

інформації щодо прав на копіювання і ліцензії для текстових джерел і зображень

в цьому проекті. Файли, що створюються і відображаються цим проектом теж мусять

мати в наявності інформацію про ліцензії та права на копіювання.

Код, в рамках цього проекту, що складається із скриптів для генерування виводу

з джерел, а також код для створення автоматичних зображень екрану, потрапляє

під GNU/GPL version 2 та новіші версії.

Організація файлів

-----------------

Цей проект містить наступні теки:

* source

Джерела в форматі AsciiDoc для довідника в теках мов директорії source. Файл

предметного покажчику названий "guide.asciidoc". Він містить визначення для інших

файлів, що формують довідник.

* assets

Зображення і текст для створення знимків екрану для довідника.

* unused

Деякі теми, що були написані або частково писались, що було вирішено не

додавати в остаточний довідник.

* guidelines / templates

Директиви та шаблони для контрибуторів цього проекту у відповідниї теках.

Директиви розміщені в форматі іншого AsciiDoc довідника, разом із предметним

показчиком "guidelines.asciidoc". Присітні окремі шаблони для тем з завданнями і

поняттями.

* scripts / output

Для побудови Довідника і Директив, використовуються скрипти в відповідній теці;

дивіться нижче для додаткової інформації. Наразі документ Директив створює лише

вивід HTML для модуля AsciiDoc Display, а скрипти Довідника Користувача

створюють HTML вивід разом із PDF та іншими форматами електронних книг.

Вивід скриптів створює результати в теці output. Підтека html в тому міці це

вивід для модуля AsciiDoc Display; електронні книги створюються в теці ebooks.

Скрипти подудови виводу ASCIIDOC

-----------------------------

Довідник і Директиви загалом наявні з скриптами для створення виводу, сумісного

із модулем AsciiDoc Display (https://www.drupal.org/project/asciidoc_display),

а також PDF і інших форматів електронних книг(скрипти адаптовані із прикладів

того проекту, і тільки Довідник наразі налаштовано для створення виводу в

форматі електронних книг).

Для запуску скрипта scripts/mkoutput.sh вам потрібно буде декілька програм

- AsciiDoc (для будь-якого виводу): http://asciidoc.org/INSTALL.html

- DocBook (для будь-якого виводу): http://docbook.org or

http://www.dpawson.co.uk/docbook/tools.html

- FOP (для PDF): http://xmlgraphics.apache.org/fop/

- Calibre (для MOBI): http://calibre-ebook.com/

На комп'ютері Linux, ви можете використовувати одну з команд для встановлення:

apt-get install asciidoc docbook fop calibre

yum install asciidoc docbook fop calibre

На Mac:

brew install asciidoc xmlto

echo "export XML_CATALOG_FILES=/usr/local/etc/xml/catalog" >> ~/.bash_profile

source ~/.bash_profile

Зверніть увагу, що ці скрипти не працюють з усіма доступними версіями AsciiDoc

та Docbook. Вони були протестовані для роботи із:

asciidoc - version 8.6.9

xmlto - version 0.0.25

Щоб перевірити версії, виконайте:

asciidoc --version

xmlto --version

в консолі.