Metacat

# Makefile for Sphinx documentation

#

# You can set these variables from the command line.

SPHINXOPTS    =

SPHINXBUILD   = sphinx-build

PAPER         =

BUILDDIR      = build

GRAPHVIZ      = /opt/local/bin/dot

# Internal variables.

PAPEROPT_a4     = -D latex_paper_size=a4

PAPEROPT_letter = -D latex_paper_size=letter

ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source

.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest pdf

help:

	@echo "Please use \`make <target>' where <target> is one of"

	@echo "  html      to make standalone HTML files"

	@echo "  dirhtml   to make HTML files named index.html in directories"

	@echo "  pickle    to make pickle files"

	@echo "  json      to make JSON files"

	@echo "  htmlhelp  to make HTML files and a HTML help project"

	@echo "  qthelp    to make HTML files and a qthelp project"

	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"

	@echo "  changes   to make an overview of all changed/added/deprecated items"

	@echo "  linkcheck to check all external links for integrity"

	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"

	@echo "  pdf       to make PDF files"

clean:

	-rm -rf $(BUILDDIR)/*

plantuml:

	GRAPHVIZ_DOT=$(GRAPHVIZ) plantuml source 

html: 

	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

	@echo

	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:

	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

	@echo

	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

pickle:

	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle

	@echo

	@echo "Build finished; now you can process the pickle files."

json:

	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json

	@echo

	@echo "Build finished; now you can process the JSON files."

pdf:

	$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf

	@echo

	@echo "Build finished. The PDF files are in $(BUILDDIR)/pdf."

htmlhelp:

	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp

	@echo

	@echo "Build finished; now you can run HTML Help Workshop with the" \

	      ".hhp project file in $(BUILDDIR)/htmlhelp."

qthelp:

	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp

	@echo

	@echo "Build finished; now you can run "qcollectiongenerator" with the" \

	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"

	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DataONEArchitecture.qhcp"

	@echo "To view the help file:"

	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DataONEArchitecture.qhc"

latex:

	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

	@echo

	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."

	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \

	      "run these through (pdf)latex."

changes:

	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes

	@echo

	@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:

	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck

	@echo

	@echo "Link check complete; look for any errors in the above output " \

	      "or in $(BUILDDIR)/linkcheck/output.txt."

doctest:

	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest

	@echo "Testing of doctests in the sources finished, look at the " \

	      "results in $(BUILDDIR)/doctest/output.txt."

skinparam activityFontColor black

skinparam activityFontSize 10

skinparam activityFontName arial

skinparam activityArrowFontColor black

skinparam activityArrowFontSize 10

skinparam activityArrowFontName arial

skinparam classArrowFontColor black

skinparam classArrowFontSize 10

skinparam classArrowFontName arial

skinparam classAttributeFontColor black

skinparam classAttributeFontSize 10

skinparam classAttributeFontName arial

skinparam classFontColor black

skinparam classFontSize 10

skinparam classFontName arial

skinparam componentFontColor black

skinparam componentFontSize 10

skinparam componentFontName arial

skinparam componentArrowFontColor black

skinparam componentArrowFontSize 10

skinparam componentArrowFontName arial

skinparam noteFontColor black

skinparam noteFontSize 10

skinparam noteFontName arial

skinparam packageFontColor black

skinparam packageFontSize 10

skinparam packageFontName arial

skinparam sequenceActorFontColor black

skinparam sequenceActorFontSize 10

skinparam sequenceActorFontName arial

skinparam sequenceArrowFontColor black

skinparam sequenceArrowFontSize 10

skinparam sequenceArrowFontName arial

skinparam sequenceGroupingFontColor black

skinparam sequenceGroupingFontSize 10

skinparam sequenceGroupingFontName arial

skinparam sequenceGroupingHeaderFontColor black

skinparam sequenceGroupingHeaderFontSize 10

skinparam sequenceGroupingHeaderFontName arial

skinparam sequenceParticipantFontColor black

skinparam sequenceParticipantFontSize 10

skinparam sequenceParticipantFontName arial

skinparam sequenceTitleFontColor black

skinparam sequenceTitleFontSize 10

skinparam sequenceTitleFontName arial

skinparam titleFontColor black

skinparam titleFontSize 10

skinparam titleFontName arial

skinparam usecaseFontColor black

skinparam usecaseFontSize 10

skinparam usecaseFontName arial

skinparam usecaseActorFontColor black

skinparam usecaseActorFontSize 10

skinparam usecaseActorFontName arial

skinparam usecaseArrowFontColor black

skinparam usecaseArrowFontSize 10

skinparam usecaseArrowFontName arial

Replication

===========

Metacat has a built-in replication feature that allows different Metacat servers 

to share data (both XML documents and data files) between each other. Metacat 

can replicate not only its home server's original documents, but also those 

that were replicated from partner Metacat servers. When changes are made to 

one server in a replication network, the changes are automatically propogated 

to the network, even if the network is down.

Replication allows users to manage their data locally and (by replicating them 

to a shared Metacat repository) to make those data available to the greater 

scientific community via a centralized search. In other words, your Metacat can 

be part of a broader network, but you retain control over the local repository 

and how it is managed.

For example, the KNB Network (Figure 6.1), which currently consists of ten 

different Metacat servers from around the world, uses replication to "join" 

the disperate servers to form a single robust and searchable data 

repository--facilitating data discovery, while leaving the data ownership and 

management with the local administrators.

.. figure:: images/screenshots/image059.jpg

   :align: center

   A map of the KNB Metacat network.

When properly configured, Metacat's replication mechanism can be triggered by 

several types of events that occur on either the home or partner server: a 

document insertion, an update, or an automatic replication (i.e., Delta-T 

monitoring), which is set at a user-specified time interval.

+----------------------+----------------------------------------------------------+

| Replication Triggers | Description                                              |

+======================+==========================================================+

| Insert               | Whenever a document is inserted into Metacat, the server |

|                      | notifies each server in its replication list             |

|                      | that it has a new file available.                        |

+----------------------+----------------------------------------------------------+

| Update               | Whenever a document is updated, the server notifies      |

|                      | each server in its replication list of the update.       |

+----------------------+----------------------------------------------------------+

| Delta-T monitoring   | At a user-specified time interval, Metacat checks each   |

|                      | of the servers in its replication list                   |

|                      | for updated documents.                                   |

+----------------------+----------------------------------------------------------+

Configuring Replication

-----------------------

To configure replication, you must configure both the home and partner servers:

1. Create a list of partner servers on your home server using the Replication Control Panel

2. Create certificate files for the home server

3. Create certificate files for the partner server

4. Import partner certificate files to the home server

5. Import home certificate to the partner server

6. Update your Metacat database 

Each step is discussed in more detail in the following sections.

Using the Replication Control Panel

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To add, remove, or alter servers on your home server's Replication list, or to 

activate and customize the Delta-T handler, use the Replication control panel, 

which is accessed via the Metacat Administration interface at the following URL::

   http://somehost.somelocation.edu/context/admin

"http://somehost.somelocation.edu/context" should be replaced with the name 

of your Metacat server and context (e.g., http://knb.ecoinformatics.org/knb/). 

You must be logged in to Metacat as an administrator.

.. figure:: images/screenshots/image061.jpg

   :align: center

   Replication control panel.

Note that currently, you cannot use the Replication Control Panel to remove a 

server after a replication has occurred. At this point in time, the only way to 

remove a replication server after replication has occurred is to remove the 

certificates. 

Generating and Exchanging Security Certificates

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Before you can take advantage of Metacat's replication feature, you must 

generate security certificates on both the replication partner and home servers. 

Depending on how the certificates are generated, the certificates may need to be

exchanged so that each machine "trusts" that the other has replication access.

Certificates that are purchased from a commercial and well-recognized 

Certificate Authority do not need to be exchanged with the other replication

partner before replication takes place.  Metacat replication relies on SSL with

client certificate authentication enabled.  When a replication partner server 

communicates with another replication partner, it presents a certificate that

serves to verify and authenticate that the server is trusted.

If you must generate a self-signed certificate, the partner replication server 

will need the public certificate added to its existing Certificate Authorities. 

Generate Certificates for Metacat running under Apache/Tomcat

.............................................................

Note: Instructions are for Ubuntu/Debian systems.

1. Generate a private key using openssl. The key will be named 

   ``<hostname>-apache.key``, where ``<hostname>`` is the name of your Metacat 

   server. Example values for the individual key fields are included in the

   table below.

   ::

     openssl req -new -out REQ.pem -keyout <hostname>-apache.key

   +--------------------------+-------------------------------------------------------------------------+

   | Key Field                | Description and Example Value                                           |

   +==========================+=========================================================================+

   | Country Name             | Two letter country code  (e.g., US)                                     |

   +--------------------------+-------------------------------------------------------------------------+

   | State or Province Name   | The name of your state or province spelled in full (e.g., California)   |

   +--------------------------+-------------------------------------------------------------------------+

   | Locality Name            | The name of your city (e.g., Santa Barbara)                             |

   +--------------------------+-------------------------------------------------------------------------+

   | Organization Name        | The company or organization name (e.g., UCSB)                           |

   +--------------------------+-------------------------------------------------------------------------+

   | Organizational Unit Name | The department or section name (e.g., NCEAS)                            |

   +--------------------------+-------------------------------------------------------------------------+

   | Common Name              | The host server name without port numbers (e.g., myserver.mydomain.edu) |

   +--------------------------+-------------------------------------------------------------------------+

   | Email Address            | Administrator's contact email (e.g., administrator@mydomain.edu)        |

   +--------------------------+-------------------------------------------------------------------------+

   | A challenge password     | --leave this field blank--                                              |

   +--------------------------+-------------------------------------------------------------------------+

   | An optional company name | --leave this field blank--                                              |

   +--------------------------+-------------------------------------------------------------------------+

2. Create the local certificate file by running the command:

   ::

     openssl req -x509 -days 800 -in REQ.pem -key <hostname>-apache.key -out <hostname>-apache.crt

   Use the same ``<hostname>`` you used when you generated the key. A file named 

   ``<hostname>-apache.crt`` will be created in the directory from which you 

   ran the openssl command. Note: You can name the certificate file anything 

   you'd like, but keep in mind that the file will be sent to the partner 

   machine used for replication. The certificate name should have enough 

   meaning that someone who sees it on that machine can figure out where it 

   came from and for what purpose it should be used. 

3. Enter the certificate into Apache's security configuration. This will

   be used to identify your server to a replication partner. You must 

   register the certificate in the local Apache instance. Note that the 

   security files may be in a different directory from the one used in the 

   instructions depending on how you installed Apache. Copy the certificate and 

   key file using the following commands:

   ::

     sudo cp <hostname>-apache.crt /etc/ssl/certs 

     sudo cp <hostname>-apache.key /etc/ssl/private 

4. Apache needs to be configured to request a “client certificate” when the 

   replication API is utilized. The helper file named "knb-ssl" has default 

   rules that configure Apache for SSL and client certificate authentication. 

   Set up these SSL settings by copying the knb-ssl file into the ``sites-available`` 

   directory, editing pertinent values to match your system and running 

   ``a2ensite`` to enable the site. (Note: some settings in knb-ssl need to be 

   changed to match the specifics of your system.) 

   ::

     sudo cp <metacat_helper_dir>/knb-ssl <apache_install_dir>/sites-available

     sudo a2ensite knb-ssl

5. Restart Apache to bring in changes by typing: 

   ::

     sudo /etc/init.d/apache2 restart

6. If using a self-signed certificate, SCP ``<hostname>-apache.crt`` to the 

   replication partner machine where it will be added as an additional 

   Certificate Authority.

If using self-signed certificates, after you have created and SCP'd a 

certificate file to each replication partner, and received a certificate file 

from each partner in return, both home and partner servers must add the 

respective partner certificates as Certificate Authorities.

To import a certificate

.......................

1. Copy it into the Apache directory

   ::

     sudo cp <remotehostfilename> /etc/ssl/certs/

2. Rehash the certificates for Apache by running: 

   ::

     cd /etc/ssl/certs

     sudo c_rehash

   where the ``<remotehostfilename>`` is the name of the certificate file 

   created on the remote partner machine and SCP'd to the home machine. 

Update your Metacat database

~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The simplest way to update the Metacat database to use replication is to use 

the Replication Control Panel. You can also update the database u

sing SQL. Instructions for both options are included in this section.

.. figure:: images/screenshots/image063.jpg

   :align: center

   Using the Replication Control Panel to update the Metacat database.

To update your Metacat database to use replication, select the "Add this server" 

radio button from the Replication Control Panel, enter the partner server name, 

and specify how the replication should occur (whether to replicate xml, data, 

or use the local machine as a hub).

To update the database using SQL

................................

1. Log in to the database

   ::

     psql -U metacat -W -h localhost metacat

2. Select all rows from the replication table

   ::

     select * from xml_replication;  

3. Insert the partner server. 

   ::

     INSERT INTO xml_replication (server,last_checked,replicate,datareplicate,hub) VALUES ('<partner.server/context>/servlet/replication',NULL,1,1,0);

   Where ``<partner.server/context>`` is the name of the partner server and 

   context. The values 'NULL, 1,1,0' indicate (respectively) the last time 

   replication occurred, that XML docs should be replicated to the partner 

   server, that data files should be replicated to the partner server, and 

   that the local server should not act as a hub. Set a value of 'NULL,0,0,0' 

   if your Metacat is only receiving documents from the partner site and not 

   replicating to that site.

4. Exit the database 

5. Restart Apache and Tomcat on both home and partner replication machines 

DataONE Member Nodes

====================

Chapter to be written.

OAI Protocol for Metadata Harvesting

====================================

Chapter to be written.

[theme]

inherit = sphinxdoc

stylesheet = readable.css

pygments_style = sphinx

[options]

bgcolor = #FFFFFF

/**

 * Sphinx theme based on sphinxdoc and arc90 readability.css

 * Dave Vieglais

 */

