This is an automated email from the ASF dual-hosted git repository. erans pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-geometry.git
The following commit(s) were added to refs/heads/master by this push: new 641a975 Project information. 641a975 is described below commit 641a975a080e46401541e9f9ee451a4353965586 Author: Gilles Sadowski <gil...@harfang.homelinux.org> AuthorDate: Tue Sep 18 12:19:27 2018 +0200 Project information. --- README.md | 13 +- src/assembly/bin.xml | 55 +++++++ src/assembly/src.xml | 35 +++++ src/changes/changes.xml | 68 +++++++++ src/site/apt/userguide/geometry.apt | 24 ++++ src/site/site.xml | 48 +++++++ src/site/xdoc/developers.xml | 277 ++++++++++++++++++++++++++++++++++++ src/site/xdoc/download_geometry.xml | 118 +++++++++++++++ src/site/xdoc/index.xml | 46 ++++++ src/site/xdoc/issue-tracking.xml | 102 +++++++++++++ src/site/xdoc/mail-lists.xml | 205 ++++++++++++++++++++++++++ src/site/xdoc/release-history.xml | 35 +++++ src/site/xdoc/userguide/index.xml | 41 ++++++ src/site/xdoc/userguide/xdoc.xsl | 68 +++++++++ 14 files changed, 1129 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a0b2cea..f889707 100644 --- a/README.md +++ b/README.md @@ -45,12 +45,13 @@ Apache Commons Geometry [](https://travis-ci.org/apache/commons-geometry-parent) [](https://coveralls.io/github/apache/commons-geometry?branch=master) -#[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-core/) -#[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-bsp/) -#[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-enclosing/) -#[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-euclidean/) -#[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-hull/) -#[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-spherical/) +<!--- +[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-core/) +[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-enclosing/) +[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-euclidean/) +[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-hull/) +[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-spherical/) +---> [](http://www.apache.org/licenses/LICENSE-2.0.html) The Apache Commons Geometry project provides geometric types and utilities. diff --git a/src/assembly/bin.xml b/src/assembly/bin.xml new file mode 100644 index 0000000..87531bf --- /dev/null +++ b/src/assembly/bin.xml @@ -0,0 +1,55 @@ +<!-- + 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. +--> +<assembly> + <id>bin</id> + <formats> + <format>tar.gz</format> + <format>zip</format> + </formats> + <baseDirectory>${project.artifactId}-${project.version}</baseDirectory> + <includeSiteDirectory>false</includeSiteDirectory> + <dependencySets> + <dependencySet> + <useProjectArtifact>false</useProjectArtifact> + <useTransitiveDependencies>false</useTransitiveDependencies> + </dependencySet> + </dependencySets> + + <fileSets> + <fileSet> + <directory>${project.basedir}/..</directory> + <includes> + <include>LICENSE.txt</include> + <include>NOTICE.txt</include> + <include>RELEASE-NOTES.txt</include> + </includes> + </fileSet> + <fileSet> + <directory>${project.basedir}/target/dependency</directory> + <outputDirectory></outputDirectory> + <includes> + <include>commons-geometry*.jar</include> + </includes> + </fileSet> + <fileSet> + <directory>${project.basedir}../target/site</directory> + <outputDirectory>docs</outputDirectory> + <excludes> + </excludes> + </fileSet> + </fileSets> +</assembly> diff --git a/src/assembly/src.xml b/src/assembly/src.xml new file mode 100644 index 0000000..cf75fed --- /dev/null +++ b/src/assembly/src.xml @@ -0,0 +1,35 @@ +<!-- + 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. +--> +<assembly> + <id>src</id> + <formats> + <format>tar.gz</format> + <format>zip</format> + </formats> + <baseDirectory>${project.artifactId}-${project.version}-src</baseDirectory> + <fileSets> + <fileSet> + <directory>${project.basedir}/..</directory> + <excludes> + <exclude>${project.build.directory}/**</exclude> + <exclude>.*/**</exclude> + <exclude>**/${project.build.directory}/**</exclude> + <exclude>**/.*/**</exclude> + </excludes> + </fileSet> + </fileSets> +</assembly> diff --git a/src/changes/changes.xml b/src/changes/changes.xml new file mode 100644 index 0000000..f4763e6 --- /dev/null +++ b/src/changes/changes.xml @@ -0,0 +1,68 @@ +<?xml version="1.0"?> +<!-- + 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. +--> + +<!-- +This file is used by the maven-changes-plugin to generate the release notes. +Useful ways of finding items to add to this file are: + +1. Add items when you fix a bug or add a feature (this makes the +release process easy :-). + +2. Do a JIRA search for tickets closed since the previous release. + +3. Use the report generated by the maven-changelog-plugin to see all +SVN commits. + +To generate the file RELEASE-NOTES.txt from this file: + +mvn changes:announcement-generate -Prelease-notes [-Dchanges.version] + +The <action> type attribute can be add,update,fix,remove. +--> + +<!-- NOTE: +The description attribute entries below are specially formatted +so as to improve the layout of the generated text release notes. + +The parsing process removes all line feeds, replacing them with a single space. +The Velocity template in src/changes/release-notes.vm has been enhanced to replace pairs of adjacent spaces +with a new-line in the release notes. (These spaces are ignored when displaying HTML). +If the output is not quite correct, check for invisible trailing spaces! +--> + +<document> + <properties> + <title>Apache Commons Geometry Release Notes</title> + </properties> + <body> + + <release version="1.0" date="TBD" description=" +This is the first release of Apache Commons Geometry. + +Apache Commons RNG 1.0 contains the following modules: + commons-geometry-core (requires Java 8) + commons-geometry-bsp (requires Java 8) + commons-geometry-hull (requires Java 8) + commons-geometry-enclosing (requires Java 8) + commons-geometry-spherical (requires Java 8) + commons-geometry-euclidean (requires Java 8) +"> + </release> + + </body> +</document> diff --git a/src/site/apt/userguide/geometry.apt b/src/site/apt/userguide/geometry.apt new file mode 100644 index 0000000..9bc40a8 --- /dev/null +++ b/src/site/apt/userguide/geometry.apt @@ -0,0 +1,24 @@ +~~ +~~ 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 Apache Commons Geometry User Guide + ----------------------------- + +1. Purpose + + <<<Commons Geometry>>> provides ... <TO DO> diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 0000000..8938488 --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + 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. +--> +<project name="Geometry"> + <bannerRight> + <name>Apache Commons Geometry</name> + <src>/images/commons_geometry.small.png</src> + <href>/index.html</href> + </bannerRight> + + <body> + <menu name="Geometry"> + <item name="Overview" href="/index.html"/> + <item name="Downloads" href="http://commons.apache.org/geometry/download_geometry.cgi"/> + <item name="Issue Tracking" href="/issue-tracking.html"/> + <item name="Source Repository (current)" + href="https://gitbox.apache.org/repos/asf/commons-geometry.git"/> + <!-- <item name="Wiki" --> + <!-- href="http://wiki.apache.org/commons/Geometry"/> --> + <item name="Developers Guide" href="/developers.html"/> + <item name="Release History" href="/release-history.html" /> + </menu> + + <menu name="User Guide"> + <item name="Contents" href="/userguide/index.html"/> + </menu> + + <head> + <![CDATA[<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"> + </script>]]> + </head> + + </body> +</project> diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml new file mode 100644 index 0000000..b781e29 --- /dev/null +++ b/src/site/xdoc/developers.xml @@ -0,0 +1,277 @@ +<?xml version="1.0"?> +<!-- + 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. + --> + +<document> + <properties> + <title>Developers Guide</title> + </properties> + + <body> + + <section name="Aims"> + <p> + Maintenance of a library by decentralized team requires communication. + It is important that developers follow guidelines laid down by the community + to ensure that the code they create can be successfully maintained by others. + </p> + </section> + + <section name='Guidelines'> + <p> + Developers are asked to comply with the following development guidelines. + Code that does not comply with the guidelines including the word <i>must</i> + will not be committed. Our aim will be to fix all of the exceptions to the + "<i>should</i>" guidelines prior to a release. + </p> + <subsection name="Contributing"> + <p><strong>Getting Started</strong></p> + <p> + <ol> + <li> + Download the Commons Geometry source code. Follow the instructions + under the heading "Repository Checkout" on the + <a href="https://git-wip-us.apache.org/">Git at the ASF page</a>. + The git url for the current development sources of Commons Geometry + is <source>http://git-wip-us.apache.org/repos/asf/commons-rng.git</source> + for anonymous read-only access and + <source>https://apach...@git-wip-us.apache.org/repos/asf/commons-rng.git</source> + (where apacheid should be replaced by each committer Apache ID) for committers + read-write access. + </li> + <li> + Like most commons components, Commons Geometry uses Apache Maven as our + build tool. The sources can also be built using Ant (a working + Ant build.xml is included in the top level project directory). + To build Commons Geometry using Maven, you can follow the instructions for + <a href="http://maven.apache.org/run-maven/index.html">Building a + project with Maven</a>. + Launch Maven from the top-level directory + in the checkout of Commons Geometry trunk. No special setup is required, + except that currently to build the site (i.e. to execute Maven's + "site" goal), you may need to increase the default memory allocation + (e.g. <code>export MAVEN_OPTS=-Xmx512m</code>) before launching + Maven. + </li> + <li> + Have a look at the new features that users and developers have requested + on the <a href="http://wiki.apache.org/commons/RngWishList"> + Geometry Wish List Wiki Page.</a> + </li> + <li> + Be sure to join the commons-dev and commons-user + <a href="mail-lists.html"> + email lists</a> and use them appropriately (make sure the string + "[Geometry]" starts the Subject line of all your postings). + Make any proposals here where the group can comment on them. + </li> + <li> + <a href="https://issues.apache.org/jira/secure/Signup!default.jspa"> + Setup an account on JIRA + </a> + and use it to submit patches and + identify bugs. Read the + <a href="http://issues.apache.org/bugwritinghelp.html"> + directions</a> + for submitting bugs and search the database to + determine if an issue exists or has already been dealt with. + <p> + See the <a href="http://commons.apache.org/rng/issue-tracking.html"> + Commons Geometry Issue Tracking Page</a> + for more information on how to + search for or submit bugs or enhancement requests. + </p> + <li> + Generating patches: The requested format for generating patches is + the Unified Diff format, which can be easily generated using the git + client or various IDEs. + <source>git diff -p > patch </source> + Run this command from the top-level project directory (where pom.xml + resides). + </li> + </li> + </ol> + </p> + <p><strong>Contributing ideas and code</strong></p> + <p> + Follow the steps below when making suggestions for additions or + enhancements to Commons Geometry. This will make it easier for the community + to comment on your ideas and for the committers to keep track of them. + Thanks in advance! + <ol> + <li>Start with a post to the commons-dev mailing list, with [Geometry] at + the beginning of the subject line, followed by a short title + describing the new feature or enhancement; for example, "[Geometry] + New cryptographically secure generator". + The body of the post should include each of the following items + (but be <strong>as brief as possible</strong>): + <ul> + <li>A concise description of the new feature / enhancement</li> + <li>References to definitions and algorithms. Using standard + definitions and algorithms makes communication much easier and will + greatly increase the chances that we will accept the code / idea</li> + <li>Some indication of why the addition / enhancement is practically + useful</li> + </ul></li> + <li>Assuming a generally favorable response to the idea on commons-dev, + the next step is to add an entry to the + <a href="http://wiki.apache.org/commons/RngWishList">Geometry Wish + List</a> corresponding to the idea. Include a reference to the + discussion thread. </li> + <li>Create a JIRA ticket using the the feature title as the short + description. Incorporate feedback from the initial posting in the + description. Add a reference to the JIRA ticket to the WishList entry. + </li> + <li>Submit code as attachments to the JIRA ticket. Please use one + ticket for each feature, adding multiple patches to the ticket + as necessary. Use the git diff command to generate your patches as + diffs. Please do not submit modified copies of existing java files. Be + patient (but not <strong>too</strong> patient) with committers reviewing + patches. Post a *nudge* message to commons-dev with a reference to the + ticket if a patch goes more than a few days with no comment or commit. + </li> + </ol> + </p> + </subsection> + + <subsection name='Coding Style'> + <p> + Commons Geometry follows <a href="http://java.sun.com/docs/codeconv/">Code + Conventions for the Java Programming Language</a>. As part of the maven + build process, style checking is performed using the Checkstyle plugin, + using the properties specified in <code>checkstyle.xml</code>. + Committed code <i>should</i> generate no Checkstyle errors. One thing + that Checkstyle will complain about is tabs included in the source code. + Please make sure to set your IDE or editor to use spaces instead of tabs. + </p> + <p> + Committers should configure the <source>user.name</source>, + <source>user.email</source> and <source>core.autocrlf</source> + git repository or global settings with <source>git config</source>. + The first two settings define the identity and mail of the committer. + The third setting deals with line endings to achieve consistency + in line endings. Windows users should configure this setting to + <source>true</source> (thus forcing git to convert CR/LF line endings + in the workspace while maintaining LF only line endings in the repository) + while OS X and Linux users should configure it to <source>input</source> + (thus forcing git to only strip accidental CR/LF when committing into + the repository, but never when cheking out files from the repository). See <a + href="http://www.git-scm.com/book/en/Customizing-Git-Git-Configuration">Customizing + Git - Git Configuration</a> in the git book for explanation about how to + configure these settings and more. + </p> + </subsection> + <subsection name='Documentation'> + <ul> + <li> + Committed code <i>must</i> include full javadoc. + </li> + <li> + All component contracts <i>must</i> be fully specified in the javadoc class, + interface or method comments, including specification of acceptable ranges + of values, exceptions or special return values. + </li> + <li> + External references or full statements of definitions for all the + terms used in component documentation <i>must</i> be provided. + </li> + <li> + Commons rng javadoc generation supports embedded LaTeX formulas via the + <a href="http://www.mathjax.org">MathJax</a> javascript display engine. + To embed mathematical expressions formatted in LaTeX in javadoc, simply surround + the expression to be formatted with either <code>\(</code> and <code>\)</code> + for inline formulas (or <code>\[</code> and <code>\]</code> to have the formula + appear on a separate line). + For example, + <code>\(</code><code>a^2 + b^2 = c^2</code><code>\)</code> + will render an in-line formula + saying that (a, b, c) is a Pythagorean triplet: \( a^2 + b^2 = c^2 \). + <br/> + See the MathJax and LaTex documentation for details on how to represent formulas + and escape special characters. + </li> + <li> + Implementations <i>should</i> use standard algorithms and + references or full descriptions of all algorithms <i>should</i> be + provided. + </li> + <li> + Additions and enhancements <i>should</i> include updates to the User + Guide. + </li> + </ul> + </subsection> + <subsection name='Exceptions'> + <ul> + <li> + Exceptions generated by Commons Geometry are all unchecked. + </li> + <li> + All public methods advertise all exceptions that they can generate. + Exceptions <i>must</i> be documented in Javadoc and the documentation + <i>must</i> include full description of the conditions under which + exceptions are thrown. + </li> + </ul> + </subsection> + <subsection name='Unit Tests'> + <ul> + <li> + Committed code <i>must</i> include unit tests. + </li> + <li> + Unit tests <i>should</i> provide full path coverage. + </li> + <li> + Unit tests <i>should</i> verify all boundary conditions specified in + interface contracts, including verification that exceptions are thrown or + special values (e.g. Double.NaN, Double.Infinity) are returned as + expected. + </li> + </ul> + </subsection> + <subsection name='Licensing and copyright'> + <ul> + <li> + All new source file submissions <i>must</i> include the Apache Software + License in a comment that begins the file. + </li> + <li> + All contributions must comply with the terms of the Apache + <a href="http://www.apache.org/licenses/cla.pdf">Contributor License + Agreement (CLA)</a>. + </li> + <li> + Patches <i>must</i> be accompanied by a clear reference to a "source" + - if code has been "ported" from another language, clearly state the + source of the original implementation. If the "expression" of a given + algorithm is derivative, please note the original source (textbook, + paper, etc.). + </li> + <li> + References to source materials covered by restrictive proprietary + licenses should be avoided. In particular, contributions should not + implement or include references to algorithms in + <a href="http://www.nr.com/">Numerical Recipes (NR)</a>. + Any questions about copyright or patent issues should be raised on + the commons-dev mailing list before contributing or committing code. + </li> + </ul> + </subsection> + </section> + </body> +</document> diff --git a/src/site/xdoc/download_geometry.xml b/src/site/xdoc/download_geometry.xml new file mode 100644 index 0000000..d76f488 --- /dev/null +++ b/src/site/xdoc/download_geometry.xml @@ -0,0 +1,118 @@ +<?xml version="1.0"?> +<!-- +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. +--> +<!-- + +======================================================================+ + |**** ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| + |**** DO NOT EDIT DIRECTLY ****| + |**** ****| + +======================================================================+ + | TEMPLATE FILE: download-page-template.xml | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | + +======================================================================+ + | | + | 1) Re-generate using: mvn commons:download-page | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | - commons.release.version (required) | + | - commons.release.name (required) | + | - commons.binary.suffix (optional) | + | (defaults to "-bin", set to "" for pre-maven2 releases) | + | - commons.release.desc (optional) | + | - commons.release.subdir (optional) | + | | + | - commons.release.2/3.version (conditional) | + | - commons.release.2/3.name (conditional) | + | - commons.release.2/3.binary.suffix (optional) | + | - commons.release.2/3.desc (optional) | + | - commons.release.2/3.subdir (optional) | + | | + | 3) Example Properties | + | (commons.release.name inherited by parent: | + | ${project.artifactId}-${commons.release.version} | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | + | </properties> | + | | + +======================================================================+ +--> +<document> + <properties> + <title>Download Apache Commons Geometry</title> + <author email="d...@commons.apache.org">Apache Commons Documentation Team</author> + </properties> + <body> + <section name="Download Apache Commons Geometry"> + <subsection name="Using a Mirror"> + <p> + We recommend you use a mirror to download our release + builds, but you <strong>must</strong> <a href="http://www.apache.org/info/verification.html">verify the integrity</a> of + the downloaded files using signatures downloaded from our main + distribution directories. Recent releases (48 hours) may not yet + be available from all the mirrors. + </p> + + <p> + You are currently using <b>[preferred]</b>. If you + encounter a problem with this mirror, please select another + mirror. If all mirrors are failing, there are <i>backup</i> + mirrors (at the end of the mirrors list) that should be + available. + <br></br> + [if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"></img></a>[end] + </p> + + <form action="[location]" method="get" id="SelectMirror"> + <p> + Other mirrors: + <select name="Preferred"> + [if-any http] + [for http]<option value="[http]">[http]</option>[end] + [end] + [if-any ftp] + [for ftp]<option value="[ftp]">[ftp]</option>[end] + [end] + [if-any backup] + [for backup]<option value="[backup]">[backup] (backup)</option>[end] + [end] + </select> + <input type="submit" value="Change"></input> + </p> + </form> + + <p> + It is essential that you + <a href="https://www.apache.org/info/verification.html">verify the integrity</a> + of downloaded files, preferably using the <code>PGP</code> signature (<code>*.asc</code> files); + failing that using the <code>SHA256</code> hash (<code>*.SHA256</code> checksum files). + </p> + <p> + The <a href="https://www.apache.org/dist/commons/KEYS">KEYS</a> + file contains the public PGP keys used by Apache Commons developers + to sign releases. + </p> + </subsection> + </section> + <section name="Apache Commons Geometry 1.0 (requires Java 8+)"> + <p>There is no release yet. Please come and help development</p> + </section> + </body> +</document> diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml new file mode 100644 index 0000000..60c42f4 --- /dev/null +++ b/src/site/xdoc/index.xml @@ -0,0 +1,46 @@ +<?xml version="1.0"?> + +<!-- + 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. + --> + +<document> + + <properties> + <title>Commons Geometry</title> + </properties> + + <body> + + <section name="Apache Commons Geometry" href="summary"> + <p> + Utilities for geometry. + </p> + </section> + + <section name="Download Apache Commons Geometry"> + <subsection name="Releases"> + <p> + Download the + <a href="http://commons.apache.org/geometry/download_geometry.cgi"> + latest release</a> of Apache Commons Geometry. + </p> + </subsection> + </section> + + </body> + +</document> diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml new file mode 100644 index 0000000..f823d12 --- /dev/null +++ b/src/site/xdoc/issue-tracking.xml @@ -0,0 +1,102 @@ +<?xml version="1.0"?> +<!-- +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. +--> +<!-- + +======================================================================+ + |**** ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| + |**** DO NOT EDIT DIRECTLY ****| + |**** ****| + +======================================================================+ + | TEMPLATE FILE: issue-tracking-template.xml | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | + +======================================================================+ + | | + | 1) Re-generate using: mvn commons:jira-page | + | | + | 2) Set the following properties in the component's pom: | + | - commons.jira.id (required, alphabetic, upper case) | + | - commons.jira.pid (required, numeric) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.jira.id>MATH</commons.jira.id> | + | <commons.jira.pid>12310485</commons.jira.pid> | + | </properties> | + | | + +======================================================================+ +--> +<document> + <properties> + <title>Apache Commons Geometry Issue tracking</title> + <author email="d...@commons.apache.org">Apache Commons Documentation Team</author> + </properties> + <body> + + <section name="Apache Commons Geometry Issue tracking"> + <p> + Apache Commons Geometry uses <a href="https://issues.apache.org/jira/">ASF JIRA</a> for tracking issues. + See the <a href="https://issues.apache.org/jira/browse/GEOMETRY">Apache Commons Geometry JIRA project page</a>. + </p> + + <p> + To use JIRA you may need to <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a> + (if you have previously created/updated Commons issues using Bugzilla an account will have been automatically + created and you can use the <a href="https://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a> + page to get a new password). + </p> + + <p> + If you would like to report a bug, or raise an enhancement request with + Apache Commons Geometry please do the following: + <ol> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12321920&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>. + If you find your issue listed then please add a comment with your details.</li> + <li><a href="mail-lists.html">Search the mailing list archive(s)</a>. + You may find your issue or idea has already been discussed.</li> + <li>Decide if your issue is a bug or an enhancement.</li> + <li>Submit either a <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12321920&issuetype=1&priority=4&assignee=-1">bug report</a> + or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12321920&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li> + </ol> + </p> + + <p> + Please also remember these points: + <ul> + <li>the more information you provide, the better we can help you</li> + <li>test cases are vital, particularly for any proposed enhancements</li> + <li>the developers of Apache Commons Geometry are all unpaid volunteers</li> + </ul> + </p> + + <p> + For more information on subversion and creating patches see the + <a href="http://www.apache.org/dev/contributors.html">Apache Contributors Guide</a>. + </p> + + <p> + You may also find these links useful: + <ul> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12321920&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Apache Commons Geometry bugs</a></li> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12321920&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Apache Commons Geometry bugs</a></li> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12321920&sorter/field=issuekey&sorter/order=DESC">All Apache Commons Geometry bugs</a></li> + </ul> + </p> + </section> + </body> +</document> diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml new file mode 100644 index 0000000..68a94d1 --- /dev/null +++ b/src/site/xdoc/mail-lists.xml @@ -0,0 +1,205 @@ +<?xml version="1.0"?> +<!-- +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. +--> +<!-- + +======================================================================+ + |**** ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| + |**** DO NOT EDIT DIRECTLY ****| + |**** ****| + +======================================================================+ + | TEMPLATE FILE: mail-lists-template.xml | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | + +======================================================================+ + | | + | 1) Re-generate using: mvn commons:mail-page | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | </properties> | + | | + +======================================================================+ +--> +<document> + <properties> + <title>Apache Commons Geometry Mailing Lists</title> + <author email="d...@commons.apache.org">Apache Commons Documentation Team</author> + </properties> + <body> + + <section name="Overview"> + <p> + <a href="index.html">Apache Commons Geometry</a> shares mailing lists with all the other + <a href="http://commons.apache.org/components.html">Commons Components</a>. + To make it easier for people to only read messages related to components they are interested in, + the convention in Commons is to prefix the subject line of messages with the component's name, + for example: + <ul> + <li>[geometry] Problem with the ...</li> + </ul> + </p> + <p> + Questions related to the usage of Apache Commons Geometry should be posted to the + <a href="http://mail-archives.apache.org/mod_mbox/commons-user/">User List</a>. + <br /> + The <a href="http://mail-archives.apache.org/mod_mbox/commons-dev/">Developer List</a> + is for questions and discussion related to the development of Apache Commons Geometry. + <br /> + Please do not cross-post; developers are also subscribed to the user list. + <br /> + You must be subscribed to post to the mailing lists. Follow the Subscribe links below + to subscribe. + </p> + <p> + <strong>Note:</strong> please don't send patches or attachments to any of the mailing lists. + Patches are best handled via the <a href="issue-tracking.html">Issue Tracking</a> system. + Otherwise, please upload the file to a public server and include the URL in the mail. + </p> + </section> + + <section name="Apache Commons Geometry Mailing Lists"> + <p> + <strong>Please prefix the subject line of any messages for <a href="index.html">Apache Commons Geometry</a> + with <i>[geometry]</i></strong> - <i>thanks!</i> + <br /> + <br /> + </p> + + <table> + <tr> + <th>Name</th> + <th>Subscribe</th> + <th>Unsubscribe</th> + <th>Post</th> + <th>Archive</th> + <th>Other Archives</th> + </tr> + + + <tr> + <td> + <strong>Commons User List</strong> + <br /><br /> + Questions on using Apache Commons Geometry. + <br /><br /> + </td> + <td><a href="mailto:user-subscr...@commons.apache.org">Subscribe</a></td> + <td><a href="mailto:user-unsubscr...@commons.apache.org">Unsubscribe</a></td> + <td><a href="mailto:u...@commons.apache.org?subject=[geometry]">Post</a></td> + <td><a href="http://mail-archives.apache.org/mod_mbox/commons-user/">mail-archives.apache.org</a></td> + <td><a href="http://markmail.org/list/org.apache.commons.users/">markmail.org</a><br /> + <a href="http://www.mail-archive.com/user@commons.apache.org/">www.mail-archive.com</a><br /> + <a href="http://news.gmane.org/gmane.comp.jakarta.commons.devel">news.gmane.org</a> + </td> + </tr> + + + <tr> + <td> + <strong>Commons Developer List</strong> + <br /><br /> + Discussion of development of Apache Commons Geometry. + <br /><br /> + </td> + <td><a href="mailto:dev-subscr...@commons.apache.org">Subscribe</a></td> + <td><a href="mailto:dev-unsubscr...@commons.apache.org">Unsubscribe</a></td> + <td><a href="mailto:d...@commons.apache.org?subject=[geometry]">Post</a></td> + <td><a href="http://mail-archives.apache.org/mod_mbox/commons-dev/">mail-archives.apache.org</a></td> + <td><a href="http://markmail.org/list/org.apache.commons.dev/">markmail.org</a><br /> + <a href="http://www.mail-archive.com/dev@commons.apache.org/">www.mail-archive.com</a><br /> + <a href="http://news.gmane.org/gmane.comp.jakarta.commons.devel">news.gmane.org</a> + </td> + </tr> + + + <tr> + <td> + <strong>Commons Issues List</strong> + <br /><br /> + Only for e-mails automatically generated by the <a href="issue-tracking.html">issue tracking</a> system. + <br /><br /> + </td> + <td><a href="mailto:issues-subscr...@commons.apache.org">Subscribe</a></td> + <td><a href="mailto:issues-unsubscr...@commons.apache.org">Unsubscribe</a></td> + <td><i>read only</i></td> + <td><a href="http://mail-archives.apache.org/mod_mbox/commons-issues/">mail-archives.apache.org</a></td> + <td><a href="http://markmail.org/list/org.apache.commons.issues/">markmail.org</a><br /> + <a href="http://www.mail-archive.com/issues@commons.apache.org/">www.mail-archive.com</a> + </td> + </tr> + + + <tr> + <td> + <strong>Commons Commits List</strong> + <br /><br /> + Only for e-mails automatically generated by the <a href="source-repository.html">source control</a> sytem. + <br /><br /> + </td> + <td><a href="mailto:commits-subscr...@commons.apache.org">Subscribe</a></td> + <td><a href="mailto:commits-unsubscr...@commons.apache.org">Unsubscribe</a></td> + <td><i>read only</i></td> + <td><a href="http://mail-archives.apache.org/mod_mbox/commons-commits/">mail-archives.apache.org</a></td> + <td><a href="http://markmail.org/list/org.apache.commons.commits/">markmail.org</a><br /> + <a href="http://www.mail-archive.com/commits@commons.apache.org/">www.mail-archive.com</a> + </td> + </tr> + + </table> + + </section> + <section name="Apache Mailing Lists"> + <p> + Other mailing lists which you may find useful include: + </p> + + <table> + <tr> + <th>Name</th> + <th>Subscribe</th> + <th>Unsubscribe</th> + <th>Post</th> + <th>Archive</th> + <th>Other Archives</th> + </tr> + <tr> + <td> + <strong>Apache Announce List</strong> + <br /><br /> + General announcements of Apache project releases. + <br /><br /> + </td> + <td><a class="externalLink" href="mailto:announce-subscr...@apache.org">Subscribe</a></td> + <td><a class="externalLink" href="mailto:announce-unsubscr...@apache.org">Unsubscribe</a></td> + <td><i>read only</i></td> + <td><a class="externalLink" href="http://mail-archives.apache.org/mod_mbox/www-announce/">mail-archives.apache.org</a></td> + <td><a class="externalLink" href="http://markmail.org/list/org.apache.announce/">markmail.org</a><br /> + <a class="externalLink" href="http://old.nabble.com/Apache-News-and-Announce-f109.html">old.nabble.com</a><br /> + <a class="externalLink" href="http://www.mail-archive.com/announce@apache.org/">www.mail-archive.com</a><br /> + <a class="externalLink" href="http://news.gmane.org/gmane.comp.apache.announce">news.gmane.org</a> + </td> + </tr> + </table> + + </section> + </body> +</document> diff --git a/src/site/xdoc/release-history.xml b/src/site/xdoc/release-history.xml new file mode 100644 index 0000000..a14ad1f --- /dev/null +++ b/src/site/xdoc/release-history.xml @@ -0,0 +1,35 @@ +<?xml version="1.0"?> +<!-- +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. +--> +<document> + <properties> + <title>Home</title> + <author email="d...@commons.apache.org">Commons Documentation Team</author> + </properties> + <body> + <!-- ================================================== --> + <!--section name="Commons Geometry Release History"> + <p><em>Note.</em> For older javadocs see the individal artifact sub-sites.</p> + <table> + <tr><th>Version</th><th>Release date (YYYY-MM-DD)</th><th>Required Java Version</th><th>Release notes</th></tr> + <tr> + <td>1.0</td><td>????-??-??</td><td>8+</td><td><a href="release-notes/RELEASE-NOTES-1.0.txt">release notes for 1.0</a></td> + </tr> + </table> + + </section--> + <!-- ================================================== --> + </body> +</document> diff --git a/src/site/xdoc/userguide/index.xml b/src/site/xdoc/userguide/index.xml new file mode 100644 index 0000000..8bcc3ff --- /dev/null +++ b/src/site/xdoc/userguide/index.xml @@ -0,0 +1,41 @@ +<?xml version="1.0"?> + +<!-- + 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. + --> + +<?xml-stylesheet type="text/xsl" href="./xdoc.xsl"?> +<document url="index.html"> + <properties> + <title>The Commons Geometry User Guide - Table of Contents</title> + </properties> + + <body> + <section name="Table of Contents" href="toc"> + + <ul> + + <li> + <a href="geometry.html#a1._Purpose"> + 1. Purpose of the library</a> + </li> + </ul> + + </section> + + </body> + +</document> diff --git a/src/site/xdoc/userguide/xdoc.xsl b/src/site/xdoc/userguide/xdoc.xsl new file mode 100644 index 0000000..cfbd5f5 --- /dev/null +++ b/src/site/xdoc/userguide/xdoc.xsl @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + 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. + --> + +<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> + <xsl:template match="/"> + <html xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <head> + <xsl:apply-templates select="/document/properties/title"/> + <xsl:apply-templates select="/document/meta"/> + <style type="text/css"> + @import url("../style/tigris.css"); + @import url("../style/maven.css"); + @import url("../style/project.css"); + </style> + <link rel="stylesheet" href="../style/print.css" type="text/css" media="print"></link> + </head> + <xsl:apply-templates select="/document/body"/> + </html> + </xsl:template> + <xsl:template match="body"> + <body> + <div class="app"> + <xsl:apply-templates/> + </div> + </body> + </xsl:template> + <xsl:template match="section"> + <div> + <h3><xsl:value-of select="@name"/></h3> + <xsl:apply-templates/> + </div> + </xsl:template> + <xsl:template match="subsection"> + <div> + <h4><xsl:value-of select="@name"/></h4> + <xsl:apply-templates/> + </div> + </xsl:template> + <xsl:template match="source"> + <div id="source"> + <pre> + <xsl:apply-templates/> + </pre> + </div> + </xsl:template> + <xsl:template match="node()|@*"> + <xsl:copy> + <xsl:apply-templates select="@*"/> + <xsl:apply-templates/> + </xsl:copy> + </xsl:template> +</xsl:stylesheet>