Changeset 5781


Ignore:
Timestamp:
Oct 4, 2011, 2:00:07 PM (11 years ago)
Author:
Nicklas Nordborg
Message:

References #1590: Documentation cleanup

Moved "Internals of the Core API" to "The BASE API" section.

Location:
trunk/doc/src/docbook/developer
Files:
6 edited
1 moved

Legend:

Unmodified
Added
Removed

  • trunk/doc/src/docbook/developer/base_api.xml

    r5780 r5781  
    25372537  </sect1>
    25382538 
    2539   <sect1 id="api_overview.core_api" chunked="1">
     2539  <sect1 id="base_api.core" chunked="1">
    25402540    <title>The Core API</title>
    25412541   
    … …  
    25432543      This section gives an overview of various parts of the core API.
    25442544    </para>
     2545   
     2546    <sect2 id="core_api.authentication">
     2547      <title>Authentication and sessions</title>
     2548      <para>
     2549        This documentation is only available in the old format which may not be up-to-date with
     2550        the current implementation.
     2551        See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/authentication.html"
     2552          >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/authentication.html</ulink>
     2553      </para>
     2554    </sect2>   
     2555   
     2556    <sect2 id="core_api.accesspermissions">
     2557      <title>Access permissions</title>
     2558      <para>
     2559        This documentation is only available in the old format which may not be up-to-date with
     2560        the current implementation.
     2561        See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/accesspermissions.html"
     2562          >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/accesspermissions.html</ulink>
     2563      </para>
     2564    </sect2>
     2565   
     2566    <sect2 id="core_api.datavalidation">
     2567      <title>Data validation</title>
     2568      <para>
     2569        TODO
     2570      </para>
     2571    </sect2>   
     2572    <sect2 id="core_api.transactions">
     2573      <title>Transaction handling</title>
     2574      <para>
     2575        TODO
     2576      </para>
     2577    </sect2>   
     2578    <sect2 id="core_api.crwd">
     2579      <title>Create/read/write/delete operations</title>
     2580      <para>
     2581        This documentation is only available in the old format which may not be up-to-date with
     2582        the current implementation.
     2583        See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/itemhandling.html"
     2584          >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/itemhandling.html</ulink>
     2585      </para>
     2586    </sect2>   
     2587    <sect2 id="core_api.batch">
     2588      <title>Batch operations</title>
     2589      <para>
     2590        This documentation is only available in the old format which may not be up-to-date with
     2591        the current implementation.
     2592        See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/batchprocessing.html"
     2593          >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/batchprocessing.html</ulink>
     2594      </para>
     2595    </sect2>   
     2596   
     2597    <sect2 id="core_api.quota">
     2598      <title>Quota</title>
     2599      <para>
     2600        TODO
     2601      </para>
     2602    </sect2>   
     2603    <sect2 id="core_api.pluginexecution">
     2604      <title>Plugin execution / job queue</title>
     2605      <para>
     2606        This documentation is only available in the old format which may not be up-to-date with
     2607        the current implementation.
     2608        See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/plugins.html"
     2609          >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/plugins.html</ulink>
     2610      </para>
     2611    </sect2>   
    25452612   
    25462613    <sect2 id="core_api.data_in_files">
    … …  
    31473214  </sect1>
    31483215
    3149   <sect1 id="api_overview.query_api">
     3216  <sect1 id="core_api.query">
    31503217    <title>The Query API</title>
    31513218    <para>
    … …  
    31573224  </sect1>
    31583225 
    3159   <sect1 id="api_overview.dynamic_and_batch_api">
    3160     <title>Analysis and the Dynamic and Batch API:s</title>
     3226  <sect1 id="core_api.dynamic">
     3227    <title>The Dynamic API</title>
    31613228    <para>
    31623229      This documentation is only available in the old format.
    … …  
    31663233  </sect1>
    31673234
    3168   <sect1 id="api_overview.extensions">
    3169     <title>Extensions API</title>
     3235  <sect1 id="core_api.extensions">
     3236    <title>The Extensions API</title>
    31703237   
    3171     <sect2 id="api_overview.extensions.core">
     3238    <sect2 id="extensions_api.core">
    31723239      <title>The core part</title>
    31733240   
    … …  
    32093276      </itemizedlist>
    32103277     
    3211       <figure id="core_api.figures.extensions_core">
     3278      <figure id="extensions_api.figures.core">
    32123279        <title>The core part of the Extensions API</title>
    32133280        <screenshot>
    … …  
    32413308      </para>
    32423309     
    3243       <example id="core_api.example.extensions_core">
     3310      <example id="extensions_api.example.menu">
    32443311        <title>The menu extensions point</title>
    32453312        <para>
    … …  
    33263393    </sect2>
    33273394   
    3328     <sect2 id="api_overview.extensions.web">
     3395    <sect2 id="extensions_api.web">
    33293396      <title>The web client part</title>
    33303397   
    … …  
    33793446      </para>
    33803447     
    3381       <figure id="core_api.figures.extensions_web">
     3448      <figure id="extensions_api.figures.web">
    33823449        <title>The web client part of the Extensions API</title>
    33833450        <screenshot>
    … …  
    34773544  </sect1>
    34783545
    3479   <sect1 id="api_overview.other_api">
     3546  <sect1 id="core_api.other">
    34803547    <title>Other useful classes and methods</title>
    34813548    <para>

  • trunk/doc/src/docbook/developer/core_ref.xml

    r5780 r5781  
    26782678          <classname docapi="net.sf.basedb.core">Group</classname>, <classname docapi="net.sf.basedb.core">Role</classname>, etc.
    26792679          must check the logged in user's membership. We don't show any more examples here. Take a look in the source code
    2680           if you want more information. You can also read <xref linkend="api_overview.query_api" /> for more examples.
     2680          if you want more information. You can also read <xref linkend="core_api.query" /> for more examples.
    26812681        </para>
    26822682
    … …  
    37883788    </sect2>
    37893789  </sect1>
    3790  
    3791   <sect1 id="core_ref.coreinternals">
    3792     <title>Internals of the Core API</title>
    3793     <para>
    3794       This documentation is only available in the old format.
    3795       See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/index.html"
    3796         >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/index.html</ulink>
    3797     </para>
    3798     <sect2 id="core_ref.authentication">
    3799       <title>Authentication and sessions</title>
    3800       <para>
    3801         This documentation is only available in the old format.
    3802         See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/authentication.html"
    3803           >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/authentication.html</ulink>
    3804       </para>
    3805     </sect2>   
    3806     <sect2 id="core_ref.accesspermissions">
    3807       <title>Access permissions</title>
    3808       <para>
    3809         This documentation is only available in the old format.
    3810         See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/accesspermissions.html"
    3811           >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/accesspermissions.html</ulink>
    3812       </para>
    3813     </sect2>   
    3814     <sect2 id="core_ref.datavalidation">
    3815       <title>Data validation</title>
    3816       <para>
    3817         TODO
    3818       </para>
    3819     </sect2>   
    3820     <sect2 id="core_ref.transactions">
    3821       <title>Transaction handling</title>
    3822       <para>
    3823         TODO
    3824       </para>
    3825     </sect2>   
    3826     <sect2 id="core_ref.crwd">
    3827       <title>Create/read/write/delete operations</title>
    3828       <para>
    3829         This documentation is only available in the old format.
    3830         See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/itemhandling.html"
    3831           >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/itemhandling.html</ulink>
    3832       </para>
    3833     </sect2>   
    3834     <sect2 id="core_ref.batch">
    3835       <title>Batch operations</title>
    3836       <para>
    3837         This documentation is only available in the old format.
    3838         See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/batchprocessing.html"
    3839           >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/batchprocessing.html</ulink>
    3840       </para>
    3841     </sect2>   
    3842     <sect2 id="core_ref.quota">
    3843       <title>Quota</title>
    3844       <para>
    3845         TODO
    3846       </para>
    3847     </sect2>   
    3848     <sect2 id="core_ref.pluginexecution">
    3849       <title>Plugin execution / job queue</title>
    3850       <para>
    3851         This documentation is only available in the old format.
    3852         See <ulink url="http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/plugins.html"
    3853           >http://base.thep.lu.se/chrome/site/doc/historical/development/overview/core/plugins.html</ulink>
    3854       </para>
    3855     </sect2>   
    3856   </sect1>
    38573790
    38583791</chapter>

  • trunk/doc/src/docbook/developer/documentation.xml

    r5738 r5781  
    18331833      found on the start page of Base Javadoc. Plugin developers and other external developers
    18341834      should pay most attention to the public API. What we consider to be the public part of the API is discussed in
    1835       <xref linkend="api_overview.public_api" />.
     1835      <xref linkend="base_api.public" />.
    18361836    </para>
    18371837

  • trunk/doc/src/docbook/developer/extensions.xml

    r5738 r5781  
    6868      <listitem>
    6969        <para>
    70         <xref linkend="api_overview.extensions" />.
     70        <xref linkend="core_api.extensions" />.
    7171        </para>
    7272      </listitem>

  • trunk/doc/src/docbook/developer/index.xml

    r5780 r5781  
    2828  <title>Developer documentation</title>
    2929  <include file="migrate_2_3.xml" />
    30   <include file="base_overview.xml"/>
     30  <include file="overview.xml"/>
    3131  <include file="plugin_developer.xml"/>
    3232  <include file="extensions.xml" />

  • trunk/doc/src/docbook/developer/overview.xml

    r5774 r5781  
    2525-->
    2626
    27 <chapter id="base_develop_overview" chunked="0">
     27<chapter id="developer.overview" chunked="0">
    2828  <title>Developer overview of BASE</title>
    2929
    … …  
    3838  </para>
    3939 
    40     <figure id="develop.figures.overview">
     40    <figure id="developer.figures.overview">
    4141      <title>Overview of the BASE application</title>
    4242      <screenshot>
    … …  
    5252    </figure>
    5353   
    54     <sect1 id="base_develop_overview.database">
     54    <sect1 id="developer.overview.database">
    5555      <title>Fixed vs. dynamic database</title>
    5656
    … …  
    8686        <listitem>
    8787          <para>
    88           <xref linkend="api_overview.dynamic_and_batch_api" />
    89           </para>
    90         </listitem>
    91       </itemizedlist>
    92    
    93     </sect1>
    94 
    95     <sect1 id="base_develop_overview.hibernate">
     88          <xref linkend="core_api.dynamic" />
     89          </para>
     90        </listitem>
     91      </itemizedlist>
     92   
     93    </sect1>
     94
     95    <sect1 id="developer.overview.hibernate">
    9696      <title>Hibernate and the DbEngine</title>
    9797   
    … …  
    145145    </sect1>
    146146
    147     <sect1 id="base_develop_overview.batchapi">
     147    <sect1 id="developer.overview.batchapi">
    148148      <title>The Batch API</title>
    149149   
    … …  
    183183        <listitem>
    184184          <para>
    185           <xref linkend="api_overview.dynamic_and_batch_api" />
     185          <xref linkend="core_api.batch" />
     186          </para>
     187        </listitem>
     188        <listitem>
     189          <para>
     190          <xref linkend="core_api.dynamic" />
    186191          </para>
    187192        </listitem>
    … …  
    191196          </para>
    192197        </listitem>
    193         <listitem>
    194           <para>
    195           <xref linkend="core_ref.batch" />
    196           </para>
    197         </listitem>
    198       </itemizedlist>
    199     </sect1>
    200    
    201     <sect1 id="base_develop_overview.classes">
     198      </itemizedlist>
     199    </sect1>
     200   
     201    <sect1 id="developer.overview.classes">
    202202      <title>Data classes vs. item classes</title>
    203203   
    … …  
    250250        <listitem>
    251251          <para>
    252           <xref linkend="core_ref.accesspermissions" />
    253           </para>
    254         </listitem>
    255         <listitem>
    256           <para>
    257           <xref linkend="core_ref.datavalidation" />
    258           </para>
    259         </listitem>
    260         <listitem>
    261           <para>
    262           <xref linkend="core_ref.batch" />
    263           </para>
    264         </listitem>
    265       </itemizedlist>
    266     </sect1>
    267 
    268     <sect1 id="base_develop_overview.queryapi">
     252          <xref linkend="core_api.accesspermissions" />
     253          </para>
     254        </listitem>
     255        <listitem>
     256          <para>
     257          <xref linkend="core_api.datavalidation" />
     258          </para>
     259        </listitem>
     260        <listitem>
     261          <para>
     262          <xref linkend="core_api.batch" />
     263          </para>
     264        </listitem>
     265      </itemizedlist>
     266    </sect1>
     267
     268    <sect1 id="developer.overview.queryapi">
    269269      <title>The Query API</title>
    270270      <para>
    … …  
    306306        <listitem>
    307307          <para>
    308           <xref linkend="api_overview.query_api" />
    309           </para>
    310         </listitem>
    311       </itemizedlist>
    312     </sect1>
    313 
    314     <sect1 id="base_develop_overview.controllerapi">
     308          <xref linkend="core_api.query" />
     309          </para>
     310        </listitem>
     311      </itemizedlist>
     312    </sect1>
     313
     314    <sect1 id="developer.overview.controllerapi">
    315315      <title>The Controller API</title>
    316316      <para>
    … …  
    326326        <listitem>
    327327          <para>
    328           <xref linkend="core_ref.coreinternals" />
    329           </para>
    330         </listitem>
    331       </itemizedlist>
    332     </sect1>
    333 
    334     <sect1 id="base_develop_overview.plugins">
     328          <xref linkend="base_api.core" />
     329          </para>
     330        </listitem>
     331      </itemizedlist>
     332    </sect1>
     333
     334    <sect1 id="developer.overview.plugins">
    335335      <title>Plug-ins</title>
    336336   
    … …  
    374374        <listitem>
    375375          <para>
    376           <xref linkend="core_ref.pluginexecution" />
    377           </para>
    378         </listitem>
    379       </itemizedlist>
    380     </sect1>
    381 
    382     <sect1 id="base_develop_overview.clients">
     376          <xref linkend="core_api.pluginexecution" />
     377          </para>
     378        </listitem>
     379      </itemizedlist>
     380    </sect1>
     381
     382    <sect1 id="developer.overview.clients">
    383383      <title>Client applications</title>
    384384      <para>

  • trunk/doc/src/docbook/developer/plugin_developer.xml

    r5738 r5781  
    32103210
    32113211    <para>
    3212     See <xref linkend="api_overview.dynamic_and_batch_api" />
     3212    See <xref linkend="core_api.dynamic" />
    32133213    for more examples of using the analysis API.
    32143214    </para>
Note: See TracChangeset for help on using the changeset viewer.