LINUX.ORG.RU

Создание русской документации.


0

1

Приветствую!
Есть время и желание сделать актуальный мануал на русском языке к одному пакету. Я подразумеваю полный перевод man страницы и плюс, возможно, некоторых How-to. Пока не решил, что это будет на выходе, но склоняюсь к PDF.

Вопросы:
1)В чем удобнее создавать документы с разметкой (Пока начал все делать в LibreOffice)
2)Посоветуйте хорошие русские шрифты которые приятно читать.
3)А хорошие английские шрифты? Для английских терминов и кода.
4) Есть ли некие правила по созданию такого рода документов? Дабы не нарушать каноны.

Буду рад любым советам по теме.


на все вопросы один ответ - wiki

Xenon ★★★ ()

…Пока начал все делать в LibreOffice…

Ничего хорошего из этого недоразумения мира виндовс не получится. Использовать следует:

DocBook => pdf, html, webhelp, epub

LaTeX => man, pdf, html, rtf

2)Посоветуйте хорошие русские шрифты которые приятно читать. 3)А хорошие английские шрифты? Для английских терминов и кода.

Для всех форматов кроме pdf вообще не надо указывать никаких конкретных семейств шрифтов, оставьте это на усмотрение пользователя т.е. задавать следует только serif, sans-serif, monospace, и ничего более.

anonymous ()

От конечной цели зависит.

Полный перевод man-страницы - в формате man и делай. Поделись этим man-ом с мэйнтейнерами дистрибутивов - всем польза будет.

В и-нет хочешь выложить - html или wiki.

Печатать будешь - TeX. Если не TeX, то pdf.

А к какому пакету, если не секрет?

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

Полный перевод man-страницы - в формате man и делай. Поделись этим man-ом с мэйнтейнерами дистрибутивов - всем польза будет.

Да, man для пакета сделаю, конечно. Это тоже входит в мои планы

А к какому пакету, если не секрет?

Нет не секрет, на данный момент хочу освежить мануалы к этим утилитам:
vzcalc
vzcpucheck
vzdqcheck
vzdqload
vzifup-post
vzmemcheck
vznetaddbr
vzpid
vzsplit
vzcfgvalidate
vzctl
vzdqdump
vzeventd
vzlist
vzmigrate
vznetcfg
vzquota
vzubc

Естественно, если поискать в сети, то можно найти перевод ы той или иной “man” страницы конкретно взятой утилиты. Только переводы, что мне попадались на глаза достаточно стары и если глянуть в оригинальный “man” по каждой утилите, всегда можно найти новые возможности, не документированные на русском языке .
Честно, не буду спорить о оригинальности идеи и вообще актуальности этой затеи. Берусь за это для того, чтобы повысить уровень своих знаний и поделиться полученным продуктом в процессе изучения с другими.

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

Полный перевод man-страницы - в формате man и делай.

Вот в формате man делать как раз и не надо. Надо делать и хранить в DocBook, который пожалуй на сегодня будет предпочтительней, т.к. xml, и редакторов масса, и позволяет изменения отслеживать, а следовательно поддерживать документацию в актуальном состоянии, или TeX, из которых потом можно путём трансформации получить практически любой формат, включая man.

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

Честно, не буду спорить о оригинальности идеи и вообще актуальности этой затеи.

А зачем спорить? Нормальная идея. Практическая польза очевидна.

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

Тем более. Будет польза для тебя - хорошо, а если к этому добавится ещё и польза для других - ещё лучше.

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

Надо делать и хранить в DocBook

или TeX

Можно и так. Никаких возражений. Просто предложил, как один из вариантов.

В освоении формата man не вижу ничего плохого. Если у кого-то man поперёк горла стоит, то и без него вполне можно обойтись. Просто я, например, больше к man привык.

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

В освоении формата man не вижу ничего плохого. Если у кого-то man поперёк горла стоит, то и без него вполне можно обойтись. Просто я, например, больше к man привык.

Я не это имел ввиду — ничего плохого в формате man разумеется нет, — это прекрасный формат для своих задач. Просто создавать и хранить документации лучше в более приспособленном для этого формате, например DocBook, из которого потом путём несложной трансформации можно получить абсолютно любой формат, включая man, что сделать имея исходник в man будет довольно затруднительно. Да, и редактировать его и поддерживать в актуальном состоянии довольно хлопотно (про контроль версий и совместную работу я уже не говорю).

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

Просто создавать и хранить документации лучше в более приспособленном для этого формате

Ок, не буду спорить о «лучшести и приспособленности» различных форматов (это бессмысленно). Против DocBook ничего не имею.

что сделать имея исходник в man будет довольно затруднительно.

Для кого как. Небольшой набор скриптов вполне справляется.

Да, и редактировать его и поддерживать в актуальном состоянии довольно хлопотно

Почему? Не вижу особых сложностей.

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