ฉันจะเขียนหน้าคนได้อย่างไร [ปิด]

16

ฉันจะเขียนหน้าคนได้อย่างไร

ฉันจะหาข้อมูลอ้างอิงของรหัสการจัดรูปแบบทั้งหมดได้จากที่ใด

มีแบบฝึกหัดที่ดีในการเขียน man pages หรือไม่?

วิธีที่สะดวกที่สุดในการเขียนหน้าคนคืออะไร? ฉันควรป้อนโดยตรงในโปรแกรมแก้ไขข้อความหรือไม่? มีบรรณาธิการ WYSIWYG หรือไม่ หรือฉันควรจะเขียนมันในรูปแบบที่แตกต่างกันแล้วแปลง?

หน้าคนดีควรกฎอะไรบ้าง

documentation

— amarillion
แหล่งที่มา

คำถามนี้ดูเหมือนจะกว้างเกินไป มันประสบความสำเร็จในการดึงดูดคำตอบของลิงค์อย่างเดียวและความคิดเห็นที่ไม่ได้รับการสนับสนุน

— 200_success

man man, man groff.

— เจนนี่ D

13

นี่เป็นหน้าเว็บบางหน้าที่จะช่วยคุณเริ่มต้นใช้งาน:

เครื่องมือที่มีประโยชน์สองอย่าง:

— หยุดชั่วคราวจนกว่าจะมีประกาศ
แหล่งที่มา

6

มีเครื่องมือสำหรับการเขียนหน้าคนที่เลี่ยงผ่านการจัดรูปแบบ troff manpages เป็นภาษาขนาดเล็กคั่นด้วยตัวเองและง่ายต่อการกำหนดเป้าหมาย

เครื่องมือยอดนิยมสองประการคือ:

xmltomanเป็นภาษา xml ขนาดเล็กและมีโครงสร้างที่สามารถสร้าง manpages และ html ได้ มันถูกใช้โดยโครงการเลนนาร์ตโพ็ตเตอริ ง ของsyrepและPulseAudio ตัวอย่างเช่น
asciidoc , ใช้โดยคอมไพล์ตัวอย่างเช่น

yodlและzoemดูเหมือนจะเป็นรูปแบบที่ดีในพื้นที่นี้

ทั้งหมดในทุกฉันแนะนำ xmltoman เพราะมันเป็น dsl เฉพาะ manpage ที่จะแนะนำคุณอย่างใกล้ชิด

— Tobu
แหล่งที่มา

"dsl" == "ภาษาเฉพาะโดเมน" หรือไม่

— หยุดชั่วคราวจนกว่าจะมีการแจ้งให้ทราบต่อไป

ใช่ (da. si. 15 ตัวอักษร)

— Tobu

1

อีกตัวเลือกที่ดีคือronnซึ่งอ่านมาร์กอัปข้อความมาร์กอัปข้อความที่ใช้กันอย่างแพร่หลาย

— poolie

5

ฉันได้เขียนบทความบล็อกที่ค่อนข้างครอบคลุมเกี่ยวกับหัวข้อซึ่งคุณสามารถค้นหาได้ที่นี่:

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

— นาธานออสมัน
แหล่งที่มา

4

มันจะมีประโยชน์ถ้าอย่างน้อยคุณก็สามารถสรุปบทความได้ที่นี่ - ลิงค์เพียงอย่างเดียวไร้ค่าเมื่อหน้าเชื่อมโยงนั้นย้ายหรือหายไปอย่างหลีกเลี่ยงไม่ได้

— Caleb

ฉันไม่เห็นด้วยกับแม็กเคเล็บ นี่คือเว็บ เว็บใช้ลิงก์และการแลกเปลี่ยนสแต็คไม่ได้มีข้อยกเว้นพิเศษใด ๆ การคัดลอกเนื้อหาต่อต้าน ไม่ว่าสิ่งที่ไม่ดีสามารถเกิดขึ้นได้ที่หน้าเว็บหรือเอกสารยังสามารถเกิดขึ้นได้นี้อย่างใดอย่างหนึ่ง เราไม่สามารถสะสมสำเนาเนื้อหาทั้งหมดได้เพียงเพราะส่วนที่เหลือของเว็บอาจหายไป (ปล่อยให้งานนั้นไปยังเว็บไซต์เช่นเครื่อง wayback)

— Kaz

Kaz คุณอาจไม่เห็นด้วย แต่ความเห็นของ Caleb นั้นเป็นวิธีที่ดีที่สุดสำหรับ ServerFault

— MadHatter

2

ฉันไม่รู้จัก IDEs หรือแบบฝึกหัดใด ๆ แต่คุณสามารถเริ่มต้นด้วยการคัดลอก man page ที่มีอยู่และแก้ไขมันให้เหมาะกับความต้องการของคุณ

สำหรับการอ้างอิงภาษา Groff กับ MAN มาโคร (ซึ่งเป็นที่ใช้โดยหน้าคน) ดูที่หน้าคนgroff_manหรืออ่านออนไลน์ได้ที่นี่

— แดน Andreatta
แหล่งที่มา

2

ลองดูที่เป็นโครงการ Ronn มันเป็นmarkdownเพื่อสร้างหน้าคน นอกจากนี้ยังสามารถสร้างหน้าคนใน html เช่นนี้

ฉันชอบความคิดในการเขียนเอกสารประกอบซอฟต์แวร์ทั้งหมดของฉันในรูปแบบเดียว Markdown IMO เป็นตัวเลือกที่ดี

— Bruno Polaco
แหล่งที่มา