body {

    font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', 'Verdana', sans-serif;

    /*font-family:"Palatino Linotype", "Book Antiqua", Palatino, serif;*/

    font-size: 14px;

    letter-spacing: -0.01em;

    line-height: 150%;

    text-align: center;

    /*background-color: #BFD1D4;*/

    /*background: #F4F3DB;*/

    background: white;

    color: black;

    /*color: #222;*/

    padding: 0;

    /*border: 1px solid #aaa;*/

    margin: 0px 80px 0px 80px;

    min-width: 740px;

}

a {

    /*color: #CA7900;*/

    color: #003399;

    text-decoration: none;

}

a:hover {

    /*color: #2491CF;*/

    text-decoration:underline;

}

pre {

    font-family: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;

    font-size: 0.95em;

    font-weight: bold;

    letter-spacing: 0.015em;

    padding: 0.5em;

    border: 1px solid darkGray;

    background-color: white;

    color: #203030;

    margin-left: 1em;

}

td.linenos pre {

    padding: 0.5em 0;

    border: 0;

    background-color: transparent;

    color: #aaa;

}

table.highlighttable {

    margin-left: 0.5em;

}

table.highlighttable td {

    padding: 0 0.5em 0 0.5em;

}

cite, code, tt {

    font-family: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;

    font-size: 0.95em;

    letter-spacing: 0.01em;

}

