Как писать справочные страницы? [закрыто]
Как мне написать справочную страницу?
Где я могу найти справочник по всем кодам форматирования?
Есть ли какие-нибудь хорошие учебники по написанию справочных страниц?
Какое самое большое удобный способ написать man-страницу? Должен ли я вводить его прямо в текстовом редакторе? Есть ли редакторы WYSIWYG? Или мне следует написать его в другом формате, а затем преобразовать?
Каким правилам должна следовать хорошая страница руководства?
Вот несколько веб-страниц, которые помогут запустить Вас:
- Создание и форматирование страниц справочника
- Создание Вашей собственной страницы справочника
- Создайте Свою собственную Страницу справочника
- Как записать страницу справочника
- Что необходимо знать для записи страниц справочника
Несколько полезных инструментов:
Существуют инструменты для записи страниц справочника того обхода troff форматирование. страницы справочника являются маленьким, хорошо разграниченным языком и легкий предназначаться.
Два популярных инструмента:
- xmltoman, маленький и хорошо структурированный xml язык, который может генерировать страницы справочника и HTML. Это используется проектами Lennart Poettering, syrep и pulseaudio, например.
- asciidoc, используемый мерзавцем, например.
yodl и zoem, кажется, другие хорошие форматы в этом пространстве.
В целом, я рекомендовал бы xmltoman, потому что это - очень страница справочника определенный dsl, который будет вести Вас тесно.
-
1
-
2
Я не знаю ни о каких IDE или учебных руководствах, но можно запустить путем копирования существующей страницы справочника и изменить ее для удовлетворения потребностям.
Для ссылки groff языка с макросами ЧЕЛОВЕКА (который является тем, что используется страницей справочника) консультируются с groff_man страницей справочника или читают его онлайн здесь