You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by us...@apache.org on 2012/04/22 11:29:31 UTC
svn commit: r1328830 - in /lucene/dev/trunk/lucene: build.xml
site/xsl/index.xsl
Author: uschindler
Date: Sun Apr 22 09:29:30 2012
New Revision: 1328830
URL: http://svn.apache.org/viewvc?rev=1328830&view=rev
Log:
LUCENE-4007: Add some documentation to the XSL, remove a useless paragraph
Modified:
lucene/dev/trunk/lucene/build.xml
lucene/dev/trunk/lucene/site/xsl/index.xsl
Modified: lucene/dev/trunk/lucene/build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/build.xml?rev=1328830&r1=1328829&r2=1328830&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/build.xml (original)
+++ lucene/dev/trunk/lucene/build.xml Sun Apr 22 09:29:30 2012
@@ -192,6 +192,11 @@
<pathconvert pathsep="|" dirsep="/" property="buildfiles">
<fileset dir="." includes="**/build.xml" excludes="build.xml,analysis/*,build/**,tools/**,backwards/**,site/**"/>
</pathconvert>
+ <!--
+ The XSL input file is ignored completely, but XSL expects one to be given,
+ so we pass ourself (${ant.file}) here. The list of module build.xmls is given
+ via string parameter, that must be splitted by the XSL at '|'.
+ -->
<xslt in="${ant.file}" out="${javadoc.dir}/index.html" style="site/xsl/index.xsl">
<outputproperty name="method" value="html"/>
<outputproperty name="version" value="4.0"/>
Modified: lucene/dev/trunk/lucene/site/xsl/index.xsl
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/site/xsl/index.xsl?rev=1328830&r1=1328829&r2=1328830&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/site/xsl/index.xsl (original)
+++ lucene/dev/trunk/lucene/site/xsl/index.xsl Sun Apr 22 09:29:30 2012
@@ -20,11 +20,17 @@
xmlns:str="http://exslt.org/strings"
extension-element-prefixes="str"
>
- <xsl:param name="buildfiles"/>
- <xsl:param name="version"/>
+ <xsl:param name="buildfiles"/>
+ <xsl:param name="version"/>
- <xsl:template match="/">
- <html>
+ <!--
+ NOTE: This template matches the root element of any given input XML document!
+ The XSL input file is ignored completely, but XSL expects one to be given,
+ so build.xml passes itsself here. The list of module build.xmls is given via
+ string parameter, that must be splitted at '|'.
+ -->
+ <xsl:template match="/">
+ <html>
<head>
<title><xsl:text>Apache Lucene </xsl:text><xsl:value-of select="$version"/><xsl:text> Documentation</xsl:text></title>
</head>
@@ -44,15 +50,13 @@
<li><a href="queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">Classic QueryParser Syntax</a></li>
</ul>
<h2>Getting Started</h2>
- <p>This document is intended as a "getting started" guide. It has three
+ <p>The following document is intended as a "getting started" guide. It has three
audiences: first-time users looking to install Apache Lucene in their
application; developers looking to modify or base the applications they develop
on Lucene; and developers looking to become involved in and contribute to the
development of Lucene. This document is written in tutorial and walk-through
format. The goal is to help you "get started". It does not go into great depth
- on some of the conceptual or inner details of Lucene.</p>
- <p>Each section listed below builds on one another. More advanced users may
- wish to skip sections.</p>
+ on some of the conceptual or inner details of Lucene:</p>
<ul>
<li><a href="demo/overview-summary.html#overview_description">About the command-line Lucene demo, its usage, and sources</a>.
This section is intended for anyone who wants to use the command-line Lucene