Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Latex или DocBook
 
Появился вопрос - в чем разница применения Latex и DocBook? понимаю, что разный синтаксис и способ формирования документа. Нашел в интернете, что Latex больше для PDF, а DocBook для HTML.
 
Цитата
fs444 пишет:
Появился вопрос - в чем разница применения Latex и DocBook? понимаю, что разный синтаксис и способ формирования документа. Нашел в интернете, что Latex больше для PDF, а DocBook для HTML.
Глупости про формат.
Latex удобен, когда в документе есть необходимость ввода сложных формул и рисования диаграмм. DocBook и DITA для этих целей мало применим. Поэтому если вам, например, надо написать математический справочник и издать его, то лучше применять Latex. Для пользовательской документации вполне подойдет и, наверное, даже будет удобнее DocBook.
techwriter.ru.com
 
oXygen имеет поддержку не только DITA и Docbook, но и MathML (в связке как с DITA, так и с Docbook).
То есть, позволяет создавать и публиковать в HTML и в PDF документы с DITA или Docbook-разметкой, содержащие математические формулы в формате MathML .
Изменено: Виктор Фигурнов - 17.10.2014 10:05:15
 
Цитата
Виктор Фигурнов пишет:
То есть, позволяет создавать и публиковать в HTML
Только не всеми браузерами поддерживается, насколько я знаю.
techwriter.ru.com
 
Цитата
techwriter пишет:
DocBook и DITA для этих целей мало применим.
Все плагины есть. Редакторы тоже поддерживают.
Цитата
techwriter пишет:
Только не всеми браузерами поддерживается, насколько я знаю.
Это проблемы формата, а не инструмента, так что и латекс и докбук подойдут для pdf.  
 
А почему не сделать формулы картинкой ? Можно не PNG/JPG, а полноценный SVG использовать.
Вставляй куда хочешь, отобразится везде. Редактировать можно в любом текстовом редакторе. И нет геморроя с форматами )
 
Цитата
ADVANCED пишет:
А почему не сделать формулы картинкой ?
Угу. Очень "удобно".
techwriter.ru.com
 
Цитата
techwriter пишет:
Угу. Очень "удобно".
иногда это быстрее, чем с Latex разобраться, тем более по нему очень мало информации в Интернете.
 
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
А почему не сделать формулы картинкой ?
Угу. Очень "удобно".
в кавычках - сарказм?
А что не удобного то? Я вот ни разу не встречал формулы в документации и ни разу не писал их. В учебниках видел только. В картинке формула будет или нет, не важно.
Не думаю что формулу нужно часто редактировать. Что неудобного?  Скриншоты ведь делаются в виде картинок, а не в виде куска html с кнопочками и надписми
 
