Repository: commons-text Updated Branches: refs/heads/master [created] 750beb923
Bootstrap commons-text component Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/750beb92 Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/750beb92 Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/750beb92 Branch: refs/heads/master Commit: 750beb9233003e5ba78ad92bfa4d6d4f4c0aeddb Parents: Author: Benedikt Ritter <benerit...@gmail.com> Authored: Tue Nov 11 20:42:39 2014 +0100 Committer: Benedikt Ritter <benerit...@gmail.com> Committed: Tue Nov 11 20:42:39 2014 +0100 ---------------------------------------------------------------------- .gitignore | 2 + LICENSE.txt | 202 +++++++++++++++++++++++++++ NOTICE.txt | 8 ++ pom.xml | 244 +++++++++++++++++++++++++++++++++ src/assembly/bin.xml | 44 ++++++ src/assembly/src.xml | 38 +++++ src/changes/changes.xml | 28 ++++ src/site/resources/profile.jacoco | 0 src/site/site.xml | 46 +++++++ src/site/xdoc/index.xml | 79 +++++++++++ src/site/xdoc/issue-tracking.xml | 102 ++++++++++++++ src/site/xdoc/mail-lists.xml | 205 +++++++++++++++++++++++++++ src/site/xdoc/proposal.xml | 97 +++++++++++++ src/site/xdoc/release-history.xml | 37 +++++ src/site/xdoc/userguide.xml | 32 +++++ 15 files changed, 1164 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/.gitignore ---------------------------------------------------------------------- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dc0d833 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +target/ + http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/LICENSE.txt ---------------------------------------------------------------------- diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/NOTICE.txt ---------------------------------------------------------------------- diff --git a/NOTICE.txt b/NOTICE.txt new file mode 100644 index 0000000..5dd8ae2 --- /dev/null +++ b/NOTICE.txt @@ -0,0 +1,8 @@ +Apache Commons Text +Copyright 2001-2014 The Apache Software Foundation + +This product includes software developed at +The Apache Software Foundation (http://www.apache.org/). + +This product includes software from the Spring Framework, +under the Apache License 2.0 (see: StringUtils.containsWhitespace()) http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..a8b0ef1 --- /dev/null +++ b/pom.xml @@ -0,0 +1,244 @@ +<?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. +--> +<project + xmlns="http://maven.apache.org/POM/4.0.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <parent> + <groupId>org.apache.commons</groupId> + <artifactId>commons-parent</artifactId> + <version>35</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <groupId>org.apache.commons</groupId> + <artifactId>commons-text</artifactId> + <version>0.1-SNAPSHOT</version> + <name>Apache Commons Text</name> + + <inceptionYear>2014</inceptionYear> + <description> + Apache Commons Text is a library focused on algorithms working on strings. + </description> + + <url>http://commons.apache.org/sandbox/commons-text/</url> + + <issueManagement> + <system>jira</system> + <url>http://issues.apache.org/jira/browse/SANDBOX</url> + </issueManagement> + + <scm> + <connection>scm:git:http://git-wip-us.apache.org/repos/asf/commons-text.git</connection> + <developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/commons-text.git</developerConnection> + <url>https://git-wip-us.apache.org/repos/asf?p=commons-text.git</url> + </scm> + + <developers> + <developer> + <name>Benedikt Ritter</name> + <id>britter</id> + <email>brit...@apache.org</email> + </developer> + </developers> + <contributors> + + </contributors> + + <!-- Lang should depend on very little --> + <dependencies> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <version>4.11</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.hamcrest</groupId> + <artifactId>hamcrest-all</artifactId> + <version>1.3</version> + <scope>test</scope> + </dependency> + </dependencies> + + <distributionManagement> + <site> + <id>apache.website</id> + <name>Apache Commons Site</name> + <url>scm:svn:https://svn.apache.org/repos/infra/websites/production/commons/content/sandbox/commons-text/</url> + </site> + </distributionManagement> + + <properties> + <project.build.sourceEncoding>ISO-8859-1</project.build.sourceEncoding> + <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> + <maven.compiler.source>1.7</maven.compiler.source> + <maven.compiler.target>1.7</maven.compiler.target> + + <commons.componentid>text</commons.componentid> + <!-- Current 3.x release series --> + <commons.release.version>0.1</commons.release.version> + <commons.release.desc>(Java 6.0+)</commons.release.desc> + + <commons.jira.id>SANDBOX</commons.jira.id> + <commons.jira.pid>12317115</commons.jira.pid> + + <commons.site.path>commons-text</commons.site.path> + <commons.scmPubUrl>https://svn.apache.org/repos/infra/websites/production/commons/content/sandbox/commons-text</commons.scmPubUrl> + <commons.scmPubCheckoutDirectory>site-content</commons.scmPubCheckoutDirectory> + </properties> + + + <build> + <plugins> + <plugin> + <artifactId>maven-assembly-plugin</artifactId> + <configuration> + <descriptors> + <descriptor>src/assembly/bin.xml</descriptor> + <descriptor>src/assembly/src.xml</descriptor> + </descriptors> + <tarLongFileMode>gnu</tarLongFileMode> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jar-plugin</artifactId> + <executions> + <execution> + <goals> + <goal>test-jar</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-publish-plugin</artifactId> + <configuration> + <ignorePathsToDelete> + <ignorePathToDelete>javadocs</ignorePathToDelete> + </ignorePathsToDelete> + </configuration> + </plugin> + </plugins> + + </build> + + <reporting> + <plugins> + <plugin> + <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.13</version> + <configuration> + <enableRulesSummary>false</enableRulesSummary> + </configuration> + <reportSets> + <reportSet> + <reports> + <report>checkstyle</report> + </reports> + </reportSet> + </reportSets> + </plugin> + <!-- Requires setting 'export MAVEN_OPTS="-Xmx512m" ' --> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>findbugs-maven-plugin</artifactId> + <version>3.0.0</version> + <configuration> + <threshold>Normal</threshold> + <effort>Default</effort> + </configuration> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>clirr-maven-plugin</artifactId> + <version>2.6.1</version> + <configuration> + <minSeverity>info</minSeverity> + </configuration> + </plugin> + <plugin> + <artifactId>maven-pmd-plugin</artifactId> + <version>3.2</version> + <configuration> + <targetJdk>${maven.compiler.target}</targetJdk> + </configuration> + <reportSets> + <reportSet> + <reports> + <report>pmd</report> + <report>cpd</report> + </reports> + </reportSet> + </reportSets> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>taglist-maven-plugin</artifactId> + <version>2.4</version> + <configuration> + <tagListOptions> + <tagClasses> + <tagClass> + <displayName>Needs Work</displayName> + <tags> + <tag> + <matchString>TODO</matchString> + <matchType>exact</matchType> + </tag> + <tag> + <matchString>FIXME</matchString> + <matchType>exact</matchType> + </tag> + <tag> + <matchString>XXX</matchString> + <matchType>exact</matchType> + </tag> + </tags> + </tagClass> + <tagClass> + <displayName>Noteable Markers</displayName> + <tags> + <tag> + <matchString>NOTE</matchString> + <matchType>exact</matchType> + </tag> + <tag> + <matchString>NOPMD</matchString> + <matchType>exact</matchType> + </tag> + <tag> + <matchString>NOSONAR</matchString> + <matchType>exact</matchType> + </tag> + </tags> + </tagClass> + </tagClasses> + </tagListOptions> + </configuration> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>javancss-maven-plugin</artifactId> + <version>2.0</version> + </plugin> + </plugins> + </reporting> + +</project> http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/assembly/bin.xml ---------------------------------------------------------------------- diff --git a/src/assembly/bin.xml b/src/assembly/bin.xml new file mode 100644 index 0000000..5762291 --- /dev/null +++ b/src/assembly/bin.xml @@ -0,0 +1,44 @@ +<!-- + 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> + <includeSiteDirectory>false</includeSiteDirectory> + <fileSets> + <fileSet> + <includes> + <include>LICENSE.txt</include> + <include>NOTICE.txt</include> + <include>RELEASE-NOTES.txt</include> + </includes> + </fileSet> + <fileSet> + <directory>target</directory> + <outputDirectory></outputDirectory> + <includes> + <include>*.jar</include> + </includes> + </fileSet> + <fileSet> + <directory>target/site/apidocs</directory> + <outputDirectory>apidocs</outputDirectory> + </fileSet> + </fileSets> +</assembly> http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/assembly/src.xml ---------------------------------------------------------------------- diff --git a/src/assembly/src.xml b/src/assembly/src.xml new file mode 100644 index 0000000..ab1da0d --- /dev/null +++ b/src/assembly/src.xml @@ -0,0 +1,38 @@ +<!-- + 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}-${commons.release.version}-src</baseDirectory> + <fileSets> + <fileSet> + <includes> + <include>LICENSE.txt</include> + <include>NOTICE.txt</include> + <include>pom.xml</include> + <include>PROPOSAL.html</include> + <include>RELEASE-NOTES.txt</include> + </includes> + </fileSet> + <fileSet> + <directory>src</directory> + </fileSet> + </fileSets> +</assembly> http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/changes/changes.xml ---------------------------------------------------------------------- diff --git a/src/changes/changes.xml b/src/changes/changes.xml new file mode 100644 index 0000000..416f579 --- /dev/null +++ b/src/changes/changes.xml @@ -0,0 +1,28 @@ +<?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>Apache Commons Text Changes</title> + </properties> + <body> + + <release version="1.0" date="tba" description="tba"> + </release> + + </body> +</document> http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/site/resources/profile.jacoco ---------------------------------------------------------------------- diff --git a/src/site/resources/profile.jacoco b/src/site/resources/profile.jacoco new file mode 100644 index 0000000..e69de29 http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 0000000..bf97590 --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,46 @@ +<?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="Lang"> + <bannerRight> + <name>Commons Text</name> + <src>/images/logo.png</src> + <href>/index.html</href> + </bannerRight> + + <body> + <menu name="Lang"> + <item name="Overview" href="/index.html"/> + <item name="Download" href="/download_commons-text.cgi"/> + <item name="Users guide" href="/userguide.html"/> + <item name="Release History" href="/release-history.html"/> + <item name="Javadoc (Latest release)" href="javadocs/api-release/index.html"/> + </menu> + + <menu name="Development"> + <item name="Mailing Lists" href="/mail-lists.html"/> + <item name="Issue Tracking" href="/issue-tracking.html"/> + <!-- TODO --> + <!--<item name="Proposal" href="/proposal.html"/>--> + <item name="Developer guide" href="/developerguide.html"/> + <item name="Source Repository" href="/source-repository.html"/> + <item name="Javadoc (latest)" href="apidocs/index.html"/> + </menu> + + </body> + +</project> http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/site/xdoc/index.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml new file mode 100644 index 0000000..4539848 --- /dev/null +++ b/src/site/xdoc/index.xml @@ -0,0 +1,79 @@ +<?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="dev@commons.apache.org">Commons Documentation Team</author> + </properties> +<body> +<!-- ================================================== --> +<section name="Commons Text"> + +<p> +Apache Commons Text is a library focused on algorithms working on strins. +</p> + +</section> +<!-- ================================================== --> +<section name="Documentation"> +<p> +The package descriptions in the <a href="javadocs/api-release/index.html">JavaDoc</a> give an overview of the available features +and various <a href="project-reports.html">project reports</a> are provided. +</p> +<p> +The <a href="source-repository.html">subversion repository</a> can be +<a href="http://svn.apache.org/viewvc/commons/proper/lang/trunk/";>browsed</a>, or you can browse/contribute via <a href="https://github.com/apache/commons-text";>GitHub</a>. +</p> +<p> +The code base is monitored by a Sonar instance running on <a href="https://analysis.apache.org/dashboard/index/72046";>analysis.apache.org</a>. +</p> +</section> +<!-- ================================================== --> +<section name="Release Information"> +<p>There have not been any official releases yet.</p> + +</section> +<!-- ================================================== --> +<section name="Getting Involved"> +<p> +The <a href="mail-lists.html">commons developer mailing list</a> is the main channel of communication for contributors. Please remember that the lists are shared between all commons components, so prefix your email by [lang]. </p> +<p>You can also visit the #apache-commons IRC channel on irc.freenode.net or peruse <a href="issue-tracking.html">JIRA</a>. Specific links of interest for JIRA are:</p> +<ul> +<li>Ideas looking for code: <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20LANG%20AND%20resolution%20%3D%20Unresolved%20AND%20fixVersion%20%3D%20%22Patch%20Needed%22%20ORDER%20BY%20priority%20DESC";>Patch Needed</a></li> +<li>Issues with patches, looking for reviews: <a href="https://issues.apache.org/jira/issues/?jql=fixVersion%20%3D%20%22Review%20Patch%22%20AND%20project%20%3D%20LANG%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20priority%20DESC";>Review Patch</a></li> +</ul> +<p>Alternatively you can go through the <em>Needs Work</em> tags in the <a href="taglist.html">TagList report</a>.</p> +<p>If you'd like to offer up pull requests via GitHub rather than applying patches to JIRA, we have a <a href="https://github.com/apache/commons-text/";>GitHub mirror</a>. </p> +</section> +<!-- ================================================== --> +<section name="Support"> +<p> +The <a href="mail-lists.html">commons mailing lists</a> act as the main support forum. +The user list is suitable for most library usage queries. +The dev list is intended for the development discussion. +Please remember that the lists are shared between all commons components, +so prefix your email by [lang]. +</p> +<p> +Bug reports and enhancements are also welcomed via the <a href="issue-tracking.html">JIRA</a> issue tracker. +Please read the instructions carefully. +</p> +</section> +<!-- ================================================== --> +</body> +</document> http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/site/xdoc/issue-tracking.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml new file mode 100644 index 0000000..650fa15 --- /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 Text Issue tracking</title> + <author email="dev@commons.apache.org">Commons Documentation Team</author> + </properties> + <body> + + <section name="Apache Commons Text Issue tracking"> + <p> + Apache Commons Text uses <a href="http://issues.apache.org/jira/";>ASF JIRA</a> for tracking issues. + See the <a href="http://issues.apache.org/jira/browse/SANDBOX";>Apache Commons Text JIRA project page</a>. + </p> + + <p> + To use JIRA you may need to <a href="http://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="http://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 Text please do the following: + <ol> + <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12317115&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="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12317115&issuetype=1&priority=4&assignee=-1";>bug report</a> + or <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12317115&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 Text 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="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12317115&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All Open Apache Commons Text bugs</a></li> + <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12317115&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All Resolved Apache Commons Text bugs</a></li> + <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12317115&sorter/field=issuekey&sorter/order=DESC";>All Apache Commons Text bugs</a></li> + </ul> + </p> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/site/xdoc/mail-lists.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml new file mode 100644 index 0000000..dace01d --- /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 Text Mailing Lists</title> + <author email="dev@commons.apache.org">Commons Documentation Team</author> + </properties> + <body> + + <section name="Overview"> + <p> + <a href="index.html">Apache Commons Text</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>[text] Problem with the ...</li> + </ul> + </p> + <p> + Questions related to the usage of Apache Commons Text 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 Text. + <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 Text Mailing Lists"> + <p> + <strong>Please prefix the subject line of any messages for <a href="index.html">Apache Commons Text</a> + with <i>[text]</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 Text. + <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=[text]";>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 Text. + <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:dev@commons.apache.org?subject=[text]";>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> http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/site/xdoc/proposal.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/proposal.xml b/src/site/xdoc/proposal.xml new file mode 100644 index 0000000..fc9477f --- /dev/null +++ b/src/site/xdoc/proposal.xml @@ -0,0 +1,97 @@ +<!-- +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>Proposal for Lang Package</title> +</properties> +<body> + + +<section name="Proposal for Lang Package"> + + + +<subsection name="(0) Rationale"> + +<p>The standard Java libraries fail to provide enough methods for +manipulation of its main components. The <em>Lang</em> Package provides +these extra methods. There are other classes which might justifiably +be included in java.lang someday, this package also provides for them.</p> + + +</subsection> +<subsection name="(1) Scope of the Package"> + +<p>This proposal is to create a package of Java utility classes for the +classes that are in java.lang's hierarchy, or are considered to be so +standard as to justify existence in java.lang. The <em>Lang</em> Package +also applies to primitives and arrays.</p> + + +</subsection> +<subsection name="(1.5) Interaction With Other Packages"> + +<p><em>Lang</em> relies only on standard JDK 1.2 (or later) APIs for +production deployment. It utilizes the JUnit unit testing framework for +developing and executing unit tests, but this is of interest only to +developers of the component. Lang will be a dependency for +several existing components in the open source world.</p> + +<p>No external configuration files are utilized.</p> + + +</subsection> +<subsection name="(2) Initial Source of the Package"> + +<p>The initial classes came from the Commons.Util subproject.</p> + +<p>The proposed package name for the new component is +<code>org.apache.commons.lang</code>.</p> + + +</subsection> +<subsection name="(3) Required Jakarta-Commons Resources"> + +<ul> +<li>CVS Repository - New directory <code>lang</code> in the + <code>jakarta-commons</code> CVS repository.</li> +<li>Mailing List - Discussions will take place on the general + <em>dev@commons.apache.org</em> mailing list. To help + list subscribers identify messages of interest, it is suggested that + the message subject of messages about this component be prefixed with + [lang].</li> +<li>Bugzilla - New component "Lang" under the "Commons" product + category, with appropriate version identifiers as needed.</li> +<li>Jyve FAQ - New category "commons-lang" (when available).</li> +</ul> + + +</subsection> +<subsection name="(4) Initial Committers"> + +<p>The initial committers on the Lang component shall be as follows: +<ul> +<li>Henri Yandell (bayard)</li> +<li>Daniel Rall (dlr)</li> +<li>Stephen Colebourne (scolebourne)</li> +</ul> +</p> + +</subsection> +</section> +</body> +</document> http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/site/xdoc/release-history.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/release-history.xml b/src/site/xdoc/release-history.xml new file mode 100644 index 0000000..e06f707 --- /dev/null +++ b/src/site/xdoc/release-history.xml @@ -0,0 +1,37 @@ +<?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="dev@commons.apache.org">Commons Documentation Team</author> + </properties> +<body> +<!-- ================================================== --> +<section name="Commons Text Release History"> + +<!-- TODO: Add the Java version for each release --> + +<table> +<tr><th>Version</th><th>Release date</th><th>Javadoc</th><th>Release notes</th></tr> +<tr><td>1.0</td><td>tba</td><td><a href="javadocs/api-1.0/">api-1.0</a></td><td><a href="release-notes/RELEASE-NOTES-1.0.txt">release notes for 1.0</a></td></tr> +</table> + +</section> +<!-- ================================================== --> +</body> +</document> http://git-wip-us.apache.org/repos/asf/commons-text/blob/750beb92/src/site/xdoc/userguide.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide.xml b/src/site/xdoc/userguide.xml new file mode 100644 index 0000000..27e4a7d --- /dev/null +++ b/src/site/xdoc/userguide.xml @@ -0,0 +1,32 @@ +<?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 Text - User guide</title> + <author email="dev@commons.apache.org">Commons Documentation Team</author> + </properties> + + <body> + + <section name='User guide for Commons "Text"'> + TODO + </section> + +</body> +</document> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org For additional commands, e-mail: dev-h...@commons.apache.org
