Repository: commons-text Updated Branches: refs/heads/master 7cbefa010 -> b2434bcbc
Add proposal for commons-text Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/1b1355d7 Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/1b1355d7 Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/1b1355d7 Branch: refs/heads/master Commit: 1b1355d7b068451a57005273c2145fe6aea0aae6 Parents: 7cbefa0 Author: Benedikt Ritter <[email protected]> Authored: Sat Nov 29 11:29:28 2014 +0100 Committer: Benedikt Ritter <[email protected]> Committed: Sat Nov 29 11:29:28 2014 +0100 ---------------------------------------------------------------------- src/site/site.xml | 3 +-- src/site/xdoc/proposal.xml | 56 ++++++++++++++++++----------------------- 2 files changed, 25 insertions(+), 34 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-text/blob/1b1355d7/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 8179c32..7fde970 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -34,8 +34,7 @@ <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="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"/> http://git-wip-us.apache.org/repos/asf/commons-text/blob/1b1355d7/src/site/xdoc/proposal.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/proposal.xml b/src/site/xdoc/proposal.xml index fc9477f..6dcc0a7 100644 --- a/src/site/xdoc/proposal.xml +++ b/src/site/xdoc/proposal.xml @@ -16,40 +16,35 @@ limitations under the License. --> <document> <properties> -<title>Proposal for Lang Package</title> +<title>Proposal for Apache Commons Text Package</title> </properties> <body> - -<section name="Proposal for Lang Package"> - - +<section name="Proposal for Apache Commons Text 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> +<p>Providing algorithms for processing texts like editing distance or +similarity is out of scope of the standard Java libraries. The +<em>Commons Text</em> Package provides these extra methods.</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> +<p>This proposal is to create a package of Java utility classes implementing +well known string algorithms and metrics.</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><em>Commons Text</em> relies only on standard JDK 7 (or later) APIs for +production deployment. It utilizes the JUnit unit testing framework and +the hamcrest matcher library for developing and executing unit tests, but +this is of interest only to developers of the component. Commons Text may be +a dependency for several existing components in the open source world that +implement higher order text processing.</p> <p>No external configuration files are utilized.</p> @@ -57,37 +52,34 @@ several existing components in the open source world.</p> </subsection> <subsection name="(2) Initial Source of the Package"> -<p>The initial classes came from the Commons.Util subproject.</p> +<p>The initial classes came from the <em>Commons Lang</em> and <em>Commons Codec</em> subprojects.</p> <p>The proposed package name for the new component is -<code>org.apache.commons.lang</code>.</p> +<code>org.apache.commons.text</code>.</p> </subsection> -<subsection name="(3) Required Jakarta-Commons Resources"> +<subsection name="(3) Required Apache Commons Resources"> <ul> -<li>CVS Repository - New directory <code>lang</code> in the - <code>jakarta-commons</code> CVS repository.</li> +<li>Git Repository - New repository <code>commons-text</code>.</li> <li>Mailing List - Discussions will take place on the general - <em>[email protected]</em> mailing list. To help + <em>[email protected]</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> + [text].</li> +<li>Jira - New component "Common Text" under the "Commons Sandbox" product.</li> +<li>Confluence FAQ - New category "commons-text" (when available).</li> </ul> </subsection> <subsection name="(4) Initial Committers"> -<p>The initial committers on the Lang component shall be as follows: +<p>The initial committers on the <em>Commons Text</em> component shall be as follows: <ul> -<li>Henri Yandell (bayard)</li> -<li>Daniel Rall (dlr)</li> -<li>Stephen Colebourne (scolebourne)</li> +<li>Bruno P. Kinoshita (kinow)</li> +<li>Benedikt Ritter (britter)</li> </ul> </p>
