Difference between revisions of "Bioscape Web Resources"

From irefindex
(A description of the bsweb package organisation.)
 
m (Changed formatting of tables.)
Line 1: Line 1:
 
The Bioscape Web resources provide the principal end-user interface to Bioscape as described in the [[Using the Bioscape Web Application|"Using the Bioscape Web Application"]] document. Typically, a user will follow a specific workflow supported by a number of resources described in the application's "site map", found in the <tt>bsweb</tt> package (specifically in the <tt>__init__.py</tt> source file) in the <tt>bsweb</tt> distribution. The following table summarises the source code organisation:
 
The Bioscape Web resources provide the principal end-user interface to Bioscape as described in the [[Using the Bioscape Web Application|"Using the Bioscape Web Application"]] document. Typically, a user will follow a specific workflow supported by a number of resources described in the application's "site map", found in the <tt>bsweb</tt> package (specifically in the <tt>__init__.py</tt> source file) in the <tt>bsweb</tt> distribution. The following table summarises the source code organisation:
  
{| border="1" cellspacing="0" cellpadding="5" style="margin: 2em"
+
{| cellspacing="0" cellpadding="5" style="border: 1px solid #000000; margin: 1em"
 
! Pages
 
! Pages
 
! Logic package/module
 
! Logic package/module

Revision as of 17:30, 20 October 2009

The Bioscape Web resources provide the principal end-user interface to Bioscape as described in the "Using the Bioscape Web Application" document. Typically, a user will follow a specific workflow supported by a number of resources described in the application's "site map", found in the bsweb package (specifically in the __init__.py source file) in the bsweb distribution. The following table summarises the source code organisation:

Pages Logic package/module Database access package/module
home (search), index (advanced search) bsweb.pages bsweb.pages.collections
gene disambiguation, gene summary bsweb.genes bsweb.genes.collections
gene and evidence mention summaries bsweb.documents bsweb.documents.viewers
document lists bsweb.documents bsweb.documents.collections
annotated documents bsweb.documents bsweb.documents.viewers
mention scoring summaries bsweb.documents bsweb.documents.collections

To summarise, page functionality typically resides in the top-level of a package, database queries providing lists of results reside in collections modules, and the special database/text index combination supporting annotated documents resides in the viewers module in the bsweb.documents package.