index.html

<!DOCTYPE html>
<!--[if lt IE 7 ]><html class="ie ie6" lang="en"> <![endif]-->
<!--[if IE 7 ]><html class="ie ie7" lang="en"> <![endif]-->
<!--[if IE 8 ]><html class="ie ie8" lang="en"> <![endif]-->
<!--[if (gte IE 9)|!(IE)]><!-->
<html lang="en">
<!--<![endif]-->

<head>

    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
    <meta name="description" content="">
    <meta name="author" content="">
    <meta name="keywords" content="">

    <title>Automatic Report Server | Official Documentation</title>

    <link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon">

    <link rel="stylesheet" type="text/css" href="fonts/font-awesome-4.3.0/css/font-awesome.min.css">
    <link rel="stylesheet" type="text/css" href="css/stroke.css">
    <link rel="stylesheet" type="text/css" href="css/bootstrap.css">
    <link rel="stylesheet" type="text/css" href="css/animate.css">
    <link rel="stylesheet" type="text/css" href="css/prettyPhoto.css">
    <link rel="stylesheet" type="text/css" href="css/style.css">

    <link rel="stylesheet" type="text/css" href="js/syntax-highlighter/styles/shCore.css" media="all">
    <link rel="stylesheet" type="text/css" href="js/syntax-highlighter/styles/shThemeRDark.css" media="all">

    <!-- CUSTOM -->
    <link rel="stylesheet" type="text/css" href="css/custom.css">

    <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
    <!--[if lt IE 9]>
      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->

</head>

