2012-09-20 11:37:42 -04:00
<?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" />
2012-09-20 18:53:05 -04:00
<xsl:param name= "luceneJavadocUrl" />
2017-10-04 14:47:11 -04:00
<xsl:param name= "solrGuideVersion" />
2012-09-20 11:37:42 -04:00
<!--
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 Solr </xsl:text> <xsl:value-of select= "$version" /> <xsl:text > Documentation</xsl:text> </title>
2015-01-18 12:38:44 -05:00
<link rel= "icon" type= "image/x-icon" href= "images/favicon.ico" />
<link rel= "shortcut icon" type= "image/x-icon" href= "images/favicon.ico" />
2012-09-20 11:37:42 -04:00
</head>
<body >
2013-07-26 05:00:27 -04:00
<div >
<a href= "http://lucene.apache.org/solr/" >
2015-01-18 12:38:44 -05:00
<img src= "images/solr.svg" style= "width:210px; margin:22px 0px 7px 20px; border:none;" title= "Apache Solr Logo" alt= "Solr" />
2013-07-26 05:00:27 -04:00
</a>
2014-12-18 20:49:37 -05:00
<div style= "z-index:100;position:absolute;top:25px;left:226px" >
2013-07-26 05:00:27 -04:00
<span style= "font-size: x-small" > TM</span>
</div>
</div>
<h1 >
<xsl:text > Apache Solr</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>
2012-09-20 11:37:42 -04:00
<p > Solr is the popular, blazing fast open source enterprise search platform from the Apache Lucene project.
Its major features include powerful full-text search, hit highlighting, faceted search, dynamic clustering,
database integration, rich document (e.g., Word, PDF) handling, and geospatial search. Solr is highly scalable,
providing distributed search and index replication, and it powers the search and navigation features of many
of the world's largest internet sites.</p>
<p > Solr is written in Java and runs as a standalone full-text search server within a servlet container such as
Jetty. Solr uses the Lucene Java search library at its core for full-text indexing and search, and has REST-like
HTTP/XML and JSON APIs that make it easy to use from virtually any programming language. Solr's powerful external
configuration allows it to be tailored to almost any type of application without Java coding, and it has an extensive
plugin architecture when more advanced customization is required.</p>
<p >
This is the official documentation for <b > <xsl:text > Apache Solr </xsl:text>
2013-04-17 21:43:27 -04:00
<xsl:value-of select= "$version" /> </b> .
2012-09-20 11:37:42 -04:00
</p>
<h2 > Reference Documents</h2>
<ul >
2013-04-17 21:43:27 -04:00
<li > <a href= "http://wiki.apache.org/solr" > Wiki</a> : Additional documentation, especially focused on using Solr.</li>
2012-09-20 11:37:42 -04:00
<li > <a href= "changes/Changes.html" > Changes</a> : List of changes in this release.</li>
2012-10-15 19:06:34 -04:00
<li > <a href= "SYSTEM_REQUIREMENTS.html" > System Requirements</a> : Minimum and supported Java versions.</li>
2017-10-04 14:47:11 -04:00
<li > <a href= "https://lucene.apache.org/solr/guide/{$solrGuideVersion}/solr-tutorial.html" > Solr Tutorial</a> : This document covers the basics of running Solr using an example schema, and some sample data.</li>
2012-09-20 18:53:05 -04:00
<li > <a href= "{$luceneJavadocUrl}index.html" > Lucene Documentation</a> </li>
2012-09-20 11:37:42 -04:00
</ul>
<h2 > API Javadocs</h2>
<xsl:call-template name= "modules" />
</body>
</html>
2015-08-11 19:15:20 -04:00
</xsl:template>
2012-09-20 11:37:42 -04:00
<xsl:template name= "modules" >
<ul >
<xsl:for-each select= "str:split($buildfiles,'|')" >
<!-- hack to list "core" and "solrj" first, contains() returns "true" which sorts before "false" if descending: -->
<xsl:sort select= "string(contains(text(), '/core/'))" order= "descending" lang= "en" />
<xsl:sort select= "string(contains(text(), '/solrj/'))" 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='solr-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>
