1. Inicio
  2. Pregunta y respuesta
  3. Código de formato en Doxia Apt Format

Código de formato en Doxia Apt Format

2011-09-22 15 views
9

Actualmente estoy empezando a escribir una documentación para uno de nuestros proyectos. Por razones de simplicidad se optó por utilizar el texto casi plana (APT) Formato, ver más información aquí: http://maven.apache.org/doxia/references/apt-format.htmlCódigo de formato en Doxia Apt Format

APT es un gran formato de documentación, ya que utiliza una sintaxis mínima y por lo tanto es muy fácil de crear y hacer cambios en la documentación sin saber mucho sobre APT.

Sin embargo, no pude encontrar una manera de formatear el código de una manera agradable. ¿Hay una etiqueta de código o similar, que se puede utilizar para incluir algún código fuente? Soy consciente de que podría usar FML, pero esto sería menos deseable.

Gracias

Fuente

2011-09-22 evgeni

+0

acabo de ver este complemento: http://code.google.com/p/m2-site-tools/wiki/UserGuide Sin embargo, la característica Hightlight no parece funcionar más bajo para Java ni para xml. – evgeni

+0

también hay este proyecto: http://doxia-include.sourceforge.net/usageAndReference.html. Sin embargo, no pude construir mi pom.xml ya que faltaban las dependencias: Error de compilación del proyecto: Extensión de compilación no resuelveble: Complemento org.apache.maven.plugins: maven-site-plugin: 3.0-beta-3 o una de sus dependencias podría no se resuelve: no se pudo encontrar el artefacto org.tinyjee: doxia-include-macro: jar: 1.0 en el centro (http://repo1.maven.org/maven2) – evgeni

+0

mismo problema con este proyecto: http: // sintaxis- highlighted-snippet.googlecode.com/svn/site/index.html – evgeni

Respuesta

2

Terminé usando la macro fragmento de la Guía Doxia Macros: http://maven.apache.org/doxia/macros/index.html#Snippet_Macro

pone el código del archivo de fragmento en una caja de pie de la letra. Sin embargo, no proporciona un resaltado de sintaxis.

Fuente

2011-09-23 08:51:34 evgeni

+0

para aquellos que todavía se preguntan cómo hacer un fragmento de código en APT: + --------------------- – JoshC13

3

Apache Maven Fluido piel destaca sintaxis fuera de la caja. Here puedes encontrar un ejemplo. Información sobre el resaltado de sintaxis en Fluido: "Las secciones de código fuente son mejoradas por Google Code Prettify, los usuarios pueden opcionalmente habilitar la representación de números de línea (deshabilitados de forma predeterminada)" desde el sitio web de Fluido.

Fuente

2013-03-22 12:35:06 Marcin

+0

La página del enlace que proporcione en su ejemplo parece haberse creado con xdoc, no con APT (consulte https://svn.apache.org/repos/asf/logging/log4j/log4j2/trunk/src/site/xdoc/manual/markers.xml). ¿Conoces un ejemplo que utiliza Fluido/Google Code Prettify con APT? (no se puede hacer realidad con mi proyecto, parece ... tal vez debería recurrir también a xdoc) – evandor

+0

@evandor El proyecto Maven Fluido Skin utiliza APT; El sitio [maven-fluido-skin] (http://maven.apache.org/skins/maven-fluido-skin/) está hecho usando APT ([fuente] (http://svn.apache.org/viewvc/maven) /skins/tags/maven-fluido-skin-1.3.0/src/site/apt/index.apt.vm?view=markup)). – Marcin

11

Para aquellos que todavía están preguntándose cómo hacer un código cortado con tijeras en APT:

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

Fuente

2013-07-22 16:09:21 JoshC13

3

La sintaxis

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

es correcta. Y Fluido resalta usando Prettify como otros lo han mencionado.

Sin embargo, un cambio de Doxia en el complemento del sitio 3.3 rompió Fluido. MSKINS-86 corrige esto, pero aún no se ha lanzado.

Soluciones provisionales

  1. Usar la site.xml workaround <body> <head> <script type="text/javascript"> $(document).ready(function() { $("div.source pre").addClass("prettyprint"); prettyPrint(); }); </script> </head> </body>
  2. uso del sitio Plugin 3.2
  3. Construir la inédita Fluido 1,4 que contiene MSKINS-86 fija y usarlo en lugar de 1.3.1

Fuente

2015-05-06 19:07:47 Keegan

Cuestiones relacionadas

 Cuestiones relacionadas