<body>

    <div id="wrapper">

        <div class="container">

            <section id="top" class="section docs-heading">

                <div class="row">
                    <div class="col-md-12">
                        <div class="big-title text-center">
                            <h1>Automatic Report Server Official Documentation</h1>
                            <p class="lead">ARS Version 1.0</p>
                        </div>
                        <!-- end title -->
                    </div>
                    <!-- end 12 -->
                </div>
                <!-- end row -->

                <hr>

            </section>
            <!-- end section -->

            <div class="row">

                <div class="col-md-3">
                    <nav class="docs-sidebar" data-spy="affix" data-offset-top="300" data-offset-bottom="200" role="navigation">
                        <ul class="nav">
                            <li><a href="#line1">Getting Started</a></li>
                            <li><a href="#line2">Register your chapter</a></li>
                            <li><a href="#line3">Use ARS with the website</a></li>
                            <li><a href="#" class="disabled" style="color: silver;">Advanced ARS ( Self Host )</a>
                                <ul class="nav">
                                    <li><a href="#" class="disabled">Facebook configuration</a></li>
                                    <li><a href="#" class="disabled">Messenger configuration</a></li>
                                    <li><a href="#" class="disabled">Host & Start your ARS</a></li>
                                </ul>
                            </li>
                        </ul>
                    </nav >
                </div>
                <div class="col-md-9">
                    <section class="welcome">
                        <div class="row">
                            <div class="col-md-12 left-align">
                                <h2 class="dark-text">Introduction<hr></h2>
                                <div class="row">

                                    <div class="col-md-12 full">
                                        <div class="intro1">
                                            <ul>
                                                <li><strong>Item Name : </strong>Automatic Report System</li>
                                                <li><strong>Item Version : </strong>1.0</li>
                                                <li><strong>Author  : </strong> <a href="https://cv.nwa2coco.fr" target="_blank">Science Division of the USS Versailles</a></li>
                                                <li><strong>Host : </strong> <a href="https://ussversailles.nwa2coco.fr" target="_blank">USS Versailles, R9</a></li>
                                                <li><strong>License : </strong> <a href="https://choosealicense.com/licenses/mit/" target="_blank">MIT Licence</a></li>
                                            </ul>
                                        </div>

                                        <hr>
                                        <div>
                                            <p>The purpose of the present documentation is to help you to register, use and even host the Automatic Report System, the best open automatic report system of the fleet !
                                                <br>If you have any question, suggestion or bug report please send a mail to contact@nwa2coco.fr with ARS in object !.
                                                <br>Have fun, The Science Division of the USS Versailles, R9.
                                            </p>
                                        </div>
                                    </div>

                                </div>
                                <!-- end row -->
                            </div>
                        </div>
                    </section>

                    <section id="line1" class="section">

                        <div class="row">
                            <div class="col-md-12 left-align">
                                <h2 class="dark-text">Getting Started <a href="#top">#back to top</a><hr></h2>
                            </div>
                            <!-- end col -->
                        </div>
                        <!-- end row -->

                        <div class="row">
                            <div class="col-md-12">
                                <p>All communications with the bot is on Facebook Messenger, the prefix for the commands is <strong>!</strong>. You can access to the bot <a href="https://m.me/arsserverreloaded">here</a>. The communication is pretty simple with these basic commands. 
                                    <br/>We will see here the 3 basic commands, <strong>!help</strong>, <strong>!about</strong> and <strong>!ping</strong></p>
                                    <p>To call a command it's simple, juste send your command ( with the prefix <strong>!</strong> to the bot and he will answer you with the output.</p>
                                    <hr>
                                <h4>Help command</h4>

                                    <p>The <strong>!help</strong> command is the the basic command, the output of this command is basicly all the commands and how to use them. The help output is the default output if you send an invalid command or word.</p>
                                    <img src="https://documentation.nwa2coco.fr/images/helpcommand.png"/>
                                    <br>
                                    <p>As you see the command show like this : <br>
                                    The first and last line is a separator to clearly see the output, the second and third lines are keys to understand the usage of the commands and after a blank line, all the other lines are commands with usage.</p>
                                    <p>For the example let's take the <strong>!ping</strong> command, there are no required argument to the command so you can send the command to the bot without other informations and this command will output a nice <strong>pong !</strong> to you !</p>
                                    <hr>
                                <h4>About command</h4>

                                    <p>The <strong>!about</strong> command is a basic information command, it's output some of informations ( developper, contact mail, host ).
                                The usage is simple, there is no required arguments so you can just send the command to the bot, he will be glad to answer !</p>
                                    <img src="https://documentation.nwa2coco.fr/images/aboutcommand.png">
                                    <hr>
                                <h4>Ping command</h4>    
                                    <p>The <strong>!ping</strong> command is pretty useless, it has an utility only if you want to test if the bot is online, if so he will answer you by a cool <strong>pong !</strong> </p>
                                    <img src="https://documentation.nwa2coco.fr/images/pingcommand.png">
                            </div>
                            <!-- end col -->
                        </div>
                        <!-- end row -->

                    </section>
                    <!-- end section -->

                    <section id="line2" class="section">

                        <div class="row">
                            <div class="col-md-12 left-align">
                                <h2 class="dark-text">Register your chapter <a href="#top">#back to top</a><hr></h2>
                            </div>
                            <!-- end col -->
                        </div>
                        <!-- end row -->

                        <div class="intro2 clearfix">
                            <p>Here is the most important section of this documentation, it will show you how to register your Chapter to the Automatic Report System</p>
                        </div>
                        <br>
                        <div class="littlediv alert alert-danger" role="alert">
                         This section apply only for the CO or the officer in charge of receiving the reports.
                        </div>
                        <hr>


                        <h4>Registring</h4>

                        <p>The process of registring is pretty easy, only one command is required to launch the procedure, the <strong>!subscribe</strong> command.
                        If you remember the help section, you know that some commands can have required argument, this is one of them, let's see the command in the help section :
                        <img src="https://documentation.nwa2coco.fr/images/subscribecommandzoom.png"></p>
                        <p>In the usage of this command we see two word beetween "<strong>[]</strong>" this are <strong>required</strong> arguments, the first argument is the <strong>SCC</strong> of the officer receive the reports, so if you followed the alert, <strong><i>you</i></strong>.
                        The second argument is the <strong>name</strong> of your chapter like <strong>USS Somevessel</strong> please, do not include the regio only "USS" and the name.
                        For example, a completed subscribe command template for the person with 00000 SCC and USS Somevessel :
                        <img src="https://documentation.nwa2coco.fr/images/subscribevessel.png"></p>
                        <p>Once you send the command, you will receive a message, it here to notice you the command were process in the system.
                        <img src="https://documentation.nwa2coco.fr/images/subscribecallback.png"></p>

                        <a href="mailto:contact@nwa2coco.fr?subject=Question via Wiki page&" class="btn btn-info">Any Question ?</a>
                        <hr>

                        <h4>Processing</h4>

                        <p>The processing of the informations you send is manned, the administrator of the system look for the existance of the chapter, scc provided, if needed contact the CO and accept or deny the pending request.</p>
                        <p>If your request is deny by the administrator you will receive this message : <img src="https://documentation.nwa2coco.fr/images/requestdenied.png"></p>
                        <p>If your request is accept by the administrator you will receive this message : <img src="https://documentation.nwa2coco.fr/images/requestaccepted.png"></p>
                    

                    </section>
                    <!-- end section -->

                    <section id="line3" class="section">

                        <div class="row">
                            <div class="col-md-12 left-align">
                                <h2 class="dark-text">Use ARS with the website <a href="#top">#back to top</a><hr></h2>
                            </div>
                            <!-- end col -->
                        </div>
                        <!-- end row -->

                        <p>You can access to the website client for Automatic Report System <a href="https://reports.nwa2coco.fr/">here</a> this website handle all the functions of a client, you can edit and save your report in the user place.</p>
                        <hr>
                        <h4>Main Page</h4>
                        <a href="https://documentation.nwa2coco.fr/images/mainpage.png"><img src="https://documentation.nwa2coco.fr/images/littlemainpage.png"></img></a>                    
                        <h5>Navigation Bar</h5>
                        <p>The main page is minimalist, the navigation bar have some usefull links, the <strong>Member Place</strong> link is the user page ( or the login page if you are not login ).
                        the <strong>Main</strong> link to the main page and the <strong>CV Generator !</strong> link to the generator of SFI CV.</p>
                             <h5>Body</h5>
                                <p>The main page body contains 3 cards which open a full page of explainations, what is ARS ?, How ARS works ? and the FAQ.
                                    A link of contact is included in the bottom of the page</p>
                        <hr>
                        <h4>Register Page</h5>
                        <a href="https://documentation.nwa2coco.fr/images/registerpage.png"><img src="https://documentation.nwa2coco.fr/images/littleregisterpage.png"></a>
                        <p>The register page is a classic one, all the field are <strong>required</strong> there is an hint for all the fields, only the register code is different, it's a very low security, the code is : <strong style="color:red">9b664WYNrL6WC4hq2u9CF3c6jVf6kHcK2Wn9X3tn</strong>
                        . <br>The <strong>Vessel</strong> field have all the vessels, please choose yours.</p>
                        <hr>
                        <h4>User page</h4>
                        <a href="https://documentation.nwa2coco.fr/images/userpage.png"><img src="https://documentation.nwa2coco.fr/images/littleuserpage.png"></a>
                        <i>Default user page</i>
                            <hr>
                        <a href="https://documentation.nwa2coco.fr/images/editionmode.png"><img src="https://documentation.nwa2coco.fr/images/littleeditionmode.png"></a>
                        <i>Edit mode user page</i>

                        <p>The user page is the core of the client, the blank field in the page is for writte the update for the report.
                            By default if you push the <strong>save</strong> button the text you writte is append to your report. If you push the <strong>Edition Mode</strong> you will be able to rewritte your report line by line by modifying the text you put earlier.
    
                        </p>
                    </section>
                    <!-- end section -->

                
                    <section id="line7" class="section">

                        <div class="row">
                            <div class="col-md-12 left-align">
                                <h2 class="dark-text">Advanced ARS ( Self Host - SOON) <a href="#top">#back to top</a><hr></h2>
                            </div>
                            <!-- end col -->
                        </div>
                        <!-- end row -->

                        <div class="row">
                            <div class="col-md-4">
                                <a href="upload/thumbnail.png" data-rel="prettyPhoto"><img src="images/upload/thumbnail.png" alt="" class="img-responsive img-thumbnail"></a>
                            </div>

                            <div class="col-md-8">
                                <h4 id="line7_1">General Options - <a href="#top">#back to top</a></h4>
                                <p>Lorem the It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. long established fact that a reader will English.</p>
                            </div>
                            <!-- end col -->
                        </div>
                        <!-- end row -->

                        <hr>

                        <div class="row">
                            <div class="col-md-4">
                                <a href="upload/thumbnail.png" data-rel="prettyPhoto"><img src="images/upload/thumbnail.png" alt="" class="img-responsive img-thumbnail"></a>
                            </div>

                            <div class="col-md-8">
                                <h4 id="line7_2">Style Options - <a href="#top">#back to top</a></h4>
                                <p>Lorem the It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. long established fact that a reader will English.</p>
                            </div>
                            <!-- end col -->
                        </div>

                        <div class="row">
                            <div class="col-md-4">
                                <a href="upload/thumbnail.png" data-rel="prettyPhoto"><img src="images/upload/thumbnail.png" alt="" class="img-responsive img-thumbnail"></a>
                            </div>

                            <div class="col-md-8">
                                <h4 id="line7_3">Style Options - <a href="#top">#back to top</a></h4>
                                <p>Lorem the It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. long established fact that a reader will English.</p>
                            </div>
                            <!-- end col -->
                        </div>
                        <!-- end row -->

                        <hr>

                    
                    </section>
                    <!-- end section -->

                
                    <section id="line10" class="section">

                        <div class="row">
                            <div class="col-md-12 left-align">
                                <h2 class="dark-text">Version History (Changelog) <a href="#top">#back to top</a><hr></h2>
                            </div>
                            <!-- end col -->
                        </div>
                        <!-- end row -->

                        <div class="row">
                            <div class="col-md-12">

                                <p>Here is the changelog, pretty empty now but this will change.</p>

                                <hr>

                                <h4>Changelog</h4>

                                <pre class="brush: html">
                                        -----------------------------------------------------------------------------------------
                                        Version 1.0.0 - May 2019
                                        -----------------------------------------------------------------------------------------

                                        - Messenger bot configuration
                                        - Commands ( help, about, ping, subscribe )

                                        -----------------------------------------------------------------------------------------
                                        Version 0.0.1 - May 2019
                                        -----------------------------------------------------------------------------------------
                                        - Initial Version ( Empty )
                                      </pre>

                            </div>
                        </div>
                        <!-- end row -->

                    </section>
                    <!-- end section -->

                    <section id="line11" class="section">

                        <div class="row">
                            <div class="col-md-12 left-align">
                                <h2 class="dark-text">Copyright and license <a href="#top">#back to top</a><hr></h2>
                            </div>
                            <!-- end col -->
                        </div>
                        <!-- end row -->

                        <div class="row">
                            <div class="col-md-12">
                                
                                <p>Code released under the <a href="https://choosealicense.com/licenses/mit/" target="_blank">MIT </a> License.</p>                        
                                <p>For more information about copyright and license check <a href="https://choosealicense.com/" target="_blank">choosealicense.com</a>.</p>
                            
                            </div>
                        </div>
                        <!-- end row -->

                    </section>
                    <!-- end section -->
                </div>
                <!-- // end .col -->

            </div>
            <!-- // end .row -->

        </div>
        <!-- // end container -->

    </div>
    <!-- end wrapper -->

    <script src="js/jquery.min.js"></script>
    <script src="js/bootstrap.min.js"></script>
    <script src="js/retina.js"></script>
    <script src="js/jquery.fitvids.js"></script>
    <script src="js/wow.js"></script>
    <script src="js/jquery.prettyPhoto.js"></script>

    <!-- CUSTOM PLUGINS -->
    <script src="js/custom.js"></script>
    <script src="js/main.js"></script>

    <script src="js/syntax-highlighter/scripts/shCore.js"></script>
    <script src="js/syntax-highlighter/scripts/shBrushXml.js"></script>
    <script src="js/syntax-highlighter/scripts/shBrushCss.js"></script>
    <script src="js/syntax-highlighter/scripts/shBrushJScript.js"></script>

</body>

</html>