vak: (Default)
[personal profile] vak
Я давно мечтал найти простой способ делать документацию. Word и LibreOffice не устраивают: слишком трудоёмко, LaTeX - слишком сложно. Наконец нашёл приемлемый вариант. Процесс укладывается в четыре шага.

(1) Текст готовится в формате MarkDown. Это по сути простое текстовое представление с самоочевидными правилами разметки, вставки рисунков и подготовки таблиц.

(2) Рисунки делаются в формате SVG в редакторе Inkscape или из скрипта на Питоне. Затем рисунки конвертируются в формат EPS для вставки в документ.

(3) Исходный текст преобразуется в формат OpenDocument (он же ODT или *.odt) утилитой Pandoc. При этом стили форматирования подставляются из заранее заготовленного файла-шаблона. Формат ODT понимают LibreOffice, Word и многие другие wysiwyg-редакторы.

(4) Файл ODT преобразуется в PDF посредством LibreOffice.

Весь процесс легко автоматизируется посредством Makefile. Последовательность выглядит примерно так:
inkscape -z picture.svg -E picture.eps
pandoc -f markdown -t odt --reference-odt=my-style.odt input.md -o output.odt
soffice --convert-to pdf output.odt --headless

Date: 2017-06-15 07:21 (UTC)
nms: (Default)
From: [personal profile] nms
Ты забыл про библиографию. Или не употребляешь по утрам? (-:

А так да, я такую технологию "открыл" полгода назад.

Осталось дождаться когда спецы по библиографии сделают российские ГОСТы. )-:

Date: 2017-06-15 07:29 (UTC)
spamsink: (Default)
From: [personal profile] spamsink
Зачем через ODT, если можно с тем же успехом через HTML, заодно порождая и документ, хорошо читаемый онлайн?

Date: 2017-06-15 22:52 (UTC)
spamsink: (Default)
From: [personal profile] spamsink
Я про то, что при рендеринге страницы в HTML не нужно делать из SVG никаких EPS, а прилады командной строки к вебкиту для генерации PDF из HTML существуют.

Date: 2017-06-16 00:34 (UTC)
spamsink: (Default)
From: [personal profile] spamsink
SVG уже сто лет как рендерится нативно. И если pandoc достаточно умный, то он должен порождать HTML того же качества, что и ODT, приписывая соответствующие стили.
Edited Date: 2017-06-16 00:36 (UTC)

Date: 2017-06-15 08:22 (UTC)
fenikso: (Default)
From: [personal profile] fenikso
Еще и в source control можно нормально положить :)

Date: 2017-06-15 14:14 (UTC)
vit_r: default (Default)
From: [personal profile] vit_r
Не знаю для кого Латех сложен. Настраивается шаблон, а потом всё просто гонится с минмальными усилиями в стандартном процессе.

Date: 2017-06-15 16:50 (UTC)
juan_gandhi: (Default)
From: [personal profile] juan_gandhi
Опа! Все мои проблемы решены! Спасибо.

Date: 2017-06-15 17:07 (UTC)
cross_join: (Default)
From: [personal profile] cross_join
Год назад я подобную технологию, только из Textile вместо MarkDown, предложил одному коллеге. Потому что он к тому времени уже начал в своем углу херачить прямо в HTML. В итоге был обвинен в том, что инженер. Я, соответственно, год с ним не разговариваю, пусть трахается дальше.
Если эта технология у вас пойдет на работе, кинь мне ссылочку, пожалуйста, "порадую" директора.
Edited Date: 2017-06-15 17:09 (UTC)

Date: 2017-06-20 17:51 (UTC)
cross_join: (Default)
From: [personal profile] cross_join
А нельзя ли концептуально-тезисно описать "ихнюю" технологию? Что используется для "сырья", какие цепочки?

Date: 2017-06-18 17:57 (UTC)
quark_p: (Default)
From: [personal profile] quark_p
Что то не получается каменный цветок. Начал ваять заметку, перевожу в PDF а оно зараза плюется. Скриншот: https://ibb.co/c2O7Q5
UPD Разобрался, в тексте было пару слешей, надо экранировать апострофами. Теперь нужно разобраться как форматировать\настраивать PDF (поля, ориентация-формат листа)
Edited Date: 2017-06-19 14:31 (UTC)