Metacat

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

.. raw:: latex

  \newpage

Identifier Management

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

.. index:: Identifiers

Author

  Matthew B. Jones

Date

  - 20100301 [MBJ] Initial draft of Identifier documentation

Version 

  1.9.2

Goal

  Extend Metacat to support identifiers with arbitrary syntax

Summary 

  Metacat currently supports identifier strings called 'docids' that have

  the syntax 'scope.object.revision', such as 'foo.34.1' (we will refer to

  these as 'LocalIDs'). We now want Metacat to support identifiers that are 

  arbitrary strings, but still enforce uniqueness and proper revision

  handling (referred to these as GUIDs).  Metacat must be able to accept 

  these strings as identifiers for all CRUD operations, and reference them 

  in search results.

Identifier Resolution

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

Because Metacat uses LocalIDs throughout the code for references to objects,

and that LocalID has a constrained structure that includes semantics about

revisions in the identifier, it is difficult to wholesale replace it with

less-constrained string identifiers without re-writing much of Metacat.

Thus, our alternate strategy would is to wrap the Metacat APIs with a

identifier resolution layer that keeps track of the unconstrained GUIDs and

maps them to constrained local identifiers which are used internally within

Metacat. The basic identifer table model is shown in Figure 1, while the

basic strategy for retrieving an object is shown in Figure 2.

Identifier Table Structure

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

.. figure:: images/identifiers.png

   Figure 1. Table structure for identifiers.

..

  This block defines the table structure diagram referenced above.

  @startuml images/identifiers.png

  identifiers "*" -- "1" xml_documents

  identifiers : String identifier

  identifiers : String docid

  identifiers : Integer rev

  xml_documents : String docid

  xml_documents : String rev

  note right of identifiers

    "identifiers.(docid,rev) is a foreign key into xml_documents"

  end note

  @enduml

.. raw:: latex

  \newpage

.. raw:: pdf

  PageBreak

Handling document read operations

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

An overview of the process needed to read an object using a GUID.

.. figure:: images/guid_read.png

   Figure 2. Basic handling for string identifiers (GUIDs) as mapped to

   docids (LocalIDs) to retrieve an object.

..

  @startuml images/guid_read.png

  !include plantuml.conf

  actor User

  participant "Client" as app_client << Application >>

  participant "CRUD API" as c_crud << MetacatRestServlet >>

  participant "Identifier Manager" as ident_man << IdentifierManager >>

  participant "Handler" as handler << MetacatHandler >>

  User -> app_client

  app_client -> c_crud: get(token, GUID)

  c_crud -> ident_man: getLocalID(GUID)

  c_crud <-- ident_man: localID

  c_crud -> handler: handleReadAction(localID)

  c_crud <-- handler: object

  c_crud --> app_client: object

  @enduml

Handling document create operations

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

An overview of the process needed to create an object using a GUID.

.. figure:: images/guid_insert.png

   Figure 3. Basic handling for string identifiers (GUIDs) as mapped to

   docids (LocalIDs) to create an object.

..

  @startuml images/guid_insert.png

  !include plantuml.conf

  actor User

  participant "Client" as app_client << Application >>

  participant "CRUD API" as c_crud << MetacatRestServlet >>

  participant "Identifier Manager" as ident_man << IdentifierManager >>

  participant "Handler" as handler << MetacatHandler >>

  User -> app_client

  app_client -> c_crud: create(token, GUID, object, sysmeta)

  c_crud -> ident_man: identifierExists(GUID)

  c_crud <-- ident_man: T or F 

  alt identifierExists == "F"

      c_crud -> ident_man: mapToLocalId(GUID)

      c_crud <-- ident_man: localID

      c_crud -> handler: handleInsertAction(localID)

      c_crud <-- handler: success

      note right of c_crud

        "Also need to address how to handle the sysmeta information wrt insertion methods"

      end note

      app_client <-- c_crud: success

  else identifierExists == "T"

      app_client <-- c_crud: IdentifierNotUnique

  end

  @enduml

Handling document update operations

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

An overview of the process needed to update an object using a GUID.

.. figure:: images/guid_update.png

   Figure 4. Basic handling for string identifiers (GUIDs) as mapped to

   docids (LocalIDs) to update an object.

