Changes between Version 2 and Version 3 of Atom Editor Overview


Ignore:
Timestamp:
28/11/08 10:37:06 (11 years ago)
Author:
cbyrom
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Atom Editor Overview

    v2 v3  
    77== Codebase overview == 
    88 
    9 The editor is created as part of a standard pylons web app - which makes up the heart of the MILK codebase.  To simplify maintenance, the editor specific code is situated in subpackages of the main pylons packages - i.e. controllers/atom_editor.  The presentation layer of the web app is provided using Genshi templates - and these, too, are located in their own specific subpackage - templates/atom_editor.  The data models used by the pages (effectively the Atom? class augmented with 'non-Atom' specific data in the MolesEntity class) are available from the ndgUtils egg (subject to change?). 
     9The editor is created as part of a standard pylons web app - which makes up the heart of the MILK codebase.  To simplify maintenance, the editor specific code is situated in subpackages of the main pylons packages - i.e. controllers/atom_editor.  The presentation layer of the web app is provided using Genshi templates - and these, too, are located in their own specific subpackage - templates/atom_editor.  The data models used by the pages (effectively the Atom? class augmented with 'non-Atom' specific data in the MolesEntity class) are available from the ndgUtils egg (subject to change?).  The validation helper class is also available from ndgUtils. 
     10 
     11The two main controllers are as follows: 
     12 
     13=== listatom.py === 
     14 
     15Provides functionality to render: 
     16 
     17 * atom editor home page - with the following links: 
     18   * create a new atom 
     19   * upload a granulite to create a new atom 
     20   * edit/list atoms 
     21 
     22 * edit/list atoms - allows searching of atoms by provider ID/type/text content.  NB, this is also used when associated atoms with each other - e.g. when selecting data granules to associate with data entities. 
     23 
     24The associated templates are: 
     25 
     26 * atom_home.html 
     27 * atom_granulator.html 
     28 * atom_list.html 
     29 
     30=== editatom.py === 
     31 
     32Provides functionality to render: 
     33 
     34 * create atom page - to create a new atom by specifying the basic header info: provider ID, type and title 
     35 * create atom from granulite page - to allow upload of granulite file with CSML/CDML file - and subsequent creation of granule atom 
     36 * view/edit atom data page 
    1037 
    1138 
     39== Tests == 
    1240 
     41== TODO ==