Công cụ biên soạn người dùng cuối hỗ trợ đa nền tảng

Question

Một số công cụ tạo tác phẩm tốt để tạo tệp trợ giúp đa nền tảng cho người dùng cuối là gì? (Ứng dụng của chúng tôi đang sử dụng khung Qt, nếu điều đó tạo ra bất kỳ sự khác biệt nào.)

Lưu ý: Tôi không quan tâm đến tài liệu API nội bộ - chúng tôi đang sử dụng doxygen cho điều đó.

Lý tưởng nhất, một giải pháp sẽ:

• Cho phép chúng tôi để quản lý tất cả các nội dung trợ giúp (văn bản, bảng nội dung, hình ảnh, vv) tại một địa điểm duy nhất.
• Xuất ra định dạng trợ giúp gốc. (CHM cho Windows - hoặc ít nhất một cái gì đó chúng tôi có thể nạp trực tiếp vào API Trợ giúp HTML; không chắc chắn định dạng trợ giúp "chuẩn" của nền tảng khác là gì.)
• Hỗ trợ WYSIWYG Decent: xử lý nhập văn bản, hình ảnh, chữ thập phổ biến dễ dàng tham khảo, nhưng chúng tôi có thể chỉnh sửa HTML khi cần.
• Định dạng tệp dựa trên văn bản cho dự án trợ giúp (XML, v.v.) để có thể được phiên bản trong Subversion.
• Bất kỳ móc nào giúp giữ nó đồng bộ với cơ sở mã thực tế sẽ là tuyệt vời. (Có lẽ bằng cách nào đó một chủ đề trợ giúp được liên kết với một tệp mã và có thể kiểm tra Subversion để xem có bất kỳ thay đổi nào đã được thực hiện hay không và gắn cờ một chủ đề là "có thể lỗi thời" ... tôi có đang mơ không?)
• Nội dung trợ giúp có thể được bản địa hoá.
• Không phản đối sản phẩm thương mại, nhưng tùy chọn miễn phí sẽ tốt đẹp.

Tôi sẽ tiếp tục và tạo một wiki này và bắt đầu bằng một vài ví dụ. Bỏ phiếu lên hoặc xuống nếu bạn có kinh nghiệm với họ và để lại một số nhận xét. Thêm các công cụ bổ sung.

Answer 1

Tôi chỉ phát hiện Sphinx; Tôi nghĩ rằng tôi đang yêu.

• Tốt hơn so với WYSIWYG trên HTML: reStructuredText
• đầu ra để QtHelp (trong số những thứ khác), như vậy sẽ dễ dàng để phân phối (và tích hợp) trong ứng dụng của chúng tôi.
• Bạn chưa chắc chắn về bản địa hóa nhưng chúng tôi sẽ vượt qua cây cầu đó khi cần.
• Dễ thiết lập và "chỉ hoạt động"; trông chuyên nghiệp.

Answer 2

Robohelp

Answer 3

Help & Manual

Answer 4

Chỉ duy nhất tôi biết là Latex, một trong các trình biến đổi latex2html, và sau đó một vài thích ứng để làm cho kết quả html sẵn sàng cho trình lưu trữ CHM.

• văn bản, html, chm, pdf, ps không thành vấn đề.
• Chuyển đổi sang Word qua RTF thường là thảm họa, không biết trạng thái hiện tại.
• chuyển đổi cao su 2 html, trong khi một số, tất cả đều có vấn đề riêng của họ.
• Các tệp pdf trông hoàn toàn tuyệt vời.
• WYSIWYM (qua lyx) có thể.

lưu trữ này có một loạt các CHMs theo cách đó (đặc biệt là prog, ref và sử dụng phần, phần còn lại (rtl, FCL, LCL) được tạo ra bởi doxygen riêng của chúng tôi tương đương, fpdoc)

http://www.stack.nl/~marcov/doc-chm.zip

Lưu ý rằng các CHM trên được thực hiện bằng trình biên dịch CHM (di động) của chính chúng ta. Vâng, không còn hội thảo nữa.

Một LyX tài liệu dưới dạng PDF và html:

pdf: http://www.stack.nl/~marcov/buildfaq.pdf

html: http://www.stack.nl/~marcov/buildfaq/

Answer 5

Tôi đã sử dụng Robohelp trong nhiều năm.

Nó là tốt, nhưng công nghệ cốt lõi là rất cũ bây giờ. Ngoài ra cách họ khóa vào các phiên bản Word là tổng số PITA (và đã buộc tôi phải tránh nâng cấp MS office nhiều lần).

Chúng tôi đang di chuyển đến dại bùng http://www.madcapsoftware.com/products/flare/robohelp.aspx

Answer 6

Tôi nghĩ DocBook địa chỉ tất cả các bạn yêu cầu, ngoại trừ có thể là móc đồng bộ, mà tôi sẽ suy nghĩ một chút nữa về. Về bản chất, nó là một tập con của XML được thiết kế để tạo tài liệu, và là mã nguồn mở và miễn phí. Nó chỉ là một định dạng cộng với một bộ biến đổi đầu ra XSL để chuyển đổi Docbook thành các định dạng hữu ích hơn (HTML và do đó CHM, JavaHelp, PDF qua XML-FO hoặc Tex).

Điều này có nghĩa là bạn vẫn cần chọn một công cụ soạn thảo XML để thực sự chỉnh sửa nó để những thứ như WYSIWYG sẽ phụ thuộc vào các tính năng của phần mềm soạn thảo XML của bạn. Chúng tôi sử dụng Cú pháp Serna vì nó có hỗ trợ tốt cho WYSIWYG và chỉnh sửa nội dòng của XML #includes (không ai khác có vẻ hỗ trợ sau này). Bạn có thể tìm thấy các công cụ soạn thảo XML khác phù hợp hơn với nhu cầu của bạn - Serna là một dịch vụ thương mại đắt tiền hợp lý.

Docbook cung cấp nhiều tính linh hoạt thông qua lược tả, cho phép bạn bao gồm/loại trừ các phần tử xml dựa trên các thuộc tính của chúng. Các trường hợp sử dụng ví dụ sẽ có đầu ra trợ giúp hơi khác cho OS = Windows so với OS = Linux. Bản địa hóa cũng được hỗ trợ thông qua lược tả và các cơ chế khác.

Một số khá tốt introduction to Docbook có thể được tìm thấy here.

Chúng tôi sử dụng Docbook cho định dạng trợ giúp của chúng tôi và biên dịch nó thành tệp CHM chỉ chứa trợ giúp cho các tính năng liên quan đến một sản phẩm cụ thể (tức là phiên bản Enterprise có các tính năng không có trong phiên bản Standard hoặc Demo). Các bước có liên quan là:

1. Chạy mẫu XSL lược tả trên nguồn XML (ví dụ: XSLTproc).
2. Chạy các mẫu XSL Trợ giúp HTML ở đầu ra 1.
3. Biên dịch các tệp HTML đầu ra bằng Trình biên dịch trợ giúp HTML của Microsoft (HHC).