You are viewing a plain text version of this content. The canonical link for it is here.
Posted to solr-commits@lucene.apache.org by yo...@apache.org on 2006/02/25 03:37:54 UTC

svn commit: r380881 - in /incubator/solr/trunk: site/ src/site/src/documentation/content/xdocs/

Author: yonik
Date: Fri Feb 24 18:37:53 2006
New Revision: 380881

URL: http://svn.apache.org/viewcvs?rev=380881&view=rev
Log:
features doc

Added:
    incubator/solr/trunk/src/site/src/documentation/content/xdocs/features.xml   (with props)
Modified:
    incubator/solr/trunk/site/index.html
    incubator/solr/trunk/site/index.pdf
    incubator/solr/trunk/site/issue_tracking.html
    incubator/solr/trunk/site/linkmap.html
    incubator/solr/trunk/site/linkmap.pdf
    incubator/solr/trunk/site/mailing_lists.html
    incubator/solr/trunk/site/tutorial.html
    incubator/solr/trunk/site/version_control.html
    incubator/solr/trunk/site/who.html
    incubator/solr/trunk/src/site/src/documentation/content/xdocs/index.xml
    incubator/solr/trunk/src/site/src/documentation/content/xdocs/site.xml

Modified: incubator/solr/trunk/site/index.html
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/site/index.html?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
--- incubator/solr/trunk/site/index.html (original)
+++ incubator/solr/trunk/site/index.html Fri Feb 24 18:37:53 2006
@@ -66,6 +66,9 @@
 <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
 <div id="menu_1.2" class="menuitemgroup">
 <div class="menuitem">
+<a href="features.html">Features</a>
+</div>
+<div class="menuitem">
 <a href="http://wiki.apache.org/solr/FAQ">FAQ</a>
 </div>
 <div class="menuitem">
@@ -139,25 +142,28 @@
 <h2 class="boxed">Introduction</h2>
 <div class="section">
 <p>
-        Solr is an open source search server based on the
-        <a href="http://lucene.apache.org/java/">Lucene Java</a> search library.
-        It's normally run as a webapp in a servlet container
-        such as <a href="http://tomcat.apache.org">Tomcat</a>.
+        Solr is an open source enterprise search server based on the
+        <a href="http://lucene.apache.org/java/">Lucene Java</a> search library, with XML/HTTP APIs,
+        caching, replication, and a web administration interface.
+        It runs in a Java servlet container such as <a href="http://tomcat.apache.org">Tomcat</a>.
+      </p>
+<p>
+        See the complete <a href="features.html">feature list</a> for more details, then check out the <a href="tutorial.html">tutorial</a>.
       </p>
 </div>
 
     
-<a name="N1001F"></a><a name="news"></a>
+<a name="N1002A"></a><a name="news"></a>
 <h2 class="boxed">News</h2>
 <div class="section">
-<a name="N10025"></a><a name="21+February%2C+2006%3A+nightly+builds"></a>
+<a name="N10030"></a><a name="21+February%2C+2006%3A+nightly+builds"></a>
 <h3 class="boxed">21 February, 2006: nightly builds</h3>
 <p>Solr now has nightly builds.  This automatically creates a
       <a href="http://cvs.apache.org/dist/lucene/solr/nightly/">downloadable version of Solr every
       night</a>.  All unit tests must pass, or a message is sent to
       the developers mailing list and no new version is created.  This
       also updates the <a href="docs/api/">javadoc</a>.</p>
-<a name="N10037"></a><a name="17+January+2006%3A+Solr+Joins+Apache+Incubator"></a>
+<a name="N10042"></a><a name="17+January+2006%3A+Solr+Joins+Apache+Incubator"></a>
 <h3 class="boxed">17 January 2006: Solr Joins Apache Incubator</h3>
 <p>Solr, a search server based on Lucene, has been accepted into the Apache Incubator.
             Solr was originally developed by CNET Networks, and is widely used within CNET