Цитата
ADVANCED пишет:
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
А почему не сделать формулы картинкой ?
Угу. Очень "удобно".
в кавычках - сарказм?
А что не удобного то? Я вот ни разу не встречал формулы в документации и ни разу не писал их. В учебниках видел только. В картинке формула будет или нет, не важно.
Не думаю что формулу нужно часто редактировать. Что неудобного? Скриншоты ведь делаются в виде картинок, а не в виде куска html с кнопочками и надписми
Потому что ты писал только документацию к бизнес-приложениям и никаким другим.
Например, у меня был фрилансерский проект по разработке онлайн-справки по работе с математическим онлайн-редактором. У этого редактора была куча функционала, который позволял писать и редактировать научные и технические статьи. Он был предназначен для преподавателей технических вузов. Возникает вопрос, совсем нетрудоемко, на твой взгляд, в этом случае отдельно писать формулы, их скриншотить и потом вставлять в текст? И, кстати, в чем ты их планируешь составлять? В "неудобном" ворде?
Изменено: techwriter - 21.10.2014 13:42:02
techwriter.ru.com
 
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
А почему не сделать формулы картинкой ?
Угу. Очень "удобно".
в кавычках - сарказм?
А что не удобного то? Я вот ни разу не встречал формулы в документации и ни разу не писал их. В учебниках видел только. В картинке формула будет или нет, не важно.
Не думаю что формулу нужно часто редактировать. Что неудобного? Скриншоты ведь делаются в виде картинок, а не в виде куска html с кнопочками и надписми
Потому что ты писал только документацию к бизнес-приложениям и никаким другим.
Например, у меня был фрилансерский проект по разработке онлайн-справки по работе с математическим онлайн-редактором. У этого редактора была куча функционала, который позволял писать и редактировать научные и технические статьи. Он был предназначен для преподавателей технических вузов. Возникает вопрос, совсем нетрудоемко, на твой взгляд, в этом случае отдельно писать формулы, их скриншотить и потом вставлять в текст? И, кстати, в чем ты их планируешь составлять? В "неудобном" ворде?
Этот пример не позволил мне понять зачем в онлайн-справке формулы. Но раз уж необходимость есть, то формулы создаются в описываемом "математическом онлайн-редакторе". С них делается скрин и вставляется в справку.
Пусть программа хоть траектории марсохода считает, если справка к программе должна содержать формулу, которая создается в этой программе, то надо ее там (в описываемой программе) создать и снять скрин. Если формула взята из какого-то нормативного акта, то ее нужно отскринить и вставить как картинку не задумываясь, т.к. менять ее нельзя (на то он и акт).
Изменено: ADVANCED - 21.10.2014 19:56:42
 
Цитата
techwriter пишет:
Например, у меня был фрилансерский проект по разработке онлайн-справки по работе с математическим онлайн-редактором. У этого редактора была куча функционала, который позволял писать и редактировать научные и технические статьи. Он был предназначен для преподавателей технических вузов.
Это такое же бизнес-приложение как и все остальные, только направленность у него не так широка, как большинство редакторов.  
Изменено: ADVANCED - 21.10.2014 19:37:55
 
Цитата
techwriter пишет:
Потому что ты писал только документацию к бизнес-приложениям и никаким другим.
Откуда такая информация?   :o  Тебя жестоко обманули  :)
 
Цитата
techwriter пишет:
Например, у меня был фрилансерский проект по разработке онлайн-справки по работе с математическим онлайн-редактором. У этого редактора была куча функционала, который позволял писать и редактировать научные и технические статьи. Он был предназначен для преподавателей технических вузов.
У меня был проект по разработке телематической платформы, где нужно было описать API модуля "расчетов", к которому должны обращаться сервисы сторонних разработчиков. И документация предназначалась именно для сторонних девелоперов, которым нужно понимать к чему обращаться, откуда ждать результаты расчетов и как все считается. Всего около тысячи операций, соответственно по несколько формул в каждой операции расчета.
Ни одной формулы не использовал, т.к. не математик и не факт, что читающий эти формулы поймет. Нарисовав формулу, совсем не очевидно, что она будет правильно осознана. А когда словами пишется, что на что умножается/делится/прибавляется/отнимается, какие коэффициенты применяются и откуда они берутся - вопросов не возникает.
Изменено: ADVANCED - 21.10.2014 19:48:47
 
Кому это нафик надо ?   wall-smile

Чем эта формула поможет пользователю/разработчику?




Даже если нужна, на картинке она круче смотрится, не поплывет ничего никуда, не перенесется, не сломается.  
 
