Return-Path: X-Original-To: apmail-maven-dev-archive@www.apache.org Delivered-To: apmail-maven-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id EB5667152 for ; Tue, 18 Oct 2011 16:07:31 +0000 (UTC) Received: (qmail 80800 invoked by uid 500); 18 Oct 2011 16:07:31 -0000 Delivered-To: apmail-maven-dev-archive@maven.apache.org Received: (qmail 80727 invoked by uid 500); 18 Oct 2011 16:07:30 -0000 Mailing-List: contact dev-help@maven.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Help: List-Post: List-Id: "Maven Developers List" Reply-To: "Maven Developers List" Delivered-To: mailing list dev@maven.apache.org Received: (qmail 80719 invoked by uid 99); 18 Oct 2011 16:07:30 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 18 Oct 2011 16:07:30 +0000 X-ASF-Spam-Status: No, hits=-0.7 required=5.0 tests=FREEMAIL_FROM,RCVD_IN_DNSWL_LOW,SPF_PASS X-Spam-Check-By: apache.org Received-SPF: pass (athena.apache.org: domain of simone.tripodi@gmail.com designates 209.85.160.171 as permitted sender) Received: from [209.85.160.171] (HELO mail-gy0-f171.google.com) (209.85.160.171) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 18 Oct 2011 16:07:25 +0000 Received: by gyg13 with SMTP id 13so1064402gyg.30 for ; Tue, 18 Oct 2011 09:07:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=mime-version:sender:in-reply-to:references:date :x-google-sender-auth:message-id:subject:from:to:content-type; bh=EKiCylxic+UDpW0FJI9hgJzAHCKAID7MAb6Fh/s5Vus=; b=mUqY8IZ2Ppow98Z2Ne/5bzzbb03+Xwg+Hkv1NVsx12JfnhC6hNmVHbdtc0tFOu7UPj ZAnUHYhtFT1DSNcZM5gMKh8sRoY520K2ZksGYVOe9NkZ3WXy9lFoJFmsl2P8fgGsxUPp atHFfModwxuRIFhh6B+g7an2uKTz6WA6pKWSI= MIME-Version: 1.0 Received: by 10.150.103.8 with SMTP id a8mr2887349ybc.11.1318954024114; Tue, 18 Oct 2011 09:07:04 -0700 (PDT) Sender: simone.tripodi@gmail.com Received: by 10.150.96.13 with HTTP; Tue, 18 Oct 2011 09:07:03 -0700 (PDT) In-Reply-To: <4E9D1C73.9000306@gmail.com> References: <4E9D1C73.9000306@gmail.com> Date: Tue, 18 Oct 2011 18:07:03 +0200 X-Google-Sender-Auth: 8DA3YpNq1PRUJw30JtBYVGx7SuQ Message-ID: Subject: Re: [skin][fluido] APT vs XDOC From: Simone Tripodi To: Maven Developers List Content-Type: text/plain; charset=UTF-8 Hi Ivan! the License page doesn't look good indeed in this way, we have to do something. As you noticed, applying the `prettyprint` class to
 elements, would warrant that feature even to
formats where classes cannot be set (due to some limitations of the
language).

Suggesting our users to port their existing sites to xdoc to have the
prettification feature wouldn't be so nice - the maven site itself is
written in APT and is a lot of documentation! - so what I suggest is
trying to understand when is not appropriate applying the current
document modification.
Maybe the License page - and few other cases that I don't know - are
just exceptions.

My 2 cents,
Simo

http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/



2011/10/18 Ivan Habunek :
> 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 
class="source">
 Then you add the prettpyrint class by javascript to all
> 
 elements within  elements.
>
> This does not allow for non-prettified 
 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) 
> b) 
> c) 
>
> This allows for much more flexibility, but requires usage of XDOC format to
> have code prettification. APT +-- syntax always produces plain 
 blocks.
>
> Again, the problem is that maven transforms 
 to
> 
 (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: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org