From dev-return-138565-apmail-commons-dev-archive=commons.apache.org@commons.apache.org  Tue Sep 18 13:42:39 2012
Return-Path: <dev-return-138565-apmail-commons-dev-archive=commons.apache.org@commons.apache.org>
X-Original-To: apmail-commons-dev-archive@www.apache.org
Delivered-To: apmail-commons-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 93EFDDE48
	for <apmail-commons-dev-archive@www.apache.org>; Tue, 18 Sep 2012 13:42:39 +0000 (UTC)
Received: (qmail 29467 invoked by uid 500); 18 Sep 2012 13:42:39 -0000
Delivered-To: apmail-commons-dev-archive@commons.apache.org
Received: (qmail 29351 invoked by uid 500); 18 Sep 2012 13:42:39 -0000
Mailing-List: contact dev-help@commons.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:dev-help@commons.apache.org>
List-Unsubscribe: <mailto:dev-unsubscribe@commons.apache.org>
List-Post: <mailto:dev@commons.apache.org>
List-Id: <dev.commons.apache.org>
Reply-To: "Commons Developers List" <dev@commons.apache.org>
Delivered-To: mailing list dev@commons.apache.org
Received: (qmail 29343 invoked by uid 99); 18 Sep 2012 13:42:39 -0000
Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230)
    by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 18 Sep 2012 13:42:39 +0000
X-ASF-Spam-Status: No, hits=-2.3 required=5.0
	tests=RCVD_IN_DNSWL_MED,SPF_HELO_PASS,SPF_PASS
X-Spam-Check-By: apache.org
Received-SPF: pass (nike.apache.org: domain of SRS0=uCZ8=HR=m4x.org=sebastien.brisard@bounces.m4x.org designates 129.104.30.34 as permitted sender)
Received: from [129.104.30.34] (HELO mx1.polytechnique.org) (129.104.30.34)
    by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 18 Sep 2012 13:42:31 +0000
Received: from mail-oa0-f43.google.com (mail-oa0-f43.google.com [209.85.219.43])
	(using TLSv1 with cipher RC4-SHA (128/128 bits))
	(No client certificate requested)
	by ssl.polytechnique.org (Postfix) with ESMTPSA id 69F57140C0BE0
	for <dev@commons.apache.org>; Tue, 18 Sep 2012 15:42:10 +0200 (CEST)
Received: by oagl10 with SMTP id l10so8125855oag.30
        for <dev@commons.apache.org>; Tue, 18 Sep 2012 06:42:09 -0700 (PDT)
MIME-Version: 1.0
Received: by 10.60.170.241 with SMTP id ap17mr383561oec.4.1347975729114; Tue,
 18 Sep 2012 06:42:09 -0700 (PDT)
Received: by 10.60.43.133 with HTTP; Tue, 18 Sep 2012 06:42:09 -0700 (PDT)
In-Reply-To: <8a1ff3c50746ebfb0527ef609ec83790@spaceroots.org>
References: <CAGRH7Hrc-5rr_Ns4y-FV-WG9KijpNwWhgEq445sam4fnxjfszQ@mail.gmail.com>
	<505795EB.6040200@free.fr>
	<CAOGo0VZ4YVS85U+PojB1ZjfBA3RXona=r=BCw3UYUwjfRX5ZMw@mail.gmail.com>
	<CAGRH7HoZ6NX357F1v0ewqCedMQaA6SZ7_Z1W3nye+U2-nwGmwA@mail.gmail.com>
	<CAGRH7HpMuJ4gDRmdWe4OsFXy=asVQzgPxExDcJTRNrb_-BNQWg@mail.gmail.com>
	<add6df8546721e22f5f23f28a9dce3f6@spaceroots.org>
	<CAGRH7Ho1nqjv-_dMtPo6HZW_VsE9BR8LeAro9uyCqh-xXwwLxQ@mail.gmail.com>
	<CAGRH7Hph53vcY7B9h7bpE6d6jkik-zUq_-UP0X3+7hyV6T=jyQ@mail.gmail.com>
	<8f9663fda98eb4c0eedb3fb012eb9d54@spaceroots.org>
	<CAGRH7Ho40rWG=fBN118gK1N4CUKGQsSeyyMq_WXU+rRiaRwC4g@mail.gmail.com>
	<8a1ff3c50746ebfb0527ef609ec83790@spaceroots.org>
