Форматировать код в формате Doxia Apt - PullRequest
Новая
       32

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

9 голосов
/ 22 сентября 2011

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

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

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

Спасибо

Ответы [ 5 ]

11 голосов
/ 22 июля 2013

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

     This is regular text
+---------------------
This is a code snippet
+---------------------
      More regular text
3 голосов
/ 06 мая 2015

The 

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

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

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

Обходные

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

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

2 голосов
/ 23 сентября 2011

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

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

0 голосов
/ 24 октября 2011

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

...