Mã định dạng ở Định dạng Doxia Apt

Tôi hiện đang bắt đầu viết tài liệu cho một trong các dự án của chúng tôi. Vì lý do đơn giản, chúng tôi đã chọn sử dụng Định dạng văn bản gần như thuần túy (APT), xem thêm thông tin tại đây: http://maven.apache.org/doxia/references/apt-format.html Mã định dạng ở Định dạng Doxia Apt

APT là định dạng tài liệu tuyệt vời vì nó sử dụng cú pháp tối thiểu và do đó rất dễ tạo và tạo thay đổi tài liệu mà không biết nhiều về APT.

Tuy nhiên, tôi không thể tìm thấy cách để định dạng mã theo cách tốt đẹp. Có một thẻ mã hoặc tương tự, có thể được sử dụng để bao gồm một số mã nguồn? Tôi biết tôi có thể sử dụng FML, nhưng điều này sẽ ít hấp dẫn hơn.

Cảm ơn

Nguồn

2011-09-22 evgeni

vừa xem plugin này: http://code.google.com/p/m2-site-tools/wiki/UserGuide tuy nhiên, tính năng cao điểm dường như không hoạt động với java hay xml. – evgeni

cũng có dự án này: http://doxia-include.sourceforge.net/usageAndReference.html. Tuy nhiên, tôi không thể xây dựng tệp pom.xml của mình vì các phần phụ thuộc bị thiếu: Lỗi xây dựng dự án: Tiện ích mở rộng không thể giải quyết: Plugin org.apache.maven.plugins: maven-site-plugin: 3.0-beta-3 hoặc một trong các phụ thuộc của nó có thể không được giải quyết: Không thể tìm thấy phần tạo tác org.tinyjee: doxia-include-macro: jar: 1.0 ở giữa (http://repo1.maven.org/maven2) – evgeni

cùng một vấn đề với dự án này: http: // syntax- highlight-snippet.googlecode.com/svn/site/index.html – evgeni

tôi đã kết thúc bằng cách sử dụng vĩ mô đoạn từ Doxia Macros Hướng dẫn: http://maven.apache.org/doxia/macros/index.html#Snippet_Macro

Nó đặt mã từ file đoạn trong một hộp đúng nguyên văn. Tuy nhiên nó không cung cấp một cú pháp tô sáng.

Nguồn

2011-09-23 08:51:34 evgeni

cho những người vẫn đang tự hỏi cách tạo đoạn mã trong APT: + --------------------- – JoshC13

-1

Phiên bản 1.0 của doxia bao gồm vĩ mô không phải là ở maven trung tâm tuy nhiên các phiên bản sau đây: http://mvnrepository.com/artifact/org.tinyjee.dim/doxia-include-macro

Nguồn

2011-10-24 08:51:09 jkellerer

Apache Maven Fluido Skin nêu bật cú pháp ra khỏi hộp. Here bạn có thể tìm thấy một ví dụ. Thông tin về đánh dấu cú pháp trong Fluido: "Các phần mã nguồn được tăng cường bởi Mã nguồn của Google, người dùng có thể tùy chọn bật hiển thị số dòng (bị tắt theo mặc định)" từ trang web Fluido.

Nguồn

2013-03-22 12:35:06 Marcin

Trang liên kết mà bạn cung cấp ví dụ của bạn dường như được tạo bằng xdoc, không phải với APT (xem https://svn.apache.org/repos/asf/logging/log4j/log4j2/trunk/src/site/xdoc/manual/markers.xml). Bạn có biết một ví dụ sử dụng Fluido/Google Code Prettify với APT? (không thể làm cho nó xảy ra với dự án của tôi có vẻ như ... có lẽ tôi nên nghỉ mát để xdoc quá) – evandor

@evandor Maven Fluido Skin dự án chính nó sử dụng APT; Trang [maven-fluido-skin] (http://maven.apache.org/skins/maven-fluido-skin/) được tạo bằng APT ([source] (http://svn.apache.org/viewvc/maven /skins/tags/maven-fluido-skin-1.3.0/src/site/apt/index.apt.vm?view=markup)). – Marcin

Đối với những người vẫn còn tự hỏi làm thế nào để làm cho một mã snipped trong APT:

 This is regular text 
+--------------------- 
This is a code snippet 
+--------------------- 
     More regular text

Nguồn

2013-07-22 16:09:21 JoshC13

Các

+--------------------- 
code 
+---------------------

cú pháp là đúng. Và Fluido làm nổi bật bằng cách sử dụng Prettify ra khỏi hộp như những người khác đã đề cập.

Tuy nhiên, thay đổi Doxia trong Plugin trang web 3.3 đã phá vỡ Fluido. MSKINS-86 sửa lỗi này nhưng chưa được phát hành.

Cách giải quyết

Sử dụng site.xml workaround <body> <head> <script type="text/javascript"> $(document).ready(function() { $("div.source pre").addClass("prettyprint"); prettyPrint(); }); </script> </head> </body>
Sử dụng trang web Plugin 3.2
Xây dựng chưa được phát hành Fluido 1,4 chứa MSKINS-86 sửa chữa và sử dụng nó thay vì 1.3.1

Nguồn

2015-05-06 19:07:47 Keegan

Mã định dạng ở Định dạng Doxia Apt

Trả lời

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