LINUX.ORG.RU

Посоветуйте методику/формат подготовки документации


0

0

Доброго времени суток!

Возникла потребность в облегчении задачи создания довольно объемной документации (текст, изображения, гиперссылки), которую можно было бы представлять в разных видах (последовательный текст, книга, HTML-странички, связанные гиперссылками и т.д.). При этом документация обладает определенной структурой (разделы, главы), есть ссылки, встречаются т.н. "врезки" - небольшие кусочки информации, привязываемые к другим местам структурированного текста. Т.е. что-то типа wiki, которую надо отображать и как книжку (с красивым разбиением на страницы, с врезками и т.д.), и как единый документ.

Вопрос: какие инструменты/методики/стандарты доступны в Линуксе для облегчения выполнения этой задачи? Желательно, чтобы существовало какое-то пошаговое руководство по знакомству, т.к. это для меня побочная задача и, вполне возможно, единичная, читать уйму описаний стандартов мне не досуг.

anonymous

Re: Посоветуйте методику/формат подготовки документации

DocBook?

ero-sennin ★★ ()

Re: Посоветуйте методику/формат подготовки документации

LaTeX или docbook.

dn2010 ★★★★★ ()

Re: Посоветуйте методику/формат подготовки документации

Из LaTeX'а можно получить HTML? С гиперссылками, сложной структурой а ля Wiki и прочим? Мне казалось, что TeX - он для подготовки книг создавался, поэтому я его не рассматривал. Я не прав? И кстати, как у него с картинками? Растровыми?

DocBook - слышал о нем. По-видимому, сделать обычную документацию в нем можно. А как насчет более сложных представлений? Скажем, в книжном представлении должны появляться красивые врезки, которые в представлении а ля стандартная документация должны быть просто ссылками. И аккуратная разбивка на страницы, заполнение колонтитулов и т.д.

anonymous ()

Re: Посоветуйте методику/формат подготовки документации

>Из LaTeX'а можно получить HTML?

Можно, man TtH.

>И кстати, как у него с картинками? Растровыми?

с pdflatex нормально с растровыми. Я предпочитаю eps для картинок.

>DocBook - слышал о нем. По-видимому, сделать обычную документацию в нем можно. А как насчет более сложных представлений? Скажем, в книжном представлении должны появляться красивые врезки, которые в представлении а ля стандартная документация должны быть просто ссылками. И аккуратная разбивка на страницы, заполнение колонтитулов и т.д.

Ну тогда верстай в скрибусе, там нормальный вендузоидный подход к вёрстке для тех, у кого указательный палец к мышке прирос.

dn2010 ★★★★★ ()

Re: Посоветуйте методику/формат подготовки документации

>Ну тогда верстай в скрибусе

Я не собираюсь ничего верстать. У меня возникла достаточно единичная задача подготовить некоторый массив информации и представить его в нескольких видах. Мне казалось, что я описал задачу.

Попробую еще раз. Есть некоторый объем информации, как текстовой, так и графической (растровые цветные изображения). Можно сказать, что эта информация разбивается на "темы" - относительно изолированные блоки, частично связанные между собой ссылками. Внутри тем есть структура - разделы, главы, комментарии. Наиболее близкая ассоциация у меня - Wiki. Требуется, во-первых, аккуратно это все представить в памяти компьютера, чтобы было удобно редактировать отдельные части массива информации или структуру организации массива, во-вторых, обеспечить несколько видов представления - как минимум что-то типа wiki (HTML) и книга (нормальное книжное представление с разбиением на страницы, оглавлением, врезками для отображения побочной информации и т.д.).

Вопрос: существуют ли подходящие инструменты? TeX - вкратце знаком, применял когда-то для подготовки математических документов. С учетом того, что в данном случае информация далека от технической или математической, а также сложившихся представлений о TeX, я его не рассматривал. Раз советуете, посмотрю на него попристальнее. DocBook - рассматривал в качестве варианта, но слишком мало о нем знаю, не представляю четко всех его возможностей.

Требуется какое-то вводное руководство, потому как описанная задача - побочная в рамках подготовки развлекательного мероприятия. И я ей не готов уделить много времени. Мои интересы очень далеки от оформления документации, верстки и т.д. Если есть удобный инструмент - замечательно, нет - жаль, но не смертельно.

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