Цитата
ADVANCED пишет:
Цитата
techwriter пишет:
Например, у меня был фрилансерский проект по разработке онлайн-справки по работе с математическим онлайн-редактором. У этого редактора была куча функционала, который позволял писать и редактировать научные и технические статьи. Он был предназначен для преподавателей технических вузов.
У меня был проект по разработке телематической платформы, где нужно было описать API модуля "расчетов", к которому должны обращаться сервисы сторонних разработчиков. И документация предназначалась именно для сторонних девелоперов, которым нужно понимать к чему обращаться, откуда ждать результаты расчетов и как все считается. Всего около тысячи операций, соответственно по несколько формул в каждой операции расчета.
Ни одной формулы не использовал, т.к. не математик и не факт, что читающий эти формулы поймет. Нарисовав формулу, совсем не очевидно, что она будет правильно осознана. А когда словами пишется, что на что умножается/делится/прибавляется/отнимается, какие коэффициенты применяются и откуда они берутся - вопросов не возникает.
Причем тут осознание формулы? Тебе надо написать примеры ввода формул в математическом редакторе, в котором используется свой язык.Ты можешь сколько угодно упираться в своем предположении, что все можно описать словами. Но факт остается фактом, необходимость ввода сложных формул в некоторой документации присутствует. Также это очень актуально при разработке содержательной конструкторской документации, где помимо текстового обоснования присутствуют математические расчеты. При этом ее основной формат - печатный. Для последнего варианта очень целесообразно использовать Latex, а не Docbook или DITA.
И повторю вопрос: ты для картинки где будешь формулу брать?  
techwriter.ru.com
 
Цитата
techwriter пишет:
И повторю вопрос: ты для картинки где будешь формулу брать?
Цитата
techwriter пишет:
Тебе надо написать примеры ввода формул в математическом редакторе, в котором используется свой язык.
Ты отвечаешь сама на свой вопрос.
 
Цитата
techwriter пишет:
Ты можешь сколько угодно упираться в своем предположении, что все можно описать словами.
Я не упираюсь. Я реально не могу понять, какова ценность: а) наличия формулы в документации в принципе; б) формулы в текстовом виде, а не в картинке.
Никогда не сталкивался. Для чего-то реально существует модуль MathML. Но для чего он, для меня это загадка.

Погуглил, нашел несколько примеров, но везде в них формулы сделаны в виде картинок. Такое ощущение, что это прикол какой-то )  
 
MathML это не модуль, а язык разметки. Mathematical Markup Language

В системах подготовки документации, имеющих поддержку формул (Madcap Flare, Adobe Framemaker), при генерации выходного представления по умолчанию формулы выводятся как картинки в HTML, и в векторном виде в PDF. Хотя и Madcap Flare и Adobe Framemaker 12 поддерживают MathML,  и вроде бы позволяют генерировать HTML включающий  MathML. Но поскольку сейчас далеко не все браузеры умеют показывать MathML (IE и Chrome не умеют), эта возможность вряд ли кем-то используется.
 
Цитата
techwriter пишет:
Но факт остается фактом, необходимость ввода сложных формул в некоторой документации присутствует. Также это очень актуально при разработке содержательной конструкторской документации, где помимо текстового обоснования присутствуют математические расчеты. При этом ее основной формат - печатный. Для последнего варианта очень целесообразно использовать Latex, а не Docbook или DITA.
И повторю вопрос: ты для картинки где будешь формулу брать?
А чем Вас H&M не устраивает? Вставка OLE-объектов Microsoft Equation 3.x или MathType (в CHM и HTML получаются gif-картинки).
 
Цитата
H&M User пишет:
Цитата
techwriter пишет:
Но факт остается фактом, необходимость ввода сложных формул в некоторой документации присутствует. Также это очень актуально при разработке содержательной конструкторской документации, где помимо текстового обоснования присутствуют математические расчеты. При этом ее основной формат - печатный. Для последнего варианта очень целесообразно использовать Latex, а не Docbook или DITA.
И повторю вопрос: ты для картинки где будешь формулу брать?
А чем Вас H&M не устраивает? Вставка OLE-объектов Microsoft Equation 3.x или MathType (в CHM и HTML получаются gif-картинки).
Я ничего против H&M не имею. Просто речь идёт о Docbook и Latex.
techwriter.ru.com
Страницы: 1
Ответить
Читают тему
Форма ответов
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить файлы
Отправить Отменить