Chúng tôi có một vài giao diện dựa trên XML được viết khá tốt trong các lược đồ XSD. Các giao diện hiện đang được cung cấp công khai và chúng tôi muốn tạo tài liệu tham khảo cho chúng.Làm thế nào để chuyển đổi xsd thành tài liệu có thể đọc được của con người?
Có công cụ nào có thể tự động chuyển đổi tệp XSD thành định dạng dễ đọc hơn không?
Không nên khó chuyển đổi (hoặc viết trước) thành định dạng docbook.
Tập lệnh XSLT có thể thực hiện công việc.
oXygen có rất đẹp XSD schema documentation tool cho phép tùy chỉnh dễ dàng thông qua các tùy chọn và tệp CSS bổ sung.
Tôi chưa từng sử dụng nó trước đây, nhưng DocFlex/XML là một công cụ tài liệu XML có thành phần tài liệu XSD được gọi là XSD Doc trông thú vị.
Của người phối ngẫu, như được chỉ ra trong các câu trả lời khác, XSD chỉ là một tệp XML để XSLT tùy chỉnh có thể được viết để tạo ra bất kỳ đầu ra tài liệu nào bạn thích.
Tỷ lệ cược khá tốt là bạn không muốn sử dụng công cụ chung để ghi lại lược đồ của mình. Các công cụ tài liệu lược đồ (tôi quen thuộc nhất với công cụ trong XML Spy) được thiết kế để làm cho các lược đồ có thể đọc được. Từ mô tả của bạn, có vẻ như đó không thực sự là điều bạn muốn; những gì bạn muốn là sử dụng thông tin trong lược đồ của bạn làm cơ sở của tài liệu phần mềm.
Khi tôi cần làm điều này, cách tiếp cận mà tôi đã thực hiện là thiết kế HTML trông giống như cách tôi cần tài liệu hướng dẫn, và sau đó tìm ra thông tin nào trong lược đồ tôi cần lấy . Sử dụng nó như một khuôn mẫu, nó khá đơn giản để lấy thông tin liên quan từ lược đồ bằng cách sử dụng XSLT.
Tôi đã tạo tài liệu trong quá khứ bằng cách sử dụng công cụ tôi tìm thấy trên Freshmeat.net được gọi là xsddoc. Tìm kiếm nó ngay bây giờ (để có được liên kết trực tiếp), tôi thấy rằng nó đã được superceded bởi các nhà phát triển của nó với một công cụ gọi là xnsdoc. Phiên bản mới hơn là miễn phí để sử dụng bởi các dự án mã nguồn mở, nhưng nếu bạn đang sử dụng nó cho một sản phẩm thương mại, bạn có thể phải cấp phép cho nó. Nếu phiên bản cuối cùng được phát hành dưới biểu ngữ "xsddoc" phù hợp với mục đích của bạn, thì bạn có thể sử dụng phiên bản đó.
Các tài liệu nó tạo ra có cái nhìn và cảm nhận của Javadoc, và cho phép đối với một số mức độ kiểm soát trong stylesheet vv
x3sp có thể làm những gì bạn muốn: http://xml.fiforms.org/xs3p/
Wow, ngạc nhiên trước phiếu bầu, có thể bởi vì có rất ít lựa chọn thay thế, nhưng đầu ra từ x3sp là cực kỳ xấu xí và khó theo dõi - chỉ cần đọc xsd đơn giản là dễ dàng hơn nhiều. Và những gì với loại "AusAddress" ngẫu nhiên nối vào cuối? –
Trang được liên kết dường như không còn tồn tại nữa và tôi không thể tìm thấy bất kỳ dấu vết nào của phần mềm có tên * x3sp * ít nhất với tìm kiếm web nhanh. –
Phụ trang này ở đầu của XSD
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="xs3p.xsl"?>
Sau đó, bạn có thể xem trực tiếp tệp XSD bằng trình duyệt web. Trình duyệt web thực hiện chuyển đổi sang HTML bằng XSLT được chỉ định.
Bạn không cần bộ xử lý XSL, nhưng biểu định kiểu như xs3p sẽ không tạo liên kết bằng cách sử dụng phương pháp này. Tôi sử dụng trình duyệt web Firefox, IE8 dường như vô dụng cho việc này.
Tôi đã thử các stylesheets xsl: https://sourceforge.net/projects/xs3p/files/xs3p-1.1.3.zip/download http://crism.maden.org/consulting/pub/xsl/xsd2html.xsl
Tôi nghĩ rằng tôi thích xs3p.
Để làm rõ: các trình duyệt web hiện đại (như Firefox) có bộ vi xử lý XSLT tích hợp sẵn sàng cho phép các phép biến đổi này xảy ra, do đó độ tin cậy của phương pháp này phụ thuộc vào môi trường thời gian chạy. – jevon
không biết về IE8 - nhưng IE11 hoạt động tốt với một báo trước, tôi dường như không thể làm cho nó hoạt động bằng cách thả tệp XSD lên đó. Tuy nhiên, nếu các tập tin được phục vụ thông qua một máy chủ web nó hoạt động tốt ... khi tôi nhấn nút IE trong intellij IDEA trong khi xem XSD, nó sẽ gửi nó thông qua localhost - vì vậy nó ám một cách chính xác.Save tôi những rắc rối của cài đặt firefox. Kể từ khi chrome sẽ không làm việc cho tôi.My giấc mơ cuối cùng của tôi sẽ được tìm thấy một cái gì đó như x3sp - nhưng điều đó không lộn xộn tài liệu tất cả cùng nhau ... thay vào đó, để nó ở vị trí tương tự mà nó đã được trong XSD (theo yếu tố nó đã được đặt sau) – ycomp
Nếu bạn đã sẵn sàng để nghiên cứu kỹ các phức tạp của Sandcastle, tôi đặc biệt khuyên bạn nên XML Schema Documenter là plugin dành cho tuyệt vời Sandcastle Help File Builder.
kết quả đầu ra có thể là giống như Sandcastle: một trang web, một HTML Help (CHM) tập tin, MS Help 2 nội dung, MS Help Viewer 1 ...
Nếu tôi không phải là 2 năm cuối, tôi sẽ nói 'gần' bởi vì nó một bản sao của http://stackoverflow.com/questions/202049/formatting-xsd-scheme-for-peer-review – f3lix