Difference between revisions of "GeneralizingCollex"

From ARC Wiki
Jump to navigation Jump to search
(New page: ==Nines Data Currently in Collex App/ Files== '''Controllers''' '''CollectionController''' TAG_INSTRUCTIONS = 'one-word keywords' ANNOTATION_INSTRUCTIONS = 'your annotat...)
 
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Nines Data Currently in Collex App/ Files==
+
Collex was designed to be easily generalized. The areas that need to be generalized are:
  
  '''Controllers'''
+
* References to NINES and my9s.
    '''CollectionController'''
+
* Stylesheets: divide the structural styles from the cosmetic styles.
      TAG_INSTRUCTIONS = 'one-word keywords'
+
* Images: segregate the NINES images from the general images.
      ANNOTATION_INSTRUCTIONS = 'your annotations'
+
* About pages, which can be easily customized through the Wordpress installations recommended when installing Collex.
    '''ExhibitedResourcesController'''
 
      resource.date_label_or_date ?
 
      resource.title ?
 
    '''LoginController'''
 
      specifies a redirect to "genre" in two places
 
    '''SidebarController'''
 
      TAG_INSTRUCTIONS = 'one-word keywords'
 
      ANNOTATION_INSTRUCTIONS = 'your annotations'
 
      NUM_VISIBLE_TAGS = 50
 
      NUM_VISIBLE_ITEMS = 5
 
 
 
  '''Helpers'''
 
    '''ApplicationHelper'''
 
      def cloud_list
 
        ["archive", "agent_facet", "year", "tag", "genre", "username"]
 
      end
 
      def facet_label(field)
 
        label = case field
 
          when "archive"        then "sites"
 
          when "roles", "agent","agent_facet" then "names"
 
          when "username"      then "peers"
 
          when "year"          then "dates"
 
          when "tag", "", nil          then "keywords"
 
        else field.pluralize
 
        end
 
        label = RELATORS[field].downcase if field =~ /role_[A-Z]{3}/
 
        label
 
      end
 
      item['title']: is assuming title on our solr objects OK?
 
    '''SidebarHelper'''
 
      def title_for(object)
 
        if(object.kind_of?(SolrResource))
 
          object.title.blank? ? "<untitled>" : object.title
 
        else
 
          object['title'].blank? ? "<untitled>" : object['title']
 
        end
 
      end
 
      items_list() has title, genre, role_
 
  
  '''Models'''
+
This page will be updated soon with details, specifically details about where to customize the Collex code and recommended deploys for generalized use. In the meantime, please visit the [https://github.com/collex GitHub repository] for the Collex software for more information.
    '''LoginMailer'''
 
      @from      = 'mailto:technologies@nines.org'
 
    '''PropertyMethods'''
 
      roles, agents, dates,
 
 
 
  '''Views'''
 
    '''collection'''
 
      collect.rhtml
 
        lots of references to Nines
 
    '''contributors'''
 
      new
 
        nines references
 
    '''exhibited_pages'''
 
      edit.rhtml
 
        creative commons url has parner 'nines': "http://creativecommons.org/license/?partner=Nines..."
 
    '''exhibits'''
 
      coming_soon.rhtml
 
        COMING SOON: Contribute to the NINES community! and other nines references
 
      intro.rhtml
 
        a bunch of nines-specific stuff
 
      new.rhtml
 
        the creative commons url has a partner 'nines': "http://creativecommons.org/license/?partner=Nines..."
 
    '''help'''
 
      all pages full of nines references
 
    '''layout'''
 
      admin.rhtml
 
        <title>NINES: <%=controller.controller_name %> / <%= controller.action_name %></title>
 
        <a href="http://www.patacriticism.org" target="_blank">Applied Research in Patacriticism</a>
 
      collex.rhtml
 
        "about us" link refers to Nines and header/layout in general is nines
 
      common.rhtml
 
        same as admin.rhtml
 
      popup.rhtml
 
        <a href="http://www.nines.org/" target="_blank">::&nbsp;learn&nbsp;more&nbsp;::</a>
 
    '''login'''
 
      login.rhtml
 
        reference to "Nines"
 
      reset_password.rhtml
 
        <a href="mailto:technologies@nines.org">let us know</a> and several other references to nines and nines help.
 
    '''search'''
 
      constraints.rhtml
 
        "No NINES objects fit your constraints."
 
      _facets.rhtml
 
        "genre" refs such as "genre" && value == "Citation"
 
        title="header=[genre] body=[browse by NINES genres]"
 
      _footer.rhtml
 
        nines refs
 
      _results.rhtml
 
        "genre" refs (and "archive")
 
        in general is would be specific to the nines data set
 
    '''sidebar'''
 
      atom.rhtml
 
        refs to "genre" and "nines"
 
      detail.rhtml
 
        lots of attribute refs like: "if @object.year or @object.agent or @object.genre"
 
    '''stats'''
 
      index.rhtml
 
        refers to genre (and archive)
 

Latest revision as of 22:08, 12 November 2013

Collex was designed to be easily generalized. The areas that need to be generalized are:

  • References to NINES and my9s.
  • Stylesheets: divide the structural styles from the cosmetic styles.
  • Images: segregate the NINES images from the general images.
  • About pages, which can be easily customized through the Wordpress installations recommended when installing Collex.

This page will be updated soon with details, specifically details about where to customize the Collex code and recommended deploys for generalized use. In the meantime, please visit the GitHub repository for the Collex software for more information.