hr {

    border: 1px solid #abc;

    margin: 2em;

}

tt {

    background-color: #f2f2f2;

    border-bottom: 1px solid #ddd;

    color: #333;

}

tt.descname {

    background-color: transparent;

    font-weight: bold;

    font-size: 1.2em;

    border: 0;

}

tt.descclassname {

    background-color: transparent;

    border: 0;

}

tt.xref {

    background-color: transparent;

    font-weight: bold;

    border: 0;

}

a tt {

    background-color: transparent;

    font-weight: bold;

    border: 0;

    /*color: #CA7900;*/

    color: inherit;

}

/*a tt:hover {

    color: #2491CF;

}*/

.field-list ul {

    margin: 0;

    padding-left: 1em;

}

.field-list p {

    margin: 0;

}

dl {

    margin-bottom: 15px;

}

dd p {

    margin-top: 0px;

}

dd ul, dd table {

    margin-bottom: 10px;

}

dd {

    margin-top: 3px;

    margin-bottom: 10px;

    margin-left: 30px;

}

.refcount {

    color: #060;

}

dt:target,

.highlight {

    background-color: #fbe54e;

}

dl.glossary dt {

    font-weight: bold;

    font-size: 1.1em;

}

pre {

    line-height: 120%;

}

pre a {

    color: inherit;

    /*text-decoration: underline;*/

}

