Difference between revisions of "Trianing Video:Browse View configuration"

From EPrints Documentation
Jump to: navigation, search
(Added text to intro and what you need to know / will learn. Added test Yourself and More Reading options)
 
(2 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
==Introduction==
 
==Introduction==
  
Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?
+
This video explains what the browse views are, how they are defined and how to define new views. It shows best practice ways to modify the default configuration and how to use the command line administration tools to optimise the performance of your server in creating and updating views.
  
 
==What You Will Learn==
 
==What You Will Learn==
  
* Learning Objective 1
+
* What a browse view is
* Learning Objective 2
+
* What are 'menu' and 'list' views
* Learning Objective 3
+
* How to create a new view
 +
* How to change the way menu and lists views are rendered
 +
* How to amend the default configuration without changing the existing config files
 +
* How to regenerate the views via the admin interface, the command line and via scheduled tasks
  
 
==What You Should Already Know==
 
==What You Should Already Know==
  
* Prerequisite 1 with links if appropriate
+
* Familiarity with the EPrints admin interface
* Prerequisite 2 with links if appropriate
+
* A basic understanding of PERL and how EPrints uses it
* Prerequisite 3 with links if appropriate
+
* Basic idea of how eprints uses configuration files
  
 
==Resources==
 
==Resources==
Line 26: Line 29:
 
The Video can be found at [http://youtu.be/Ap_u7_MCnhI http://youtu.be/Ap_u7_MCnhI].
 
The Video can be found at [http://youtu.be/Ap_u7_MCnhI http://youtu.be/Ap_u7_MCnhI].
 
====Index====
 
====Index====
 +
* [http://youtu.be/Ap_u7_MCnhI?t=0m00s 0:00 - What is a browse view]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=0m50s 0:50 - .include files (unbranded lists)]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=1m20s 1:20 - columns and pages on browse menus]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=1m50s 1:50 - configuration file overview (from front end)]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=2m50s 2:50 - multiple-menu views]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=3m30s 3:30 - value ranges on menus]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=4m24s 4:24 - variations on lists]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=4m47s 4:47 - hideempty]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=5m43s 5:43 - regenerating browse views]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=8m08s 8:08 - reloading the configuration]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=9m11s 9:11 - create new browse view (on the command line)]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=13m27s 13:27 - controlling columns on menus]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=13m48s 13:48 - reloading the configuration and refreshing the views (on the command line)]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=15m59s 15:59 - change rendering of browse list]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=16m20s 16:20 - creating render function]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=18m30s 18:30 - creating a DOM object]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=19m42s 19:42 - rendering an eprint with a custom citation style]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=20m30s 20:30 - generating just one view]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=21m35s 21:35 - running epadmin test]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=22m55s 22:55 - example of custom rendered browse view]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=24m13s 24:13 - set citation style on a view list]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=24m44s 24:44 - creating a citation style]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=26m50s 26:50 - optimising browse view generation]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=27m37s 27:37 - increasing the browse view timeout]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=28m08s 28:08 - max items parameter]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=28m40s 28:40 - finding documentation on the EPrints wiki]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=30m05s 30:05 - setting max_list_age and max_menu_age (witout modifying default configuration files)]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=32m10s 32:10 - modifying existing configuration with a loop]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=35m38s 35:38 - confirming properties are set]
 +
* [http://youtu.be/Ap_u7_MCnhI?t=37m35s 37:35 - nightly generation of single browse views]
  
 
==== The Video====
 
==== The Video====
Line 38: Line 71:
 
==Test Yourself==
 
==Test Yourself==
  
Exercises as appropriate to allow the learner to practice the subject of the page.
+
* Create a new view to show items by publication in 2 columns
 +
* Modify this view to show 3 columns
 +
* Create a render function to add some simple text to the list items
 +
* Modify the function to add the eprintid field to the list items
  
 
==More Reading==
 
==More Reading==
  
* Wiki page 1
+
* [[Adding_new_views | Adding New Views]]
* Wiki page 2
+
* [[Views.pl | The default views configuration ]]
* Wiki page 3
 

Latest revision as of 11:32, 27 November 2015


Introduction

This video explains what the browse views are, how they are defined and how to define new views. It shows best practice ways to modify the default configuration and how to use the command line administration tools to optimise the performance of your server in creating and updating views.

What You Will Learn

  • What a browse view is
  • What are 'menu' and 'list' views
  • How to create a new view
  • How to change the way menu and lists views are rendered
  • How to amend the default configuration without changing the existing config files
  • How to regenerate the views via the admin interface, the command line and via scheduled tasks

What You Should Already Know

  • Familiarity with the EPrints admin interface
  • A basic understanding of PERL and how EPrints uses it
  • Basic idea of how eprints uses configuration files

Resources

Each resource on this page (video, document, block of wiki text) should have a similar format to the Video section below.

Video

The Video can be found at http://youtu.be/Ap_u7_MCnhI.

Index

The Video

Notes, Errata and Additional Information

Any notes, version information, errata, etc concerned with this video

  • EPrints 3.3.14

Test Yourself

  • Create a new view to show items by publication in 2 columns
  • Modify this view to show 3 columns
  • Create a render function to add some simple text to the list items
  • Modify the function to add the eprintid field to the list items

More Reading