LINUX.ORG.RU

В чём писать документацию?

 ,


1

1

В какой программе и в каком формате писать доки в Linux? Решил как все белые люди писать в LibreOffice с последующим экспортом в PDF, глянул на результат - плохо стало. Какие шрифты ни выбирай, всё равно буквы в итоге какие-то мохнатые уродцы.

Ответ на: комментарий от kovrik

+100500 за латех.

А осилить его очень легко: за пару недель он на начальном уровне осиливается при помощи Львовского. Еще где-то за полгода осиливается уже по-человечески при помощи Кнута.

Eddy_Em ☆☆☆☆☆
()
Ответ на: комментарий от chelovek-bugurt

По-умолчанию — dvi, но если будешь компилировать pdflatex'ом, получишь pdf.

Можешь для ознакомления у меня в ЖЖшке, например, посмотреть.

Eddy_Em ☆☆☆☆☆
()
Последнее исправление: Eddy_Em (всего исправлений: 1)
Ответ на: комментарий от Eddy_Em

Спасибо за наводку. Книжку скачал.
Поставлю плагин для vim'а и буду параллельно изучать и то, и другое :)

kovrik ★★★★★
()

Ну ты и кадр!

Сначала спрашиваешь, в чем нормальные люди документацию пишут, а потом еще и материшься!

Не хочешь — сиди в своем идиотском LO. Трать время на войну с ним.

Eddy_Em ☆☆☆☆☆
()
Ответ на: комментарий от Kalashnikov

А есть какой-нибудь хороший текстовый редактор с экспортом в html? Чтоб всё визуально было. LibreOffice Writer и в html жопно экспортирует - строки прыгают.

chelovek-bugurt
() автор топика
Ответ на: комментарий от Eddy_Em

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

chelovek-bugurt
() автор топика
Ответ на: комментарий от chelovek-bugurt

Нафига вообще PDF? Делай html или odt.

toney ★★★★★
()
Ответ на: комментарий от chelovek-bugurt

Ну, если ты не собираешься в дальнейшем заниматься документацией, можешь LyX потыкать — это кривой WYSIWYM-редактор для латеха. Уровень вхождения практически нулевой, зато результат — почти как при подготовке исходников вручную.

Eddy_Em ☆☆☆☆☆
()
Ответ на: комментарий от chelovek-bugurt

А зачем? Тебе и пары тегов из html2 хватит, имхо, проще руками.

Вообще, есть какой-то няшный генератор доков который генерит хтмл, доки Qt вроде им сделаны, попробуй погуглить.

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

за пару недель он на начальном уровне осиливается при помощи Львовского. Еще где-то за полгода осиливается уже по-человечески при помощи Кнута.

Ага. А работать кто будет эти полгода? А кушать / за квартиру платить? А самое главное КТО потом читать будет эту документацию, если стандарт де факто это .doс или .pdf если надо распечатать.

Alve ★★★★★
()
Ответ на: комментарий от chelovek-bugurt

Это не умею, то учить не буду...а хочешь, чтобы было красиво и все как у людей...
так не бывает :)

kovrik ★★★★★
()

LaTeX

Заготовку можно набить в org-mode, кстати

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

Ага. А работать кто будет эти полгода? А кушать / за квартиру платить? А самое главное КТО потом читать будет эту документацию, если стандарт де факто это .doс или .pdf если надо распечатать.

Так можно в .pdf сохранить, кто мешает-то?

kovrik ★★★★★
()
Ответ на: комментарий от chelovek-bugurt

Ну тогда визивиг. Он-лайн редакторов особенно полно, мне например нравится Редактор от Имперави. Гугл подсказывает что и десктопные есть.

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

Это можно попробовать. Правда, тут по зависимостям 90 пакетов весом в 300 метров вытягивается, но я подожду :)

chelovek-bugurt
() автор топика
Ответ на: комментарий от chelovek-bugurt

Японский городовой!

Если ты ничего не знаешь и не умеешь, о какой документации может идти речь?

Eddy_Em ☆☆☆☆☆
()
Ответ на: комментарий от chelovek-bugurt

Естественно: там texlive в зависимостях. А к нему еще неплохо мегабайт 200 пакетов установить. Но для начального уровня это не нужно.

Eddy_Em ☆☆☆☆☆
()
Ответ на: комментарий от Alve

Ага. А работать кто будет эти полгода?

для документации более чем хватит начального уровня, который осиливается за пару недель _в_процессе_ написания этой документации. Проверено

А самое главное КТО потом читать будет эту документацию, если стандарт де

факто это .doс или .pdf

все. Берётся latex и экспортируется одной командой (или шорткатом) в pdf. Какие проблемы?

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

А работать кто будет эти полгода?

Ничего, что это делается обычно в туалете/на диване дома?

стандарт де факто это .doс

