Облегченные языки разметки ((multi)markdown vs ReST vs asciidoc vs всё остальное)
Модератор: Модераторы разделов
- Hephaestus
- Сообщения: 3729
- Статус: Многоуважаемый джинн...
- ОС: Slackware64-14.1/14.2
- Контактная информация:
Облегченные языки разметки
Случилось мне на днях написать текст на техническую тему. How-to для
пользователя.
Ну, думаю, будет на пару страниц (в итоге вышло страниц шесть, но дело не в
этом).
А там помимо текста примеры консольных команд, имена программ, несколько
картинок, формул. Ну... оформить бы по-человечески.
Ради нескольких формул расчехлять LaTeX?
Я им всерьёз не пользовался со времен диплома. И посему пачки преамбул на все случаи жизни нету под рукой.
Кроме того, формат латеховскх команд типа \samecommand{текст}
никогда не был удобным для меня. Расставлять эту разметку по всему тексту... Короче, возиться с этим откровенно лень.
И тут я вспоминаю о "концепции единого источника".
Универсальная вещь, из одного файла позволяет получать разные форматы.
Неплохо бы освоить, пригодится.
В связи с этим вспоминается прежде всего DocBook. Который по сути есть XML, и из которого якобы можно потом получить всё, что угодно - хоть html, хоть tex-файл, хоть ещё чего.
Вроде бы замечательная идея, xml прекасен для машинной обработки, но писать руками xml-разметку... У-ф-ф-ф! Лучше уж LaTeX тогда.
Нет, я конечно, справлюсь и с xml, я не раз писал xml-файлы для
dvdauthor, и когда-то писал конвертер модулей для sword,
одним словом, xml-разметкой меня не напугаешь.
Но не могу сказать, что именно об этом я мечтал.
Стало быть, и разметку надо, и возиться лень.
Вроде бы как раз для таких случаев у нас есть языки облегченной разметки, которые
позволяют создавать файлы, одинаково пригодные и для чтения человеком и для
конвертации в другие форматы.
Я когда-то щупал markdown, потом asciidoc.
А в этот раз решил попробовать restructuredtext. Он и формулы умеет в
TeX-нотации.
Написал текст. С разметкой. Проверки ради сделал из него html.
Вроде нормально получилось, даже формулы выглядели как формулы.
Ну, думаю, надо сделать PDF. Конвертнул в tex-файл.
Но получить из него PDF не удалось без доводки напильником.
Вот это уже плохо. Писать текст с разметкой, перегонять в tex-файл, а потом
ковырять ещё и этот tex-файл... Не, не пойдет.
И конвертации в DocBook там как-то не оказалось из коробки.
Есть какой-то xml. Это значит перегонять в него, а потом этот xml превращать в
другой xml, который уже DocBook. Можно, конечно, но как-то не то.
Tex-файл я конечно подпилил и PDF из него получил.
Но решил всё-таки пощупать что-то ещё.
Вернулся к asciidoc. Там и DocBook заявлен. И wordpress есть.
И возможности разметки там шире, например, четыре уровня заголовков, а в ReST
вроде только три.
Думаю, надо перегнать свой rst-файл в asciidoc.
Чем перегнать - непонятно. Порыскал по сети...
Попробовал pandoc. Он мне чего-то перегнал.
Оказалось, криво. Пришлось допиливать руками.
В asciidoc не понравилось то, что файл не имеет собственного расширения.
В ReST файлы имеют расширение rst, а в asciidoc - txt.
Поэтому в редакторе подстветка синтаксиса не подхватывается.
Начал ковырять asciidoc на примере того же своего файла. Для проверки гнал в html.
С формулами дело обстоит иначе, чем в ReST.
Формулы с выключкой как-то не получилось по уму сделать.
В DocBook вроде перегоняет, но насколько хорошо, пока не проверял.
Вот не знаю, у DocBook валидатор есть?
Пока искал да выбирал, натыкался на множество всяких статей и сравнительных таблиц вроде этой
В итоге, не знаю, на чём остановиться.
А в соседней теме вот про multimarkdown упоминалось. Его я вообще ни разу не видел.
В общем, хочу чтобы было
LML -> DocBook -> {pdf, html, etc..}
Ну или аналогичную схему с "единым источником".
И ещё желательно, чтобы мой любимый vim нормально поддерживал подсветку.
А какие LML вы использовали?
Что (не)понравилось?
На чём остановили свой выбор?
Прошу высказываться.
пользователя.
Ну, думаю, будет на пару страниц (в итоге вышло страниц шесть, но дело не в
этом).
А там помимо текста примеры консольных команд, имена программ, несколько
картинок, формул. Ну... оформить бы по-человечески.
Ради нескольких формул расчехлять LaTeX?
Я им всерьёз не пользовался со времен диплома. И посему пачки преамбул на все случаи жизни нету под рукой.
Кроме того, формат латеховскх команд типа \samecommand{текст}
никогда не был удобным для меня. Расставлять эту разметку по всему тексту... Короче, возиться с этим откровенно лень.
И тут я вспоминаю о "концепции единого источника".
Универсальная вещь, из одного файла позволяет получать разные форматы.
Неплохо бы освоить, пригодится.
В связи с этим вспоминается прежде всего DocBook. Который по сути есть XML, и из которого якобы можно потом получить всё, что угодно - хоть html, хоть tex-файл, хоть ещё чего.
Вроде бы замечательная идея, xml прекасен для машинной обработки, но писать руками xml-разметку... У-ф-ф-ф! Лучше уж LaTeX тогда.
Нет, я конечно, справлюсь и с xml, я не раз писал xml-файлы для
dvdauthor, и когда-то писал конвертер модулей для sword,
одним словом, xml-разметкой меня не напугаешь.
Но не могу сказать, что именно об этом я мечтал.
Стало быть, и разметку надо, и возиться лень.
Вроде бы как раз для таких случаев у нас есть языки облегченной разметки, которые
позволяют создавать файлы, одинаково пригодные и для чтения человеком и для
конвертации в другие форматы.
Я когда-то щупал markdown, потом asciidoc.
А в этот раз решил попробовать restructuredtext. Он и формулы умеет в
TeX-нотации.
Написал текст. С разметкой. Проверки ради сделал из него html.
Вроде нормально получилось, даже формулы выглядели как формулы.
Ну, думаю, надо сделать PDF. Конвертнул в tex-файл.
Но получить из него PDF не удалось без доводки напильником.
Вот это уже плохо. Писать текст с разметкой, перегонять в tex-файл, а потом
ковырять ещё и этот tex-файл... Не, не пойдет.
И конвертации в DocBook там как-то не оказалось из коробки.
Есть какой-то xml. Это значит перегонять в него, а потом этот xml превращать в
другой xml, который уже DocBook. Можно, конечно, но как-то не то.
Tex-файл я конечно подпилил и PDF из него получил.
Но решил всё-таки пощупать что-то ещё.
Вернулся к asciidoc. Там и DocBook заявлен. И wordpress есть.
И возможности разметки там шире, например, четыре уровня заголовков, а в ReST
вроде только три.
Думаю, надо перегнать свой rst-файл в asciidoc.
Чем перегнать - непонятно. Порыскал по сети...
Попробовал pandoc. Он мне чего-то перегнал.
Оказалось, криво. Пришлось допиливать руками.
В asciidoc не понравилось то, что файл не имеет собственного расширения.
В ReST файлы имеют расширение rst, а в asciidoc - txt.
Поэтому в редакторе подстветка синтаксиса не подхватывается.
Начал ковырять asciidoc на примере того же своего файла. Для проверки гнал в html.
С формулами дело обстоит иначе, чем в ReST.
Формулы с выключкой как-то не получилось по уму сделать.
В DocBook вроде перегоняет, но насколько хорошо, пока не проверял.
Вот не знаю, у DocBook валидатор есть?
Пока искал да выбирал, натыкался на множество всяких статей и сравнительных таблиц вроде этой
В итоге, не знаю, на чём остановиться.
А в соседней теме вот про multimarkdown упоминалось. Его я вообще ни разу не видел.
В общем, хочу чтобы было
LML -> DocBook -> {pdf, html, etc..}
Ну или аналогичную схему с "единым источником".
И ещё желательно, чтобы мой любимый vim нормально поддерживал подсветку.
А какие LML вы использовали?
Что (не)понравилось?
На чём остановили свой выбор?
Прошу высказываться.
- Bizdelnick
- Модератор
- Сообщения: 20791
- Статус: nulla salus bello
- ОС: Debian GNU/Linux
Re: Облегченные языки разметки
Hephaestus писал(а): ↑17.10.2015 12:44И тут я вспоминаю о "концепции единого источника".
Универсальная вещь, из одного файла позволяет получать разные форматы.
halibut
Hephaestus писал(а): ↑17.10.2015 12:44xml прекасен для машинной обработки, но писать руками xml-разметку...
lyx
Пишите правильно:
в консоли вку́пе (с чем-либо) в общем вообще | в течение (часа) новичок нюанс по умолчанию | приемлемо проблема пробовать трафик |
- Hephaestus
- Сообщения: 3729
- Статус: Многоуважаемый джинн...
- ОС: Slackware64-14.1/14.2
- Контактная информация:
Re: Облегченные языки разметки
Глянул краем глаза halibut.
Честно говоря, не очень.
Во-первых, набор выходных форматов, прямо скажем, скромный.
А во-вторых, насколько я понял, разметка там сродни LaTeX - сплошные бекслеши, фигурные скобки...
а я как раз от этого хочу уйти, ибо ставить эти знаки во время написания текста весьма неудобно, а расставлять разметку после написания текста - это ещё неудобнее.
Это существенный недостаток LaTeX, несмотря на все его замечательные возможности.
Если же Вы это предлагаете мне в качестве варианта - однозначно нет.
Я когда-то его пробовал, для LaTeX, кстати. Через какое-то время понял, что TeX-овскую разметку удобней набирать вручную.
Сейчас пощупал его ещё раз...
Ну, какой может быть lyx после vim'а? Правильно, никакой.
Поэтому и рассматривается вариант LML -> DocBook -> всё остальное.
LML тем и хорош, что позволяет набирать текст практически в любом редакторе, формат вроде бы и текстовый (человекочитаемый) и в то же время с разметкой, которую, кстати, можно делать прямо во время набора (не отвлекает).
Честно говоря, не очень.
Во-первых, набор выходных форматов, прямо скажем, скромный.
А во-вторых, насколько я понял, разметка там сродни LaTeX - сплошные бекслеши, фигурные скобки...
а я как раз от этого хочу уйти, ибо ставить эти знаки во время написания текста весьма неудобно, а расставлять разметку после написания текста - это ещё неудобнее.
Это существенный недостаток LaTeX, несмотря на все его замечательные возможности.
Если это просто замечание на тему, что можно набирать и сохранять в xml и, в частности, в DocBook - да, наверное можно.
Если же Вы это предлагаете мне в качестве варианта - однозначно нет.
Я когда-то его пробовал, для LaTeX, кстати. Через какое-то время понял, что TeX-овскую разметку удобней набирать вручную.
Сейчас пощупал его ещё раз...
Ну, какой может быть lyx после vim'а? Правильно, никакой.
Поэтому и рассматривается вариант LML -> DocBook -> всё остальное.
LML тем и хорош, что позволяет набирать текст практически в любом редакторе, формат вроде бы и текстовый (человекочитаемый) и в то же время с разметкой, которую, кстати, можно делать прямо во время набора (не отвлекает).
- Bizdelnick
- Модератор
- Сообщения: 20791
- Статус: nulla salus bello
- ОС: Debian GNU/Linux
Re: Облегченные языки разметки
Других сильно распространённых вариантов разметки кроме TeX-образной или XML я и не знаю. groff разве что, но это уж совсем жесть. markdown довольно убог по возможностям, а вариации на его тему типа ResT хотя и добавляют функционала, но много теряют в плане читаемости. Из того, что не упоминалось выше, в голову приходит разве что POD, но там никаких формул нет.
Пишите правильно:
в консоли вку́пе (с чем-либо) в общем вообще | в течение (часа) новичок нюанс по умолчанию | приемлемо проблема пробовать трафик |
- Bizdelnick
- Модератор
- Сообщения: 20791
- Статус: nulla salus bello
- ОС: Debian GNU/Linux
Re: Облегченные языки разметки
DocBook 5 — это XML, схемы в наличии имеются, а значит можно использовать утилиты для валидации XML. xmlstarlet, например.
Пишите правильно:
в консоли вку́пе (с чем-либо) в общем вообще | в течение (часа) новичок нюанс по умолчанию | приемлемо проблема пробовать трафик |
- Hephaestus
- Сообщения: 3729
- Статус: Многоуважаемый джинн...
- ОС: Slackware64-14.1/14.2
- Контактная информация:
Re: Облегченные языки разметки
А их и не надо. DocBook (то есть XML) в качестве "единого источника" подходит вполне.Bizdelnick писал(а): ↑17.10.2015 23:46Других сильно распространённых вариантов разметки кроме TeX-образной или XML я и не знаю.
Вопрос в том, чтобы выстроить цепочку LML ->DocBook -> конечный формат.
Вот первое звено я как раз и не могу выбрать.
Помню. Пробовал когда-то. А что можете сказать о multimarkdown?
Вы его упоминали в соседней теме, а я вот хотел пощупать, да никак не доберусь его собрать.
Есть http://fletcherpenney.net/multimarkdown/
который предлагает исходники на https://github.com/fletcher/MultiMarkdown-4
А есть ещё https://github.com/fletcher/MultiMarkdown
который тоже что-то такое предлагает.
Кто из них правильный-то?
UPD:А, всё, понял.
https://github.com/fletcher/MultiMarkdown не поддерживается и отсылает на http://fletcherpenney.net/multimarkdown/
А кроме этого есть http://multimarkdown.com, но там вроде редактор, а не сам mmd.
Ну, я бы не сказал. Я сначала разметил текст именно в ReST. С читаемостью всё было нормально. И с формулами тоже.Bizdelnick писал(а): ↑17.10.2015 23:46вариации на его тему типа ResT хотя и добавляют функционала, но много теряют в плане читаемости.
Но как-то не очень было с выходными форматами.
asciidoc в этом смысле мне понравился больше.
А кто-то, наоборот, хвалит Sphinx, (где как раз ReST) и утверждает, что остальным до него далеко и сравниться может разве что asciidoc.
Вот я и не могу сделать выбор. Вроде и asciidoc - хорошо, и ReST - неплохо.
А тут ещё multimarkdown, пока не опробованный, но многообещающий.
- Hephaestus
- Сообщения: 3729
- Статус: Многоуважаемый джинн...
- ОС: Slackware64-14.1/14.2
- Контактная информация:
Re: Облегченные языки разметки
Потыкал веточкой multimarkdown.
Он, оказывается, никаким боком не умеет docbook.
Плюс посмотрел повнимательнее sphinx (который ReST).
Там тоже docbook отсутствует. Так что получить docbook из ReST - это значит, гнать в xml, а оттуда - в другой xml (который уже docbook).
Посему, пока единственным приемлемым вариантом остаётся asciidoc.
Ну, может, ещё какой LML всплывёт.
P.S. Кстати, vim нормально подхватывает синтаксис asciidoc, если расширение файла .asciidoc.
И файл синтаксиса присутствует в составе vim.
Похоже, что неплохо допилили всё это хозяйство, с тех пор, как я это пробовал.
Он, оказывается, никаким боком не умеет docbook.
Плюс посмотрел повнимательнее sphinx (который ReST).
Там тоже docbook отсутствует. Так что получить docbook из ReST - это значит, гнать в xml, а оттуда - в другой xml (который уже docbook).
Посему, пока единственным приемлемым вариантом остаётся asciidoc.
Ну, может, ещё какой LML всплывёт.
P.S. Кстати, vim нормально подхватывает синтаксис asciidoc, если расширение файла .asciidoc.
И файл синтаксиса присутствует в составе vim.
Похоже, что неплохо допилили всё это хозяйство, с тех пор, как я это пробовал.
- Bizdelnick
- Модератор
- Сообщения: 20791
- Статус: nulla salus bello
- ОС: Debian GNU/Linux
Re: Облегченные языки разметки
Перегонять из чего-то в docbook — занятие довольно бессмысленное. Никакой LML по возможностям с ним не сравнится.
Пишите правильно:
в консоли вку́пе (с чем-либо) в общем вообще | в течение (часа) новичок нюанс по умолчанию | приемлемо проблема пробовать трафик |
Re: Облегченные языки разметки
Hephaestus
А какие требования то есть? Может проще будет свой условный формат и скрипт на perl/python/ruby/etc?
А какие требования то есть? Может проще будет свой условный формат и скрипт на perl/python/ruby/etc?
- Hephaestus
- Сообщения: 3729
- Статус: Многоуважаемый джинн...
- ОС: Slackware64-14.1/14.2
- Контактная информация:
Re: Облегченные языки разметки
Не более, чем само использование docbook.Bizdelnick писал(а): ↑18.10.2015 12:43Перегонять из чего-то в docbook — занятие довольно бессмысленное.
Да, кто-то набивает xml руками. Но не все.
Стало быть, либо спец. редактор, либо некий формат, который гонят в docbook.
Спец. редактор в моём случае отпадает, остаётся промежуточный формат.
И я не первый, кто идёт этим путём.
А lyx сравнится?
Можно взять LML и перегнать в docbook, можно взять редактор и сохранить как docbook. Какая разница?
Единственный способ задействовать все возможности docbook - это писать сразу в xml.
Любые другие варианты, скорее всего, не дадут 100% возможностей. Но их и не надо все 100%.
Ничего особенного.
С точки зрения оформления текста нужны заголовки, маркированные/нумерованные списки, рисунки, таблицы, листинги, формулы. Ну, может быть, ещё какие-нибудь сноски/примечания.
Вполне обычный набор. Кстати, asciidoc его вполне покрывает.
С точки зрения хранения нужен некий формат, из которого можно при необходимости получить другие форматы.
Я из таких знаю только XML-разметку. Вот Bizdelnick выше подсказал ещё halibut, где TeX-разметка.
На мой взгляд, XML подходит больше, поскольку именно с прицелом на преобразования в разные форматы он и создавался. Значит, XML. А раз так, то сам собой напрашивается DocBook.
А LML мне нужен потому, что сильно лень набирать руками xml-разметку, а тем более, TeX-разметку.
Я это вполне могу делать, но лень.
Кстати, попутно поясню, зачем DocBook и почему не делать напрямую asciidoc -> pdf или asciidoc -> html, благо, он это умеет.
Во-первых, XML более приспособлен для машинной обработки, во-вторых, предполагаю более высокое качество преобразования в другие форматы.
Сотворить свой формат + инструмент будет проще, чем использовать уже готовый? Чем же это проще?
И чем это решение будет лучше того же asciidoc?
Если уж писать своё, то с прицелом на тот же DocBook, только с более полной поддержкой.
Хотя не вижу в этом особого смысла.
- Bizdelnick
- Модератор
- Сообщения: 20791
- Статус: nulla salus bello
- ОС: Debian GNU/Linux
Re: Облегченные языки разметки
Hephaestus писал(а): ↑18.10.2015 16:05Не более, чем само использование docbook.
Да, кто-то набивает xml руками. Но не все.
Стало быть, либо спец. редактор, либо некий формат, который гонят в docbook.
Не понимаю. Зачем нужно что-то гнать в docbook, если он сам — лишь исходный формат для генерации других?
А что за обработка такая требуется? Полновесный парсер XML — не такая уж простая штука, а примитивными средствами типа регулярок с ним не справишься.
Hephaestus писал(а): ↑18.10.2015 16:05во-вторых, предполагаю более высокое качество преобразования в другие форматы
Я бы поэкспериментировал прежде чем предполагать.
P. S. Почитал немножко про asciidoc — похоже крутая штука, надо запомнить на случай, если понадобится.
Пишите правильно:
в консоли вку́пе (с чем-либо) в общем вообще | в течение (часа) новичок нюанс по умолчанию | приемлемо проблема пробовать трафик |
Re: Облегченные языки разметки
Hephaestus писал(а): ↑18.10.2015 16:05Ничего особенного.
С точки зрения оформления текста нужны заголовки, маркированные/нумерованные списки, рисунки, таблицы, листинги, формулы. Ну, может быть, ещё какие-нибудь сноски/примечания.
Вполне обычный набор. Кстати, asciidoc его вполне покрывает.
Тогда почему не использовать asciidoc, а подсветка в vim'е есть, достаточно набрать :set syntax=asciidoc?
Hephaestus писал(а): ↑18.10.2015 16:05Сотворить свой формат + инструмент будет проще, чем использовать уже готовый? Чем же это проще?
И чем это решение будет лучше того же asciidoc?
Если уж писать своё, то с прицелом на тот же DocBook, только с более полной поддержкой.
Хотя не вижу в этом особого смысла.
Ну, просто что-то всё Вам не нравится, вот и подумалось, что может нужно что-то своё.
А так, можно взять, например, slim и писать вот так:
Код: Выделить всё
book
title book name
chapter id="chapter_1"
title Chapter 1
para Hello, World!
para This is
very long
text
chapter id="chapter_2"
title Chpater 2
para Some text
Потом сделать slimrb a.slim > a.dbk и получить нормальный DocBook XML на выходе, если дело только в XML.
- Hephaestus
- Сообщения: 3729
- Статус: Многоуважаемый джинн...
- ОС: Slackware64-14.1/14.2
- Контактная информация:
Re: Облегченные языки разметки
Его не слишком удобно набирать. Теги отвлекают от основного текста.Bizdelnick писал(а): ↑18.10.2015 16:26Зачем нужно что-то гнать в docbook, если он сам — лишь исходный формат для генерации других?
LML позволяет набирать текст в любом редакторе и при этом файл одинаково пригоден и для конвертации, и для чтения человеком. Вроде бы и тегов нет, и в то же время разметка есть.
В этом его сила. Этим он меня и привлекает.
Для некоторых LML есть даже viewer, позволяющий смотреть результаты разметки.
А для asciidoc есть asciidoctor - текстовый процессор. Но это мне не очень надо.
Ну, xltproc + xsl вроде справляются.Bizdelnick писал(а): ↑18.10.2015 16:26А что за обработка такая требуется? Полновесный парсер XML — не такая уж простая штука, а примитивными средствами типа регулярок с ним не справишься.
А обработка нужна самая обыкновенная: получить из xml-файла нужный формат.
Разумеется, можно из asciidoc получить нужный формат, но у docbook с этим обстоит несколько лучше.
Если бы внимательно прочитали тему, Вы бы знали, что я совсем не против использования asciidoc и о подстветке мне известно. Более того, vim автоматически включает подсветку, елси расширение файла .asciidoc.
А docbook мне нужен потому что это:
разные форматы из единого источника
данные отдельно от оформления
стандарт де-факто для документации.
С чего Вы взяли, что мне всё не нравится?
markdown, multimarkdown и ReST я действительно отсеял, ибо изначально нужен был docbook, а у них с этим туго.
А вот asciidoc вполне соответствует требованиям. У него в прошлом были недостатки, которые не позволяли нормально пользоваться (проблемы с русским языком, например), но с тех пор его вроде бы допилили.
Так что этот инструмент вполне неплох.
Имеется совокупность факторов:
желание использовать docbook
нежелание вручную набирать xml-разметку или TeX-разметку
нежелание отказываться от любимого текстового редактора
Это приводит меня к такой схеме: хранить текст в xml, но набирать его в чём-то другом.
Таким образом, выстраивается цепочка LML ->docbook.
Из просмотренных мной LML, asciidoc оказался наиболее подходящим.
Насколько это удачно, покажет время.
Однако я не исключаю, что есть другие подходящие LML.
Поэтому я и создал тему: вдруг есть ещё какой-то, о котором я не знаю.
- Bizdelnick
- Модератор
- Сообщения: 20791
- Статус: nulla salus bello
- ОС: Debian GNU/Linux
Re: Облегченные языки разметки
Hephaestus писал(а): ↑18.10.2015 17:50Его не слишком удобно набирать. Теги отвлекают от основного текста.
LML позволяет набирать текст в любом редакторе и при этом файл одинаково пригоден и для конвертации, и для чтения человеком. Вроде бы и тегов нет, и в то же время разметка есть.
В этом его сила. Этим он меня и привлекает.
Да нет, это понятно. Непонятно, почему обязательным условием ставится возможность преобразования в docbook как промежуточный формат. Значение имеет ведь только конечный результат.
Пишите правильно:
в консоли вку́пе (с чем-либо) в общем вообще | в течение (часа) новичок нюанс по умолчанию | приемлемо проблема пробовать трафик |
Re: Облегченные языки разметки
Ну, про asciidoc Вы писали, что там формулы с выключкой что-то не получилось, вот и показалось, что не подошёл ни один, и ищете что-то новое. Ладно, не буду лезть в тему, в LML не разбираюсь, пользуюсь XeTeX.
- Hephaestus
- Сообщения: 3729
- Статус: Многоуважаемый джинн...
- ОС: Slackware64-14.1/14.2
- Контактная информация:
Re: Облегченные языки разметки
То есть, почему я прицепился именно к docbook?Bizdelnick писал(а): ↑18.10.2015 18:22Непонятно, почему обязательным условием ставится возможность преобразования в docbook как промежуточный формат.
Отвечаю: Поскольку речь идёт о технических текстах, то нужен был формат, который, скажем так, под это заточен, но также нужна была возможность при случае получить другие форматы.
docbook вроде бы создан именно для таких случаев.
Ну какой формат позволяет получить из одного и того же файла html, pdf, chm, txt?
Может быть, такой и найдется, но docbook это умеет точно.
На просторах сети в различных статьях формату docbook приписывают следующие преимущества:
Кроме того, заявляется, что docbook стал стандартом де-факто для технической документации.Возможность генерации документов в разном формате (онлайновых, печатных, help-файлов и т.д.) из единого исходного текста.
Авторам не приходится заботиться об оформлении стиль верстки выходных документов задается программно.
Поддержка коллективной работы над документацией, возможность повторного использования документов.
Возможность создавать собственные расширения и разрабатывать на основе DocBook специализированные приложения.
Мне это показалось достойным внимания и я решил, что будет нелишним это дело освоить.
Когда-то раньше я уже его щупал, мне попадалось в сети что-то вроде how-to, где на конкретном примере показывался весь процесс "от и до" - от создания xml, до получения из него pdf. Вот жаль, что сейчас найти не могу. Возможно, это было из документации к предыдущей версии.
Я тогда это опробовал, и у меня даже что-то получилось.
В целом идея произвела хорошее впечатление, единственное, что огорчало - необходимость написания текста с xml-разметкой. Поэтому сейчас я решил подойти немного с другой стороны, задействовав LML.
Ах, это...
Да это я просто сравнивал два LML, и для быстрой проверки сделал вывод в html.
В одном формулы были с выключкой, в другом - нет. Но это несущественно, поскольку основная цель для меня - docbook. А LML - всего лишь вспомогательное средство.
- Bizdelnick
- Модератор
- Сообщения: 20791
- Статус: nulla salus bello
- ОС: Debian GNU/Linux
Re: Облегченные языки разметки
Hephaestus писал(а): ↑18.10.2015 22:24Ну какой формат позволяет получить из одного и того же файла html, pdf, chm, txt?
Тот же halibut, например. Если бы он устраивал в плане синтаксиса, была бы невозможность конвертации в docbook критичной?
А если убрать из списка CHM (который при необходимости можно сделать из HTML), то список подходящих форматов будет очень большим.
Hephaestus писал(а): ↑18.10.2015 22:24заявляется, что docbook стал стандартом де-факто для технической документации.
По-моему, слишком громко заявляется. Ну в редхате его используют (точнее основанный на нём publican, который добавляет возможность локализации), может ещё кое-где, но как-то особой массовости я не замечал. Благодаря stackexchange и github сейчас кругом markdown, и ReST мне частенько встречался, а вот docbook — не особо.
Пишите правильно:
в консоли вку́пе (с чем-либо) в общем вообще | в течение (часа) новичок нюанс по умолчанию | приемлемо проблема пробовать трафик |
- Hephaestus
- Сообщения: 3729
- Статус: Многоуважаемый джинн...
- ОС: Slackware64-14.1/14.2
- Контактная информация:
Re: Облегченные языки разметки
Я бы тогда обошелся LaTeX'ом и даже не помышлял бы ни о каких xml, честное слово.Bizdelnick писал(а): ↑18.10.2015 23:51Тот же halibut, например. Если бы он устраивал в плане синтаксиса
Впрочем, не исключено, что я остановлюсь на тех результатах, которые даёт LML (html, latex).
С настройками надо разобраться.
Кроме Редхата упоминаются IBM, Microsoft, Hewlett-Packard, Sun, Novell, WWW Consortium.Bizdelnick писал(а): ↑18.10.2015 23:51По-моему, слишком громко заявляется. Ну в редхате его используют (точнее основанный на нём publican, который добавляет возможность локализации), может ещё кое-где, но как-то особой массовости я не замечал.
Я, конечно, рискую наврать, но...
ещё OpenSuse, вроде бы. Справочная система какого-то проекта (KDE что ли?) построена как раз на этой штуке.
Это потому что markdown прост, как шпала. И кроме html от него ничего не нужно. Для блогеров и прочих сайтов - самое то.Bizdelnick писал(а): ↑18.10.2015 23:51Благодаря stackexchange и github сейчас кругом markdown, и ReST мне частенько встречался, а вот docbook — не особо.
А вот, скажем, здесь рассказывается, что docbook был выбран для разработки документации и объясняется, почему.
- Bizdelnick
- Модератор
- Сообщения: 20791
- Статус: nulla salus bello
- ОС: Debian GNU/Linux
Re: Облегченные языки разметки
Hephaestus писал(а): ↑19.10.2015 07:28А вот, скажем, здесь рассказывается, что docbook был выбран для разработки документации и объясняется, почему.
Я б его тоже выбрал для разработки документации. Особенно если документация будет разрабатываться не мной. ☺
Но это был бы именно первичный язык, а не промежуточный.
Пишите правильно:
в консоли вку́пе (с чем-либо) в общем вообще | в течение (часа) новичок нюанс по умолчанию | приемлемо проблема пробовать трафик |
Re: Облегченные языки разметки
Hephaestus писал(а): ↑17.10.2015 12:44А какие LML вы использовали?
Что (не)понравилось?
На чём остановили свой выбор?
Прошу высказываться.
Markdown и reST. Выбрал reST — иногда нужна простенькая табличка. Ещё он как-то лучше продуман, что ли: почти не приходится экранировать символы.
Но я не пишу формул. Только разные мелкие заметки для себя.
Re: Облегченные языки разметки
А движок mediawiki не умеет всего этого ? А с плагинами к нему ?
P.S. я именно спрашиваю - сам не смотрел
P.S. я именно спрашиваю - сам не смотрел
Molchanov Alexander (aka Xor)
*offtopic* - ololo!
*offtopic* - ololo!
- Hephaestus
- Сообщения: 3729
- Статус: Многоуважаемый джинн...
- ОС: Slackware64-14.1/14.2
- Контактная информация:
Re: Облегченные языки разметки
xorader
Я в первом посте приводил ссылку на сравнительную таблицу.
Там есть из mediawiki в числе прочих. Полюбопытствуйте.
Я в первом посте приводил ссылку на сравнительную таблицу.
Там есть из mediawiki в числе прочих. Полюбопытствуйте.
Re: Облегченные языки разметки
Ссылку нашёл, спасибо. Но я так и не понял чем mediawiki не устроила. К ней куча плагинов. По поводу docbook, вот гугль вывалил в первых же ссылках:
* https://www.mediawiki.org/wiki/Extension:XML_Bridge
* https://code.google.com/p/gwtwiki/wiki/Mediawiki2Docbook
* https://www.mediawiki.org/wiki/DocBook_XML_export
P.S. а экспорт из mediawiki в PDF и HTML там (чуть-ли не) встроено
* https://www.mediawiki.org/wiki/Extension:XML_Bridge
* https://code.google.com/p/gwtwiki/wiki/Mediawiki2Docbook
* https://www.mediawiki.org/wiki/DocBook_XML_export
P.S. а экспорт из mediawiki в PDF и HTML там (чуть-ли не) встроено
Molchanov Alexander (aka Xor)
*offtopic* - ololo!
*offtopic* - ololo!
- Hephaestus
- Сообщения: 3729
- Статус: Многоуважаемый джинн...
- ОС: Slackware64-14.1/14.2
- Контактная информация:
Re: Облегченные языки разметки
А я говорил, что она меня не устроила?
Я её и не пробовал.
Те варианты, которые я отсеял - их я опробовал. И по результатам отсеял.
А mediawiki я не пробовал, поэтому не могу сказать, чем лучше она или хуже.
Сравнительная таблица неполна, но если посмотреть хотя бы то, что есть, То у mediawiki нет никаких ощутимых преимуществ по сравнению с asciidoc. В лучшем случае - то же самое, а местами синтаксис asciidoc проще.
А вот у asciidoc против mediawiki, по крайней мере, одно преимущество есть: в слаке он присутствует из коробки.
mediawiki же надо ещё собрать, и делать это только для того, чтобы убедиться в отсутствии преимуществ, мне откровенно лень.