.first {

    margin-top: 0 !important;

}

div.document {

    background-color: white;

    text-align: left;

    background-image: url(contents.png);

    background-repeat: repeat-x;

}

/*

div.documentwrapper {

    width: 100%;

}

*/

div.banner {

    height: 5.5em;

}

div.banner img {

    height: 5em;

    float: left;

}

div.banner p.title {

    font-weight: bold;

    font-size: 2em;

    text-align: left;

    margin-left: 2em;

}

div.clearer {

    clear: both;

}

div.related h3 {

    display: none;

}

div.related ul {

    background-image: url(navigation.png);

    height: 2em;

    list-style: none;

    border-top: 1px solid #ddd;

    border-bottom: 1px solid #ddd;

    margin: 0;

    padding-left: 10px;

}

div.related ul li {

    margin: 0;

    padding: 0;

    height: 2em;

    float: left;

}

div.related ul li.right {

    float: right;

    margin-right: 5px;

}

div.related ul li a {

    margin: 0;

    padding: 0 5px 0 5px;

    line-height: 1.75em;

    /*color: #EE9816;*/

    color: #555;

}

div.related ul li a:hover {

    /*color: #3CA8E7;*/

}

div.body {

    margin: 0;

    padding: 0.5em 20px 20px 20px;

}

div.bodywrapper {

    /*margin: 0 240px 0 0;*/

    /*border-right: 1px solid #ccc;*/

}

div.body a {

    /*text-decoration: underline;*/

    text-decoration:inherit;

}

div.body a:hover {

  text-decoration: underline;

}

div.sphinxsidebar {

    margin: 0;

    padding: 0.5em 15px 15px 0;

    width: 210px;

    float: right;

    text-align: left;

/*    margin-left: -100%; */

}

div.sphinxsidebarwrapper {

  position: fixed;

  width: 210px;

}

div.sphinxsidebar h4, div.sphinxsidebar h3 {

    font-size: 0.9em;

    /*margin: 1em 0 0.5em 0;

    padding: 0.1em 0 0.1em 0.5em;

    color: white;

    border: 1px solid #86989B;

    background-color: #AFC1C4; */

}

div.sphinxsidebar h3 a {

    color: white;

}

div.sphinxsidebar a {

  color: #555;

}

div.sphinxsidebar ul {

    padding-left: 1.5em;

    margin-top: 7px;

    list-style: none;

    padding: 0;

    line-height: 130%;

}

div.sphinxsidebar ul ul {

    list-style: square;

    margin-left: 20px;

}

p {

    margin: 0.8em 0 0.5em 0;

}

p.rubric {

    font-weight: bold;

}

div.sidebar {

    margin: 0 0 0.5em 1em;

    border: 1px solid #ddb;

    padding: 7px 7px 0 7px;

    background-color: #B3B4C9;

    width: 40%;

    float: right;

}

