1. casa
  2. Domanda e risposta
  3. Formato codice in Doxia Apt Formato

Formato codice in Doxia Apt Formato

2011-09-22 11 views
9

Attualmente sto iniziando a scrivere una documentazione per uno dei nostri progetti. Per ragioni di semplicità, abbiamo scelto di utilizzare il testo quasi normale (APT) Formato, vedere di più informazioni qui: http://maven.apache.org/doxia/references/apt-format.htmlFormato codice in Doxia Apt Formato

APT è grande formato di documentazione, in quanto utilizza una sintassi minima e quindi è molto facile creare e rendere modifiche alla documentazione senza sapere molto su APT.

Tuttavia, non sono riuscito a trovare un modo per formattare il codice in un modo piacevole. Esiste un tag di codice o simile, che può essere utilizzato per includere un codice sorgente? Sono consapevole che potrei usare FML, ma questo sarebbe meno desiderabile.

Grazie

fonte

2011-09-22 evgeni

+0

ha appena visto questo plug-in: http://code.google.com/p/m2-site-tools/wiki/UserGuide tuttavia, la funzione hightlight non sembra funzionare nether per java né per xml. – evgeni

+0

c'è anche questo progetto: http://doxia-include.sourceforge.net/usageAndReference.html. Tuttavia, non sono riuscito a compilare il mio pom.xml in quanto mancavano le dipendenze: Errore di compilazione del progetto: estensione build non risolvibile: Plugin org.apache.maven.plugins: plugin-site-plugin: 3.0-beta-3 o una delle sue dipendenze potrebbe non risolto: Impossibile trovare artefatto org.tinyjee: doxia-include-macro: jar: 1.0 in central (http://repo1.maven.org/maven2) – evgeni

+0

stesso problema con questo progetto: http: // sintassi- highlighted-snippet.googlecode.com/svn/site/index.html – evgeni

risposta

2

ho finito per usare la macro frammento della Guida Doxia Macro: http://maven.apache.org/doxia/macros/index.html#Snippet_Macro

mette il codice dal file di frammento di in una scatola di Verbatim. Tuttavia non fornisce una evidenziazione della sintassi.

fonte

2011-09-23 08:51:34 evgeni

+0

per coloro che si stanno ancora chiedendo come creare uno snippet di codice in APT: + --------------------- – JoshC13

3

Apache Maven Fluido pelle mette in evidenza la sintassi fuori dalla scatola. Here puoi trovare un esempio. Informazioni sull'evidenziazione della sintassi in Fluido: "Le sezioni del codice sorgente sono migliorate da Google Code Prettify, gli utenti possono abilitare facoltativamente il rendering dei numeri di riga (disabilitato per impostazione predefinita)" dal sito Web di Fluido.

fonte

2013-03-22 12:35:06 Marcin

+0

La pagina del link fornito in il tuo esempio sembra essere creato con xdoc, non con APT (vedi https://svn.apache.org/repos/asf/logging/log4j/log4j2/trunk/src/site/xdoc/manual/markers.xml). Ti capita di conoscere un esempio utilizzando Fluido/Google Code Prettify with APT? (non può farlo accadere con il mio progetto sembra ... forse dovrei ricorrere anche a xdoc) – evandor

+0

@evandor Maven Fluido Skin stesso del progetto usa APT; [maven-fluido-skin] (http://maven.apache.org/skins/maven-fluido-skin/) il sito è realizzato usando APT ([fonte] (http://svn.apache.org/viewvc/maven /skins/tags/maven-fluido-skin-1.3.0/src/site/apt/index.apt.vm?view=markup)). – Marcin

11

Per coloro che sono ancora chiedendo come fare un codice snipped in APT:

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

fonte

2013-07-22 16:09:21 JoshC13

3

La sintassi

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

è corretto. E Fluido evidenzia usando Prettify fuori dalla scatola come altri hanno menzionato.

Tuttavia, un cambio Doxia nel plug-in sito 3.3 ha rotto Fluido. MSKINS-86 risolve questo problema, ma non è ancora stato rilasciato.

Soluzioni alternative

  1. Utilizzare il site.xml plugin workaround <body> <head> <script type="text/javascript"> $(document).ready(function() { $("div.source pre").addClass("prettyprint"); prettyPrint(); }); </script> </head> </body>
  2. uso Site 3.2
  3. Costruire la inedito Fluido 1.4 che contiene MSKINS-86 fix e utilizzarlo al posto di 1.3.1

fonte

2015-05-06 19:07:47 Keegan

Problemi correlati

 Problemi correlati