Modified: incubator/solr/trunk/site/index.pdf
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/site/index.pdf?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
Binary files - no diff available.

Modified: incubator/solr/trunk/site/issue_tracking.html
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/site/issue_tracking.html?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
--- incubator/solr/trunk/site/issue_tracking.html (original)
+++ incubator/solr/trunk/site/issue_tracking.html Fri Feb 24 18:37:53 2006
@@ -66,6 +66,9 @@
 <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
 <div id="menu_1.2" class="menuitemgroup">
 <div class="menuitem">
+<a href="features.html">Features</a>
+</div>
+<div class="menuitem">
 <a href="http://wiki.apache.org/solr/FAQ">FAQ</a>
 </div>
 <div class="menuitem">

Modified: incubator/solr/trunk/site/linkmap.html
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/site/linkmap.html?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
--- incubator/solr/trunk/site/linkmap.html (original)
+++ incubator/solr/trunk/site/linkmap.html Fri Feb 24 18:37:53 2006
@@ -66,6 +66,9 @@
 <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
 <div id="menu_1.2" class="menuitemgroup">
 <div class="menuitem">
+<a href="features.html">Features</a>
+</div>
+<div class="menuitem">
 <a href="http://wiki.apache.org/solr/FAQ">FAQ</a>
 </div>
 <div class="menuitem">
@@ -157,6 +160,12 @@
 <a href="">Documentation</a>&nbsp;&nbsp;&nbsp;_________________________&nbsp;&nbsp;<em>docs</em>
 </li>
 <ul>
+    
+<ul>
+<li>
+<a href="features.html">Features</a>&nbsp;&nbsp;&nbsp;_________________________&nbsp;&nbsp;<em>features</em>
+</li>
+</ul>
     
 <ul>
 <li>

Modified: incubator/solr/trunk/site/linkmap.pdf
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/site/linkmap.pdf?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
Binary files - no diff available.

Modified: incubator/solr/trunk/site/mailing_lists.html
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/site/mailing_lists.html?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
--- incubator/solr/trunk/site/mailing_lists.html (original)
+++ incubator/solr/trunk/site/mailing_lists.html Fri Feb 24 18:37:53 2006
@@ -66,6 +66,9 @@
 <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
 <div id="menu_1.2" class="menuitemgroup">
 <div class="menuitem">
+<a href="features.html">Features</a>
+</div>
+<div class="menuitem">
 <a href="http://wiki.apache.org/solr/FAQ">FAQ</a>
 </div>
 <div class="menuitem">

Modified: incubator/solr/trunk/site/tutorial.html
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/site/tutorial.html?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
--- incubator/solr/trunk/site/tutorial.html (original)
+++ incubator/solr/trunk/site/tutorial.html Fri Feb 24 18:37:53 2006
@@ -66,6 +66,9 @@
 <div onclick="SwitchMenu('menu_selected_1.2', 'skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Documentation</div>
 <div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
 <div class="menuitem">
+<a href="features.html">Features</a>
+</div>
+<div class="menuitem">
 <a href="http://wiki.apache.org/solr/FAQ">FAQ</a>
 </div>
 <div class="menuitem">

Modified: incubator/solr/trunk/site/version_control.html
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/site/version_control.html?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
--- incubator/solr/trunk/site/version_control.html (original)
+++ incubator/solr/trunk/site/version_control.html Fri Feb 24 18:37:53 2006
@@ -66,6 +66,9 @@
 <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
 <div id="menu_1.2" class="menuitemgroup">
 <div class="menuitem">
+<a href="features.html">Features</a>
+</div>
+<div class="menuitem">
 <a href="http://wiki.apache.org/solr/FAQ">FAQ</a>
 </div>
 <div class="menuitem">

Modified: incubator/solr/trunk/site/who.html
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/site/who.html?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
--- incubator/solr/trunk/site/who.html (original)
+++ incubator/solr/trunk/site/who.html Fri Feb 24 18:37:53 2006
@@ -66,6 +66,9 @@
 <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
 <div id="menu_1.2" class="menuitemgroup">
 <div class="menuitem">
