Kod formatu w formacie Doxia Apt

Obecnie rozpoczynam tworzenie dokumentacji dla jednego z naszych projektów. Dla uproszczenia zdecydowaliśmy się użyć Tekst Prawie Węgierska (APT) Format, zobacz więcej informacji tutaj: http://maven.apache.org/doxia/references/apt-format.html Kod formatu w formacie Doxia Apt

APT jest wielkim formatem dokumentacji, ponieważ wykorzystuje minimalną składnię, a więc jest to bardzo łatwe do tworzenia i zmiany w dokumentacji, nie wiedząc wiele o APT.

Jednak nie udało mi się znaleźć sposobu na wygodne sformatowanie kodu. Czy istnieje tag kodowy lub podobny, który może być użyty do dołączenia kodu źródłowego? Jestem świadomy, że mogę użyć FML, ale byłoby to mniej pożądane.

Dzięki

Źródło

2011-09-22 evgeni

Właśnie zobaczyłem tę wtyczkę: http://code.google.com/p/m2-site-tools/wiki/UserGuide , jednak funkcja hightlight nie wydaje się działać nether dla java ani dla xml. – evgeni

jest również ten projekt: http://doxia-include.sourceforge.net/usageAndReference.html. Jednak nie udało mi się skompilować pliku pom.xml, ponieważ brakowało zależności: Błąd budowy projektu: Nierozwiązywalna wersja kompilacji: Plugin org.apache.maven.plugins: maven-site-plugin: 3.0-beta-3 lub jedna z jego zależności mogła nie można rozwiązać: Nie można znaleźć artefaktu org.tinyjee: doxia-include-macro: jar: 1.0 w centralnym (http://repo1.maven.org/maven2) – evgeni

ten sam problem z tym projektem: http: // syntax- podświetlone-snippet.googlecode.com/svn/site/index.html – evgeni

skończyło się za pomocą makra urywek z Doxia Makra Przewodnik: http://maven.apache.org/doxia/macros/index.html#Snippet_Macro

Stawia kod z pliku urywka w verbatim pudełku. Jednak nie zapewnia podświetlania składni.

Źródło

2011-09-23 08:51:34 evgeni

dla tych, którzy wciąż zastanawiają się, jak utworzyć fragment kodu w APT: + --------------------- – JoshC13

-1

Wersja 1.0 doxia zawierać makra nie jest w centralnej Maven jednak następujące wersje: http://mvnrepository.com/artifact/org.tinyjee.dim/doxia-include-macro

Źródło

2011-10-24 08:51:09 jkellerer

Apache Maven Fluido skóry podkreśla składnię po wyjęciu z pudełka. Here można znaleźć przykład. Informacje o podświetlaniu składni w Fluido: "Sekcje kodu źródłowego są ulepszane przez Google Code Prettify, użytkownicy mogą opcjonalnie włączyć renderowanie numerów linii (domyślnie wyłączone)" ze strony Fluido.

Źródło

2013-03-22 12:35:06 Marcin

Strona linku podanego w Twój przykład wydaje się być stworzony przy pomocy xdoc, nie z APT (zobacz https://svn.apache.org/repos/asf/logging/log4j/log4j2/trunk/src/site/xdoc/manual/markers.xml). Czy znasz przykład użycia Fluido/Google Code Prettify with APT? (nie mogę tego zrobić z moim projektem wydaje się, że ... może powinienem też uciekać się do xdoc) – evandor

@evandor Projekt Maven Fluido Skin sam używa APT; Stronę [maven-fluido-skin] (http://maven.apache.org/skins/maven-fluido-skin/) tworzy się za pomocą APT ([źródło] (http://svn.apache.org/viewvc/maven /skins/tags/maven-fluido-skin-1.3.0/src/site/apt/index.apt.vm?view=markup)). – Marcin

Dla tych, którzy są wciąż zastanawiasz się, jak zrobić kod snipped w APT:

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

Źródło

2013-07-22 16:09:21 JoshC13

Składnia

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

jest poprawna. Fluido uwypukla przy użyciu Prettify po wyjęciu z pudełka, o czym wspomnieli inni.

Jednak zmiana Doxia w Pluginie strony 3.3 złamała Fluido. MSKINS-86 to naprawia, ale jeszcze nie zostało wydane.

Obejścia

Użyj site.xml workaround <body> <head> <script type="text/javascript"> $(document).ready(function() { $("div.source pre").addClass("prettyprint"); prettyPrint(); }); </script> </head> </body>
Wykorzystanie strony Plugin 3.2
Zbuduj niepublikowane Fluido 1.4, który zawiera Skórki-86 poprawki i używać go zamiast 1.3.1

Źródło

2015-05-06 19:07:47 Keegan

Odpowiedz

Powiązane problemy