Lucene example source code file (skinconf.xml)

This example Lucene source code file (skinconf.xml) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Lucene tags/keywords

apache, cfdced, color, disable, disable, e5e4d9, e5e4d9, forrest, license, license, lucene, this, this, toc

The Lucene skinconf.xml source code

<?xml version="1.0"?>
<!--
  Copyright 2002-2005 The Apache Software Foundation or its licensors,
  as applicable.

  Licensed 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.
-->

<!--
Skin configuration file. This file contains details of your project,
which will be used to configure the chosen Forrest skin.
-->

<!DOCTYPE skinconfig PUBLIC "-//APACHE//DTD Skin Configuration V0.7-1//EN" "http://forrest.apache.org/dtd/skinconfig-v07-1.dtd">
<skinconfig>
  <!-- To enable lucene search add provider="lucene" (default is google).
    Add box-location="alt" to move the search box to an alternate location
    (if the skin supports it) and box-location="all" to show it in all
    available locations on the page.  Remove the <search> element to show
    no search box. @domain will enable sitesearch for the specific domain with google.
    In other words google will search the @domain for the query string.
  -->
  <search name="Lucene Java"  provider="Lucene"/>

  <!-- Disable the print link? If enabled, invalid HTML 4.0.1 -->
  <disable-print-link>true  
  <!-- Disable the PDF link? -->
  <disable-pdf-link>true
  <!-- Disable the POD link? -->
  <disable-pod-link>true
  <!-- Disable the Text link? FIXME: NOT YET IMPLEMENETED. -->
  <disable-txt-link>true
  <!-- Disable the xml source link? -->
  <!-- The xml source link makes it possible to access the xml rendition
    of the source frim the html page, and to have it generated statically.
    This can be used to enable other sites and services to reuse the
    xml format for their uses. Keep this disabled if you don't want other
    sites to easily reuse your pages.-->
  <disable-xml-link>true

  <!-- Disable navigation icons on all external links? -->
  <disable-external-link-image>true

  <!-- Disable w3c compliance links? 
    Use e.g. align="center" to move the compliance links logos to 
    an alternate location default is left.
    (if the skin supports it) -->
  <disable-compliance-links>true

  <!-- Render mailto: links unrecognisable by spam harvesters? -->
  <obfuscate-mail-links>false
  <obfuscate-mail-value> ... 

  <!-- Disable the javascript facility to change the font size -->
  <disable-font-script>true

  <!-- mandatory project logo
       default skin: renders it at the top -->
  <project-name>Lucene
  <project-description>Apache Lucene is a high-performance, full-featured text search engine library written entirely in
      Java. It is a technology suitable for nearly any application that requires full-text search, especially cross-platform.</project-description>
  <project-url>http://lucene.apache.org/java/
  <project-logo>http://lucene.apache.org/images/lucene_green_300.gif
    <!-- http://lucene.apache.org/images/lucene_green_300.gif -->
  <!-- Alternative static image:
  <project-logo>images/project-logo.gif -->

  <!-- optional group logo
       default skin: renders it at the top-left corner -->
    <!-- group logo -->
    <group-name>Lucene
    <group-description>Apache Lucene
    <group-url>http://lucene.apache.org/
    <group-logo>http://www.apache.org/images/asf_logo_simple.png

    <!-- Alternative static image:
   <group-logo>images/group-logo.gif -->

  <!-- optional host logo (e.g. sourceforge logo)
       default skin: renders it at the bottom-left corner -->
  <host-url>
  <host-logo>

  <!-- relative url of a favicon file, normally favicon.ico -->
  <favicon-url>images/favicon.ico

  <!-- The following are used to construct a copyright statement -->
  <year>2006
  <vendor>The Apache Software Foundation.
  <copyright-link>http://www.apache.org/licenses/

  <!-- Some skins use this to form a 'breadcrumb trail' of links.
    Use location="alt" to move the trail to an alternate location
    (if the skin supports it).
    Omit the location attribute to display the trail in the default location.
    Use location="none" to not display the trail (if the skin supports it).
    For some skins just set the attributes to blank.
    
    NOTE: If a breadcrumb entry points at a local file the href must
    be complete, that is it must point to the file itself, not to a 
    directory.
  -->
  <trail>
    <link1 name="Apache" href="http://www.apache.org/"/>
    <link2 name="Lucene" href="http://lucene.apache.org/"/>
    <link3 name="" href="/"/>
  </trail>

  <!-- Configure the TOC, i.e. the Table of Contents.
  @max-depth
   how many "section" levels need to be included in the
   generated Table of Contents (TOC). 
  @min-sections
   Minimum required to create a TOC.
  @location ("page","menu","page,menu", "none")
   Where to show the TOC.
  -->
  <toc max-depth="2" min-sections="1" location="page"/>

  <!-- Heading types can be clean|underlined|boxed  -->
  <headings type="boxed"/>
  
  <!-- The optional feedback element will be used to construct a
    feedback link in the footer with the page pathname appended:
    <a href="@href">{@to}
    -->
    <!--
  <feedback to="webmaster@foo.com"
    href="mailto:webmaster@foo.com?subject=Feedback " >
    Send feedback about the website to:
  </feedback>
  -->

  <!-- Optional message of the day (MOTD).
    Note: This is only implemented in the pelt skin.
    If the optional <motd> element is used, then messages will be appended
    depending on the URI string pattern.
    motd-option : Specifies a pattern to match and provides small text content.
    motd-title : This text will be added in brackets after the <html>