+<a href="features.html">Features</a>
+</div>
+<div class="menuitem">
 <a href="http://wiki.apache.org/solr/FAQ">FAQ</a>
 </div>
 <div class="menuitem">

Added: incubator/solr/trunk/src/site/src/documentation/content/xdocs/features.xml
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/src/site/src/documentation/content/xdocs/features.xml?rev=380881&view=auto
==============================================================================
--- incubator/solr/trunk/src/site/src/documentation/content/xdocs/features.xml (added)
+++ incubator/solr/trunk/src/site/src/documentation/content/xdocs/features.xml Fri Feb 24 18:37:53 2006
@@ -0,0 +1,132 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" 
+          "http://forrest.apache.org/dtd/document-v20.dtd">
+
+<document>
+
+<header>
+  <title>Introduction to The Solar Enterprise Search Server</title> 
+</header> 
+
+<body>
+
+<section>
+<title>Solr in a Nutshell</title>
+  <p>
+  Solar is a standalone enterprise search server with a web-services like API. You put documents in it (called "indexing") via XML over HTTP. You query it via HTTP GET and receive XML results.
+  </p>
+  <ul>
+    <li> Advanced Full-Text Search Capabilities </li>
+    <li> Optimized for High Volume Web Traffic </li>
+    <li> Standards Based Open Interfaces - XML and HTTP </li>
+    <li> Comprehensive HTML Administration Interfaces </li>
+    <li> Scalability - Efficient Replication to other Solar Search Servers </li>
+    <li> Flexible and Adaptable with XML configuration </li>
+    <li> Extensible Plugin Architecture </li>
+  </ul>
+</section>
+
+<section>
+<title>Solar Uses the Lucene Search Library and Extends it!</title>
+  <ul>
+    <li> A Real Data Schema, with Dynamic Fields, Unique Keys </li>
+    <li> Powerful Extensions to the Lucene Query Language </li>
+    <li> Support for Dynamic Result Grouping and Filtering </li>
+    <li> Advanced, Configurable Text Analysis </li>
+    <li> Highly Configurable and User Extensible Caching </li>
+    <li> Performance Optimizations </li>
+    <li> External Configuration via XML </li>
+    <li> An Administration Interface </li>
+    <li> Monitorable Logging </li>
+    <li> Fast Incremental Updates and Snapshot Distribution </li>
+  </ul>
+</section>
+
+<section>
+<title>Detailed Features</title>
+
+  <section><title>Schema</title>
+    <ul>
+      <li>Defines the field types and fields of documents</li>
+      <li>Can drive more intelligent processing</li>
+      <li>Declarative Lucene Analyzer specification</li>
+      <li>Dynamic Fields enables on-the-fly addition of fields</li>
+      <li>CopyField functionality allows indexing a single field multiple ways, or combining multiple fields into a single searchable field</li>
+      <li>Explicit types eliminates the need for guessing types of fields</li>
+      <li>External file-based configuration of stopword lists, synonym lists, and protected word lists</li>
+    </ul>
+  </section>
+
+  <section><title>Query</title>
+    <ul>
+      <li>Sort specifications added to query language</li>
+      <li>Constant scoring range and prefix queries - no idf, coord, or lengthNorm factors, and no restriction on the number of terms the query matches.</li>
+      <li>Function Query - influence the score by a function of a field's numeric value or ordinal</li>
+      <li>Performance Optimizations</li>
+    </ul>
+  </section>
+
+  <section><title>Core</title>
+    <ul>
+      <li>Pluggable query handlers and extensible XML data format</li>
+      <li>Document uniqueness enforcement based on unique key field</li>
+      <li>Batches updates and deletes for high performance</li>
+      <li>User configurable commands triggered on index changes</li>
+      <li>Searcher concurrency control</li>
+      <li>Correct handling of numeric types for both sorting and range queries</li>
+      <li>Ability to control where docs with the sort field missing will be placed</li>
+      <li>Support for dynamic grouping of search results</li>
+    </ul>
+  </section>
+
+  <section><title>Caching</title>
+    <ul>
+      <li>Configurable Query Result, Filter, and Document cache instances</li>
+      <li>Pluggable Cache implementations</li>
+      <li>Cache warming in background
+        <ul><li> When a new searcher is opened, configurable searches are run against
+            it in order to warm it up to avoid
+            slow first hits.  During warming, the current searcher handles live requests.
+        </li></ul>
+      </li>
+      <li>Autowarming in background
+        <ul>
+          <li>The most recently accessed items in the caches of the current
+            searcher are re-populated in the new searcher, enabing high cache hit
+            rates across index/searcher changes.</li>
+        </ul>
+      </li>
+      <li>Fast/small filter implementation</li>
+      <li>User level caching with autowarming support</li>
+    </ul>
+  </section>
+
+  <section><title>Replication</title>
+    <ul>
+      <li>Efficient distribution of index parts that have changed via rsync transport</li>
+      <li>Pull strategy allows for easy addition of searchers</li>
+      <li>Configurable distribution interval allows tradeoff between timeliness and cache utilization</li>
+    </ul>
+  </section>
+
+  <section><title>Admin Interface</title>
+    <ul>
+      <li>Comprehensive statistics on cache utilization, updates, and queries</li>
+      <li>Text analysis debugger, showing result of every stage in an analyzer</li>
+      <li>Web Query Interface w/ debugging output
+        <ul>
+          <li>parsed query output</li>
+          <li>Lucene explain() document score detailing</li>
+          <li>explain score for documents outside of the requested range to debug why a given document wasn't ranked higher.</li>
+        </ul>
+      </li>
+    </ul>
+  </section>
+
+
+
+</section>
+
+</body>
+</document>

