lucene/site/xsl/index.xsl - lucene-solr - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
 <xsl:stylesheet version="1.0"
   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   xmlns:str="http://exslt.org/strings"
   extension-element-prefixes="str"
 >
   <xsl:param name="buildfiles"/>
   <xsl:param name="version"/>
   <xsl:param name="defaultCodec"/>

   <!-- ANT cannot lowercase a property, so we hack this here: -->
   <xsl:variable name="defaultCodecPackage" select="translate($defaultCodec,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')"/>

   <!--
     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 itself 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>
       <body>
         <div><a href="http://lucene.apache.org/core/"><img src="lucene_green_300.gif" title="Apache Lucene Logo" alt="Lucene" border="0"/></a></div>
         <h1>
           <xsl:text>Apache Lucene</xsl:text>
           <span style="vertical-align: top; font-size: x-small">
             <xsl:text>TM</xsl:text>
           </span>
           <xsl:text> </xsl:text>
           <xsl:value-of select="$version"/>
           <xsl:text> Documentation</xsl:text>
         </h1>
         <p>Lucene is a Java full-text search engine. Lucene is not a complete application,
         but rather a code library and API that can easily be used to add search capabilities
         to applications.</p>
         <p>
           This is the official documentation for <b><xsl:text>Apache Lucene </xsl:text>
           <xsl:value-of select="$version"/></b>. Additional documentation is available in the
           <a href="http://wiki.apache.org/lucene-java">Wiki</a>.
         </p>
         <h2>Getting Started</h2>
         <p>The following section 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. 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>
         <ul>
         <li><a href="demo/overview-summary.html#overview.description">Lucene demo, its usage, and sources</a>:
         Tutorial and walk-through of the command-line Lucene demo.</li>
         <li><a href="core/overview-summary.html#overview.description">Introduction to Lucene's APIs</a>:
         High-level summary of the different Lucene packages. </li>
         <li><a href="core/org/apache/lucene/analysis/package-summary.html#package.description">Analysis overview</a>:
         Introduction to Lucene's analysis API.  See also the
         <a href="core/org/apache/lucene/analysis/TokenStream.html">TokenStream consumer workflow</a>.</li>
         </ul>
         <h2>Reference Documents</h2>
           <ul>
             <li><a href="changes/Changes.html">Changes</a>: List of changes in this release.</li>
             <li><a href="SYSTEM_REQUIREMENTS.html">System Requirements</a>: Minimum and supported Java versions.</li>
             <li><a href="MIGRATE.html">Migration Guide</a>: What changed in Lucene 8; how to migrate code from Lucene 7.x.</li>
             <li><a href="JRE_VERSION_MIGRATION.html">JRE Version Migration</a>: Information about upgrading between major JRE versions.</li>
             <li><a href="core/org/apache/lucene/codecs/{$defaultCodecPackage}/package-summary.html#package.description">File Formats</a>: Guide to the supported index format used by Lucene.  This can be customized by using <a href="core/org/apache/lucene/codecs/package-summary.html#package.description">an alternate codec</a>.</li>
             <li><a href="core/org/apache/lucene/search/package-summary.html#package.description">Search and Scoring in Lucene</a>: Introduction to how Lucene scores documents.</li>
             <li><a href="core/org/apache/lucene/search/similarities/TFIDFSimilarity.html">Classic Scoring Formula</a>: Formula of Lucene's classic <a href="http://en.wikipedia.org/wiki/Vector_Space_Model">Vector Space</a> implementation. (look <a href="core/org/apache/lucene/search/similarities/package-summary.html#package.description">here</a> for other models)</li>
             <li><a href="queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package.description">Classic QueryParser Syntax</a>: Overview of the Classic QueryParser's syntax and features.</li>
           </ul>
         <h2>API Javadocs</h2>
         <xsl:call-template name="modules"/>
         <h2>Tools</h2>
           <ul>
             <li>Luke - Lucene Toolbox GUI tool: A Swing app for browsing documents, indexed terms and posting lists, searching an index, and so on. Type "/path/to/lucene-<xsl:value-of select="$version"/>/luke/luke.{sh|bat}" to launch Luke.</li>
           </ul>
       </body>
     </html>
   </xsl:template>

   <xsl:template name="modules">
     <ul>
       <xsl:for-each select="str:split($buildfiles,'|')">
         <!-- hack to list "core" first, contains() returns "true" which sorts before "false" if descending: -->
         <xsl:sort select="string(contains(text(), '/core/'))" order="descending" lang="en"/>
         <!-- hack to list "test-framework" at the end, contains() returns "true" which sorts after "false" if ascending: -->
         <xsl:sort select="string(contains(text(), '/test-framework/'))" order="ascending" lang="en"/>
         <!-- sort the remaining build files by path name: -->
         <xsl:sort select="text()" order="ascending" lang="en"/>

         <xsl:variable name="buildxml" select="document(.)"/>
         <xsl:variable name="name" select="$buildxml/*/@name"/>
         <li>
           <xsl:if test="$name='core'">
             <xsl:attribute name="style">font-size:larger; margin-bottom:.5em;</xsl:attribute>
           </xsl:if>
           <b><a href="{$name}/index.html"><xsl:value-of select="$name"/>
           </a><xsl:text>: </xsl:text></b>
           <xsl:value-of select="normalize-space($buildxml/*/description)"/>
         </li>
       </xsl:for-each>
     </ul>
   </xsl:template>

 </xsl:stylesheet>
	<?xml version="1.0" encoding="UTF-8"?>
	<!--
	Licensed to the Apache Software Foundation (ASF) under one or more
	contributor license agreements. See the NOTICE file distributed with
	this work for additional information regarding copyright ownership.
	The ASF licenses this file to You under the Apache License, Version 2.0
	(the "License"); you may not use this file except in compliance with
	the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
	-->
	<xsl:stylesheet version="1.0"
	xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
	xmlns:str="http://exslt.org/strings"
	extension-element-prefixes="str"
	>
	<xsl:param name="buildfiles"/>
	<xsl:param name="version"/>
	<xsl:param name="defaultCodec"/>

	<!-- ANT cannot lowercase a property, so we hack this here: -->
	<xsl:variable name="defaultCodecPackage" select="translate($defaultCodec,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')"/>

	<!--
	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 itself 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>
	<body>
	<div><a href="http://lucene.apache.org/core/"><img src="lucene_green_300.gif" title="Apache Lucene Logo" alt="Lucene" border="0"/></a></div>
	<h1>
	<xsl:text>Apache Lucene</xsl:text>
	<span style="vertical-align: top; font-size: x-small">
	<xsl:text>TM</xsl:text>
	</span>
	<xsl:text> </xsl:text>
	<xsl:value-of select="$version"/>
	<xsl:text> Documentation</xsl:text>
	</h1>
	<p>Lucene is a Java full-text search engine. Lucene is not a complete application,
	but rather a code library and API that can easily be used to add search capabilities
	to applications.</p>
	<p>
	This is the official documentation for <b><xsl:text>Apache Lucene </xsl:text>
	<xsl:value-of select="$version"/></b>. Additional documentation is available in the
	<a href="http://wiki.apache.org/lucene-java">Wiki</a>.
	</p>
	<h2>Getting Started</h2>
	<p>The following section 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. 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>
	<ul>
	<li><a href="demo/overview-summary.html#overview.description">Lucene demo, its usage, and sources</a>:
	Tutorial and walk-through of the command-line Lucene demo.</li>
	<li><a href="core/overview-summary.html#overview.description">Introduction to Lucene's APIs</a>:
	High-level summary of the different Lucene packages. </li>
	<li><a href="core/org/apache/lucene/analysis/package-summary.html#package.description">Analysis overview</a>:
	Introduction to Lucene's analysis API. See also the
	<a href="core/org/apache/lucene/analysis/TokenStream.html">TokenStream consumer workflow</a>.</li>
	</ul>
	<h2>Reference Documents</h2>
	<ul>
	<li><a href="changes/Changes.html">Changes</a>: List of changes in this release.</li>
	<li><a href="SYSTEM_REQUIREMENTS.html">System Requirements</a>: Minimum and supported Java versions.</li>
	<li><a href="MIGRATE.html">Migration Guide</a>: What changed in Lucene 8; how to migrate code from Lucene 7.x.</li>
	<li><a href="JRE_VERSION_MIGRATION.html">JRE Version Migration</a>: Information about upgrading between major JRE versions.</li>
	<li><a href="core/org/apache/lucene/codecs/{$defaultCodecPackage}/package-summary.html#package.description">File Formats</a>: Guide to the supported index format used by Lucene. This can be customized by using <a href="core/org/apache/lucene/codecs/package-summary.html#package.description">an alternate codec</a>.</li>
	<li><a href="core/org/apache/lucene/search/package-summary.html#package.description">Search and Scoring in Lucene</a>: Introduction to how Lucene scores documents.</li>
	<li><a href="core/org/apache/lucene/search/similarities/TFIDFSimilarity.html">Classic Scoring Formula</a>: Formula of Lucene's classic <a href="http://en.wikipedia.org/wiki/Vector_Space_Model">Vector Space</a> implementation. (look <a href="core/org/apache/lucene/search/similarities/package-summary.html#package.description">here</a> for other models)</li>
	<li><a href="queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package.description">Classic QueryParser Syntax</a>: Overview of the Classic QueryParser's syntax and features.</li>
	</ul>
	<h2>API Javadocs</h2>
	<xsl:call-template name="modules"/>
	<h2>Tools</h2>
	<ul>
	<li>Luke - Lucene Toolbox GUI tool: A Swing app for browsing documents, indexed terms and posting lists, searching an index, and so on. Type "/path/to/lucene-<xsl:value-of select="$version"/>/luke/luke.{sh\|bat}" to launch Luke.</li>
	</ul>
	</body>
	</html>
	</xsl:template>

	<xsl:template name="modules">
	<ul>
	<xsl:for-each select="str:split($buildfiles,'\|')">
	<!-- hack to list "core" first, contains() returns "true" which sorts before "false" if descending: -->
	<xsl:sort select="string(contains(text(), '/core/'))" order="descending" lang="en"/>
	<!-- hack to list "test-framework" at the end, contains() returns "true" which sorts after "false" if ascending: -->
	<xsl:sort select="string(contains(text(), '/test-framework/'))" order="ascending" lang="en"/>
	<!-- sort the remaining build files by path name: -->
	<xsl:sort select="text()" order="ascending" lang="en"/>

	<xsl:variable name="buildxml" select="document(.)"/>
	<xsl:variable name="name" select="$buildxml/*/@name"/>
	<li>
	<xsl:if test="$name='core'">
	<xsl:attribute name="style">font-size:larger; margin-bottom:.5em;</xsl:attribute>
	</xsl:if>
	<b><a href="{$name}/index.html"><xsl:value-of select="$name"/>
	</a><xsl:text>: </xsl:text></b>
	<xsl:value-of select="normalize-space($buildxml/*/description)"/>
	</li>
	</xsl:for-each>
	</ul>
	</xsl:template>

	</xsl:stylesheet>