Difference between revisions of "Training Video:Technical Orientation"

From EPrints Documentation
Jump to: navigation, search
(Index)
(Introduction)
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
 
==Introduction==
 
==Introduction==
  
Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?
+
This video will explain what EPrints configuration files are and where to find them.  It explains some of the most commonly changed files, and is an ideal start for working with EPrints at the back end.
  
 
==What You Will Learn==
 
==What You Will Learn==
  
* Learning Objective 1
+
* Where to find the main configuration files in EPrints using the command line
* Learning Objective 2
+
* How EPrints configuration files are structured
* Learning Objective 3
+
* How to make local changes safely
  
 
==What You Should Already Know==
 
==What You Should Already Know==
  
* Prerequisite 1 with links if appropriate
+
* Basic Linux command line interface
* Prerequisite 2 with links if appropriate
+
* EPrints as a user and admin
* Prerequisite 3 with links if appropriate
+
  
 
==Resources==
 
==Resources==
Line 22: Line 21:
 
=== Video===
 
=== Video===
 
The Video can be found at [http://youtu.be/-D4hEsRB0g4 http://youtu.be/-D4hEsRB0g4].
 
The Video can be found at [http://youtu.be/-D4hEsRB0g4 http://youtu.be/-D4hEsRB0g4].
 +
 
====Index====
 
====Index====
  
0:00 Introduction to the topics in the video
+
* [http://youtu.be/-D4hEsRB0g4?t=0m00s 0:00 Introduction to the topics in the video]
0:25 Where is EPrints installed? (Ubuntu / Debian style)
+
* [http://youtu.be/-D4hEsRB0g4?t=0m25s 0:25 Where is EPrints installed? (Ubuntu / Debian style)]
0:36 Using the Apache configuration file to find EPrints
+
* [http://youtu.be/-D4hEsRB0g4?t=0m36s 0:36 Using the Apache configuration file to find EPrints]
2:05 What is EPrints? (as a system)
+
* [http://youtu.be/-D4hEsRB0g4?t=2m05s 2:05 What is EPrints? (as a system)]
2:17 Finding the database (default file)
+
* [http://youtu.be/-D4hEsRB0g4?t=2m17s 2:17 Finding the database (default file)]
2:40 Checking for overrides to the default file
+
* [http://youtu.be/-D4hEsRB0g4?t=2m40s 2:40 Checking for overrides to the default file]
3:40 Looking at the database
+
* [http://youtu.be/-D4hEsRB0g4?t=3m40s 3:40 Looking at the database]
3:57 Listing tables in the database
+
* [http://youtu.be/-D4hEsRB0g4?t=3m57s 3:57 Listing tables in the database]
4:05 The EPrint table (non-multiple fields)
+
* [http://youtu.be/-D4hEsRB0g4?t=4m05s 4:05 The EPrint table (non-multiple fields)]
4:21 Finding tables holding multiple fields
+
* [http://youtu.be/-D4hEsRB0g4?t=4m21s 4:21 Finding tables holding multiple fields]
6:06 The cfg.d directory
+
* [http://youtu.be/-D4hEsRB0g4?t=6m06s 6:06 The cfg.d directory]
6:25 Simple and complex configurations
+
* [http://youtu.be/-D4hEsRB0g4?t=6m25s 6:25 Simple and complex configurations]
7:13 eprint_render.pl - changing abstract pages
+
* [http://youtu.be/-D4hEsRB0g4?t=7m13s 7:13 eprint_render.pl - changing abstract pages]
7:35 views.pl - changing browse views
+
* [http://youtu.be/-D4hEsRB0g4?t=7m35s 7:35 views.pl - changing browse views]
7:45 Best practice for customising configuration settings
+
* [http://youtu.be/-D4hEsRB0g4?t=7m45s 7:45 Best practice for customising configuration settings]
8:20 Adding a new field in a new configuration file
+
* [http://youtu.be/-D4hEsRB0g4?t=8m20s 8:20 Adding a new field in a new configuration file]
9:15 Using diff to check local configuration files against default configuration files
+
* [http://youtu.be/-D4hEsRB0g4?t=9m15s 9:15 Using diff to check local configuration files against default configuration files]
10:00 Benefits of using separate files when upgrading
+
* [http://youtu.be/-D4hEsRB0g4?t=10m00s 10:00 Benefits of using separate files when upgrading]
10:21 The /bin directory
+
* [http://youtu.be/-D4hEsRB0g4?t=10m21s 10:21 The /bin directory]
10:35 epadmin - some common functions
+
* [http://youtu.be/-D4hEsRB0g4?t=10m35s 10:35 epadmin - some common functions]
11:25 Default configuration files for a new archive
+
* [http://youtu.be/-D4hEsRB0g4?t=11m25s 11:25 Default configuration files for a new archive]
11:53 Global (all archives) settings in the /lib directory
+
* [http://youtu.be/-D4hEsRB0g4?t=11m53s 11:53 Global (all archives) settings in the /lib directory]
12:37 Overriding global configurations for an archive (Templates example)
+
* [http://youtu.be/-D4hEsRB0g4?t=12m37s 12:37 Overriding global configurations for an archive (Templates example)]
14:51 Reloading the repository to show changes
+
* [http://youtu.be/-D4hEsRB0g4?t=14m51s 14:51 Reloading the repository to show changes]
15:28 Making changes to phrases (displayed text)
+
* [http://youtu.be/-D4hEsRB0g4?t=15m28s 15:28 Making changes to phrases (displayed text)]
17:35 The /archives directory
+
* [http://youtu.be/-D4hEsRB0g4?t=17m35s 17:35 The /archives directory]
17:53 Inside an archive directory
+
* [http://youtu.be/-D4hEsRB0g4?t=17m53s 17:53 Inside an archive directory]
18:03 The archive /documents directory
+
* [http://youtu.be/-D4hEsRB0g4?t=18m03s 18:03 The archive /documents directory]
24:01 Finding the documents for a specific EPrint
+
* [http://youtu.be/-D4hEsRB0g4?t=24m01s 24:01 Finding the documents for a specific EPrint]
26:00 System generated documents (previews)
+
* [http://youtu.be/-D4hEsRB0g4?t=26m00s 26:00 System generated documents (previews)]
26:23 History of an EPrint - Revision files in the /revisions directory
+
* [http://youtu.be/-D4hEsRB0g4?t=26m23s 26:23 History of an EPrint - Revision files in the /revisions directory]
27:04 Static files in /html
+
* [http://youtu.be/-D4hEsRB0g4?t=27m04s 27:04 Static files in /html]
28:41 Static files in /cfg/lang/[en]/static and cfg/static
+
* [http://youtu.be/-D4hEsRB0g4?t=28m41s 28:41 Static files in /cfg/lang/[en]/static and cfg/static]
31:12 Running generate_static to refresh html pages (and --prune option to remove)
+
* [http://youtu.be/-D4hEsRB0g4?t=31m12s 31:12 Running generate_static to refresh html pages (and --prune option to remove)]
31:57 Citations - where to find them
+
* [http://youtu.be/-D4hEsRB0g4?t=31m57s 31:57 Citations - where to find them]
32:30 Plugins - where to find them
+
* [http://youtu.be/-D4hEsRB0g4?t=32m30s 32:30 Plugins - where to find them]
34:06 Plugins - where to create a directory for Archive-specific plugins
+
* [http://youtu.be/-D4hEsRB0g4?t=34m06s 34:06 Plugins - where to create a directory for Archive-specific plugins]
  
 
==== The Video====
 
==== The Video====
Line 79: Line 79:
  
 
* Find the name of the database in the default file.  Check it hasn't been overridden by another configuration file.
 
* Find the name of the database in the default file.  Check it hasn't been overridden by another configuration file.
 +
 +
* Find the cfg.d folder for an archive.  Compare it to the defaultcfg/cfg.d folder
 +
 +
* Create a static page in the /lang/en/static folder (or whichever language your archive is in)
 +
 +
* Change a phrase by adding a copy to the local.xml file.
  
 
==More Reading==
 
==More Reading==
  
* Wiki page 1
+
* For more details on specific configuration tasks, see the [[:Category:Training_Video|Training Course]] sections on Configuring EPrints and Maintaining and Developing EPrints.
* Wiki page 2
+
* Wiki page 3
+

Latest revision as of 16:31, 11 January 2016


Introduction

This video will explain what EPrints configuration files are and where to find them. It explains some of the most commonly changed files, and is an ideal start for working with EPrints at the back end.

What You Will Learn

  • Where to find the main configuration files in EPrints using the command line
  • How EPrints configuration files are structured
  • How to make local changes safely

What You Should Already Know

  • Basic Linux command line interface
  • EPrints as a user and admin

Resources

Video

The Video can be found at http://youtu.be/-D4hEsRB0g4.

Index

The Video

Notes, Errata and Additional Information

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

  • EPrints 3.3.14
  • Ubuntu 15.04

Test Yourself

Exercises as appropriate to allow the learner to practice the subject of the page.

  • Locate the home directory of your EPrints installation using Apache configuration files.
  • Find the name of the database in the default file. Check it hasn't been overridden by another configuration file.
  • Find the cfg.d folder for an archive. Compare it to the defaultcfg/cfg.d folder
  • Create a static page in the /lang/en/static folder (or whichever language your archive is in)
  • Change a phrase by adding a copy to the local.xml file.

More Reading

  • For more details on specific configuration tasks, see the Training Course sections on Configuring EPrints and Maintaining and Developing EPrints.