Propchange: incubator/solr/trunk/src/site/src/documentation/content/xdocs/features.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/solr/trunk/src/site/src/documentation/content/xdocs/features.xml
------------------------------------------------------------------------------
    svn:executable = *

Modified: incubator/solr/trunk/src/site/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/src/site/src/documentation/content/xdocs/index.xml?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
--- incubator/solr/trunk/src/site/src/documentation/content/xdocs/index.xml (original)
+++ incubator/solr/trunk/src/site/src/documentation/content/xdocs/index.xml Fri Feb 24 18:37:53 2006
@@ -24,10 +24,13 @@
     <section id="intro">
       <title>Introduction</title>
       <p>
-        Solr is an open source search server based on the
-        <a href="http://lucene.apache.org/java/">Lucene Java</a> search library.
-        It's normally run as a webapp in a servlet container
-        such as <a href="http://tomcat.apache.org">Tomcat</a>.
+        Solr is an open source enterprise search server based on the
+        <a href="http://lucene.apache.org/java/">Lucene Java</a> search library, with XML/HTTP APIs,
+        caching, replication, and a web administration interface.
+        It runs in a Java servlet container such as <a href="http://tomcat.apache.org">Tomcat</a>.
+      </p>
+      <p>
+        See the complete <a href="features.html">feature list</a> for more details, then check out the <a href="tutorial.html">tutorial</a>.
       </p>
     </section>
 

Modified: incubator/solr/trunk/src/site/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/incubator/solr/trunk/src/site/src/documentation/content/xdocs/site.xml?rev=380881&r1=380880&r2=380881&view=diff
==============================================================================
--- incubator/solr/trunk/src/site/src/documentation/content/xdocs/site.xml (original)
+++ incubator/solr/trunk/src/site/src/documentation/content/xdocs/site.xml Fri Feb 24 18:37:53 2006
@@ -42,6 +42,7 @@
   </about>
 
   <docs label="Documentation">
+    <features    label="Features"         href="features.html" />
     <faq         label="FAQ"              href="ext:faq" />
     <wiki        label="Wiki"             href="ext:wiki" />
     <tutorial    label="Tutorial"         href="tutorial.html" />