Hi,

One problem with using APT for writing docs is that code can only be included within the +-- tags. This is rendeder as two nested elements <div class="source"><pre> Then you add the prettpyrint class by javascript to all <pre> elements within <code> elements.

This does not allow for non-prettified <pre> blocks and makes some pages look pretty weird, e.g.:
http://people.apache.org/~olamy/maven/site/license.html

The only reasonable alternative i discovered is using XDOC and specifying your own blocks as either:
a) <pre>
b) <pre class="prettyprint">
c) <pre class="prettyprint linenums">

This allows for much more flexibility, but requires usage of XDOC format to have code prettification. APT +-- syntax always produces plain <pre> blocks.

Again, the problem is that maven transforms <pre class="prettyprint"> to <div class="prettyprint"><pre> (why o why?) but this can also be fixed by javascript.

To conclude, I'm migrating most of log4php docs to XDOC format because of this and some other APT limitations. It is a bit more difficult to write, but it is more flexible.

If you like the solution I can transfer it to the sandbox.

Regards,
Ivan



---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to