div.quotebar {

    background-color: #f8f8f8;

    max-width: 250px;

    float: right;

    padding: 2px 7px;

    border: 1px solid #ccc;

}

p.sidebar-title {

    font-weight: bold;

}

div.topic {

    background-color: #f8f8f8;

    border: 1px solid #ccc;

    padding: 7px 7px 0 7px;

    margin: 10px 0 10px 0;

}

p.topic-title {

    font-size: 1.1em;

    font-weight: bold;

}

h1 {

    margin: 0;

    padding: 0.7em 0 0.3em 0;

    /*font-size: 1.5em;*/

    /*color: #11557C;*/

    display: block;

    border-bottom: 1px solid #333;

    font-size: 1.4em;

}

h2 {

    margin: 1.3em 0 0.2em 0;

    font-size: 1.35em;

    padding: 0;

}

h3 {

    margin: 1em 0 -0.3em 0;

    font-size: 1.2em;

}

div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a {

    color: black!important;

}

h1 a.anchor, h2 a.anchor, h3 a.anchor, h4 a.anchor, h5 a.anchor, h6 a.anchor {

    display: none;

    margin: 0 0 0 0.3em;

    padding: 0 0.2em 0 0.2em;

    color: #aaa!important;

}

h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor,

h5:hover a.anchor, h6:hover a.anchor {

    display: inline;

}

h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover,

h5 a.anchor:hover, h6 a.anchor:hover {

    color: #777;

    background-color: #eee;

}

table {

    border-collapse: collapse;

    margin: 0 -0.5em 0 -0.5em;

}

table td, table th {

    padding: 0.2em 0.5em 0.2em 0.5em;

}

div.footer {

    /*background-color: #E3EFF1;*/

    color: #86989B;

    padding: 3px 8px 3px 0;

    clear: both;

    font-size: 0.8em;

    text-align: right;

}

div.footer a {

    color: #86989B;

    text-decoration: underline;

}

div.pagination {

    margin-top: 2em;

    padding-top: 0.5em;

    border-top: 1px solid black;

    text-align: center;

}

div.sphinxsidebar ul.toc {

    margin: 1em 0 1em 0;

    padding: 0 0 0 0.5em;

    list-style: none;

}

div.sphinxsidebar ul.toc li {

    margin: 0.5em 0 0.5em 0;

    font-size: 0.9em;

    line-height: 130%;

}

div.sphinxsidebar ul.toc li p {

    margin: 0;

    padding: 0;

}

div.sphinxsidebar ul.toc ul {

    margin: 0.2em 0 0.2em 0;

    padding: 0 0 0 1.8em;

}

div.sphinxsidebar ul.toc ul li {

    padding: 0;

}

div.admonition, div.warning {

    font-size: 0.9em;

    margin: 1em 0 0 0;

    border: 1px solid #86989B;

    background-color: #f7f7f7;

}

div.admonition p, div.warning p {

    margin: 0.5em 1em 0.5em 1em;

    padding: 0;

}

div.admonition pre, div.warning pre {

    margin: 0.4em 1em 0.4em 1em;

}

div.admonition p.admonition-title,

div.warning p.admonition-title {

    margin: 0;

    padding: 0.1em 0 0.1em 0.5em;

    color: white;

    border-bottom: 1px solid #86989B;

    font-weight: bold;

    background-color: #AFC1C4;

}

div.warning {

    border: 1px solid #940000;

}

div.warning p.admonition-title {

    background-color: #CF0000;

    border-bottom-color: #940000;

}

div.admonition ul, div.admonition ol,

div.warning ul, div.warning ol {

    margin: 0.1em 0.5em 0.5em 3em;

    padding: 0;

}

div.versioninfo {

    margin: 1em 0 0 0;

    border: 1px solid #ccc;

    background-color: #DDEAF0;

    padding: 8px;

    line-height: 1.3em;

    font-size: 0.9em;

}

a.headerlink {

    color: #c60f0f!important;

    font-size: 1em;

    margin-left: 6px;

    padding: 0 4px 0 4px;

    text-decoration: none!important;

    visibility: hidden;

}

h1:hover > a.headerlink,

h2:hover > a.headerlink,

h3:hover > a.headerlink,

h4:hover > a.headerlink,

h5:hover > a.headerlink,

h6:hover > a.headerlink,

dt:hover > a.headerlink {

    visibility: visible;

}

a.headerlink:hover {

    background-color: #ccc;

    color: white!important;

}

table.indextable td {

    text-align: left;

    vertical-align: top;

}

table.indextable dl, table.indextable dd {

    margin-top: 0;

    margin-bottom: 0;

}

table.indextable tr.pcap {

    height: 10px;

}

table.indextable tr.cap {

    margin-top: 10px;

    background-color: #f2f2f2;

}

img.toggler {

    margin-right: 3px;

    margin-top: 3px;

    cursor: pointer;

}

form.pfform {

    margin: 10px 0 20px 0;

}

table.contentstable {

    width: 90%;

}

