Làm thế nào để tôi viết trang người đàn ông? [đóng cửa]

16

Làm thế nào để tôi viết một trang người đàn ông?

Tôi có thể tìm tài liệu tham khảo của tất cả các mã định dạng ở đâu?

Có bất kỳ hướng dẫn tốt về viết trang người đàn ông?

Cách thuận tiện nhất để viết một trang người đàn ông là gì? Tôi có nên nhập nó trực tiếp trong một trình soạn thảo văn bản? Có biên tập viên WYSIWYG không? Hoặc tôi nên viết nó trong một định dạng khác và sau đó chuyển đổi?

Những người đàn ông tốt nên làm theo những quy tắc nào?

documentation

— amarillion
nguồn

Câu hỏi này dường như quá rộng. Nó chỉ thành công trong việc thu hút một loạt các câu trả lời chỉ liên kết và một vài ý kiến không được hỗ trợ.

— 200_success

man man, man groff.

— Jenny D nói Phục hồi lại

13

Dưới đây là một vài trang web sẽ giúp bạn bắt đầu:

Một vài công cụ hữu ích:

— Tạm dừng cho đến khi thông báo thêm.
nguồn

6

Có các công cụ để viết các trang man bỏ qua định dạng troff. manpages là một ngôn ngữ nhỏ, được phân định rõ ràng và dễ nhắm mục tiêu.

Hai công cụ phổ biến là:

xmltoman , một ngôn ngữ xml nhỏ và có cấu trúc tốt có thể tạo ra các trang và html. Nó được sử dụng bởi các dự án, syrep và pulseaudio của Lennart Poettering chẳng hạn .
asciidoc , được sử dụng bởi git chẳng hạn .

yodl và zoem dường như là các định dạng đẹp khác trong không gian này.

Tất cả trong tất cả tôi muốn giới thiệu xmltoman bởi vì đó là một dsl cụ thể rất manpage sẽ hướng dẫn bạn chặt chẽ.

— Tobu
nguồn

"dsl" == "ngôn ngữ cụ thể của miền"?

— Tạm dừng cho đến khi có thông báo mới.

vâng (da. si. 15 ký tự.)

— Tobu

1

Một tùy chọn tốt khác là ronn , đọc ngôn ngữ đánh dấu văn bản Markdown được sử dụng rộng rãi hơn.

— poolie

5

Tôi đã viết một bài viết blog khá rộng rãi về chủ đề, mà bạn có thể tìm thấy ở đây:

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

— Nathan Osman
nguồn

4

Sẽ hữu ích nếu bạn ít nhất có thể tóm tắt bài viết ở đây - một mình các liên kết là vô giá trị khi trang được liên kết chắc chắn di chuyển hoặc biến mất.

— Caleb

Tôi không đồng ý với Caleb. Đây là trang web. Web dựa trên các liên kết và stackexchange không mang bất kỳ ngoại lệ đặc biệt nào cho việc này. Sao chép nội dung là phản tác dụng. Bất cứ điều gì xấu điều có thể xảy ra để mà trang hoặc tài liệu cũng có thể xảy ra đối với này một. Chúng tôi không thể tích trữ các bản sao của tất cả nội dung chỉ vì phần còn lại của web có thể biến mất. (Để công việc đó cho các trang web như máy quay ngược).

— Kaz

Kaz, bạn có thể không đồng ý, nhưng nhận xét của Caleb chắc chắn là cách thực hành tốt nhất của ServerFault.

— MadHatter hỗ trợ Monica

2

Tôi không biết về bất kỳ IDE hay hướng dẫn nào, nhưng bạn có thể bắt đầu bằng cách sao chép một trang man hiện có và sửa đổi nó cho phù hợp với nhu cầu của bạn.

Để tham khảo ngôn ngữ groff với các macro MAN (là những gì được sử dụng bởi một trang người đàn ông), hãy tham khảo trang người đàn ông groff_man hoặc đọc nó trực tuyến tại đây

— Dan Andreatta
nguồn

2

Hãy nhìn vào dự án ronn . Đó là một markdown để tạo trang người đàn ông. Nó cũng có thể tạo các trang man trong html, như thế này .

Tôi thích ý tưởng viết tất cả tài liệu phần mềm của tôi theo một định dạng. Markdown IMO là một lựa chọn tốt

— Bruno Polaco
nguồn