Date: Tue, 18 Sep 2012 15:42:09 +0200
Message-ID: <CAGRH7Hpy0d95BYDwe596+PZyJrkRPWpm+YN1Hrvpm7TgZ3N2AQ@mail.gmail.com>
Subject: Re: [all] xdoc vs. apt
From: =?ISO-8859-1?Q?S=E9bastien_Brisard?= <sebastien.brisard@m4x.org>
To: Commons Developers List <dev@commons.apache.org>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable
X-AV-Checked: ClamAV using ClamSMTP at svoboda.polytechnique.org (Tue Sep 18 15:42:10 2012 +0200 (CEST))
X-Org-Mail: sebastien.brisard.1997@polytechnique.org
X-Old-Spam-Flag: No, tests=bogofilter, spamicity=0.250635, queueID=B1608140C0BE1

Hi Luc,

2012/9/18 luc <luc@spaceroots.org>:
> Le 2012-09-18 14:34, S=E9bastien Brisard a =E9crit :
>
>> Hi Luc,
>>
>>>
>>>>
>>>>>
>>>>> Having something compatible with Mathjax would be a tremendous step
>>>>> forward
>>>>> for [math]. I would really love to see this happen!
>>>>>
>>>>
>>>> We can in fact make it happen now! In the site.xml file, we just need
>>>> to add (in the <body></body> section)
>>>>
>>>> <head>
>>>> <script src=3D'http://cdn.mathjax.org/mathjax/latest/MathJax.js'
>>>
>>>
>>>
>>> Yes, I know about that, but this means our page depend on some external
>>> service which is frowned upon at Apache. If we want to jump to the
>>> MathJax
>>> bandwagon I think we should have a copy of MathJax installed on our
>>> servers.
>>> We could do it ourselves in a dedicated area of our components, but it
>>> may be
>>> better to ask infra about it  before (for the record, MathJax is
>>> distributed under the
>>> terms of the Apache License V2).
>>>
>>
>> OK, you already knew about that. I'm sorry.
>>
>>>
>>> On the other hand, if we set up the site.xml file to point to a local
>>> installation,
>>> then users who regenerate the site and do not install MathJax by
>>> themselves
>>> would get weird results.
>>>
>> I have never tried to install MathJax locally, I understand it's quite
>> a ride. We should spare this to our users...
>
>
> It's quite simple (just unzip an archive somewhere yours server has read
> access too).
> However, it is quite large. The zip archive is 17.6 MB (for 2.0) and expa=
nd
> to a 136 MB tree.
> So yes, we should spare this to our users.
>
>
>>
>>>
>>> So at least we have to think a little about it.
>>>
>> Another option would be this: since maven-site works with strict xhtml
>> (unlike javadoc), we can embed MathML code in our pages. I'm not sure
>> how we would do it in xdoc or apt, but we can certainly write our
>> user's guide in xhtml (which would not make much of a difference as
>> compared to xdoc). I know MathML is (very) verbose, but our site would
>> then be fully self-sufficient. One approach I use quite consistently
>> is to write MathML objects in *.mml files, which are included in the
>> xhtml file.
>
>
> Please, don't go that way. MathML is really tough to write and to read. I=
t
> is something
> that should be done only by tools, it's not an authoring environment.
>
I won't go this way before we discuss it, of course! I know the
argument about MathML not to be used directly. However, I *have* used
it for lack of a better solution. MathJax is very good, but if I'm
offline, then I can't see my doc properly. However, I thought that
MathJax was both huge and difficult to install. Since it is only
large, I might consider installing it locally.

> Really, MathJax (I think Gilles was the first to suggest it years ago) is=
 a
> very good
> option with its support to simpler syntax than MathML. Perhaps the concer=
ns
> I have
> about hosting the files are stupid. Perhaps even if we decide to host the=
se
> files
> it would be easy to do use local files for our own servers and have the
> regular maven
> build for users use the public cdn files.
>
That would certainly work, but then our users would not be able to see
the documentation properly if they are off-line.

S=E9bastien


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