TEXT-62: Minor tweeks
Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/5faf6e15 Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/5faf6e15 Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/5faf6e15 Branch: refs/heads/release Commit: 5faf6e15f3d489e363aa867ea7e75e2effd10439 Parents: 9fa1158 Author: Rob Tompkins <chtom...@gmail.com> Authored: Mon Jan 30 07:49:30 2017 -0500 Committer: Rob Tompkins <chtom...@gmail.com> Committed: Mon Jan 30 07:49:30 2017 -0500 ---------------------------------------------------------------------- src/site/site.xml | 1 + src/site/xdoc/userguide.xml | 29 +++++++++++++---------------- 2 files changed, 14 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-text/blob/5faf6e15/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 35c303f..747c67b 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -26,6 +26,7 @@ <menu name="Text"> <item name="Overview" href="/index.html"/> <item name="Download" href="http://commons.apache.org/text/download_text.cgi"/> + <item name="User guide" href="/userguide.html" /> <item name="Release History" href="/release-history.html"/> <item name="Javadoc (Latest release)" href="javadocs/api-release/index.html"/> </menu> http://git-wip-us.apache.org/repos/asf/commons-text/blob/5faf6e15/src/site/xdoc/userguide.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/userguide.xml b/src/site/xdoc/userguide.xml index 9432fb6..b18fdd8 100644 --- a/src/site/xdoc/userguide.xml +++ b/src/site/xdoc/userguide.xml @@ -42,17 +42,9 @@ limitations under the License. <section name="Description"> <p>The Commons Text library provides additions to the standard JDK's - java.lang package. Very generic, very reusable components for everyday - use. - </p> - <p>The text package was added in Commons Lang 2.2. It provides, amongst - other classes, a replacement for StringBuffer named <code> - StrBuilder</code>, a class for substituting variables within a String - named <code>StrSubstitutor</code> and a replacement for StringTokenizer - named <code>StrTokenizer</code>. While somewhat ungainly, the <code> - Str - </code> prefix has been used to ensure we don't clash with any current - or future standard Java classes. + text handling. Our goal is to provide a consistent set of tools for + processing text generally from computing distances between Strings + to being able to effeciently do String escaping of various types. </p> </section> @@ -88,15 +80,20 @@ limitations under the License. </subsection> <subsection name="Similarity and Distance"> - <p>The <code>similarity</code> packages contains various different mechanisms of + <p>The <code>org.apache.commons.text.beta.similarity</code> packages contains various different mechanisms of calculating "similarity scores" as well as "edit distances between Strings. Note, the difference between a "similarity score" and a "distance function" is that a distance functions meets the following qualifications: <ul> - <li><code>d(x,y) >= 0</code>, non-negativity or separation axiom</li> - <li><code>d(x,y) == 0</code>, if and only if, <code>x == y</code></li> - <li><code>d(x,y) == d(y,x)</code>, symmetry, and</li> - <li><code>d(x,z) <= d(x,y) + d(y,z)</code>, the triangle inequality</li> + <li><code>d(x,y) >= 0</code>, non-negativity or separation axiom + </li> + <li><code>d(x,y) == 0</code>, if and only if, + <code>x == y</code> + </li> + <li><code>d(x,y) == d(y,x)</code>, symmetry, and + </li> + <li><code>d(x,z) <= d(x,y) + d(y,z)</code>, the triangle inequality + </li> </ul> whereas a "similarity score" need not satisfy all such properties. Though, it is fairly easy to "normalize" a similarity score to manufacture an "edit distance."
