2009-03-17 28 views
5

Công ty của tôi đang làm việc trên tài liệu người dùng/nhà phát triển cuối bằng cách sử dụng mediawiki. Tôi muốn lấy rất nhiều tài liệu API mà phpdoc nhổ ra (cho các chức năng/phương pháp cụ thể) và có nó trong đánh dấu wiki để chuyển dễ dàng.phpDocumentor to wiki?

Bất kỳ giải pháp nào ở đó để nhận đánh dấu wiki hoặc đầu ra wiki từ phpDoc? Tôi đã nhìn xung quanh và không tìm thấy gì cả.

+0

Bạn đã bao giờ tìm hoặc phát triển giải pháp chưa? Tôi quan tâm đến một giải pháp như vậy. –

Trả lời

0

Một tùy chọn (ngoài đỉnh đầu của tôi) là sử dụng xây dựng API trong MediaWiki và tự đăng dữ liệu. (thông qua kịch bản, tất nhiên).

Cách duy nhất khác là hack phpDoc, và thậm chí sau đó, bạn phải đăng nó lên MediaWiki bằng cách nào đó.

1

Theo trang web PHPDocumentor và documentation đầu ra HTML và XML của chúng tôi là có thể. Sau đó, bạn có thể nhập XML bằng cách sử dụng các tính năng được xây dựng sẵn trong MediaWiki import mặc dù bạn có thể muốn xuất đầu tiên để xem định dạng của XML là gì. Họ cũng đề cập rằng việc sử dụng XML để nhập một lượng lớn dữ liệu có thể dẫn đến timeouts và có một thay thế cho phép bạn tạo các truy vấn SQL để chèn dữ liệu. Ngoài ra bạn có thể sẽ cần một phần mở rộng cho MediaWiki để hiển thị mã (giống như SyntaxHighlight GeSHi).

Tất cả điều này không thực sự giải thích cách chuyển đổi đầu ra của PHPDocumentor thành một cái gì đó có thể sử dụng với MediaWiki (tức là sử dụng cú pháp Wiki). Nhiều khả năng bạn sẽ sử dụng tập lệnh để chuyển đổi cú pháp này sang cú pháp khác. Dường như việc tạo ra định dạng đầu ra của riêng bạn thông qua PHPDocumentor là cách dễ nhất (mặc dù xuất ra dưới dạng XML: DocBook có thể hoạt động).

+0

Bạn cũng có thể chuyển đổi một tài liệu XML sang XML có cấu trúc khác nhau bằng cách sử dụng tập lệnh XSLT. Khá tiện dụng và có hiệu suất tốt. –

2

Chỉ cần xem xét điều này trong khi tìm cách tạo ra đầu ra Twiki từ phpDoc. Tôi đã không tìm thấy một giải pháp tốt cho việc này và đã bắt đầu một dự án ở đây: http://step2.co.in/content/phpdoc-twiki để bắt đầu công việc này. Nếu bất cứ ai quan tâm đến việc giúp đỡ, xin vui lòng liên lạc.

Các vấn đề liên quan