home | career | drupal | java | mac | mysql | perl | scala | uml | unix  

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


  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  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">
  <!-- 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 the PDF link? -->
  <!-- Disable the POD link? -->
  <!-- Disable the Text link? FIXME: NOT YET IMPLEMENETED. -->
  <!-- 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 navigation icons on all external links? -->

  <!-- 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) -->

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

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

  <!-- mandatory project logo
       default skin: renders it at the top -->
  <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>
    <!-- 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-description>Apache Lucene

    <!-- 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 -->

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

  <!-- The following are used to construct a copyright statement -->
  <vendor>The Apache Software Foundation.

  <!-- 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 
    <link1 name="Apache" href="http://www.apache.org/"/>
    <link2 name="Lucene" href="http://lucene.apache.org/"/>
    <link3 name="" href="/"/>

  <!-- Configure the TOC, i.e. the Table of Contents.
   how many "section" levels need to be included in the
   generated Table of Contents (TOC). 
   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:

  <!-- 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>
    motd-page : This text will be added in a panel on the face of the page,
    with the "motd-page-url" being the hyperlink "More".
    Values for the "location" attribute are:
      page : on the face of the page, e.g. in the spare space of the toc
      alt : at the bottom of the left-hand navigation panel
      both : both
    <motd-option pattern="docs_0_80">
      <motd-page location="both">
        This is documentation for development version v0.8
    <motd-option pattern="docs_0_70">
      <motd-page location="both">
        This is documentation for current version v0.7

    extra-css - here you can define custom css-elements that are 
    A) overriding the fallback elements or 
    B) adding the css definition from new elements that you may have 
       used in your documentation.
    <!--Example of reason B:
        To define the css definition of a new element that you may have used
        in the class attribute of a <p> node. 
        e.g. <p class="quote"/>
    p.quote {
      margin-left: 2em;
      padding: .5em;
      background-color: #f0f0f0;
      font-family: monospace;
    img.float-right {
      float: right;
      margin-left: 2em;
      padding: .5em;
        To override the colours of links only in the footer.
    #footer a { color: #0F3660; }
    #footer a:visited { color: #009999; }

    pre.code {
      margin-left: 2em;
      margin-right: 2em;
      padding: 0.5em;
      background-color: #f0f0f0;

  <!-- These values are used for the generated CSS files.
    They essentially "override" the default colors defined in the chosen skin.
    There are four duplicate "groups" of colors below, denoted by comments:
      Color group: Forrest, Krysalis, Collabnet, and Lenya using Pelt.
    They are provided for example only. To customize the colors of any skin,
    uncomment one of these groups of color elements and change the values
    of the particular color elements that you wish to change.
    Note that by default, all color groups are commented-out which means that
    the default colors provided by the skin are being used.

  <!-- Color group: Forrest: example colors similar to forrest.apache.org
    Some of the element names are obscure, so comments are added to show how
    the "pelt" skin uses them, other skins might use these elements in a different way.
    Tip: temporarily change the value of an element to red (#ff0000) and see the effect.
     pelt: breadtrail: the strip at the top of the page and the second strip under the tabs
     pelt: header: top strip containing project and group logos
     pelt: heading|subheading: section headings within the content
     pelt: navstrip: the strip under the tabs which contains the published date
     pelt: menu: the left-hand navigation panel
     pelt: toolbox: the selected menu item
     pelt: searchbox: the background of the searchbox
     pelt: border: line border around selected menu item
     pelt: body: any remaining parts, e.g. the bottom of the page
     pelt: footer: the second from bottom strip containing credit logos and published date
     pelt: feedback: the optional bottom strip containing feedback link
    <color name="breadtrail" value="#cedfef" font="#0F3660" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
    <color name="header" value="#294563"/>
    <color name="tab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
    <color name="tab-unselected" value="#b5c7e7" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
    <color name="subtab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
    <color name="subtab-unselected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
    <color name="heading" value="#294563"/>
    <color name="subheading" value="#4a6d8c"/>
    <color name="published" value="#4C6C8F" font="#FFFFFF"/>
    <color name="feedback" value="#4C6C8F" font="#FFFFFF" align="center"/>
    <color name="navstrip" value="#4a6d8c" font="#ffffff" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
    <color name="menu" value="#4a6d8c" font="#cedfef" link="#ffffff" vlink="#ffffff" hlink="#ffcf00"/>    
    <color name="toolbox" value="#4a6d8c"/>
    <color name="border" value="#294563"/>
    <color name="dialog" value="#4a6d8c"/>
    <color name="searchbox" value="#4a6d8c" font="#000000"/>
    <color name="body" value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
    <color name="table" value="#7099C5"/>    
    <color name="table-cell" value="#f0f0ff"/>    
    <color name="highlight" value="#ffff00"/>
    <color name="fixme" value="#cc6600"/>
    <color name="note" value="#006699"/>
    <color name="warning" value="#990000"/>
    <color name="code" value="#CFDCED"/>
    <color name="footer" value="#cedfef"/>

  <!-- Color group: Krysalis -->
    <color name="header"    value="#FFFFFF"/>

    <color name="tab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
    <color name="tab-unselected" value="#F7F7F7"  link="#000000" vlink="#000000" hlink="#000000"/>
    <color name="subtab-selected" value="#a5b6c6"  link="#000000" vlink="#000000" hlink="#000000"/>
    <color name="subtab-unselected" value="#a5b6c6"  link="#000000" vlink="#000000" hlink="#000000"/>

    <color name="heading" value="#a5b6c6"/>
    <color name="subheading" value="#CFDCED"/>
    <color name="navstrip" value="#CFDCED" font="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
    <color name="toolbox" value="#a5b6c6"/>
    <color name="border" value="#a5b6c6"/>
    <color name="menu" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>    
    <color name="dialog" value="#F7F7F7"/>
    <color name="body"    value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
    <color name="table" value="#a5b6c6"/>    
    <color name="table-cell" value="#ffffff"/>    
    <color name="highlight" value="#ffff00"/>
    <color name="fixme" value="#cc6600"/>
    <color name="note" value="#006699"/>
    <color name="warning" value="#990000"/>
    <color name="code" value="#a5b6c6"/>
    <color name="footer" value="#a5b6c6"/>

  <!-- Color group: Collabnet --> 
    <color name="header"    value="#003366"/>

    <color name="tab-selected" value="#dddddd" link="#555555" vlink="#555555" hlink="#555555"/>
    <color name="tab-unselected" value="#999999" link="#ffffff" vlink="#ffffff" hlink="#ffffff"/>
    <color name="subtab-selected" value="#cccccc" link="#000000" vlink="#000000" hlink="#000000"/>
    <color name="subtab-unselected" value="#cccccc" link="#555555" vlink="#555555" hlink="#555555"/>

    <color name="heading" value="#003366"/>
    <color name="subheading" value="#888888"/>
    <color name="navstrip" value="#dddddd" font="#555555"/>
    <color name="toolbox" value="#dddddd" font="#555555"/>
    <color name="border" value="#999999"/>
    <color name="menu" value="#ffffff"/>    
    <color name="dialog" value="#eeeeee"/>
    <color name="body"      value="#ffffff"/>
    <color name="table" value="#ccc"/>    
    <color name="table-cell" value="#ffffff"/>   
    <color name="highlight" value="#ffff00"/>
    <color name="fixme" value="#cc6600"/>
    <color name="note" value="#006699"/>
    <color name="warning" value="#990000"/>
    <color name="code" value="#003366"/>
    <color name="footer" value="#ffffff"/>
 <!-- Color group: Lenya using pelt-->

    <color name="header" value="#ffffff"/>

    <color name="tab-selected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
    <color name="tab-unselected" value="#F5F4E9" link="#000000" vlink="#000000" hlink="#000000"/>
    <color name="subtab-selected" value="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
    <color name="subtab-unselected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>

    <color name="heading" value="#E5E4D9"/>
    <color name="subheading" value="#000000"/>
    <color name="published" value="#000000"/>
    <color name="navstrip" value="#E5E4D9" font="#000000"/>
    <color name="toolbox" value="#CFDCED" font="#000000"/>
    <color name="border" value="#999999"/>

    <color name="menu" value="#E5E4D9" font="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
    <color name="dialog" value="#CFDCED"/>
    <color name="body" value="#ffffff" />

    <color name="table" value="#ccc"/>
    <color name="table-cell" value="#ffffff"/>
    <color name="highlight" value="#ffff00"/>
    <color name="fixme" value="#cc6600"/>
    <color name="note" value="#006699"/>
    <color name="warning" value="#990000"/>
    <color name="code" value="#003366"/>

    <color name="footer" value="#E5E4D9"/>
    Credits are typically rendered as a set of small clickable
    images in the page footer.
    Use box-location="alt" to move the credits to an alternate location
    (if the skin supports it).

    For example, pelt skin:
    - box-location="alt" will place the logo at the end of the
      left-hand coloured menu panel.
    - box-location="alt2" will place them underneath that panel
      in the left-hand whitespace.
    - Otherwise they are placed next to the compatibility icons
      at the bottom of the screen.

    Comment out the whole <credit>-element if you want no credits in the
    web pages  
    <credit box-location="alt">
      <name>Built with Apache Forrest</name>
    <!-- A credit with @role="pdf" will be used to compose a footer
     for each page in the PDF, using either "name" or "url" or both.
    <credit role="pdf">
      <name>Built with Apache Forrest</name>

<div id="after_source_code">
<h2>Other Lucene examples (source code examples)</h2>
<p>Here is a short list of links related to this Lucene skinconf.xml source code file:</p>
  <li><a href="/java/jwarehouse"><img src="/images/scw/find.png" border="0"> The search page</a></li>
  <li><a href="index.shtml"><img src="/images/scw/folder.png" border="0"> Other Lucene source code examples at this package level</a></li>
  <li><a href="/java/jwarehouse/about.shtml"><img src="/images/scw/information.png" border="0"> Click here to learn more about this project</a></li>

<div align="center">
<a href="https://alvinalexander.com/scala/functional-programming-simplified-book"><img
   src="/images/functional-programming-simplified-book-cover.jpg" />
   <br/>my book on functional programming</a>
<br/> <br/>

<div id="whats_new">
<h2>new blog posts</h2>
<div id="whats_new_list">
<li><a class="whats_new_link" href="/photos/12000-feet-rocky-mountain-national-park-estes-park-area">12,000 feet up in Rocky Mountain National Park (Estes Park area)</a></li>
<li><a class="whats_new_link" href="/photos/shoji-screen-and-christmas-lights">Shoji screen and Christmas lights</a></li>
<li><a class="whats_new_link" href="/misc/never-be-prisoner-of-past-lesson-not-life-sentence">Never be a prisoner of your past</a></li>
<li><a class="whats_new_link" href="/photos/the-flatirons-boulder-colorado">The flatirons, Boulder, Colorado</a></li>
<li><a class="whats_new_link" href="/photos/texas-am-aerospace-engineering-space-shuttle-poster">Space Shuttle poster, circa ~1986</a></li>
<li><a class="whats_new_link" href="/photos/cloudy-day-estes-park-september-2018-2019">A cloudy day at Estes Park</a></li>
<li><a class="whats_new_link" href="/misc/talked-to-doctor-about-diets-statins-apples-bees-zen-life-death">Talked to a doctor about diets, statins, apples, bees, Zen ...</a></li>
<li><a class="whats_new_link" href="/photos/usb-led-computer-powered-christmas-lights">USB/computer-powered Christmas lights</a></li>
<li><a class="whats_new_link" href="/misc/stung-by-a-bee">Stung by a bee</a></li>

<p> </p>

<p align="center"><font color="#000000" size="2"
face="Verdana,Arial">Copyright 1998-2019 Alvin Alexander, alvinalexander.com<br/>
All Rights Reserved.<br/>
A percentage of advertising revenue from<br/>
pages under the <a href="/java/jwarehouse">/java/jwarehouse</a> 
URI on this website is<br/>
paid back to open source projects.</p>

<script type="text/javascript">

  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'UA-35326316-1']);

  (function() {
    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);


var div = document.getElementById("leftcol");
var pre = '<div style="margin: 0; padding-right: 1.6em"><h2 align="center">favorite books</h2>';
var post = '</div>';
if (adblock) {
  var str = books.slice(0,3).join(" ");
  div.insertAdjacentHTML('beforeend', pre + str + post);
} else {
  var str = books.slice(0,1).join(" ");
  div.insertAdjacentHTML('beforeend', pre + str + post);

<p style="padding-bottom: 80px;"> </p>