{% extends "../../layout.html" %}

{% block sectionClasses %}plugins hasBreadCrumb plugins-spincast-config {% endblock %}
{% block meta_title %}Plugins - Spincast Config{% endblock %}
{% block meta_description %}Spincast Config plugin provides the default configurations required by Spincast.{% endblock %}

{% block scripts %}
<script>

    {#==========================================
    Initialize the Table Of Content
    ==========================================#}
    $(function() {
        app.toc(230);
    });

</script>
{% endblock %}

{% block body %}

<div class="container pluginDoc">

    <ol class="breadcrumb">
        <li><img class="inlineIcon breadIcon" src="/public/images/icons/bread.png" /> <a href="/plugins">Plugins</a></li>
        <li class="active">Spincast Config Addon plugin</li>
    </ol>
    
    <div id="sectionTitle" class="row"> 
        <div class="col-xs-12"> 
            <a href="#top"><h2 class="shortTop noBottom"><img class="inlineIcon" src="/public/images/icons/breadPlugin.png" /> Spincast Config Addon <span>plugin</span></h2></a>
            <div class="pluginBadges">
                <div class="pluginBadgeTop hint--bottom-left hint--bounce" 
                     data-hint="Plugin's Javadoc">
                     <a class="javadoc" href="/public/javadoc/index.html?org/spincast/plugins/config/package-summary.html"><img class="inlineIcon" src="/public/images/javadoc-badge.png" /></a>
                </div>
                <div class="pluginBadgeTop hint--bottom-left hint--bounce" 
                     data-hint="Default plugin included in the 'spincast-default' artifact"><img class="inlineIcon" src="/public/images/default-badge.png" /></div>
                <span class="clear"></span>
            </div>  
        </div>
    </div>
    
    <div id="sectionTitleFixed" class="row"> 
        <div class="col-xs-12">
            <a href="#top"><h2 class="shortTop"><img src="/public/images/logo_xsmall.png" /> Spincast Config Addon <span>plugin</span></h2></a>
        </div>
    </div>

    <div class="row">
        <nav id="toc" class="longTitle col-md-3">
            <ul class="nav nav-stacked">
                <li class="openable"><a href="#top">Overview</a></li>
                <li class="openable"><a href="#installation">Installation</a></li>
                <li class="openable"><a href="#plugin_class">Plugin class</a></li>
                <li class="openable"><a href="#javadoc">Javadoc</a></li>
            </ul>
        </nav>
        
        <div id="toc-content" class="col-md-9">

            <section id="overview">
	            <h3>
                    <a class="anchor" href="#overview" title="permanent link"></a>
                    Overview
                </h3>
	            <p>
	                This plugin provides a default implementation
                    for the <a class="javadoc" href="/public/javadoc/org/spincast/core/config/SpincastConfig.html">SpincastConfig</a>
                    interface : <a class="javadoc" href="/public/javadoc/org/spincast/plugins/config/SpincastConfigDefault.html">SpincastConfigDefault</a>.
                    The implementation is very simple : the default configurations are simply hardcoded.
                </p>
                <p>
                    <img class="inlineIcon" src="/public/images/icons/tipy.png" />
                    A small <a href="http://spincast.loc:44420/documentation#default_config">Default Configurations</a> section
                    of the documentation introduces the most important configurations. Also, have
                    a look at the source code of 
                    <a href="https://github.com/spincast/spincast-framework/blob/master/spincast-plugins/spincast-plugins-config-parent/spincast-plugins-config/src/main/java/org/spincast/plugins/config/SpincastConfigDefault.java">SpincastConfigDefault</a> 
                    to see what the default values are.
                </p>
                <p>
                    Finally, notice that if you want to be able to configure your application using a <code>.properties</code> file,
                    you may be interested by the <a href="/plugins/spincast-properties-file-config">Spincast Properties File Config</a> plugin. 
                </p> 
            </section>
            
            
            
            <section id="installation">
                <h3>
                    <a class="anchor" href="#installation" title="permanent link"></a>
                    Installation
                </h3>
                <p>
                    <img class="inlineIcon" src="/public/images/default-badge.png" />
                    <em>If you use the <code>spincast-default</code> artifact and the standard <a href="/documentation#boot_bootstrapper">Bootstrapper</a>, 
                    this plugin is already installed by default so you have nothing to do!</em>
                </p>
                <p>
                    If you start from scratch, using the <code>spincast-core</code> artifact, you can use the
                    plugin by :
                </p>
                <p>
                    1. 
                    Adding this Maven artifact to your project:
                    <div>
                        <p>
                            <pre class="ace ace-xml"
>&lt;dependency&gt;
    &lt;groupId&gt;org.spincast&lt;/groupId&gt;
    &lt;artifactId&gt;spincast-plugins-config&lt;/artifactId&gt;
    &lt;version&gt;{{spincast.spincastCurrrentVersion}}&lt;/version&gt;
&lt;/dependency&gt;</pre> 
                        </p>
                    </div>  
                </p>
                <p>
                    2. Installing the provided <a class="javadoc" href="/public/javadoc/org/spincast/plugins/config/SpincastConfigPluginModule.html">SpincastConfigPluginModule</a> 
                    module to your Guice context.
                </p>
            </section>
            
            <section id="plugin_class">
                <h3>
                    <a class="anchor" href="#plugin_class" title="permanent link"></a>
                    Plugin class
                </h3>
                <p>
                    The class implementing the <a class="javadoc" href="/public/javadoc/org/spincast/core/guice/SpincastPlugin.html">SpincastPlugin</a> 
                    interface is <a class="javadoc" href="/public/javadoc/org/spincast/plugins/config/SpincastConfigPlugin.html">SpincastConfigPlugin</a>.
                </p>
            </section>
            
           
           
           
            
            <section id="javadoc">
                <h3>
                    <a class="anchor" href="#javadoc" title="permanent link"></a>
                    Javadoc
                </h3>
                <p>
                    <ul>
                        <li>
                            <a class="javadoc" href="/public/javadoc/org/spincast/core/config/SpincastConfig.html">SpincastConfig</a> 
                        </li>
                        <li>
                            <a class="javadoc" href="/public/javadoc/org/spincast/plugins/config/SpincastConfigDefault.html">SpincastConfigDefault</a>
                        </li>
                    </ul>
                </p> 
            </section>
            
            
        </div>
    </div>
</div> 

{% endblock %}