..

  @startuml images/guid_update.png

  !include plantuml.conf

  actor User

  participant "Client" as app_client << Application >>

  participant "CRUD API" as c_crud << MetacatRestServlet >>

  participant "Identifier Manager" as ident_man << IdentifierManager >>

  participant "Handler" as handler << MetacatHandler >>

  User -> app_client

  app_client -> c_crud: update(token, GUID, object, obsoletedGUID, sysmeta)

  c_crud -> ident_man: identifierExists(obsoletedGUID)

  c_crud <-- ident_man: T or F 

  alt identifierExists == "T"

      c_crud -> ident_man: identifierExists(GUID)

      c_crud <-- ident_man: T or F 

      alt identifierExists == "F"

          c_crud -> ident_man: mapToLocalId(GUID, obsoletedGUID)

          c_crud <-- ident_man: localID

          c_crud -> handler: handleUpdateAction(localID)

          c_crud <-- handler: success

          note right of c_crud

            "Also need to address how to handle the sysmeta information wrt update methods"

          end note

          app_client <-- c_crud: success

      else identifierExists == "T"

          app_client <-- c_crud: IdentifierNotUnique

      end

  else identifierExists == "F"

      app_client <-- c_crud: NotFound

  end

  @enduml

Handling document delete operations

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

An overview of the process needed to delete an object using a GUID.

.. figure:: images/guid_delete.png

   Figure 5. Basic handling for string identifiers (GUIDs) as mapped to

   docids (LocalIDs) to delete an object.

..

  @startuml images/guid_delete.png

  !include plantuml.conf

  actor User

  participant "Client" as app_client << Application >>

  participant "CRUD API" as c_crud << MetacatRestServlet >>

  participant "Identifier Manager" as ident_man << IdentifierManager >>

  participant "Handler" as handler << MetacatHandler >>

  User -> app_client

  app_client -> c_crud: delete(token, GUID)

  c_crud -> ident_man: identifierExists(GUID)

  c_crud <-- ident_man: T or F 

  alt identifierExists == "T"

      c_crud -> ident_man: mapToLocalId(GUID)

      c_crud <-- ident_man: localID

      c_crud -> handler: handleDeleteAction(localID)

      c_crud <-- handler: success

      app_client <-- c_crud: success

  else identifierExists == "F"

      app_client <-- c_crud: NotFound

  end

  @enduml

..

  This block defines the interaction diagram referenced above.

  startuml images/01_interaction.png

    !include plantuml.conf

    actor User

    participant "Client" as app_client << Application >>

    User -> app_client

    participant "CRUD API" as c_crud << Coordinating Node >>

    activate c_crud

    app_client -> c_crud: resolve(GUID, auth_token)

    participant "Authorization API" as c_authorize << Coordinating Node >>

    c_crud -> c_authorize: isAuth(auth_token, GUID)

    participant "Verify API" as c_ver << Coordinating Node >>

    c_authorize -> c_ver: isValidToken (token)

    c_authorize <-- c_ver: T or F

    c_crud <-- c_authorize: T or F

    app_client <-- c_crud: handle_list

    deactivate c_crud

    participant "CRUD API" as m_crud << Member Node >>

    activate m_crud

    app_client -> m_crud: get(auth_token, handle)

    participant "Server Authentication API" as m_authenticate << Member Node >>

    m_crud -> m_authenticate: isAuth(auth_token, GUID)

    m_crud <-- m_authenticate: T or F

    m_crud -> m_crud: log(get, UserID, GUID)

    app_client <-- m_crud: object or unauth or doesNotExist

    deactivate m_crud

  enduml

.. Metacat documentation master file, created by

   sphinx-quickstart on Mon Mar  1 14:16:16 2010.

   You can adapt this file completely to your liking, but it should at least

   contain the root `toctree` directive.

Welcome to Metacat's documentation!

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

Contents:

.. toctree::

   :maxdepth: 2

   identifiers.txt

Indices and tables

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

* :ref:`genindex`

* :ref:`modindex`

* :ref:`search`

