LINUX.ORG.RU
ФорумTalks

Pandoc + MS Word + Powershell = документация по ГОСТу

 ,


3

2

Опубликован набор шаблонов и скриптов для компиляции научно-технических отчётов и программной документации (docx) из исходников в Markdown. С формулами, таблицами, ссылками, списком литературы и всем остальным. Опционально — работа через GitLab и автоматическая удалённая компиляция.

Репозиторий с README.

Пример результата.

Технические подробности.

Ога, а для Latex актуальные стили ГОСТ для всего в подряд так и будем по всяким помойкам искать?

И почему docx, а не OASIS, который как бы сам есть ГОСТ?

DarkAmateur ★★★ ()
Последнее исправление: DarkAmateur (всего исправлений: 2)

Новохомяковск

Сначала прочитал слегка иначе

Deleted ()
Ответ на: комментарий от DarkAmateur

а для Latex актуальные стили ГОСТ

У нас пока нет, увы.

почему docx, а не OASIS, который как бы сам есть ГОСТ?

Без особых причин, просто docx исторически прижился и никто не жалуется. Можно приделать и сохранялку в ODT, аналогично тому, как сейчас сохраняется в PDF. Первый эксперимент показал, что при сохранении в ODT и последующем открытии документ выглядит иначе, меняются межстрочные интервалы на титульной странице.

ringill ()

Круто, было бы мне полезно в бытность студентом.

theNamelessOne ★★★★★ ()

Поддерживаю всеми лапами! Если мне вдруг, не дай б-г, придётся делать документацию по ГОСТ, обязательно воспользуюсь. Так-то я у себя в отделе давно завёл систему подготовки документации по принципу «единого источника» (вдохновляясь, среди прочих, статьями AP). Начал с DocBook ещё, но сейчас основной формат - markdown, а DocBook работает чанкером для html (ну и кое-где PDF из него тоже делается. Сборка документов на мейкфайлах, типа make pdf. Удобно разбивать портянки Markdown-а на смысловые куски простейшим препроцессором gpp

undertaker ★★ ()
Ответ на: комментарий от undertaker

Так-то я у себя в отделе давно завёл систему подготовки документации по принципу «единого источника» (вдохновляясь, среди прочих, статьями AP).

Б-же, вот это память у людей!

AP ★★★★★ ()
Ответ на: комментарий от ringill

Без особых причин, просто docx исторически прижился и никто не жалуется. Можно приделать и сохранялку в ODT, аналогично тому, как сейчас сохраняется в PDF.

А PDF зачем перегонять-то в DOCX (?job=build_docx) ???

https://gitlab.iaaras.ru/iaaras/gostdown/-/jobs/artifacts/master/file/demo-report.pdf?job=build_docx

P.S.: "... и программной документации (docx)..." , — что ЭТО?

atsym ★★★★★ ()

Github как онлайн Desktop Publishing платформа: Markdown + Pandoc + Travis CI = PDF (и/или LaTeX)

Опционально — работа через GitLab и автоматическая удалённая компиляция.

Я вот недавно трэд об автоматизации c помощью Github+Travis CI создавал. Там есть много полезных ссылок
>>> Github как онлайн Desktop Publishing платформа: Markdown + Pandoc + Travis CI = PDF (и/или LaTeX)

P.S.: ringill, может будет интерестно покрутить htmldoc вместо Pandoc

atsym ★★★★★ ()
Последнее исправление: atsym (всего исправлений: 1)

Необходима ОС Windows, преимущественно по причине использования COM. (Остальные вещи в той или иной степени существуют и на Linux и Mac OS X.) Тем не менее, Windows необходима лишь для автоматической вёрстки (в т.ч. удалённой, см. ниже),

ringill, кстати, PowerShell есть же и под Linux
>>> https://github.com/PowerShell/PowerShell/releases

А без MS Word конвертировать Markdown в PDF (с помощью твоих батников и PowerShell) под Linux не получится?

P.S.: выхлоп в DOCX мне не ненужен.

atsym ★★★★★ ()
Ответ на: комментарий от atsym

А PDF зачем перегонять-то в DOCX (?job=build_docx) ???

Это docx перегоняется в PDF. build_docx — это джоб, который производит, вопреки названию, не только demo-report.docx, но и demo-report.pdf. Ссылка, составленная таким образом, выводит на заданный артефакт джоба для последней успешной сборки.

"... и программной документации (docx)..." , — что ЭТО?

Комплект документов по ЕСПД.

может будет интерестно покрутить htmldoc вместо Pandoc

Вряд ли получится. Нам ведь нужны колонтитулы и латеховские формулы.

кстати, PowerShell есть же и под Linux

Да, но COM под Linux нет, к сожалению. Как и нативного Word. Есть Word под Wine (включая CrossOver Office), но и там фактически нет COM.

А без MS Word конвертировать Markdown в PDF (с помощью твоих батников и PowerShell) под Linux не получится?

При отказе от Word потребуется другой рендерер PDF. Из всего, что есть, только LaTeX может обеспечить требуемый результат. Но шаблонов и стилей для LaTeX в GOSTdown нет. (Нашей основной целью был docx, т.к. его требуют заказчики.) В принципе вариант Markdown — LaTeX — PDF возможен.

ringill ()
Ответ на: комментарий от ringill

только LaTeX может обеспечить требуемый результат.

А на htmldoc смотрел?
>>> hhttps://github.com/michaelrsweet/htmldoc

Он минималистычный (в отличии от дистрибутивов LaTeX) и поддерживает Markdown -> PDF. Возможно нужно будет слегка его пропатчить для получения нужного результата, но зато сразу уберётся куча зависимостей

atsym ★★★★★ ()
Ответ на: комментарий от atsym

Кажется, патчить придётся слишком много.

Попробовал преобразовать Markdown в PDF. Изображений и кириллицы нет (хотя, возможно, их реально включить). В мануале забавное предупреждение: «Note: UTF-8 support is limited to the first 128 Unicode characters found in the input». Формул нет в принципе. Опций для установки своего шрифта нет. Таблицы отображаются не все (а те, что отображаются, делают это криво).

Отсутствие формул = блокер.

ringill ()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.