Changeset 3315


Ignore:
Timestamp:
May 9, 2007, 2:35:11 PM (16 years ago)
Author:
Nicklas Nordborg
Message:

Synchronized table of contents for developer documentation with the draft.
Added links to the old documentation for all sections where this was possible.

Location:
trunk/doc/src/docbook/developerdoc
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/src/docbook/developerdoc/api_overview.xml

    r3246 r3315  
    2727-->
    2828
    29 <chapter id="api_overview">
     29<chapter id="api_overview" chunked="0">
    3030  <?dbhtml dir="api"?>
    3131  <title>API overview (how to use and code examples)</title>
    32     <sect1>
    33       <title></title>
    34       <para></para>
    35     </sect1>
     32
     33  <sect1 id="api_overview.data_api">
     34    <title>The database schema and the Data Layer API</title>
     35
     36    <para>
     37      This documentation is only available in the old format.
     38      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/data/index.html"
     39        >http://base.thep.lu.se/chrome/site/doc/development/overview/data/index.html</ulink>
     40    </para>
     41   
     42  </sect1>
     43 
     44  <sect1 id="api_overview.core_api">
     45    <title>The Core API</title>
     46    <para>
     47      TODO
     48    </para>
     49  </sect1>
     50
     51  <sect1 id="api_overview.query_api">
     52    <title>The Query API</title>
     53    <para>
     54      This documentation is only available in the old format.
     55      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/query/index.html"
     56        >http://base.thep.lu.se/chrome/site/doc/development/overview/query/index.html</ulink>
     57    </para>
     58   
     59  </sect1>
     60 
     61  <sect1 id="api_overview.dynamic_and_batch_api">
     62    <title>Analysis and the Dynamic and Batch API:s</title>
     63    <para>
     64      This documentation is only available in the old format.
     65      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/dynamic/index.html"
     66        >http://base.thep.lu.se/chrome/site/doc/development/overview/dynamic/index.html</ulink>
     67    </para>
     68  </sect1>
     69
     70  <sect1 id="api_overview.other_api">
     71    <title>Other useful classes and methods</title>
     72    <para>
     73      TODO
     74    </para>
     75  </sect1>
     76 
    3677</chapter>

  • trunk/doc/src/docbook/developerdoc/base_overview.xml

    r3246 r3315  
    3030  <?dbhtml dir="develop_overview"?>
    3131  <title>Overview of BASE2</title>
    32     <sect1>
    33       <title></title>
    34       <para></para>
    35     </sect1>
     32
     33  <para>
     34    This documentation is only available in the old format.
     35    See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/index.html"
     36      >http://base.thep.lu.se/chrome/site/doc/development/overview/index.html</ulink>
     37  </para>
    3638</chapter>

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

    r3246 r3315  
    2727-->
    2828
    29 <chapter id="core_ref">
     29<chapter id="core_ref" chunked="0">
    3030  <?dbhtml dir="core_ref"?>
    3131  <title>Core developer reference</title>
    32     <sect1>
    33       <title></title>
    34       <para></para>
    35     </sect1>
     32
     33  <sect1 id="core_ref.procedures">
     34    <title>Important procedures</title>
     35    <para>
     36      This documentation is only available in the old format.
     37      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/index.html#rules"
     38        >http://base.thep.lu.se/chrome/site/doc/development/index.html#rules</ulink>
     39    </para>
     40  </sect1>
     41 
     42  <sect1 id="core_ref.release">
     43    <title>Publishing a new release</title>
     44    <para>
     45      This documentation is only available in the old format.
     46      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/index.html#newrelease"
     47        >http://base.thep.lu.se/chrome/site/doc/development/index.html#newrelease</ulink>
     48    </para>
     49  </sect1>
     50 
     51  <sect1 id="core_ref.build">
     52    <title>Subversion / building BASE</title>
     53    <para>
     54      This documentation is only available in the old format.
     55      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/build.html"
     56        >http://base.thep.lu.se/chrome/site/doc/development/build.html</ulink>
     57    </para>
     58  </sect1>
     59
     60  <sect1 id="core_ref.rules">
     61    <title>Coding rules and guidelines</title>
     62   
     63    <sect2 id="core_ref.rules.devprocess">
     64      <title>Development process</title>
     65      <para>
     66        This documentation is only available in the old format.
     67        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/coding/process.html"
     68          >http://base.thep.lu.se/chrome/site/doc/development/coding/process.html</ulink>
     69      </para>
     70    </sect2>
     71    <sect2 id="core_ref.rules.style">
     72      <title>General coding style guidelines</title>
     73      <para>
     74        This documentation is only available in the old format.
     75        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/coding/generic.html"
     76          >http://base.thep.lu.se/chrome/site/doc/development/coding/generic.html</ulink>
     77      </para>
     78    </sect2>   
     79    <sect2 id="core_ref.rules.compatibility">
     80      <title>API changes and backwards compatibility</title>
     81      <para>
     82        TODO
     83      </para>
     84    </sect2>   
     85    <sect2 id="core_ref.rules.datalayer">
     86      <title>Data-layer rules</title>
     87      <para>
     88        This documentation is only available in the old format.
     89        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/coding/data/index.html"
     90          >http://base.thep.lu.se/chrome/site/doc/development/coding/data/index.html</ulink>
     91      </para>
     92    </sect2>   
     93    <sect2 id="core_ref.rules.itemclass">
     94      <title>Item-class rules</title>
     95      <para>
     96        This documentation is only available in the old format.
     97        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/coding/item/index.html"
     98          >http://base.thep.lu.se/chrome/site/doc/development/coding/item/index.html</ulink>
     99      </para>
     100    </sect2>   
     101    <sect2 id="core_ref.rules.batchclass">
     102      <title>Batch-class rules</title>
     103      <para>
     104        TODO
     105      </para>
     106    </sect2>   
     107    <sect2 id="core_ref.rules.testclass">
     108      <title>Test-class rules</title>
     109      <para>
     110        TODO
     111      </para>
     112    </sect2>   
     113  </sect1>
     114 
     115  <sect1 id="core_ref.coreinternals">
     116    <title>Internals of the Core API</title>
     117    <para>
     118      This documentation is only available in the old format.
     119      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/index.html"
     120        >http://base.thep.lu.se/chrome/site/doc/development/overview/core/index.html</ulink>
     121    </para>
     122    <sect2 id="core_ref.authentication">
     123      <title>Authentication and sessions</title>
     124      <para>
     125        This documentation is only available in the old format.
     126        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/authentication.html"
     127          >http://base.thep.lu.se/chrome/site/doc/development/overview/core/authentication.html</ulink>
     128      </para>
     129    </sect2>   
     130    <sect2 id="core_ref.accesspermissions">
     131      <title>Access permissions</title>
     132      <para>
     133        This documentation is only available in the old format.
     134        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/accesspermissions.html"
     135          >http://base.thep.lu.se/chrome/site/doc/development/overview/core/accesspermissions.html</ulink>
     136      </para>
     137    </sect2>   
     138    <sect2 id="core_ref.datavalidation">
     139      <title>Data validation</title>
     140      <para>
     141        TODO
     142      </para>
     143    </sect2>   
     144    <sect2 id="core_ref.transactions">
     145      <title>Transaction handling</title>
     146      <para>
     147        TODO
     148      </para>
     149    </sect2>   
     150    <sect2 id="core_ref.crwd">
     151      <title>Create/read/write/delete operations</title>
     152      <para>
     153        This documentation is only available in the old format.
     154        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/itemhandling.html"
     155          >http://base.thep.lu.se/chrome/site/doc/development/overview/core/itemhandling.html</ulink>
     156      </para>
     157    </sect2>   
     158    <sect2 id="core_ref.batch">
     159      <title>Batch operations</title>
     160      <para>
     161        This documentation is only available in the old format.
     162        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/batchprocessing.html"
     163          >http://base.thep.lu.se/chrome/site/doc/development/overview/core/batchprocessing.html</ulink>
     164      </para>
     165    </sect2>   
     166    <sect2 id="core_ref.quota">
     167      <title>Quota</title>
     168      <para>
     169        TODO
     170      </para>
     171    </sect2>   
     172    <sect2 id="core_ref.pluginexecution">
     173      <title>Plugin execution / job queue</title>
     174      <para>
     175        This documentation is only available in the old format.
     176        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/plugins.html"
     177          >http://base.thep.lu.se/chrome/site/doc/development/overview/core/plugins.html</ulink>
     178      </para>
     179    </sect2>   
     180  </sect1>
     181
    36182</chapter>

  • trunk/doc/src/docbook/developerdoc/javadoc.xml

    r3246 r3315  
    3030  <?dbhtml dir="javadoc"?>
    3131  <title>Javadoc</title>
    32     <sect1>
    33       <title></title>
    34       <para></para>
    35     </sect1>
     32
     33  <para>
     34    The Javadoc documentation is available online at:
     35    <ulink url="http://base.thep.lu.se/chrome/site/doc/api/index.html"
     36      >http://base.thep.lu.se/chrome/site/doc/api/index.html</ulink>
     37  </para>
     38 
     39
    3640</chapter>

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

    r3246 r3315  
    12911291  <sect1 id="plugin_developer.import">
    12921292    <title>Import plugins</title>
    1293     <para></para>
     1293    <para>
     1294   
     1295      This documentation is only available in the old format.
     1296      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/plugins/import/index.html"
     1297        >http://base.thep.lu.se/chrome/site/doc/development/plugins/import/index.html</ulink>
     1298    </para>
    12941299   
    12951300    <sect2 id="plugin_developer.import.autodetect">
    … …  
    13061311  <sect1 id="plugin_developer.export">
    13071312    <title>Export plugins</title>
    1308     <para></para>
     1313    <para>TODO</para>
    13091314   
    13101315    <sect2 id="plugin_developer.export.download">
    13111316      <title>Immediate download of exported data</title>
    1312       <para></para>
     1317      <para>TODO</para>
    13131318    </sect2>
    13141319  </sect1>
    … …  
    13341339}
    13351340</programlisting>
     1341
     1342      <para>
     1343        More documentation is available in the old format.
     1344        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/plugins/analysis/index.html"
     1345          >http://base.thep.lu.se/chrome/site/doc/development/plugins/analysis/index.html</ulink>
     1346      </para>
     1347
     1348
    13361349  </sect1>
    13371350 
    … …  
    13421355    <sect2 id="plugin_developer.other.authentication">
    13431356      <title>Authentication plugins</title>
    1344       <para></para>
     1357      <para>
     1358        This documentation is only available in the old format.
     1359        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/plugins/authentication/index.html"
     1360          >http://base.thep.lu.se/chrome/site/doc/development/plugins/authentication/index.html</ulink>
     1361      </para>
    13451362    </sect2>
    13461363   
    13471364    <sect2 id="plugin_developer.other.secondary">
    13481365      <title>Secondary file storage plugins</title>
    1349       <para></para>
     1366      <para>
     1367        This documentation is only available in the old format.
     1368        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/plugins/storage/index.html"
     1369          >http://base.thep.lu.se/chrome/site/doc/development/plugins/storage/index.html</ulink>
     1370      </para>
    13501371    </sect2>
    13511372   
    13521373    <sect2 id="plugin_developer.other.unpacker">
    13531374      <title>File unpacker plugins</title>
    1354       <para></para>
     1375      <para>
     1376        TODO
     1377      </para>
    13551378    </sect2>
    13561379  </sect1>
    … …  
    13581381  <sect1 id="plugin_developer.example">
    13591382    <title>Example plugins (with download)</title>
    1360     <para></para>
     1383    <para>
     1384      <para>
     1385        This documentation is only available in the old format.
     1386        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/index.html#plugins"
     1387          >http://base.thep.lu.se/chrome/site/doc/development/index.html#plugins</ulink>
     1388      </para>
     1389    </para>
    13611390  </sect1>
    13621391</chapter>
Note: See TracChangeset for help on using the changeset viewer.