table.contentstable p.biglink {

    line-height: 150%;

}

a.biglink {

    font-size: 1.3em;

}

span.linkdescr {

    font-style: italic;

    padding-top: 5px;

    font-size: 90%;

}

ul.search {

    margin: 10px 0 0 20px;

    padding: 0;

}

ul.search li {

    padding: 5px 0 5px 20px;

    background-image: url(file.png);

    background-repeat: no-repeat;

    background-position: 0 7px;

}

ul.search li a {

    font-weight: bold;

}

ul.search li div.context {

    color: #888;

    margin: 2px 0 0 30px;

    text-align: left;

}

ul.keywordmatches li.goodmatch a {

    font-weight: bold;

}

img.math {

    vertical-align: center;

}

div.math {

    text-align: center;

}

span.eqno {

    float: right;

}

img.logo {

    border: 0;

}

div.banner img.logo-right {

    border: 0;

    float: right;

}

{%- block doctype -%}

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

{%- endblock %}

{%- set reldelim1 = reldelim1 is not defined and ' »' or reldelim1 %}

{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}

{%- macro relbar() %}

    <div class="related">

      <h3>{{ _('Navigation') }}</h3>

      <ul>

        {%- if pagename != "search" %}

        <li class="right">

        <span id="searchbox" style="display: none; margin-right: 10px">

            <form class="search" action="{{ pathto('search') }}" method="get">

              <input type="text" name="q" size="18" />

              <input type="submit" value="{{ _('Go') }}" />

              <input type="hidden" name="check_keywords" value="yes" />

              <input type="hidden" name="area" value="default" />

            </form>

        </span>

        </li>

        <script type="text/javascript">$('#searchbox').show(0);</script>

        {%- endif %}

        {%- for rellink in rellinks %}

        <li class="right">

          <a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags }}"

             {{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>

          {{ reldelim2 }}</li>

        {%- endfor %}

        {%- block rootrellink %}

        <li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>

        {%- endblock %}

        {%- for parent in parents %}

          <li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>

        {%- endfor %}

        {%- block relbaritems %} {% endblock %}

      </ul>

    </div>

{%- endmacro %}

{%- macro sidebar() %}

      {%- if not embedded %}{% if not theme_nosidebar|tobool %}

      <div class="sphinxsidebar">

        <div class="sphinxsidebarwrapper">

          {%- block sidebarlogo %}

          {%- if logo %}

            <p class="logo"><a href="{{ pathto(master_doc) }}">

              <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>

            </a></p>

          {%- endif %}

          {%- endblock %}

          {%- block sidebartoc %}

          {%- if display_toc %}

            <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>

            {{ toc }}

          {%- endif %}

          {%- endblock %}

          {%- block sidebarrel %}

          {%- if prev %}

            <h4>{{ _('Previous topic') }}</h4>

            <p class="topless"><a href="{{ prev.link|e }}"

                                  title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>

          {%- endif %}

          {%- if next %}

            <h4>{{ _('Next topic') }}</h4>

            <p class="topless"><a href="{{ next.link|e }}"

                                  title="{{ _('next chapter') }}">{{ next.title }}</a></p>

          {%- endif %}

          {%- endblock %}

          {%- block sidebarsourcelink %}

          {%- if show_source and has_source and sourcename %}

            <h3>{{ _('This Page') }}</h3>

            <ul class="this-page-menu">

              <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"

                     rel="nofollow">{{ _('Show Source') }}</a></li>

            </ul>

          {%- endif %}

          {%- endblock %}

          {%- if customsidebar %}

          {% include customsidebar %}

          {%- endif %}

          {%- block sidebarsearch %}

          {%- if pagename != "search" %}

          <div id="searchbox" style="display: none">

            <h3>{{ _('Quick search') }}</h3>

              <form class="search" action="{{ pathto('search') }}" method="get">

                <input type="text" name="q" size="18" />

                <input type="submit" value="{{ _('Go') }}" />

                <input type="hidden" name="check_keywords" value="yes" />

                <input type="hidden" name="area" value="default" />

              </form>

              <p class="searchtip" style="font-size: 90%">

              {{ _('Enter search terms or a module, class or function name.') }}

              </p>

          </div>

          <script type="text/javascript">$('#searchbox').show(0);</script>

          {%- endif %}

          {%- endblock %}

        </div>

      </div>

      {%- endif %}{% endif %}

{%- endmacro %}

<html xmlns="http://www.w3.org/1999/xhtml">

  <head>

    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

    {{ metatags }}

    {%- if not embedded %}

      {%- set titlesuffix = " — "|safe + docstitle|e %}

    {%- else %}

      {%- set titlesuffix = "" %}

    {%- endif %}

    <title>{{ title|striptags }}{{ titlesuffix }}</title>

    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />

    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />

    {%- if not embedded %}

    <script type="text/javascript">

      var DOCUMENTATION_OPTIONS = {

        URL_ROOT:    '{{ pathto("", 1) }}',

        VERSION:     '{{ release|e }}',

        COLLAPSE_MODINDEX: false,

        FILE_SUFFIX: '{{ file_suffix }}',

        HAS_SOURCE:  {{ has_source|lower }}

      };

    </script>

    {%- for scriptfile in script_files %}

    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>

    {%- endfor %}

    {%- if use_opensearch %}

    <link rel="search" type="application/opensearchdescription+xml"

          title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"

          href="{{ pathto('_static/opensearch.xml', 1) }}"/>

    {%- endif %}

    {%- if favicon %}

    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>

    {%- endif %}

    {%- endif %}

{%- block linktags %}

    {%- if hasdoc('about') %}

    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />

    {%- endif %}

    {%- if hasdoc('genindex') %}

    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />

    {%- endif %}

    {%- if hasdoc('search') %}

    <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />

    {%- endif %}

    {%- if hasdoc('copyright') %}

    <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />

    {%- endif %}

    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />

    {%- if parents %}

    <link rel="up" title="{{ parents[-1].title|striptags }}" href="{{ parents[-1].link|e }}" />

    {%- endif %}

    {%- if next %}

    <link rel="next" title="{{ next.title|striptags }}" href="{{ next.link|e }}" />

    {%- endif %}

    {%- if prev %}

    <link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}" />

    {%- endif %}

{%- endblock %}

{%- block extrahead %} {% endblock %}

  </head>

  <body>

  <div class="banner">

      <img class="logo" src="_static/metacat-logo.png" />

      <img class="logo-right" src="_static/nceas-logo.png" />

      <p class="title">Metacat: Metadata and Data Management Server</p>

  </div>

{%- block header %}{% endblock %}

{%- block relbar1 %}{{ relbar() }}{% endblock %}

{# Comment out the sidebar

  {%- block sidebar1 %} {# possible location for sidebar  {% endblock %}

#}

    <div class="document">

{%- block document %}

      <div class="documentwrapper">

      {%- if not embedded %}{% if not theme_nosidebar|tobool %}

        <div class="bodywrapper">

      {%- endif %}{% endif %}

          <div class="body">

            {% block body %} {% endblock %}

          </div>

      {%- if not embedded %}{% if not theme_nosidebar|tobool %}

        </div>

      {%- endif %}{% endif %}

      </div>

{%- endblock %}

{# {%- block sidebar2 %}{{ sidebar() }}{% endblock %} #}

      <div class="clearer"></div>

    </div>

{%- block relbar2 %}{{ relbar() }}{% endblock %}

{%- block footer %}

    <div class="footer">

    {%- if hasdoc('copyright') %}

      {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}

    {%- else %}

      {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}

    {%- endif %}

    {%- if last_updated %}

      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}

    {%- endif %}

    {%- if show_sphinx %}

      {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}

    {%- endif %}

    </div>

{%- endblock %}

  </body>

</html>

License

=======

::

                      GNU GENERAL PUBLIC LICENSE

                         Version 2, June 1991

   Copyright (C) 1989, 1991 Free Software Foundation, Inc.

                         59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

   Everyone is permitted to copy and distribute verbatim copies

   of this license document, but changing it is not allowed.

                              Preamble

    The licenses for most software are designed to take away your

  freedom to share and change it.  By contrast, the GNU General Public

  License is intended to guarantee your freedom to share and change free

  software--to make sure the software is free for all its users.  This

  General Public License applies to most of the Free Software

  Foundation's software and to any other program whose authors commit to

  using it.  (Some other Free Software Foundation software is covered by

  the GNU Library General Public License instead.)  You can apply it to

  your programs, too.

    When we speak of free software, we are referring to freedom, not

  price.  Our General Public Licenses are designed to make sure that you

  have the freedom to distribute copies of free software (and charge for

  this service if you wish), that you receive source code or can get it

  if you want it, that you can change the software or use pieces of it

  in new free programs; and that you know you can do these things.

    To protect your rights, we need to make restrictions that forbid

  anyone to deny you these rights or to ask you to surrender the rights.

  These restrictions translate to certain responsibilities for you if you

  distribute copies of the software, or if you modify it.

    For example, if you distribute copies of such a program, whether

  gratis or for a fee, you must give the recipients all the rights that

  you have.  You must make sure that they, too, receive or can get the

  source code.  And you must show them these terms so they know their

  rights.

    We protect your rights with two steps: (1) copyright the software, and

  (2) offer you this license which gives you legal permission to copy,

  distribute and/or modify the software.

    Also, for each author's protection and ours, we want to make certain

  that everyone understands that there is no warranty for this free

  software.  If the software is modified by someone else and passed on, we

  want its recipients to know that what they have is not the original, so

  that any problems introduced by others will not reflect on the original

  authors' reputations.

    Finally, any free program is threatened constantly by software

  patents.  We wish to avoid the danger that redistributors of a free

  program will individually obtain patent licenses, in effect making the

  program proprietary.  To prevent this, we have made it clear that any

  patent must be licensed for everyone's free use or not licensed at all.

    The precise terms and conditions for copying, distribution and

  modification follow.

                      GNU GENERAL PUBLIC LICENSE

     TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

    0. This License applies to any program or other work which contains

  a notice placed by the copyright holder saying it may be distributed

  under the terms of this General Public License.  The "Program", below,

  refers to any such program or work, and a "work based on the Program"

  means either the Program or any derivative work under copyright law:

  that is to say, a work containing the Program or a portion of it,

  either verbatim or with modifications and/or translated into another

  language.  (Hereinafter, translation is included without limitation in

  the term "modification".)  Each licensee is addressed as "you".

  Activities other than copying, distribution and modification are not

  covered by this License; they are outside its scope.  The act of

  running the Program is not restricted, and the output from the Program

  is covered only if its contents constitute a work based on the

  Program (independent of having been made by running the Program).

  Whether that is true depends on what the Program does.

    1. You may copy and distribute verbatim copies of the Program's

  source code as you receive it, in any medium, provided that you

  conspicuously and appropriately publish on each copy an appropriate

  copyright notice and disclaimer of warranty; keep intact all the

  notices that refer to this License and to the absence of any warranty;

  and give any other recipients of the Program a copy of this License

  along with the Program.

  You may charge a fee for the physical act of transferring a copy, and

  you may at your option offer warranty protection in exchange for a fee.

    2. You may modify your copy or copies of the Program or any portion

  of it, thus forming a work based on the Program, and copy and

  distribute such modifications or work under the terms of Section 1

  above, provided that you also meet all of these conditions:

      a) You must cause the modified files to carry prominent notices

      stating that you changed the files and the date of any change.

      b) You must cause any work that you distribute or publish, that in

      whole or in part contains or is derived from the Program or any

      part thereof, to be licensed as a whole at no charge to all third

      parties under the terms of this License.

      c) If the modified program normally reads commands interactively

      when run, you must cause it, when started running for such

      interactive use in the most ordinary way, to print or display an

      announcement including an appropriate copyright notice and a

      notice that there is no warranty (or else, saying that you provide

      a warranty) and that users may redistribute the program under

      these conditions, and telling the user how to view a copy of this

      License.  (Exception: if the Program itself is interactive but

      does not normally print such an announcement, your work based on

      the Program is not required to print an announcement.)

  These requirements apply to the modified work as a whole.  If

  identifiable sections of that work are not derived from the Program,

  and can be reasonably considered independent and separate works in

  themselves, then this License, and its terms, do not apply to those

  sections when you distribute them as separate works.  But when you

  distribute the same sections as part of a whole which is a work based

  on the Program, the distribution of the whole must be on the terms of

  this License, whose permissions for other licensees extend to the

  entire whole, and thus to each and every part regardless of who wrote it.

  Thus, it is not the intent of this section to claim rights or contest

  your rights to work written entirely by you; rather, the intent is to

  exercise the right to control the distribution of derivative or

  collective works based on the Program.

  In addition, mere aggregation of another work not based on the Program

  with the Program (or with a work based on the Program) on a volume of

  a storage or distribution medium does not bring the other work under

  the scope of this License.

    3. You may copy and distribute the Program (or a work based on it,

  under Section 2) in object code or executable form under the terms of

  Sections 1 and 2 above provided that you also do one of the following:

      a) Accompany it with the complete corresponding machine-readable

      source code, which must be distributed under the terms of Sections

      1 and 2 above on a medium customarily used for software interchange; or,

      b) Accompany it with a written offer, valid for at least three

      years, to give any third party, for a charge no more than your

      cost of physically performing source distribution, a complete

      machine-readable copy of the corresponding source code, to be

      distributed under the terms of Sections 1 and 2 above on a medium

      customarily used for software interchange; or,

      c) Accompany it with the information you received as to the offer

      to distribute corresponding source code.  (This alternative is

      allowed only for noncommercial distribution and only if you

      received the program in object code or executable form with such

      an offer, in accord with Subsection b above.)

  The source code for a work means the preferred form of the work for

  making modifications to it.  For an executable work, complete source

  code means all the source code for all modules it contains, plus any

  associated interface definition files, plus the scripts used to

  control compilation and installation of the executable.  However, as a

  special exception, the source code distributed need not include

  anything that is normally distributed (in either source or binary

  form) with the major components (compiler, kernel, and so on) of the

  operating system on which the executable runs, unless that component

  itself accompanies the executable.

  If distribution of executable or object code is made by offering

  access to copy from a designated place, then offering equivalent

  access to copy the source code from the same place counts as

  distribution of the source code, even though third parties are not

  compelled to copy the source along with the object code.

    4. You may not copy, modify, sublicense, or distribute the Program

  except as expressly provided under this License.  Any attempt

  otherwise to copy, modify, sublicense or distribute the Program is

  void, and will automatically terminate your rights under this License.

  However, parties who have received copies, or rights, from you under