commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From S├ębastien Brisard <sebastien.bris...@m4x.org>
Subject [math] APT format for the users guide
Date Thu, 20 Sep 2012 06:45:43 GMT
Hello,
as I previously said, I'd like to extend the user's guide for the
special functions package. I am not a big fan of the xdoc format
currently in use, at is not easily readable. So I thought I would give
APT a go. Please find below the code corresponding to the current
"Special Functions" page.
The learning curve is not steep at all (about 5 minutes!). I think
it's much better (even for tables, which might require a large screen
;)).

The generated pages are identical (I've even reproduced the typo in
5.4...), but for the fact that you cannot have anchors with a name
different from the text they refer to. So anchor {Beta} would be named
"Beta", and not "beta" as is currently the case. I don't think this is
much of an issue, as there is no reference to these anchors (I'll
check the other pages of the user's guide, and update them if
necessary).

So, what do you think? Should I pursue, or would you like me to stay
with the xdoc format?

I would like to emphasize I'm not advocating for a complete switch
from one format to another. But since I'm going to concentrate on this
section of the users guide, I thought I might as well choose the
format which I am most comfortable with. If you do not like the idea
of having two different formats for the same site, please let me know.

Best regards,
S├ębastien

Here is the text (best viewed after copying/pasting in a real text editor).

~~
~~ Licensed to the Apache Software Foundation (ASF) under one or more
~~ contributor license agreements.  See the NOTICE file distributed with
~~ this work for additional information regarding copyright ownership.
~~ The ASF licenses this file to You under the Apache License, Version 2.0
~~ (the "License"); you may not use this file except in compliance with
~~ the License.  You may obtain a copy of the License at
~~
~~      http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing, software
~~ distributed under the License is distributed on an "AS IS" BASIS,
~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~~ See the License for the specific language governing permissions and
~~ limitations under the License.
~~

  -----------------------------------------------
  The Commons Math User Guide - Special Functions
  -----------------------------------------------

5 Special Functions

* 5.1 Overview

  The special functions portion of Commons-Math contains several useful
  functions not provided by <<<java.lang.Math>>>.  These functions mostly
serve
  as building blocks for other portions of Commons-Math but, as others may find
  them useful as stand-alone methods, these special functions were included as
  part of the Commons-Math public API.

* 5.2 Erf functions

  {{{../apidocs/org/apache/commons/math3/special/Erf.html}Erf}} contains
  several useful functions involving the Error Function, Erf.

*----------------+---------+-------------------------------------------------------------------+
|| Function      || Method || Reference
                        |
*----------------+---------+-------------------------------------------------------------------+
| Error Function |erf      | See
{{{http://mathworld.wolfram.com/Erf.html}Erf}} from MathWorld |
*----------------+---------+-------------------------------------------------------------------+

* 5.3 Gamma functions

  {{{../apidocs/org/apache/commons/math3/special/Gamma.html}Gamma}} contains
  several useful functions involving the Gamma Function.

*-------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
|| Function         || Method           || Reference

          |
*-------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
| Log Gamma         | logGamma          | See
{{{http://mathworld.wolfram.com/GammaFunction.html}Gamma Function}}
from MathWorld                        |
*-------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
| Regularized Gamma | regularizedGammaP | See
{{{http://mathworld.wolfram.com/RegularizedGammaFunction.html}Regularized
Gamma Function}} from MathWorld |
*-------------------+-------------------+---------------------------------------------------------------------------------------------------------------+

* 5.4 Beta funtions

  {{{../apidocs/org/apache/commons/math3/special/Beta.html}Beta}} contains
  several useful functions involving the Beta Function.

*------------------+-----------------+-------------------------------------------------------------------------------------------------------------+
|| Function        || Method         || Reference

     |
*------------------+-----------------+-------------------------------------------------------------------------------------------------------------+
| Log Beta         | logBeta         | See
{{{http://mathworld.wolfram.com/BetaFunction.html}Beta Function}} from
MathWorld                        |
*------------------+-----------------+-------------------------------------------------------------------------------------------------------------+
| Regularized Beta | regularizedBeta | See
{{{http://mathworld.wolfram.com/RegularizedBetaFunction.html}Regularized
Beta Function}} from MathWorld |
*------------------+-----------------+-------------------------------------------------------------------------------------------------------------+


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


Mime
View raw message