Difference between revisions of "Training Video:Subject Trees"
(Updated link to import_subjects API page) |
|||
(3 intermediate revisions by 2 users not shown) | |||
Line 4: | Line 4: | ||
==Introduction== | ==Introduction== | ||
− | + | This video shows you how to manipulate subject trees in EPrints. Subject trees allow you to browse by hierarchies, such as subjects and departments. | |
− | ==Video== | + | ==What You Will Learn== |
+ | |||
+ | * How to change display names of subject trees | ||
+ | * How to add a new node to a tree | ||
+ | * How to make bulk changes to subject files | ||
+ | * How to import a subject file | ||
+ | * How to export a subject tree | ||
+ | |||
+ | ==What You Should Already Know== | ||
+ | |||
+ | * How to use the EPrints Admin interface | ||
+ | * Basic use of command line interface to run EPrints commands | ||
+ | |||
+ | == Resources == | ||
+ | === Video=== | ||
+ | The Video can be found at http://www.youtube.com/watch?v=1rYT9krerxM. | ||
+ | ====Index==== | ||
+ | * [http://youtu.be/1rYT9krerxM 0:00 Introduction] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=0m22s 0:22 Browsing by subject and divisions] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=0m50s 0:50 Subject trees in the deposit workflow] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=1m43s 1:43 Change name of subject tree] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=2m45s 2:45 Properties of a subject] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=3m55s 3:55 Verifying change in the workflow] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=4m05s 4:05 Adding a new department to the divisions tree] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=5m51s 5:51 Verifying change in the workflow] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=6m40s 6:40 Description of subject tree import format] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=8m14s 8:14 Creation of new tree in the subjects file] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=14m02s 14:02 Importing subjects file] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=14m40s 14:40 Verifying change in the workflow] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=15m09s 15:09 Exporting the subject tree] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=16m14s 16:14 Listing export options] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=16m50s 16:50 XML export] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=17m15s 17:15 Fixing bug in exporter] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=17m55s 17:55 Exporting in subject format, writing to a file] | ||
+ | * [http://youtu.be/1rYT9krerxM?t=18m06s 18:06 Reordering subjects file to be more editable] | ||
+ | |||
+ | ==== The Video==== | ||
<youtube>1rYT9krerxM</youtube> | <youtube>1rYT9krerxM</youtube> | ||
− | ==Notes== | + | ====Notes, Errata and Additional Information==== |
+ | |||
+ | Any notes, version information, errata, etc concerned with this video | ||
+ | |||
+ | * EPrints 3.3.14 | ||
+ | * Ubuntu 15.04 | ||
+ | |||
+ | ==Test Yourself== | ||
+ | |||
+ | Use the admin interface to edit a subject | ||
+ | |||
+ | Create a subject tree in the basic text format, e.g.: | ||
+ | |||
+ | subjects:Name of Subject Tree:ROOT:0 | ||
+ | subjA:First Subject Name:subjects:0 | ||
+ | childA1:First Child Subject A:subjA:1 | ||
+ | subjB:Second Subject Name:subjects:0 | ||
+ | childB1:First Child Subject B:subjB:1 | ||
+ | childB2:Second Child Subject B:subjB:1 | ||
+ | subjC:Third Subject Name:subjects:0 | ||
+ | childC1:First Child Subject C:subjC:1 | ||
+ | |||
+ | Import this into the archive using the command line tool bin/import_subjects | ||
+ | |||
+ | Now add a new tree to show the organisation structure. Remember the system names must be unique across all subject trees, e.g.: | ||
+ | |||
+ | divisions:Name of Department Tree:ROOT:0 | ||
+ | facA:Faculty A:divisions:0 | ||
+ | deptA1:Department A1:facA:1 | ||
+ | facB:Faculty B:divisions:0 | ||
+ | deptB1:Department B1:facB:1 | ||
+ | facC:Faculty C:divisions:0 | ||
+ | deptC1:Department C1:facC:1 | ||
+ | deptC2:Department C2:facC:1 | ||
+ | |||
+ | Import this into the archive using the command line tool | ||
+ | |||
+ | Change the name of one of your new subjects using the admin interface | ||
+ | |||
+ | Now export that tree using the commandline tool bin/export [archivename] subject Subject | ||
+ | |||
+ | ==More Reading== | ||
+ | |||
+ | * [[API:bin/import_subjects|Importing Subjects on the command line]] |
Latest revision as of 12:08, 28 January 2022
Contents
Introduction
This video shows you how to manipulate subject trees in EPrints. Subject trees allow you to browse by hierarchies, such as subjects and departments.
What You Will Learn
- How to change display names of subject trees
- How to add a new node to a tree
- How to make bulk changes to subject files
- How to import a subject file
- How to export a subject tree
What You Should Already Know
- How to use the EPrints Admin interface
- Basic use of command line interface to run EPrints commands
Resources
Video
The Video can be found at http://www.youtube.com/watch?v=1rYT9krerxM.
Index
- 0:00 Introduction
- 0:22 Browsing by subject and divisions
- 0:50 Subject trees in the deposit workflow
- 1:43 Change name of subject tree
- 2:45 Properties of a subject
- 3:55 Verifying change in the workflow
- 4:05 Adding a new department to the divisions tree
- 5:51 Verifying change in the workflow
- 6:40 Description of subject tree import format
- 8:14 Creation of new tree in the subjects file
- 14:02 Importing subjects file
- 14:40 Verifying change in the workflow
- 15:09 Exporting the subject tree
- 16:14 Listing export options
- 16:50 XML export
- 17:15 Fixing bug in exporter
- 17:55 Exporting in subject format, writing to a file
- 18:06 Reordering subjects file to be more editable
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
Use the admin interface to edit a subject
Create a subject tree in the basic text format, e.g.:
subjects:Name of Subject Tree:ROOT:0 subjA:First Subject Name:subjects:0 childA1:First Child Subject A:subjA:1 subjB:Second Subject Name:subjects:0 childB1:First Child Subject B:subjB:1 childB2:Second Child Subject B:subjB:1 subjC:Third Subject Name:subjects:0 childC1:First Child Subject C:subjC:1
Import this into the archive using the command line tool bin/import_subjects
Now add a new tree to show the organisation structure. Remember the system names must be unique across all subject trees, e.g.:
divisions:Name of Department Tree:ROOT:0 facA:Faculty A:divisions:0 deptA1:Department A1:facA:1 facB:Faculty B:divisions:0 deptB1:Department B1:facB:1 facC:Faculty C:divisions:0 deptC1:Department C1:facC:1 deptC2:Department C2:facC:1
Import this into the archive using the command line tool
Change the name of one of your new subjects using the admin interface
Now export that tree using the commandline tool bin/export [archivename] subject Subject