Форматировать код в формате Doxia Apt

Question

Форматировать код в формате Doxia Apt

В настоящее время я начинаю писать документацию для одного из наших проектов. Для простоты мы решили использовать формат почти простого текста (APT), дополнительную информацию см. Здесь: http://maven.apache.org/doxia/references/apt-format.html

APT - это отличный формат документации, поскольку он использует минимальный синтаксис и, следовательно, его очень легко создавать и вносить в документацию, не зная много о APT.

Однако я не смог найти способ отформатировать код хорошим способом. Существует ли кодовый тег или аналогичный, который можно использовать для включения некоторого исходного кода? Я знаю, что мог бы использовать FML, но это было бы менее желательно.

Спасибо

9

maven documentation apt doxia

Источник

user618870 22 сен '11 в 14:20

5 ответов

Другие вопросы по тегам maven documentation apt doxia

user564875 22 июл '13 в 16:09 2013-07-22 16:09 · Answer 1 · 2013-07-22 16:09

Для тех, кто все еще задается вопросом, как сделать код, отсекаемый в APT:

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

11

Источник

user564875 22 июл '13 в 16:09

user160256 06 май '15 в 19:07 2015-05-06 19:07 · Answer 2 · 2015-05-06 19:07

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

синтаксис правильный. А Fluido выделяет использование Prettify из коробки, как уже упоминали другие.

Однако изменение Doxia в Site Plugin 3.3 сломало Fluido. MSKINS-86 исправляет это, но еще не выпущено.

обходные

Используйте обходной путь site.xml<body> <head> <script type="text/javascript"> $(document).ready(function () { $("div.source pre").addClass("prettyprint"); prettyPrint(); }); </script> </head> </body>
Используйте плагин сайта 3.2
Создайте неизданный Fluido 1.4, содержащий исправление MSKINS-86, и используйте его вместо 1.3.1.

user629762 22 мар '13 в 12:35 2013-03-22 12:35 · Answer 3 · 2013-03-22 12:35

Apache Maven Fluido Skin выделяет синтаксис из коробки. Здесь вы можете найти пример. Информация о выделении синтаксиса во Fluido: "Разделы исходного кода расширены с помощью Google Code Prettify, пользователи могут по желанию включить отображение номеров строк (по умолчанию отключено)" с веб-сайта Fluido.

user618870 23 сен '11 в 08:51 2011-09-23 08:51 · Answer 4 · 2011-09-23 08:51

В итоге я использовал макрос фрагмента из Руководства по макросам Doxia: http://maven.apache.org/doxia/macros/index.html

Он помещает код из файла сниппета в дословное поле. Однако он не обеспечивает подсветку синтаксиса.

2

Источник

user618870 23 сен '11 в 08:51

user1010517 24 окт '11 в 08:51 2011-10-24 08:51 · Answer 5 · 2011-10-24 08:51

Версия 1.0 макроса doxia include отсутствует в maven central, однако доступны следующие версии: http://mvnrepository.com/artifact/org.tinyjee.dim/doxia-include-macro

-1

Источник

user1010517 24 окт '11 в 08:51