Changeset 5782


Ignore:
Timestamp:
Oct 4, 2011, 3:43:16 PM (12 years ago)
Author:
Nicklas Nordborg
Message:

References #1590: Documentation cleanup

Restructured documentation to generate shorter filenames.

Location:
trunk
Files:
1 deleted
36 edited
1 moved

Legend:

Unmodified
Added
Removed

  • trunk/build.xml

    r5743 r5782  
    12881288    <mkdir dir="${docbook.html.out}/admin"/>
    12891289    <mkdir dir="${docbook.html.out}/developer"/>
    1290     <mkdir dir="${docbook.html.out}/overview"/>
     1290    <mkdir dir="${docbook.html.out}/developer/plugins"/>
     1291    <mkdir dir="${docbook.html.out}/developer/extensions"/>
     1292    <mkdir dir="${docbook.html.out}/developer/api"/>
     1293    <mkdir dir="${docbook.html.out}/developer/documentation"/>
    12911294    <mkdir dir="${docbook.html.out}/user"/>
     1295    <mkdir dir="${docbook.html.out}/user/webclient"/>
     1296    <mkdir dir="${docbook.html.out}/user/projects"/>
     1297    <mkdir dir="${docbook.html.out}/user/files"/>
     1298    <mkdir dir="${docbook.html.out}/user/annotations"/>
     1299    <mkdir dir="${docbook.html.out}/user/biomaterials"/>
     1300    <mkdir dir="${docbook.html.out}/user/experiments"/>
    12921301    <mkdir dir="${docbook.html.out}/faq" />
    12931302    <mkdir dir="${docbook.html.out}/appendix" />

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

    r5738 r5782  
    2525-->
    2626<part id="admin">
    27   <?dbhtml dir="admin"?>
     27  <?dbhtml dir="admin" filename="index.html" ?>
    2828  <title>Admin documentation</title>
    2929  <include file="installation.xml"/>

  • trunk/doc/src/docbook/appendix/base.config.xml

    r5738 r5782  
    2626
    2727<appendix id="appendix.base.config">
     28  <?dbhtml filename="base.config.html" ?>
    2829 
    2930  <title>base.config reference</title>

  • trunk/doc/src/docbook/appendix/basefile.xml

    r5244 r5782  
    2626
    2727<sect1 id="appendix.fileformats.basefile">
     28  <?dbhtml filename="basefile.html" ?>
    2829  <title>The BASEfile format</title>
    2930 

  • trunk/doc/src/docbook/appendix/bfs.xml

    r5319 r5782  
    2525-->
    2626<sect1 id="appendix.fileformats.bfs" >
     27  <?dbhtml filename="bfs.html" ?>
    2728  <title>The BFS (BASE File Set) format</title>
    2829 

  • trunk/doc/src/docbook/appendix/coreplugins.xml

    r5035 r5782  
    2727
    2828<appendix id="appendix.coreplugins">
     29  <?dbhtml filename="coreplugins.html" ?>
    2930  <title>Core plug-ins shipped with BASE</title>
    3031

  • trunk/doc/src/docbook/appendix/extended_properties.xml

    r5678 r5782  
    2626
    2727<appendix id="appendix.extendedproperties">
     28  <?dbhtml filename="extendedproperties.html" ?>
    2829  <title>extended-properties.xml reference</title>
    2930 

  • trunk/doc/src/docbook/appendix/fileformats.xml

    r5244 r5782  
    2525-->
    2626<appendix id="appendix.fileformats" chunked="1">
     27  <?dbhtml filename="fileformats.html" ?>
    2728  <title>File formats</title>
    2829  <include file="bfs.xml" />

  • trunk/doc/src/docbook/appendix/incompatible.xml

    r5780 r5782  
    2626
    2727<appendix id="appendix.incompatible">
     28  <?dbhtml filename="incompatible.html" ?>
    2829  <title>API changes that may affect backwards compatibility</title>
    2930  <para>

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

    r5677 r5782  
    2525-->
    2626<part id="appendix">
    27   <?dbhtml dir="appendix"?>
     27  <?dbhtml dir="appendix" filename="index.html" ?>
    2828  <title>Appendix</title>
    2929  <include file="coreplugins.xml" />

  • trunk/doc/src/docbook/appendix/jobagent.properties.xml

    r5448 r5782  
    2626
    2727<appendix id="appendix.jobagent.properties">
     28  <?dbhtml filename="jobagent.properties.html" ?>
    2829  <title>jobagent.properties reference</title>
    2930 

  • trunk/doc/src/docbook/appendix/jobagent.sh.xml

    r5678 r5782  
    2626
    2727<appendix id="appendix.jobagent.sh">
     28  <?dbhtml filename="jobagent.sh.html" ?>
    2829  <title>jobagent.sh reference</title>
    2930

  • trunk/doc/src/docbook/appendix/other_config.xml

    r5678 r5782  
    2626
    2727<appendix id="appendix.otherconfig">
     28  <?dbhtml filename="otherconfig.html" ?>
    2829  <title>Other configuration files</title>
    2930

  • trunk/doc/src/docbook/appendix/raw_data_types.xml

    r5780 r5782  
    2626
    2727<appendix id="appendix.rawdatatypes">
     28  <?dbhtml filename="rawdatatypes.html" ?>
    2829  <title>Platforms and raw-data-types.xml reference</title>
    2930 

  • trunk/doc/src/docbook/appendix/update_warnings.xml

    r5738 r5782  
    2626
    2727<appendix id="appendix.update_warnings">
     28  <?dbhtml filename="updatewarnings.html" ?>
    2829  <title>Things to consider when updating an existing BASE installation</title>
    2930  <para>

  • trunk/doc/src/docbook/appendix/web.xml.xml

    r5737 r5782  
    2727
    2828<appendix id="appendix.web.xml">
     29  <?dbhtml filename="web.xml.html" ?>
    2930  <title>web.xml reference</title>
    3031  <para>

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

    r5781 r5782  
    2626
    2727<chapter id="base_api">
     28  <?dbhtml dir="api" filename="index.html" ?>
    2829  <title>The BASE API</title>
    2930
    3031  <sect1 id="base_api.public">
     32    <?dbhtml filename="public_api.html" ?>
    3133    <title>The Public API of BASE</title>
    3234   
    … …  
    158160
    159161  <sect1 id="base_api.data" chunked="1">
     162    <?dbhtml filename="data_api.html" ?>
    160163    <title>The Data Layer API</title>
    161164
    … …  
    25382541 
    25392542  <sect1 id="base_api.core" chunked="1">
     2543    <?dbhtml filename="core_api.html" ?>
    25402544    <title>The Core API</title>
    25412545   
    … …  
    32153219
    32163220  <sect1 id="core_api.query">
     3221    <?dbhtml filename="query_api.html" ?>
    32173222    <title>The Query API</title>
    32183223    <para>
    … …  
    32253230 
    32263231  <sect1 id="core_api.dynamic">
     3232    <?dbhtml filename="dynamic_api.html" ?>
    32273233    <title>The Dynamic API</title>
    32283234    <para>
    … …  
    32343240
    32353241  <sect1 id="core_api.extensions">
     3242    <?dbhtml filename="extensions_api.html" ?>
    32363243    <title>The Extensions API</title>
    32373244   
    … …  
    35443551  </sect1>
    35453552
    3546   <sect1 id="core_api.other">
     3553  <sect1 id="base_api.other">
    35473554    <title>Other useful classes and methods</title>
    35483555    <para>

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

    r5781 r5782  
    2626
    2727<chapter id="documentation">
     28  <?dbhtml dir="documentation" filename="index.html" ?>
    2829  <title>Write documentation</title>
    2930
    3031  <sect1 id="documentation.docbook">
     32    <?dbhtml filename="docbook.html" ?>
    3133    <title>User, administrator and developer documentation with Docbook</title>
    3234
    … …  
    13121314 
    13131315  <sect1 id="documentation.magicdraw">
     1316    <?dbhtml filename="magicdraw.html" ?>
    13141317    <title>Create UML diagrams with MagicDraw</title>
    13151318
    … …  
    17851788 
    17861789  <sect1 id="documentation.javadoc">
     1790    <?dbhtml filename="javadoc.html" ?>
    17871791    <title>Javadoc</title>
    17881792

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

    r5781 r5782  
    2626
    2727<chapter id="extensions_developer">
     28  <?dbhtml dir="extensions" filename="index.html" ?>
    2829  <title>Extensions developer</title>
    2930
    3031  <sect1 id="extensions_developer.overview">
     32    <?dbhtml filename="overview.html" ?>
    3133    <title>Overview</title>
    3234    <para>
    … …  
    224226 
    225227  <sect1 id="extensions_developer.helloworld">
     228    <?dbhtml filename="helloworld.html" ?>
    226229    <title>Hello world as an extension</title>
    227230   
    … …  
    408411
    409412  <sect1 id="extensions_developer.factories">
     413    <?dbhtml filename="factories.html" ?>
    410414    <title>Custom action factories</title>
    411415
    … …  
    688692
    689693  <sect1 id="extensions_developer.resources">
     694    <?dbhtml filename="resources.html" ?>
    690695    <title>Custom images, JSP files, and other resources</title>
    691696
    … …  
    920925 
    921926  <sect1 id="extensions_developer.renderer">
     927    <?dbhtml filename="renderer.html" ?>
    922928    <title>Custom renderers and renderer factories</title>
    923929
    … …  
    10481054 
    10491055  <sect1 id="extensions_developer.extension_points">
     1056    <?dbhtml filename="extensionpoints.html" ?>
    10501057    <title>Extension points</title>
    10511058   
    … …  
    12931300 
    12941301  <sect1 id="extensions_developer.servlets">
     1302    <?dbhtml filename="servlets.html" ?>
    12951303    <title>Custom servlets</title>
    12961304    <para>
    … …  
    14631471 
    14641472  <sect1 id="extensions_developer.base_extension_points">
     1473    <?dbhtml filename="builtin.html" ?>
    14651474    <title>Extension points defined by BASE</title>
    14661475   

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

    r5781 r5782  
    2424  along with BASE. If not, see <http://www.gnu.org/licenses/>.
    2525-->
    26 <part id="developerdoc">
    27   <?dbhtml dir="developer"?>
     26<part id="developer">
     27  <?dbhtml dir="developer" filename="index.html" ?>
    2828  <title>Developer documentation</title>
    2929  <include file="migrate_2_3.xml" />
    3030  <include file="overview.xml"/>
    31   <include file="plugin_developer.xml"/>
     31  <include file="plugins.xml"/>
    3232  <include file="extensions.xml" />
    3333  <include file="webservices.xml"/>

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

    r5758 r5782  
    2525-->
    2626<chapter id="migrate_2_3" chunked="0">
     27  <?dbhtml filename="migrate.html" ?>
    2728  <title>Migrating code from BASE 2 to BASE 3</title>
    2829

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

    r5781 r5782  
    2626
    2727<chapter id="developer.overview" chunked="0">
     28  <?dbhtml filename="overview.html" ?>
    2829  <title>Developer overview of BASE</title>
    2930

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

    r5781 r5782  
    2626
    2727<chapter id="plugin_developer">
     28  <?dbhtml dir="plugins" filename="index.html" ?>
    2829  <title>Plug-in developer</title>
    2930  <sect1 id="plugin_developer.organize">
     31    <?dbhtml filename="organize.html" ?>
    3032    <title>How to organize your plug-in project</title>
    3133   
    … …  
    310312
    311313  <sect1 id="plugin_developer.api">
     314    <?dbhtml filename="api.html" ?>
    312315    <title>The Plug-in API</title>
    313316    <para>
    … …  
    18881891
    18891892  <sect1 id="plugin_developer.import">
     1893    <?dbhtml filename="import.html" ?>
    18901894    <title>Import plug-ins</title>
    18911895
    … …  
    26092613
    26102614  <sect1 id="plugin_developer.export">
     2615    <?dbhtml filename="export.html" ?>
    26112616    <title>Export plug-ins</title>
    26122617   
    … …  
    29902995 
    29912996  <sect1 id="plugin_developer.analyse">
     2997    <?dbhtml filename="analysis.html" ?>
    29922998    <title>Analysis plug-ins</title>
    29932999    <para>
    … …  
    32903296 
    32913297  <sect1 id="plugin_developer.other">
     3298    <?dbhtml filename="other.html" ?>
    32923299    <title>Other plug-ins</title>
    3293     <para></para>
    32943300   
    32953301    <sect2 id="plugin_developer.other.authentication">
    … …  
    44204426 
    44214427  <sect1 id="plugin_developer.signals">
     4428    <?dbhtml filename="signals.html" ?>
    44224429    <title>Enable support for aborting a running a plug-in</title>
    44234430   
    … …  
    45324539 
    45334540  <sect1 id="plugin_developer.classload">
     4541    <?dbhtml filename="classloading.html" ?>
    45344542    <title>How BASE load plug-in classes</title>
    45354543   
    … …  
    46784686 
    46794687  <sect1 id="plugin_developer.example">
     4688    <?dbhtml filename="examples.html" ?>
    46804689    <title>Example plug-ins (with download)</title>
    46814690    <para>

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

    r5738 r5782  
    2525-->
    2626
    27 <chapter id="webservices">
     27<chapter id="webservices" chunked="0">
     28  <?dbhtml filename="webservices.html" ?>
    2829  <title>Web services</title>
    2930  <para>

  • trunk/doc/src/docbook/faq/faqs.xml

    r5738 r5782  
    2727
    2828<part id="faqsdoc">
    29   <?dbhtml dir="faq"?>
     29  <?dbhtml dir="faq" filename="index.html" ?>
    3030  <title>FAQ</title>
    3131
    3232  <chapter id="faqs" chunked="0">
     33    <?dbhtml filename="faq.html" ?>
    3334    <title>Frequently Asked Questions with answers</title>
    3435

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

    r5738 r5782  
    2727
    2828<chapter id="features" chunked="0">
     29  <?dbhtml filename="features.html"?>
    2930  <title>BASE features</title>
    3031

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

    r5738 r5782  
    2626-->
    2727<part id="overviewdoc">
    28   <?dbhtml dir="overview"?>
     28  <?dbhtml filename="overview.html"?>
    2929  <title>Overview</title>
    3030
    … …  
    4444  <include file="why_base.xml"/>
    4545  <include file="features.xml"/>
    46   <include file="base_overview.xml"/>
    4746  <include file="resources.xml"/>
    4847</part>

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

    r5738 r5782  
    2626
    2727<chapter id="resources" chunked="0">
     28  <?dbhtml filename="resources.html"?>
    2829  <title>Resources</title>
    2930  <para>

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

    r5738 r5782  
    2525-->
    2626
    27 <chapter id="why_base">
     27<chapter id="why_base" chunked="0">
     28  <?dbhtml filename="why_base.html"?>
    2829  <title>Why use BASE</title>
    2930    <sect1 id="nolabelhereyet">

  • trunk/doc/src/docbook/user/annotations.xml

    r5738 r5782  
    2626
    2727<chapter id="annotations">
     28  <?dbhtml dir="annotations" filename="index.html" ?>
     29 
    2830  <title>Annotations</title>
    2931 
    3032  <sect1 id="annotations.types">
     33    <?dbhtml filename="types.html" ?>
    3134    <title>Annotation Types</title>
    3235
    … …  
    542545 
    543546  <sect1 id="annotations.categories">
     547    <?dbhtml filename="categories.html" ?>
    544548    <title>Annotation type categories</title>
    545549   
    … …  
    600604
    601605  <sect1 id="annotations.annotating">
     606    <?dbhtml filename="annotating.html" ?>
    602607    <title>Annotating items</title>
    603608   

  • trunk/doc/src/docbook/user/biomaterials.xml

    r5738 r5782  
    2626-->
    2727<chapter id="biomaterials">
     28  <?dbhtml dir="biomaterials" filename="index.html" ?>
     29
    2830  <title>Biomaterial</title>
    2931  <sect1 id="biomaterial.introduction">
     32    <?dbhtml filename="introduction.html" ?>
    3033    <title>Introduction</title>
    3134    <para>
    … …  
    7881 
    7982  <sect1 id="biomaterials.biosources">
     83    <?dbhtml filename="biosources.html" ?>
    8084    <title>Biosources</title>
    8185
    … …  
    166170  </sect1>
    167171  <sect1 id="biomaterial.samples">
     172    <?dbhtml filename="samples.html" ?>
    168173    <title>Samples</title>
    169174    <para>
    … …  
    440445
    441446  <sect1 id="biomaterials.extracts">
     447    <?dbhtml filename="extracts.html" ?>
    442448    <title>Extracts</title>
    443449    <para>
    … …  
    736742
    737743  <sect1 id="biomaterials.tags">
     744    <?dbhtml filename="tags.html" ?>
    738745    <title>Tags</title>
    739746    <para>
    … …  
    809816 
    810817  <sect1 id="biomaterials.bioplates">
     818    <?dbhtml filename="bioplates.html" ?>
    811819    <title>Bioplates</title>
    812820    <para>
    … …  
    16241632 
    16251633  <sect1 id="biomaterials.lists">
     1634    <?dbhtml filename="lists.html" ?>
    16261635    <title>Biomaterial lists</title>
    16271636   
    … …  
    16331642
    16341643  <sect1 id="biomaterials.bioassays">
     1644    <?dbhtml filename="bioassays.html" ?>
    16351645    <title>Physical bioassays</title>
    16361646    <para>

  • trunk/doc/src/docbook/user/experiments_analysis.xml

    r5738 r5782  
    2626
    2727<chapter id="experiments_analysis">
     28  <?dbhtml dir="experiments" filename="index.html" ?>
     29
    2830  <title>Experiments and analysis</title>
    2931  <include file="scans_images.xml"/>

  • trunk/doc/src/docbook/user/file_system.xml

    r5738 r5782  
    2626
    2727<chapter id="file_system">
     28  <?dbhtml dir="files" filename="index.html" ?>
    2829  <title>File management</title>
    2930  <sect1 id="file_system.system">
     31    <?dbhtml filename="filesystem.html" ?>
    3032    <title>File system</title>
    3133    <para>
    … …  
    222224
    223225  <sect1 id="file_system.handling">
     226    <?dbhtml filename="files.html" ?>
    224227    <title>Handling files</title>
    225228   

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

    r5738 r5782  
    2525-->
    2626<part id="user">
    27   <?dbhtml dir="user"?>
     27  <?dbhtml dir="user" filename="index.html" ?>
    2828  <title>User documentation</title>
    2929  <include file="overview.xml"/>

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

    r5738 r5782  
    2626
    2727<chapter id="userdoc_overview" chunked="0">
     28  <?dbhtml filename="overview.html" ?>
     29
    2830  <title>Overview of user documentation</title>
    2931  <para> The 'User documentation' part is quite extensive and covers everything from how to Log in on

  • trunk/doc/src/docbook/user/project_permission.xml

    r5738 r5782  
    2626
    2727<chapter id="project_permission">
     28  <?dbhtml dir="projects" filename="index.html" ?>
    2829  <title>Projects and the permission system</title>
    2930    <sect1 id="project_permission.permissions">
     31      <?dbhtml filename="permissions.html" ?>
    3032      <title>The permission system</title>
    3133      <para>
    … …  
    284286   
    285287    <sect1 id="project_permission.projects">
     288      <?dbhtml filename="projects.html" ?>
    286289   
    287290      <title>Projects</title>
    … …  
    770773   
    771774    <sect1 id="project_permission.templates">
     775      <?dbhtml filename="templates.html" ?>
    772776      <title>Permission templates</title>
    773777   

  • trunk/doc/src/docbook/user/webclient.xml

    r5738 r5782  
    2626
    2727<chapter id="webclient">
     28  <?dbhtml dir="webclient" filename="index.html" ?>
    2829  <title>Using the web client</title>
    2930    <sect1 id="webclient.introduction">
     31      <?dbhtml filename="introduction.html" ?>
    3032      <title>Introduction</title>
    3133     
    … …  
    364366   
    365367    <sect1 id="webclient.configuration">
     368      <?dbhtml filename="configuration.html" ?>
    366369      <title>Configuring your account</title>
    367370     
    … …  
    955958   
    956959    <sect1 id="webclient.items">
     960      <?dbhtml filename="items.html" ?>
    957961      <title>Working with items</title>
    958962     
    … …  
    14901494   
    14911495    <sect1 id="webclient.itemlist">
     1496      <?dbhtml filename="lists.html" ?>
    14921497      <title>Listing items</title>
    14931498     
    … …  
    21572162
    21582163    <sect1 id="webclient.trashcan">
     2164      <?dbhtml filename="trashcan.html" ?>
    21592165      <title>Trashcan</title>
    21602166      <para>
    … …  
    22782284   
    22792285  <sect1 id="webclient.itemoverview">
     2286    <?dbhtml filename="itemoverview.html" ?>
    22802287    <title>Item overview</title>
    22812288
Note: See TracChangeset for help on using the changeset viewer.