{%- 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>

{%- 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>

[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;

    letter-spacing: 0.015em;

    padding: 0.5em;

    border: 1px solid #ccc;

    background-color: #f8f8f8;

}

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.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: #ffe;

    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;

}

# -*- coding: utf-8 -*-

#

# Metacat documentation build configuration file, created by

# sphinx-quickstart on Mon Mar  1 14:16:16 2010.

#

# This file is execfile()d with the current directory set to its containing dir.

#

# Note that not all possible configuration values are present in this

# autogenerated file.

#

# All configuration values have a default; values that are commented out

# serve to show the default.

import sys, os

# If extensions (or modules to document with autodoc) are in another directory,

# add these directories to sys.path here. If the directory is relative to the

# documentation root, use os.path.abspath to make it absolute, like shown here.

#sys.path.append(os.path.abspath('.'))

# -- General configuration -----------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be extensions

# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

extensions = []

# Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']

# The suffix of source filenames.

source_suffix = '.txt'

# The encoding of source files.

#source_encoding = 'utf-8'

# The master toctree document.

master_doc = 'index'

# General information about the project.

project = u'Metacat'

copyright = u'2010, Matthew B. Jones'

# The version info for the project you're documenting, acts as replacement for

# |version| and |release|, also used in various other places throughout the

# built documents.

#

# The short X.Y version.

version = '2.0'

# The full version, including alpha/beta/rc tags.

release = '2.0.0'

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

#language = None

# There are two options for replacing |today|: either, you set today to some

# non-false value, then it is used:

#today = ''

# Else, today_fmt is used as the format for a strftime call.

#today_fmt = '%B %d, %Y'

# List of documents that shouldn't be included in the build.

#unused_docs = []

# List of directories, relative to source directory, that shouldn't be searched

# for source files.

exclude_trees = []

# The reST default role (used for this markup: `text`) to use for all documents.

#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.

#add_function_parentheses = True

# If true, the current module name will be prepended to all description

# unit titles (such as .. function::).

#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the

# output. They are ignored by default.

#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.

pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.

#modindex_common_prefix = []

# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  Major themes that come with

# Sphinx are currently 'default' and 'sphinxdoc'.

#html_theme = 'default'

html_theme = 'readable'

# Theme options are theme-specific and customize the look and feel of a theme

# further.  For a list of options available for each theme, see the

# documentation.

#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.

html_theme_path = ['themes',]

# The name for this set of Sphinx documents.  If None, it defaults to

# "<project> v<release> documentation".

#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.

#html_short_title = None

# The name of an image file (relative to this directory) to place at the top

# of the sidebar.

#html_logo = None

# The name of an image file (within the static path) to use as favicon of the

# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32

# pixels large.

#html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,

# relative to this directory. They are copied after the builtin static files,

# so a file named "default.css" will overwrite the builtin "default.css".

html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

# using the given strftime format.

#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to

# typographically correct entities.

#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.

#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to

# template names.

#html_additional_pages = {}

# If false, no module index is generated.

#html_use_modindex = True

# If false, no index is generated.

#html_use_index = True

# If true, the index is split into individual pages for each letter.

#html_split_index = False

# If true, links to the reST sources are added to the pages.

#html_show_sourcelink = True

# If true, an OpenSearch description file will be output, and all pages will

# contain a <link> tag referring to it.  The value of this option must be the

# base URL from which the finished HTML is served.

#html_use_opensearch = ''

# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").

#html_file_suffix = ''

# Output file base name for HTML help builder.

htmlhelp_basename = 'Metacatdoc'

# -- Options for LaTeX output --------------------------------------------------

# The paper size ('letter' or 'a4').

#latex_paper_size = 'letter'

# The font size ('10pt', '11pt' or '12pt').

#latex_font_size = '10pt'

# Grouping the document tree into LaTeX files. List of tuples

# (source start file, target name, title, author, documentclass [howto/manual]).

latex_documents = [

  ('index', 'Metacat.tex', u'Metacat Documentation',

   u'Matthew B. Jones', 'manual'),

]

# The name of an image file (relative to this directory) to place at the top of

# the title page.

#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,

# not chapters.

#latex_use_parts = False

# Additional stuff for the LaTeX preamble.

#latex_preamble = ''

# Documents to append as an appendix to all manuals.

#latex_appendices = []

# If false, no module index is generated.

#latex_use_modindex = True

# 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: