Skip to content

Sufia Dashboard Documentation

Kyle Lawhorn edited this page Oct 10, 2016 · 12 revisions

Dashboard Documentation and Breakdown

views and layout

sufia/config/locales/sufia.en.yml -

  • config for menu and icons;
  • including Dashboard
  • many mnore

Path:sufia/app/views/dashboard/…

Index.html.erb * <%= content_for :sidebar do %> <%= render current_user %> <% end %>

  • Render dashboard/_index_partials/contents
  • Render "dashboard/_index_partials/heading_greetings"
  • Render "dashboard/_index_partials/heading_actions"

index_partials/

  • contents.html.erb - layout for panels below heading (see headings_actions.html.rb)
  • heading_actions.html.erb - bootstrap row setup, layout of top rows (icons for Create Work, Create…)
  • heading_greetings.html.erb - set h1 dashboard title
  • proxy_rights.html.erb
  • **transfers.html.erb **

Differences between Catalog View and Dashboard features

As discussed, while similar, the Catalog and Dashboard are designed to be two entirely separate parts of the site filling two different functions. The Dashboard is for logged-in users to manage literally everything about their content in Scholar. This includes creating works/collections, and adding works to those collections.

List of features available from the Dashboard:

  • Easy access to view owned collections and works
  • Easy access to view and edit profile
  • Basic CRUD of database objects (Collections/Works, etc.)
  • Metadata of submitted items(how many works/collections, downloads from attached files, work views), followers of your profile, etc.
  • Notification centers for User Activity (User X has submitted/edited/deleted Work Y)
  • Proxy depositor management
  • Work ownership transfer management

The dashboard is only viewable to logged-in users and for the most part acts as the catalog would. The actual catalog view is the only way for non logged-in users to browse the content hosted on Scholar, so it would be inappropriate to integrate CRUD functionality there. We should strive to keep that functionality confined in the dashboard as the more appropriate location

Clone this wiki locally