dnaber 2004/10/19 14:43:42
Modified: xdocs gettingstarted.xml
docs gettingstarted.html
Log:
change the layout of the "getting started" page a bit so that the links are more
visible; fixing typos
Revision Changes Path
1.2 +21 -39 jakarta-lucene/xdocs/gettingstarted.xml
Index: gettingstarted.xml
===================================================================
RCS file: /home/cvs/jakarta-lucene/xdocs/gettingstarted.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- gettingstarted.xml 26 Jan 2002 15:17:22 -0000 1.1
+++ gettingstarted.xml 19 Oct 2004 21:43:41 -0000 1.2
@@ -6,7 +6,7 @@
</properties>
<body>
-<section name="About this Document">
+<section name="Getting Started">
<p>
This document is intended as a "getting started" guide. It has three basic
audiences: novices looking to install Jakarta Lucene on their application or
@@ -16,53 +16,35 @@
format. It intends to help you in "getting started", but does not go into great
depth into some of the conceptual or inner details of Jakarta Lucene.
</p>
-</section>
-<section name="Format of this Guide">
<p>
Each section listed below builds on one another. That being said more advanced
users may
wish to skip sections.
</p>
-</section>
-<section name="The Simple Demo">
-<p>
-In <a href="demo.html">this</a> section we walk through the basic Lucene demo and
executing it.
-This section is intended for anyone who wants a basic background on using the
provided Lucene demos.
-</p>
-</section>
+<ul>
+ <li><a href="demo.html">About the basic Lucene demo and its usage</a>.
+ This section is intended for anyone who wants a basic background on using the
provided Lucene demos.</li>
-<section name="Simple Demo Source Walkthrough">
-<p>
-In <a href="demo2.html">this</a> section we walk through the sources and
implementation
-for the basic Lucene demo. This section is intended for developers.
-</p>
-</section>
+ <li><a href="demo2.html">About the sources and implementation
+ for the basic Lucene demo</a> section we walk through . This section is
intended for developers.</li>
-<section name="Template Web Application">
-<p>
-In <a href="demo3.html">this</a> section we walk through installing
-and configuring the template web application. While this walkthough assumes
-Tomcat 4.0.x as your container of choice, there is no reason you can't (provided
you have
-the requisite knowledge) adapt the instructions to your container. This section is
intended
-for those responsible for the development or deployment of Lucene-based web
applications.
-</p>
-</section>
+ <li><a href="demo3.html">About installing
+ and configuring the template web application</a>. While this walkthrough
assumes
+ Tomcat 4.0.x as your container of choice, there is no reason you can't
(provided you have
+ the requisite knowledge) adapt the instructions to your container. This
section is intended
+ for those responsible for the development or deployment of Lucene-based web
applications.</li>
-<section name="Template Web Application sources">
-<p>
-In <a href="demo4.html">this</a> section we walk through the sources used to
construct the
-template web application. Please note the template application is designed to
highlight
-features of Lucene and is <b>not</b> an example of best practices. (One would
hopefully
-use MVC architecture such as provided by Jakarta Struts and taglibs, or better yet
XML
-with stylesheets, but showing you how to do that would be WAY beyond the scope of
this
-demonstration. Additionally once could cache results, and perform other
performance
-optimizations, but those are beyond the scope of this demo).
-</p>
-<p>
-This section is intended for developers and those wishing to customize the template
web
-application to their needs. The sections useful to developers only are clearly
delineated.
-</p>
+ <li><a href="demo4.html">About the sources used to construct the
+ template web application</a>. Please note the template application is
designed to highlight
+ features of Lucene and is <b>not</b> an example of best practices. (One would
hopefully
+ use MVC architecture such as provided by Jakarta Struts and taglibs, or better
yet XML
+ with stylesheets, but showing you how to do that would be WAY beyond the scope
of this
+ demonstration. Additionally one could cache results, and perform other
performance
+ optimizations, but those are beyond the scope of this demo).
+ This section is intended for developers and those wishing to customize the
template web
+ application to their needs. The sections useful to developers only are
clearly delineated.</li>
+</ul>
</section>
</body>
1.26 +25 -95 jakarta-lucene/docs/gettingstarted.html
Index: gettingstarted.html
===================================================================
RCS file: /home/cvs/jakarta-lucene/docs/gettingstarted.html,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- gettingstarted.html 18 May 2004 13:32:00 -0000 1.25
+++ gettingstarted.html 19 Oct 2004 21:43:41 -0000 1.26
@@ -133,7 +133,7 @@
<table
border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="About this Document"><strong>About this Document</strong></a>
+ <a name="Getting Started"><strong>Getting Started</strong></a>
</font>
</td></tr>
<tr><td>
@@ -147,103 +147,33 @@
format. It intends to help you in "getting started", but does not go into great
depth into some of the conceptual or inner details of Jakarta Lucene.
</p>
- </blockquote>
- </p>
- </td></tr>
- <tr><td><br/></td></tr>
- </table>
- <table border="0" cellspacing="0"
cellpadding="2" width="100%">
- <tr><td bgcolor="#525D76">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="Format of this Guide"><strong>Format of this Guide</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <p>
+ <p>
Each section listed below builds on one another. That being said more advanced
users may
wish to skip sections.
</p>
- </blockquote>
- </p>
- </td></tr>
- <tr><td><br/></td></tr>
- </table>
- <table border="0" cellspacing="0"
cellpadding="2" width="100%">
- <tr><td bgcolor="#525D76">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="The Simple Demo"><strong>The Simple Demo</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <p>
-In <a href="demo.html">this</a> section we walk through the basic Lucene demo and
executing it.
-This section is intended for anyone who wants a basic background on using the
provided Lucene demos.
-</p>
- </blockquote>
- </p>
- </td></tr>
- <tr><td><br/></td></tr>
- </table>
- <table border="0" cellspacing="0"
cellpadding="2" width="100%">
- <tr><td bgcolor="#525D76">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="Simple Demo Source Walkthrough"><strong>Simple Demo Source
Walkthrough</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <p>
-In <a href="demo2.html">this</a> section we walk through the sources and
implementation
-for the basic Lucene demo. This section is intended for developers.
-</p>
- </blockquote>
- </p>
- </td></tr>
- <tr><td><br/></td></tr>
- </table>
- <table border="0" cellspacing="0"
cellpadding="2" width="100%">
- <tr><td bgcolor="#525D76">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="Template Web Application"><strong>Template Web
Application</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <p>
-In <a href="demo3.html">this</a> section we walk through installing
-and configuring the template web application. While this walkthough assumes
-Tomcat 4.0.x as your container of choice, there is no reason you can't (provided
you have
-the requisite knowledge) adapt the instructions to your container. This section is
intended
-for those responsible for the development or deployment of Lucene-based web
applications.
-</p>
- </blockquote>
- </p>
- </td></tr>
- <tr><td><br/></td></tr>
- </table>
- <table border="0" cellspacing="0"
cellpadding="2" width="100%">
- <tr><td bgcolor="#525D76">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="Template Web Application sources"><strong>Template Web
Application sources</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <p>
-In <a href="demo4.html">this</a> section we walk through the sources used to
construct the
-template web application. Please note the template application is designed to
highlight
-features of Lucene and is <b>not</b> an example of best practices. (One would
hopefully
-use MVC architecture such as provided by Jakarta Struts and taglibs, or better yet
XML
-with stylesheets, but showing you how to do that would be WAY beyond the scope of
this
-demonstration. Additionally once could cache results, and perform other
performance
-optimizations, but those are beyond the scope of this demo).
-</p>
- <p>
-This section is intended for developers and those wishing to customize the template
web
-application to their needs. The sections useful to developers only are clearly
delineated.
-</p>
+ <ul>
+ <li><a href="demo.html">About the basic Lucene demo and its usage</a>.
+ This section is intended for anyone who wants a basic background on using the
provided Lucene demos.</li>
+
+ <li><a href="demo2.html">About the sources and implementation
+ for the basic Lucene demo</a> section we walk through . This section is
intended for developers.</li>
+
+ <li><a href="demo3.html">About installing
+ and configuring the template web application</a>. While this walkthrough
assumes
+ Tomcat 4.0.x as your container of choice, there is no reason you can't
(provided you have
+ the requisite knowledge) adapt the instructions to your container. This
section is intended
+ for those responsible for the development or deployment of Lucene-based web
applications.</li>
+
+ <li><a href="demo4.html">About the sources used to construct the
+ template web application</a>. Please note the template application is
designed to highlight
+ features of Lucene and is <b>not</b> an example of best practices. (One would
hopefully
+ use MVC architecture such as provided by Jakarta Struts and taglibs, or better
yet XML
+ with stylesheets, but showing you how to do that would be WAY beyond the scope
of this
+ demonstration. Additionally one could cache results, and perform other
performance
+ optimizations, but those are beyond the scope of this demo).
+ This section is intended for developers and those wishing to customize the
template web
+ application to their needs. The sections useful to developers only are
clearly delineated.</li>
+</ul>
</blockquote>
</p>
</td></tr>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
