<!DOCTYPE html>
    <html lang="en">
        <head>
            <meta charset="utf-8">
                <title>Jaggery - Delicious Javascript</title>
                <meta name="description" content="">
                    <meta name="author" content="">

                        <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
                        <!--[if lt IE 9]>
                        <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
                        <![endif]-->

                        <!-- Le styles -->
                        <link href="../css/bootstrap.css" rel="stylesheet">
                            <style type="text/css">
                            body {
                                padding-top: 60px;
                                }
                            </style>
                            <link href="../css/prettify.css" rel="stylesheet">
                                <!-- Le fav and touch icons -->
                                <link rel="shortcut icon" href="../images/favicon.ico">
                                    <link rel="apple-touch-icon" href="../images/apple-touch-icon.png">
                                        <link rel="apple-touch-icon" sizes="72x72"
                                        href="../images/apple-touch-icon-72x72.png">
                                            <link rel="apple-touch-icon" sizes="114x114"
                                            href="../images/apple-touch-icon-114x114.png">
                                            </head>

                                            <body>

                                                <%
                                                include('/includes/topnavi.jag');
%>

<div class="container-fluid" style="width: 960px; margin: auto;">
<div class="row">
    <div class="span16">
        <div class="page-header">
            <h1  id="top">
                Documentation
                <small>API documentation for Jaggery.js</small>
            </h1>
        </div>
    </div>
</div>

<div class="row">
<div class="span4">
    <div class="well">
        <%
        include('/includes/navi.jag');
        %>
     </div>

</div>
<div class="span12">
<div class="content" id="syn" name="syn">
<h3>jaggery.conf</h3>

<pre class="prettyprint linenums">
{
    "displayName":"Minimal Sample",
    "welcomeFiles":["index.jag", "index.html"],
    "errorPages":[
        {
            "errorCode":"500",
            "location":"/error1.html"
        },
        {
            "errorCode":"404",
            "location":"/error.html"
        }
    ],
    "securityConstraints":[
        {
            "securityConstraint":{
                "webResourceCollection":{
                    "name":"foo",
                    "urlPatterns":["/bar/*"],
                    "methods":["GET", "POST", "PUT", "DELETE"]
                },
                "authRoles":["admin"]
            }
        }
    ],
    "loginConfig":{
        "authMethod":"BASIC"
    },
    "securityRoles":["admin", "everyone"],
    "urlMappings" : [
		{
			"url" : "/sample/uri-mapping",
			"path" : "/index.jag"
		}
	]
}
</pre>

<section id="overview">

<h4>Overview</h4>
<p class="description">Jaggery configuration file specifies the application specific configurations</p>

</section>
                <section id="operations">
                    <h4>Configuration Options</h4>
                    <table class="clsStd operations-table">
                        <tbody>
                        <tr>
                            <th>Configuration</th>
                            <th>Description</th>
                        </tr>
                        <tr>
                            <td><code>displayName</code></td>
                            <td>
<pre class="prettyprint">
"displayName" : "Minimal Sample"
</pre>
The display name of the application
                            </td>
                        </tr>
                        <tr>
                            <td><code>welcomeFiles</code></td>
                            <td>
<pre class="prettyprint">
"welcomeFiles" : ["index.jag", "index.html"]
</pre>
specifys an array of welcome files
                            </td>
                        </tr>
                        <tr>
                            <td><code>errorPages</code></td>
                            <td>
<pre class="prettyprint">
"errorPages":[{
                "errorCode":"500",
                "location":"/error1.html"
             }]
</pre>
specifys an error page for the corresponding HTTP error code
                            </td>
                        </tr>
                        <tr>
                            <td><code>securityConstraints</code></td>
                            <td>
<pre class="prettyprint">
"securityConstraints":[
        {
            "securityConstraint":{
                "webResourceCollection":{
                    "name":"foo",
                    "urlPatterns":["/bar/*"],
                    "methods":["GET", "POST", "PUT", "DELETE"]
                },
                "authRoles":["admin"]
            }
        }
    ]
</pre>
specifys security constraint for a certain web resource (jaggery file/directory etc).
                            </td>
                        </tr>
                        <tr>
                            <td><code>loginConfig <br/>["BASIC" <br/>| "CLIENT-CERT" <br/>| "FORM"]</code></td>
                            <td>
<pre class="prettyprint">
"loginConfig":{
        "authMethod":"BASIC"
    }
</pre>
specifys login mechanism "BASIC" or "FORM"
                            </td>
                        </tr>
                        <tr>
                            <td><code>securityRoles</code></td>
                            <td>
<pre class="prettyprint">
"securityRoles":["admin", "everyone"]
</pre>
specifys the roles that applies to application's security constraints
                            </td>
                        </tr>
                        <tr>
                             <td><code>urlMappings</code></td>
                             <td>
<pre class="prettyprint">
"urlMappings" : [{
            "url" : "/sample/uri-mapping",
            "path" : "/index.jag"
        }]
</pre>
specifys URL mappings
                                                        </td>
                                                    </tr>
                        </tbody>
                    </table>
                </section>
</div>
<br>
<br>
</div>

</div>
<%
include('/includes/footer.jag');
%>


</div>
<!-- /container -->
<%
include('/includes/scripts.jag')
%>
	<script>

		$(document).ready(function(){
        $('#conf').toggleClass('active')
		$('#docs').addClass('active')
        });




	</script>
</body>
</html>