Man sayfalarını nasıl yazarım? [kapalı]

16

Bir adam sayfasını nasıl yazarım?

Tüm biçimlendirme kodlarının bir referansını nerede bulabilirim?

Man sayfaları yazmayla ilgili iyi öğreticiler var mı?

Bir el yazısı sayfası yazmanın en uygun yolu nedir? Doğrudan bir metin düzenleyicisine girmeli miyim? WYSIWYG editörleri var mı? Yoksa farklı bir biçimde yazmalı ve sonra dönüştürmeli miyim?

İyi bir sayfa hangi kurallara uymalı?

documentation

— amarillion
kaynak

Bu soru çok geniş görünüyor. Sadece bir grup sadece bağlantıya verilen cevapları ve birkaç desteklenmeyen görüşü çekmeyi başardı.

— 200_success

man man, man groff.

— Jenny D

13

İşte başlamanıza yardımcı olacak birkaç web sayfası:

Birkaç yararlı araç:

— Bir sonraki duyuruya kadar duraklatıldı.
kaynak

6

Troff biçimlendirmesini atlayan adam sayfaları yazmak için araçlar vardır. Manpajlar küçük, iyi sınırlandırılmış bir dildir ve hedeflemesi kolaydır.

İki popüler araç:

xmltoman , küçük resim ve html oluşturabilen küçük ve iyi yapılandırılmış bir xml dili. Örneğin , Lennart Poettering'in projeleri, syrep ve pulseaudio tarafından kullanılır .
asciidoc , örneğin git tarafından kullanılır .

yodl ve zoem bu alandaki diğer güzel biçimler gibi görünüyor.

Sonuçta xmltoman tavsiye ederim çünkü size yakından rehberlik edecek çok manpage belirli bir dsl.

— Tobu
kaynak

"dsl" == "alana özgü dil"?

— sonraki duyuruya kadar duraklatıldı.

evet (da. si. 15 karakter)

— Tobu

1

Başka bir iyi seçenek de , daha yaygın olarak kullanılan Markdown metin biçimlendirme dilini okuyan ronn'dir .

— poolie

5

Konu hakkında burada bulabileceğiniz oldukça geniş bir blog makalesi yazdım:

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

— Nathan Osman
kaynak

4

En azından buradaki makaleyi özetleyebiliyorsanız faydalı olabilir - bağlantılı sayfa kaçınılmaz olarak hareket ettiğinde veya kaybolduğunda yalnızca bağlantılar değersizdir.

— Caleb

Caleb ile aynı fikirde değilim. Bu web. Web bağlantıları temel alır ve stackexchange bunun özel bir istisnası taşımaz. İçerik kopyalamak verimsizdir. Kötü olursa olsun bir şey başına gelebilecek bu sayfaya veya belge aynı zamanda başına gelebilecek bu one. Web'in geri kalanı kaybolabileceğinden tüm içeriğin kazınmış kopyalarını biriktiremeyiz. (Bu işi geri dönüş makinesi gibi sitelere bırakın).

— Kaz

Kaz, kabul etmeyebilirsin, ama Caleb'in yorumu kesinlikle ServerFault'un en iyi uygulaması.

— MadHatter

2

Herhangi bir IDE veya öğretici bilmiyorum, ancak mevcut bir man sayfasını kopyalayıp ihtiyaçlarınıza göre değiştirerek başlayabilirsiniz.

MAN makrolarıyla groff diline referans için (bir man sayfası tarafından kullanılan şeydir) groff_man man sayfasına bakın veya buradan çevrimiçi okuyun

— Dan Andreatta
kaynak

2

Ronn projesine bir göz atın . Onun adam sayfası jeneratör için bir markdown . Aynı zamanda gibi html adam sayfaları oluşturabilir bu .

Tüm yazılım belgelerimi tek bir formatta yazma fikrini seviyorum. Markdown IMO iyi bir seçimdir

— Bruno Polaco
kaynak