{#==========================================
Documentation
==========================================#}
{% extends "./layout.html" %}

{% block sectionClasses %}documentation{% endblock %}
{% block meta_title %}Documentation{% endblock %}
{% block meta_description %}Documentation / Installation / Quick start{% endblock %}

{% block scripts %}

<script>

    {#==========================================
    Initialize the Table Of Content
    ==========================================#}
    $(function() {  
        app.toc(180);
    }); 
 
</script>
{% endblock %}

{% block body %} 

<div class="container">

    <div id="sectionTitle" class="row"> 
        <div class="col-xs-12">
            <h2 class="shortTop noBottom"><a href="#top">Documentation</a></h2>
            <div class="pluginBadges">
                <div class="pluginBadgeTop hint--bottom-left hint--bounce" 
                     data-hint="Browse Spincast Javadoc">
                     <a href="/public/javadoc/"><img class="inlineIcon" src="/public/images/javadoc-badge.png" /></a>
                </div>
                <span class="clear"></span>
            </div>
        </div>
    </div>
    <div id="sectionTitleFixed" class="row longTitle"> 
        <div class="col-xs-12">
            <a href="#top"><h2 class="shortTop"><img src="/public/images/logo_xsmall.png" /> Documentation</h2></a>
        </div>
    </div>

    <div class="row">
    
        {#==========================================
        Table of content
        ==========================================#}
        <nav id="toc" class="col-md-3">
            <ul class="nav nav-stacked">
                <li class="openable">
                    <a href="#top">Installation</a>
                    <ul class="nav nav-stacked">
                        <li><a href="#requirements">Requirements</a></li>
                        <li><a href="#quick_start"><img id="quickIconSmall" class="inlineIcon" src="/public/images/icons/flash.png" /> Quick Start application</a></li>
                        <li><a href="#using_default_module">Using SpincastDefaultGuiceModule</a></li>
                    </ul>
                </li>
                <li class="openable">
                    <a href="#overview">Spincast overview</a>
                    <ul class="nav nav-stacked">
                        <li><a href="#introduction">Introduction</a></li>
                        <li><a href="#architecture">Architecture</a></li>
                        <li><a href="#request_handling">Request handling</a></li>
                        <li><a href="#required_components">The required components and their default implementations</a></li>
                        <li><a href="#dependencies">Transitive dependencies</a></li>
                    </ul>
                </li>
                <li class="openable">
                    <a href="#bootstrapping">Bootstrapping your app</a>
                    <ul class="nav nav-stacked">
                        <li><a href="#everything_in_main">Everything in the <code>main</code> method</a></li>
                        <li><a href="#main_class_as_boot">The main class used as the bootstrapping class</a></li>
                        <li><a href="#custom_guice_module">Using a custom Guice module</a></li>
                        <li><a href="#overriding_modules">Using overriding modules</a></li> 
                        <li><a href="#bootstrapping_as_config">Bootstrapping class as the configuration class</a></li> 
                        <li><a href="#using_controllers">Using controllers and services</a></li>
                        <li><a href="#boot_with_core">Using <code>SpincastCoreModule</code> directly</a></li> 
                    </ul>
                </li>
                <li class="openable">
                    <a href="#request_context">The request context</a>
                    <ul class="nav nav-stacked">
                        <li><a href="#core_rc_add-ons">The core request context <code>add-ons</code></a></li>
                        <li><a href="#core_rc_methods">The core request context methods</a></li>
                        <li><a href="#extending_request_context">Extending the request context</a></li>
                    </ul>
                </li>
                <li class="openable">
                    <a href="#routing">Routing</a>
                    <ul class="nav nav-stacked">
                        <li><a href="#routing_process">The routing process</a></li>
                        <li><a href="#adding_route">Adding a route</a></li>
                        <li><a href="#http_method_and_path">HTTP method and path</a></li>
                        <li><a href="#dynamic_parameters">Dynamic parameters</a></li>
                        <li><a href="#routing_types">Routing Types</a></li>
                        <li><a href="#route_content-type">Content-Types</a></li>
                        <li><a href="#route_http_caching">HTTP Caching route options</a></li>
                        <li><a href="#route_saving">Saving the route</a></li>
                        <li><a href="#filters">Filters</a></li>
                        <li><a href="#routing_websockets">WebSockets</a></li>
                        <li><a href="#static_resources">Static resources</a></li>
                        <li><a href="#dynamic_resources">Dynamic resources</a></li>
                        <li><a href="#cors">Cors</a></li>
                        <li><a href="#http_auth">HTTP Authentication</a></li>
                        <li><a href="#redirections">Redirection rules</a></li>
                        <li><a href="#special_exceptions">Special exceptions</a></li>
                        <li><a href="#router_dynamic">The router is dynamic</a></li>
                    </ul>
                </li>
                <li class="openable">
                    <a href="#http_caching">HTTP Caching</a>
                    <ul class="nav nav-stacked">
                        <li><a href="#http_caching_cache_control">Cache-Control</a></li>
                        <li><a href="#http_caching_default">Default Caching</a></li>
                        <li><a href="#http_caching_no_cache">No Cache</a></li>
						<li><a href="#http_caching_cache_busting">Cache busting</a></li>
                        <li><a href="#http_caching_etag_last_modified">ETag and Last Modified</a></li>
                    </ul>
                </li>
                <li class="openable">
                    <a href="#websockets">WebSockets</a>
                    <ul class="nav nav-stacked">
                        <li><a href="#websockets_quick_example">Quick Example</a></li>
                        <li><a href="#websockets_routing">WebSocket Routing</a></li>
                        <li><a href="#websockets_controllers">WebSocket Controllers</a></li>
                        <li><a href="#websockets_context">The WebSocket context</a></li>
                        <li><a href="#websockets_extending_context">Extending the WebSocket context</a></li>
                    </ul>
                </li>
                <li class="openable">
                    <a href="#testing">Testing</a>
                    <ul class="nav nav-stacked">
                        <li><a href="#testing_installation">Installation</a></li>
                        <li><a href="#testing_app_example">Integration test example</a></li>
                        <li><a href="#testing_custom_example">Custom context test example</a></li>
                        <li><a href="#testing_runner">Spincast JUnit runner</a></li>
                        <li><a href="#testing_spincast_test_base">SpincastTestBase</a></li>
                        <li><a href="#testing_spincast_integration_test_base">SpincastIntegrationTestBase</a></li>
                        <li><a href="#testing_other_base_classes">Other test base classes</a></li>
                    </ul>
                </li>
                <li class="openable">
                    <a href="#miscellaneous">Miscellaneous</a>
                    <ul class="nav nav-stacked">
                        <li><a href="#default_config">Default configurations</a></li>
                        <li><a href="#templating_engine">Templating engine</a></li>
                        <li><a href="#ssl">Using a SSL certificate (HTTPS)</a></li>
                        <li><a href="#jsonobject">IJsonObject</a></li>
                        <li><a href="#spincast_utils">Spincast Utilities</a></li>
                        <li><a href="#main_args">@MainArgs</a></li>
                        <li><a href="#init_method">Using an <code>init()</code> method</a></li>
                    </ul>
                </li>
                
            </ul>
        </nav>
        
        {#==========================================
        Content
        ==========================================#}
        <div id="toc-content" class="col-md-9">
        
            {#==========================================
            Section "installation"
            ==========================================#}
            {% include "./docs/installation.html" %}

            {#==========================================
            Section "overview"
            ==========================================#}
            {% include "./docs/overview.html" %}

            {#==========================================
            Section "bootstrapping"
            ==========================================#}
            {% include "./docs/bootstrapping.html" %}
            
            {#==========================================
            Section "Request Context"
            ==========================================#}
            {% include "./docs/requestContext.html" %}

            {#==========================================
            Section "Routing"
            ==========================================#}
            {% include "./docs/routing.html" %}

            {#==========================================
            Section "HTTP Caching"
            ==========================================#}
            {% include "./docs/httpCaching.html" %}

            {#==========================================
            Section "WebsSockets"
            ==========================================#}
            {% include "./docs/websockets.html" %}
            
            {#==========================================
            Section "Testing"
            ==========================================#}
            {% include "./docs/testing.html" %}

            {#==========================================
            Section "Miscellaneous"
            ==========================================#}
            {% include "./docs/miscellaneous.html" %}

        </div> {# end : id="docs" #}

    </div> {# end : row #}
    
</div> 

{% endblock %}