Это в ублюдочных организациях .doc — стандарт. У нормальных людей документация в pdf.

Eddy_Em ☆☆☆☆☆
()
Ответ на: комментарий от Alve

Ага. А работать кто будет эти полгода?

Если не требуется никаких изысков, то на освоение latex хватит и дня. А дальше по мере возникновения вопросов посматривать в книгу.

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

осиливается за пару недель в процессе написания

Вот именно! Читаем по вечерам книжечку + держим документацию открытой. Чуть что непонятно — подглядываем. У меня теща вообще хреновато латех знает, но уже лет 10 (а то и больше) в нем набивает статьи для шефа.

Eddy_Em ☆☆☆☆☆
()

Если их возможностей хватит, то, имхо, можно обойтись rest / markdown / whatever.

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

Читаем по вечерам книжечку + держим документацию открытой.

тю, я даже почти не читал специально(может только если самое начало). Набиваю документ, какие-то проблемы возникли в процессе - в поиск.

lazyklimm ★★★★★
()

Решил как все белые люди писать в LibreOffice…

Гамадрилы масть поменяли, белой шерстью покрылись? В LO (OOo, MSO) такие вещи не делают, не приспособлены они для этого совершенно. Не хочешь осваивать LaTeX, изучай DocBook, он попроще будет, опять-же: контроль версий, преобразование в manpages (это первостепенная задача как я понимаю?), pdf, html, epub, webhelp.

anonymous
()
Ответ на: комментарий от chelovek-bugurt

Да блин, что там знать? Тебе часа хватит чтоб понять всё если не клинический идиот.

А для доков хватит <h3>, <p>, <pre>, какого-нибудь <i> и всё. Посолить CSS по вкусу.

Kalashnikov ★★★
()
Ответ на: комментарий от chelovek-bugurt

Час от часу смешнее.

А откуда такое нежелание (или боязнь) изучать что-то новое? Какие-то проблемы с когнитивными способностями?
Ты же сам пишешь, что нужно написать документацию и нужно это сделать красиво. Так скачай книгу, почитай, попробуй. Вот и все.

Если же тебе чисто для твоих нужд, то открыл любой редактор и сплошным текстом пишешь.

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

Над тем, как человеку, возжелавшему перевести и оформить каких-то жалких 50 страниц документации, предлагают для этого убить пару недель на ЛаТеХ или окровавить свои глаза на освоении Имакса.

chelovek-bugurt
() автор топика
Ответ на: комментарий от chelovek-bugurt

убить пару недель на ЛаТеХ

пара недель - это на относительно крупную работу, с кучей формул, графиков, и при этом далеко не полный день.

окровавить свои глаза на освоении Имакса.

а что такого кровавого для глаз в емаксе? Gtk (в меню и диалогах) - и в африке gtk, шрифты сглаженные умеет, что ещё от редактора нужно?

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

Там не в плохих шрифтах дело, а в том, что все эти LO не предназначены для печатной подготовки. Они — простое подспорье, помогающее сделать быстро какую-нибудь фигню класса служебки/заявления/тупого текста.

Eddy_Em ☆☆☆☆☆
()

Внесу свои пять копеек.

Подход «не умею верстать ни в чём, но хочу красивую документацию, ЛОо не устраивает» - заранее ущербен. Хотя можно попробовать какой-нибудь abiword, но я не уверен за PDF в нём.

Тем не менее, тут правильно сказали: что для HTML, что для LaTeX - сначала пишешь текст, а уже потом начинаешь выделять абзацы, заголовки и прочее. Махом всё изучается в процессе написания документации. Вообще я в любом редакторе сначала набираю текст, а уже потом делаю форматирование (так, наверное, делают многие, кому приходится писать документацию), поэтому я не понимаю, что такого страшного в вёрстке (особенно с учётом того, что осваивают её без проблем даже школьники).

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

Вообще я в любом редакторе сначала набираю текст, а уже потом делаю форматирование (так, наверное, делают многие, кому приходится писать документацию)

Нет, в латехе все делаешь сразу. Это несложно.

Eddy_Em ☆☆☆☆☆
()
Ответ на: комментарий от chelovek-bugurt

Видимо у него своё понятие начального уровня. Начальный уровень в лёгкую за вечер можно осилить, а потом по мере надобности гуглить или сразу на http://tex.stackexchange.com/. А потом по мере времени можно повышать уровень.

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

Жёстковато будет. Одно временно осиливать две вещи, которые далеко не каждый по отдельности в состояние осилить.

HunOL ★★★★
()

у меня гуглдокс отлично в pdf экспортит.

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

Может быть. Я предпочитаю разделять эти процессы. Мне удобнее не отвлекаться на вёрстку в процессе написания - так легче мысль течёт. Впрочем, это вопрос арбуза и свиного хрящика.

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