Return-Path: 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 863BA108AB for ; Wed, 17 Jul 2013 23:53:08 +0000 (UTC) Received: (qmail 83923 invoked by uid 500); 17 Jul 2013 23:53:08 -0000 Delivered-To: apmail-commons-dev-archive@commons.apache.org Received: (qmail 83843 invoked by uid 500); 17 Jul 2013 23:53:08 -0000 Mailing-List: contact dev-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "Commons Developers List" Delivered-To: mailing list dev@commons.apache.org Received: (qmail 83835 invoked by uid 99); 17 Jul 2013 23:53:08 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 17 Jul 2013 23:53:08 +0000 X-ASF-Spam-Status: No, hits=-0.0 required=5.0 tests=RCVD_IN_DNSWL_NONE,SPF_PASS X-Spam-Check-By: apache.org Received-SPF: pass (nike.apache.org: domain of phil.steitz@gmail.com designates 209.85.192.181 as permitted sender) Received: from [209.85.192.181] (HELO mail-pd0-f181.google.com) (209.85.192.181) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 17 Jul 2013 23:53:00 +0000 Received: by mail-pd0-f181.google.com with SMTP id 14so2359388pdj.40 for ; Wed, 17 Jul 2013 16:52:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=message-id:date:from:user-agent:mime-version:to:subject:references :in-reply-to:content-type:content-transfer-encoding; bh=HEaprO9vZG2Rky+cUqoAGxNMP3i+ijwPNtG8ki1VwGw=; b=CDWIo9QikXpPbWB3m32Km0/yAVbo/Fz2Ln2x2x1cYWWABhKsUPK0CLZ6adCH9WU5wp hF0o5lF5nNY5HTSYCYkBoWco8EsG7t9IxFUoMLvwQ57NsdvHhBYloQCG5n71p/r15afU C1j0WAiMTmrdxEJSB+3MjlytH5GIZu7nlbBCAgO8gdKLeIfLXlK/qEkgJMyS3MF+5KkM E24pdFFAeqoDPLlD6PM4+WYas0pFe15BVr6ExKzqahz9ojKiqv3SDnndSEsL8pUFTHuK +1frz3acayupaUQVxsjqKJk9OFXBGHqiD3/OH3Mm18kVtpQI1MTnOod9ZSrkXpRA4bgy +P9w== X-Received: by 10.66.163.73 with SMTP id yg9mr10292600pab.77.1374105159546; Wed, 17 Jul 2013 16:52:39 -0700 (PDT) Received: from [192.168.2.104] (ip72-208-109-243.ph.ph.cox.net. [72.208.109.243]) by mx.google.com with ESMTPSA id dc5sm10117858pbc.37.2013.07.17.16.52.38 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 17 Jul 2013 16:52:38 -0700 (PDT) Message-ID: <51E72E45.1010104@gmail.com> Date: Wed, 17 Jul 2013 16:52:37 -0700 From: Phil Steitz User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:17.0) Gecko/20130620 Thunderbird/17.0.7 MIME-Version: 1.0 To: Commons Developers List Subject: Re: svn commit: r1504314 - in /commons/proper/math/trunk: build.xml pom.xml src/changes/changes.xml src/site/xdoc/developers.xml References: <20130717224207.E074F23888E2@eris.apache.org> In-Reply-To: Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit X-Virus-Checked: Checked by ClamAV on apache.org On 7/17/13 4:08 PM, sebb wrote: > On 17 July 2013 23:42, wrote: >> Author: psteitz >> Date: Wed Jul 17 22:42:07 2013 >> New Revision: 1504314 >> >> URL: http://svn.apache.org/r1504314 >> Log: >> Enabled LaTeX expressions in javadoc via MathJax. JIRA: MATH-1006. >> >> Modified: >> commons/proper/math/trunk/build.xml >> commons/proper/math/trunk/pom.xml >> commons/proper/math/trunk/src/changes/changes.xml >> commons/proper/math/trunk/src/site/xdoc/developers.xml >> >> Modified: commons/proper/math/trunk/build.xml >> URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/build.xml?rev=1504314&r1=1504313&r2=1504314&view=diff >> ============================================================================== >> --- commons/proper/math/trunk/build.xml (original) >> +++ commons/proper/math/trunk/build.xml Wed Jul 17 22:42:07 2013 >> @@ -247,6 +247,7 @@ >> doctitle="<h1>${component.title} ${component.version}</h1>" >> windowtitle="${component.title} ${component.version}" >> bottom="Copyright (c) 2003-${current.year} Apache Software Foundation" >> + additionalparam="-header '<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>'" >> classpathref="compile.classpath"> >> >> >> >> Modified: commons/proper/math/trunk/pom.xml >> URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/pom.xml?rev=1504314&r1=1504313&r2=1504314&view=diff >> ============================================================================== >> --- commons/proper/math/trunk/pom.xml (original) >> +++ commons/proper/math/trunk/pom.xml Wed Jul 17 22:42:07 2013 >> @@ -455,7 +455,15 @@ >> >> >> >> - >> + >> + >> + org.apache.maven.plugins >> + maven-javadoc-plugin >> + 2.9.1 > Version should be defined as a property. > CP32 defines commons.javadoc.version as 2.9.1, so the line could be > dropped if Math moves to CP32. > Otherwise, just define commons.javadoc.version as 2.9.1 locally, and > drop the version lines (CP30 defines them) Thanks for reviewing. I was not sure it would be correctly inherited, so put it in explicitly. If we can count on it coming correctly from the parent, I would say drop it. Phil >> + >> + -header '<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>' >> + >> + >> >> >> >> @@ -578,6 +586,15 @@ >> >> >> >> + >> + >> + org.apache.maven.plugins >> + maven-javadoc-plugin >> + 2.9.1 > Version is unnecessary - see above. > >> + >> + -header '<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>' >> + >> + >> >> >> >> >> Modified: commons/proper/math/trunk/src/changes/changes.xml >> URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/changes/changes.xml?rev=1504314&r1=1504313&r2=1504314&view=diff >> ============================================================================== >> --- commons/proper/math/trunk/src/changes/changes.xml (original) >> +++ commons/proper/math/trunk/src/changes/changes.xml Wed Jul 17 22:42:07 2013 >> @@ -51,6 +51,9 @@ If the output is not quite correct, chec >> >> >> >> + >> + Enabled LaTeX expressions in javadoc via MathJax. >> + >> >> Add mode function to Frequency class. >> >> >> Modified: commons/proper/math/trunk/src/site/xdoc/developers.xml >> URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/developers.xml?rev=1504314&r1=1504313&r2=1504314&view=diff >> ============================================================================== >> --- commons/proper/math/trunk/src/site/xdoc/developers.xml (original) >> +++ commons/proper/math/trunk/src/site/xdoc/developers.xml Wed Jul 17 22:42:07 2013 >> @@ -175,6 +175,17 @@ >> External references or full statements of definitions for all mathematical >> terms used in component documentation must be provided. >>
  • >> + Commons math javadoc generation now supports embedded LaTeX formulas via the >> + MathJax javascript display engine. To >> + embed mathematical expressions formatted in LaTeX in javadoc, simply surround >> + the expression to be formatted with either \( and \) for inline >> + formulas, or \[ and \] to have the formula appear on a separate line. >> + For example, \(a^2 + b^2 = c^2\) will render an in-line formula >> + saying thqt (a, b, c) is Pythagorean triplet. Using \[ and \] on >> + the ends will render the same formula on a separate line. See the MathJax >> + and LaTex documentation for details on how to represent formulas and >> + escape special characters.
    • >> +
  • >> Implementations should use standard algorithms and >> references or full descriptions of all algorithms should be >> provided.
    • >> >> > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org > For additional commands, e-mail: dev-help@commons.apache.org > > --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org For additional commands, e-mail: dev-help@commons.apache.org