Introduction:
=============
The API documentation is available in gtk-doc format and is installed in 
$(prefix)/share/gtk-doc/html/libogs

A gain of using gtk-doc is that you can use a tool developed by Imendio
called Devhelp to browse and search your API documentation. Devhelp is
available as GPL at:
http://www.imendio.com/projects/devhelp

Structure:
==========
libogs: Contains the Search Application core.

modules: Search modules

src: The application



Makefile snippet for installing the module:
===========================================
In order to use your module you need to install it so that OGS can found it.

mymoduledir = $(libdir)/ogs/modules
mymodule_LTLIBRARIES = libmymodule.la

libmymodule_la_SOURCES = mymodule.c myplugin.c myplugin.h

This will install the module in the OGS modules directory.

Configuration format
====================

The location configuration file should be named locations.conf and
contain configuration in the following format:

  <global-search-locations>
    <!-- The users documents path -->
    <documents-path>/usr/share/doc</documents-path>

    <!-- The mount point for the MMC card -->
    <memory-card-path>/mnt/memcard</memory-card-path>
  </global-search-locations>

Paths must be absolute, unless they start with the special $HOME string,
which is replaced with the user's home directory.

Note that the environment variable MMC_MOUNTPOINT overrides the
configuration for the MMC card, and MYDOCSDIR overrides the documents
path setting.


Category/MIME type mapping
==========================

When searching for files in a certain category, the search application
uses the category/MIME type mapping maintained by the osso_mime_* API in
the libossomime package (source package name osso-gnomevfs-extra). See
the API documentation for for more information on how to setup this
mapping.
