share/nitdoc/help.html

   1 <!DOCTYPE html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>NitDoc | Help</title>
   6
   7                 <script type="text/javascript" src="scripts/jquery-1.7.1.min.js"></script>
   8                 <script type="text/javascript" src="scripts/js-facilities.js"></script>
   9
  10         <link rel="shortcut icon" href="favicon.ico">
  11         <link rel="stylesheet" href="./styles/main.css" type="text/css"  media="screen">
  12         </head>
  13         <body>
  14                 <!-- Page header -->
  15                 <header>
  16                         <!-- Main navigation -->
  17                         <nav class="main">
  18                                 <ul>
  19                                         <li><a href="index.html">Overview</a></li>
  20                                         <li><a href="full-index.html">Full Index</a></li>
  21                                         <li class="current">Help</li>
  22                                 </ul>
  23                         </nav>
  24                 </header>
  25
  26                 <!-- Page content -->
  27                 <div class="page">
  28                         <!-- Content -->
  29                         <div class="content fullpage">
  30                                 <h1>Help</h1>
  31                                 <div class="subtitle">This documentation is organized as follows.</div>
  32
  33                                 <article>
  34                                         <h2>Menu Bar</h2>
  35                                         <p>The menu bar allows you to navigate different views of this documentation.</p>
  36                                         <ul>
  37                                                 <li>The <a href="index.html">Overview</a> is the front page of this documentation</li>
  38                                                 <li>The <a href="full-index.html">Full Index</a> lists all properties, classes and modules</li>
  39                                                 <li>The <a href="help.html">Help</a> displays this page</li>
  40                                         </ul>
  41                                         <p>If JavaScript is enabled on your browser, a search field appears and allows you to search in all properties, classes and modules.</p>
  42                                 </article>
  43
  44                                 <article>
  45                                         <h2>Overview</h2>
  46                                         <p>The <a href="index.html">Overview</a> page is the front page of this documentation and provides a list of all modules with a summary for each.</p>
  47                                 </article>
  48
  49                                 <article>
  50                                         <h2>Modules</h2>
  51                                         <p>Each module has a page that contains a summary of the module, a graphic representation and a list of its classes (including interfaces) and properties. The left block contains a list of imported and nested modules.</p>
  52                                         <p>If JavaScript is enabled on your browser, classes and properties can be filtered by name.</p>
  53                                 </article>
  54
  55                                 <article>
  56                                         <h2>Class</h2>
  57                                         <p>Each class and interface has its own separate page. Each of these pages has four sections consisting of a class/interface description, virtual and formal types list, detailed properties descriptions and inherited properties.</p>
  58                                         <p>Blocks on the left display :</p>
  59                                         <ul>
  60                                                 <li>Properties (virtual types, formal types, methods)</li>
  61                                                 <li>Inheritance relations (super and subclasses)</li>
  62                                         </ul>
  63                                         <p>Before the detail of each property an icon show the type of property (diamond = virtual type, square = constructor, circle = method). The color of the icon reflect the property visibility (red = private, orange = protected, green = public).</p>
  64                                 </article>
  65
  66                                 <article>
  67                                         <h2>Full Index</h2>
  68                                         <p>The <a href="full-index.html">Full Index</a> contains an alphabetic list of all modules, classes/interfaces and properties.</p>
  69                                         <p>If JavaScript is enabled on your browser, lists can be filtered by name.</p>
  70                                 </article>
  71                         </div>
  72                         <div class="clear"></div>
  73                 </div>
  74         </body>
  75 </html>