Difference between revisions of "Developer notes"
Line 71: | Line 71: | ||
[[Category:Developer documentation]] | [[Category:Developer documentation]] | ||
[[Category:Development (Web Dev)]] | [[Category:Development (Web Dev)]] | ||
+ | [[Category:Development General (Web Dev)]] |
Revision as of 15:37, 19 June 2014
Contents
Common Model Elements
(These are now all object attributes supplied by WormBase::API::Role::Object. Please see the docs therein for their use).
A number of elements are repeated across the AceDB schema. To make the external model easier to maintain, fetching and parsing of these elements is stored in one place and accessible to all models. All external models automatically inherit the following:
Expected AceDB model tag | Object.pm method | config field | template macro |
---|---|---|---|
Laboratory | laboratory() | "fields laboratory" | laboratory |
"Name" (indirect, returns name and ID of object) | name() | "fields name" | name |
"Common" (indirect, returns the public name of an object if one exists) | common_name() | "fields common_name" | common_name |
Other_name | other_names() | "fields other_names" | other_names |
Description | description() | "fields description" | description |
Status | status() | "fields status" | status |
Remarks | remarks() | "fields remarks" | remarks |
Species | taxonomy() | "fields taxonomy" | taxonomy |
Here's how to use them.
1. Be certain to add the appropriate configuration to wormbase.conf (eg "fields remarks") to make the data accessible in your template.
2. Add stub documentation in your model for the shared field. (THIS STEP SUBJECT TO CHANGE)
3. In the appropriate template, include the macro. Some macros take optional parameters.
[% remarks %]
File paths
It's important to be consistent with where we place things on the filesystem since it makes it easier to find things, and easier to handle proxy redirects. Here are some rough guidelines.
Static content
html/ - All static content (and only static content) belongs in html/. html/js - javascript files. Create subdirectories as necessary html/css - stylesheets (see below)
Temporary images and files
/tmp /var/tmp
Temporary files should be placed outside of the document root. This includes any files that need to expire at the end of a given release cycle.
Images
CSS
Please consolidate style information into one of the existing stylesheets or creat a new one if necessary. Please try to avoid using style information inline in a document.
Handling Common Issues
Creating a simple list of items? (Note: this approach isn't consistently used throughout the model or templates)
Model:
$items = $self->_pack_objects($object->$tag); # Returns a hash of packed objects. return { data => %$items ? $items : undef };
Template link_objects(fields.FIELD.data); # Sorts then links a hash of packed objects
Constants
Constants should be defined in conf/elegans.pm.