Як мені писати чоловічі сторінки? [зачинено]


16

Як мені написати чоловічу сторінку?

Де я можу знайти посилання на всі коди форматування?

Чи є хороші підручники з написання чоловічих сторінок?

Який найзручніший спосіб написати чоловічу сторінку? Чи слід вводити його безпосередньо в текстовому редакторі? Чи є редактори WYSIWYG? Або я мушу записати його в іншому форматі і потім конвертувати?

Яких правил повинна дотримуватися сторінка хорошого чоловіка?


Це питання видається занадто широким. Це лише вдалося залучити купу відповідей, що стосуються лише посилань, та декілька непідтримуваних думок.
200_успіх

man man, man groff.
Дженні Д

Відповіді:


13

6

Існують інструменти для написання довідкових сторінок, які обходять форматування troff. manpages - це невелика, добре розмежована мова та її легко орієнтувати.

Два популярних інструменти:

yodl і zoem, здається, є іншими приємними форматами на цьому просторі.

Загалом, я б рекомендував xmltoman, тому що це дуже специфічний dsl для manpage, який буде вас орієнтувати.



так (да. сі. 15 годин.)
Тобу

1
Ще один хороший варіант - ronn , який читає більш широко використовувану мову розмітки тексту Markdown.
poolie

5

Я написав досить обширну статтю в блозі про цю тему, яку ви можете знайти тут:

http://2buntu.com/articles/1034/how-to-write-a-manpage/


4
Було б корисно, якби ви могли принаймні узагальнити статтю тут - самі посилання марні, як тільки пов’язана сторінка неминуче рухається чи зникає.
Калеб

Я не згоден з Калебом. Це мережа. Веб-мережа базується на посиланнях, а stackexchange не становить особливого винятку з цього. Копіювання вмісту є контрпродуктивним. Що б погано не сталося з цією сторінкою або документом, може трапитися і з цією . Ми не можемо зберігати скребкі копії всього вмісту лише тому, що решта Інтернету може зникнути. (Залиште цю роботу на таких сайтах, як "зворотна машина").
Каз

Каз, ви можете не погодитися, але коментар Калеба, безумовно, є найкращою практикою ServerFault.
MadHatter

2

Я не знаю жодних IDE чи навчальних посібників, але ви можете почати, скопіювавши існуючу сторінку man і змінивши її відповідно до ваших потреб.

Для ознайомлення з мовою groff з макросами MAN (що використовується сторінкою man) перегляньте сторінку man groff_man або прочитайте її в Інтернеті тут


2

Погляньте на проект ronn . Це генератор відмітки до людини. Він також може генерувати довідкові сторінки в html, як це .

Мені подобається ідея написати всю свою програмну документацію в одному форматі. Відмітка IMO - хороший вибір

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.