1. PDF generated using the open source mwlib toolkit. See http://code.pediapress.com/ for more information. PDF generated at: Mon, 05 May 2014 09:31:20 CEST IR-GUIDE

2. Contents Articles Introduction 1 SUNScholar/Practical guidelines for starting an institutional repository (IR) 1 SUNScholar/Checklist 3 SUNScholar/Reference Architecture 5 SUNScholar/DSpace/Why Ubuntu Server 6 Step 1 10 SUNScholar/Guidelines/Step 1 10 SUNScholar/Open Access 11 SUNScholar/Repository Preservation 16 Step 2 18 SUNScholar/Guidelines/Step 2 18 Step 3 20 SUNScholar/Guidelines/Step 3 20 SUNScholar/Capacity Building/Digital Repository Systems Management 21 SUNScholar/Capacity Building/Digital Repository Content Management 24 Step 4 28 SUNScholar/Guidelines/Step 4 28 Step 5 30 SUNScholar/Guidelines/Step 5 30 SUNScholar/Install Ubuntu 31 SUNScholar/Prepare Ubuntu 32 SUNScholar/Install DSpace 32 Install DSpace/S04/3.2 32 Install DSpace/S04/1.8.2 37 Step 6 43 SUNScholar/Guidelines/Step 6 43 SUNScholar/Disaster Recovery/Backups/Client Setup 44 SUNScholar/Disaster Recovery/Backups/Server Setup 44 3. Step 7 47 SUNScholar/Guidelines/Step 7 47 Step 8 48 SUNScholar/Guidelines/Step 8 48 SUNScholar/Populating 49 Step 9 51 SUNScholar/Guidelines/Step 9 51 Step 10 52 SUNScholar/Guidelines/Step 10 52 Step 11 53 SUNScholar/Guidelines/Step 11 53 SUNScholar/Optimisations 53 Step 12 56 SUNScholar/Repository Information 56 XMLUI 60 SUNScholar/XMLUI Theme 60 SUNScholar/XMLUI Theme/Tutorial 60 SUNScholar/XMLUI Theme/Creation 66 SUNScholar/XMLUI Theme/Modify 68 SUNScholar/XMLUI Theme/Page Content 68 SUNScholar/XMLUI Theme/Page Structure 73 SUNScholar/XMLUI Theme/Language 78 SUNScholar/XMLUI Theme/Styling 80 Copyright 81 SUNScholar/Copyright 81 SUNScholar/Embargo 83 SUNScholar/Embargo Systems/3.2 85 SUNScholar/Embargo Systems/1.8.2 89 Customisation 92 SUNScholar/Customisation 92 SUNScholar/Theme 95 4. SUNScholar/JSPUI Theme 96 SUNScholar/Language 96 SUNScholar/Web Analytics 97 SUNScholar/Licences 98 SUNScholar/Browse Indexes 98 SUNScholar/Email Templates 100 SUNScholar/Item and Collection Permissions 100 SUNScholar/Community Management 102 SUNScholar/Harvesting 102 SUNScholar/SOLR Statistics 104 SUNScholar/Export and Import Artifacts 106 SUNScholar/Submission System 107 System Admin 108 SUNScholar/Upgrading 108 SUNScholar/Change Management 108 SUNScholar/Upgrading/DSpace/Release Notes/3.2 109 SUNScholar/Upgrading/Server Software 110 SUNScholar/Upgrading/Hardware/New Server 114 SUNScholar/Upgrading/Hardware/Add a New Disk 116 SUNScholar/User Management 119 SUNScholar/Rebuild DSpace 127 SUNScholar/Daily Admin 129 SUNScholar/Handle Server 130 SUNScholar/Internet Security 137 SUNScholar/Secure Internet Connections 138 SUNScholar/Firewall 152 References Article Sources and Contributors 155 Image Sources, Licenses and Contributors 157 Article Licenses License 158 5. 1 Introduction SUNScholar/Practical guidelines for starting an institutional repository (IR) Introduction The guidelines are targeted at academic institutions in developing countries world wide, who want to start an open access research repository and who want to know in detail what is required and how to do it step-by-step. This soup-to-nuts [1] overview may be particularly useful for those involved in the early stages of planning [2] for an institutional repository. The focus during development of the open system has been long term repository preservation, security, stability and interoperability on the internet. These guidelines are also an attempt to promote the use of a reference architecture as best practice, for the implementation of DSpace as a trusted institutional digital repository, as we did for our repository, SUNScholar (http://scholar.sun.ac.za). Considerations After quickly reading all of the steps below and then carefully building a test system, it should be possible to derive a business plan/model to solicit funding or prepare a fairly comprehensive initial capital expenditure foundation budget and then an implementation plan/schedule. It is assumed that the institution has internet access and is prepared to make provision for a production and two backup data centers [3] , in different geophysical locations, for the purposes of disaster recovery. It is also assumed that the institution is aware of the critical importance of data sovereignty [4] and repository preservation, especially in the light of the revelations about the American NSA [5] and the "takedown" campaign by Elsevier [6] . Step by step recommendations Step 1 - Open Access Policy and Repository Preservation Plan Step 2 - Marketing Friendly Persistent URL and Preservable Digital Objects Step 3 - Employ Repository Management Personnel Step 4 - Build Repository IT Infrastructure Step 5 - Install DSpace Repository Software Step 6 - Repository System Backup & Monitoring Step 7 - Repository Launch and Registration with Harvesters Step 8 - Capture Research Records and Submit Research Items Step 9 - Repository Self-Help and News Step 10 - Engage Research Partners Step 11 - Continuous System Improvement and Maintenance Step 12 - Repository Research, Support and Management Help Contacts 6. SUNScholar/Practical guidelines for starting an institutional repository (IR) 2 For open access advocacy and repository content management , please contact: Ina Smith: ?Subject=Libopedia%20Reference%20-%20Repository%20Content%20Management ismith@sun.ac.za [7] For repository preservation, repository interoperability and digitisation management, please contact: Wouter Klapwijk: ?Subject=Libopedia%20Reference%20-%20Repository%20Digital%20Preservation wklap@sun.ac.za [8] For repository systems management and errors/omissions/improvements regarding this wiki guide, please contact: Hilton Gibson: ?Subject=Libopedia%20Reference%20-%20Repository%20Systems%20Infrastructure hilton.gibson@gmail.com [9] Latest information for installations http://wiki.lib.sun.ac.za/index.php/SUNScholar/DSpace http://wiki.lib.sun.ac.za/index.php/SUNScholar/System_Admin http://wiki.lib.sun.ac.za/index.php/SUNScholar/Customisation http://wiki.lib.sun.ac.za/index.php/SUNScholar/Optimisations Use the online wiki when doing test/development/production/backup system installations because the wiki has the latest information. See the links above. Latest News http://lists.lib.sun.ac.za/mailman/listinfo/irtalk''' Printable PDF Book http://hdl.handle.net/10019.1/79321''' Shortened Web Link http://bit.ly/goodir References [1] http://en.wikipedia.org/wiki/Soup_to_nuts [2] https://wiki.duraspace.org/display/DSPACE/DSpaceResources#DSpaceResources-RepositoryPlanning [3] http://en.wikipedia.org/wiki/Data_center [4] https://www.google.co.za/search?q=data+sovereignty&oq=data+sovereignty&aqs=chrome..69i57j69i64&sourceid=chrome& ie=UTF-8#q=data+sovereignty [5] http://en.wikipedia.org/wiki/Global_surveillance_disclosures_(2013%E2%80%93present) [6] http://www.washingtonpost.com/blogs/the-switch/wp/2013/12/19/ how-one-publisher-is-stopping-academics-from-sharing-their-research/ [7] mailto:ismith@sun.ac.za [8] mailto:wklap@sun.ac.za [9] mailto:hilton.gibson@gmail.com 7. SUNScholar/Checklist 3 SUNScholar/Checklist Back to Guidelines Introduction This wiki page attempts to provide a simple quick check list with which to evaluate the repository system required for possible deployment. This quick check list is open systems based and does not only introduce the repository software but also the system, including preparedness for disaster recovery and long term repository preservation. The ultimate goal is to provide a high performance trusted system, that is sustainable in the long term, using open published standards and software. Essential Reading (Only available online) 2014 - EU - DUTCH CITY EDE SAVES 92% ON SOFTWARE LICENCES WITH OPEN SOURCE SOFTWARE [1] 2014 - COMPUTERWORLD - 4 REASONS WHY COMPANIES SAY YES TO OPEN SOURCE SOFTWARE 2013 - MDPI - THE IMPORTANCE OF OPEN SOURCE SOFTWARE AND STANDARDS IN MODERN SCIENTIFIC PUBLISHING Archival Standards NISO - Framework for Good Digital Collections [2] CCSDS - Open Archival Information System (OAIS) CCSDS - Audit and Certification of Trusted Digital Repositories OCLC - RLG - Trusted Digital Repositories Policies and Plans Open Access Policy (OAP) Repository Preservation Plan (RPP) Management System Personnel Content Personnel Researcher Identification Visibility Authorisation 8. SUNScholar/Checklist 4 Network Secure Connections Internet Firewall Hardware Bare Metal Server Virtualised Server Cloud Server Digital Objects Digital Object - Identifier Digital Object - Preservation Digital Object - Open Formats Digital Object - Closed Formats Software Open Source Server Operating System [3] Open Source Web Application Repository Software [4] System System Administration System Backups References http://bit.ly/goodir http://bit.ly/garpir References [1] https://joinup.ec.europa.eu/elibrary/case/dutch-city-ede-spends-92-percent-less-its-peers-software-licenses [2] http://wiki.lib.sun.ac.za/digital-collection [3] http://www.ubuntu.com [4] http://www.dspace.org 9. SUNScholar/Reference Architecture 5 SUNScholar/Reference Architecture Back to Guidelines Essential Reading (Only available online) 2008 - INTERSCIENCE - THE CONCEPT OF REFERENCE ARCHITECTURES Introduction In order to make the use of DSpace systems, simpler, more reliable and standardised it is proposed that the DSpace community adopt a reference architecture approach to DSpace. The benefits of the reference architecture approach would be: Much simpler installations. Much simpler configuration. Much simpler customisation. Much simpler upgrades. The very popular Wordpress CMS uses the LAMP stack [1] as it's de-facto reference architecture. This has made Wordpress very easy to install, configure and customise. The popular Open Journal System [2] (OJS) software also uses the LAMP stack. Definition http://en.wikipedia.org/wiki/Reference_architecture http://en.wikipedia.org/wiki/Software_architecture http://en.wikipedia.org/wiki/Systems_architecture http://en.wikipedia.org/wiki/Systems_design http://en.wikipedia.org/wiki/Systems_engineering http://whatis.techtarget.com/definition/reference-architecture Implementations http://www.ibm.com/developerworks/rational/library/2774.html http://www.redhat.com/resourcelibrary/reference-architectures http://www.opengroup.org/soa/source-book/soa_refarch Proposal for DSpace 1. Standardise on an open source server operating system such as Ubuntu LTS. 2.2. Match versions of DSpace to the server operating system. 3.3. Match versions of required software to versions of DSpace and server operating system For example: 10. SUNScholar/Reference Architecture 6 Reference DSpace Ubuntu OS Database Java runtime Ant compiler Java webapp server RA-01 3.2 10.04 LTS PostgreSQL 8.4 OpenJDK 1.6 Ant 1.7 Tomcat 6 RA-02 4.1 12.04 LTS PostgreSQL 9.1 OpenJDK 1.7 Ant 1.8 Tomcat 6 |+ References [1] http://en.wikipedia.org/wiki/LAMP_(software_bundle) [2] http://www.journals.ac.za/index.php/System_Admin SUNScholar/DSpace/Why Ubuntu Server Back to Install Ubuntu - Step 1 Introduction In order to make the research outputs of Stellenbosch University available, the library decided develop an open access research repository service. The repository has to make the research available for future researchers as well. With this in mind as a selection criteria, DSpace [1] on top of the Ubuntu server [2] was used for the following reasoning: Reasoning 1.1. We cannot predict what technology will exist in the future. 2. But we can be almost certain, that open systems [3] based on open standards [4] will have a better chance of surviving to the future. 3.3. Since we are employing open systems based on open standards, we have to eliminate any proprietary systems or standards. 4.4. DSpace is open source software, supported by a foundation and is based on open standards. 5. DSpace is also very popular as a repository management system [5] . 6. Ubuntu is also supported by a foundation and is also one of the most popular linux distributions which are based on open source software [6] . 7. Ubuntu is committed to releasing a "long term support" (LTS) [7] version of the distribution every two years. 8. The method of Ubuntu LTS releases [8] allows us to plan for upgrades and makes capacity planning of the repository more effective. 9. In addition, Ubuntu is derived from Debian [9] , the original linux distribution. 10.10. Debian is very stable, and has a very large community supporting it. 11. Most linux distributions are based on open Unix [10] standards. 12. The Microsoft server software and client access licences are extremely expensive. [11] So considering all of the above, DSpace on an Ubuntu server made logical sense to comply with most of BOAI, section 3. 11. SUNScholar/DSpace/Why Ubuntu Server 7 Please Note: It is not a good idea to use to use the latest LTS release of Ubuntu, if you do not have access to an expert Ubuntu linux system administrator. For example: If you install using Ubuntu 10.04 LTS, then wait until the second point release of the next LTS version before considering upgrading. If you are considering using Redhat Enterprise Linux (RHEL), then remember Redhat is commercial and if they fail then so does your support. Whereas Ubuntu can be supported by Canonical commercially and by the Debian and Ubuntu linux community. So, long term support for Ubuntu/Debian is much more sustainable. See: http://community.ubuntu.com''' Comments on LinkedIn 12. SUNScholar/DSpace/Why Ubuntu Server 8 13. SUNScholar/DSpace/Why Ubuntu Server 9 References http://ubuntu.sun.ac.za/wiki/index.php/Enterprise_Server_Management http://www.jorgecastro.org/2013/04/29/13-reasons-to-deploy-with-ubuntu-server References [1] http://www.dspace.org/ [2] http://www.ubuntu.com/business/server/overview [3] http://en.wikipedia.org/wiki/Open_system_(computing) [4] http://en.wikipedia.org/wiki/Open_standard [5] http://wiki.lib.sun.ac.za/images/1/10/Opendoar-dspace-usage.png [6] http://en.wikipedia.org/wiki/Open-source_software [7] http://ubuntu.sun.ac.za/wiki/index.php/LTS [8] http://wiki.ubuntu.com/LTS/ [9] http://www.debian.org/ [10] http://www.unix.org/ [11] http://news.slashdot.org/story/13/08/09/2021205/microsoft-will-squeeze-datacenters-on-price-of-windows-server 14. 10 Step 1 SUNScholar/Guidelines/Step 1 Back to Guidelines Step 1 - Open Access Policy and Repository Preservation Plan Formulate an open access policy and then a repository preservation plan which leads to planning for and building repository management capacity, all of which, are designed to produce a trustworthy academic research repository. Proposed systems life cycle for open access academic research repositories. Below are links to information regarding the digital scholarly communication systems life cycle for open access academic research repositories, as demonstrated in the diagram above. The principles of an open access policy. Usually for the repository director to formulate in collaboration with institutional management. The principles of a repository preservation plan. Usually for the repository manager to formulate in collaboration with the institutions IT department. The principles of a trustworthy academic research repository. Usually an understanding between the repository management team and the institutions research office. PREVIOUS NEXT 15. SUNScholar/Open Access 11 SUNScholar/Open Access Back to Guidelines - Step 1 First, we go green open access, with repositories [1] . Then we go gold open access, with academic journals [2] . Until eventually, everything simply becomes open access. Brief History A subversive proposal [3] by Steven Harnard in 1994, precipitated later by the serials crisis [4] , led to the beginning of the open access movement [5] and the creation of institutional repositories [6] . Formulation An open access policy is usually for the repository director to formulate in collaboration with institutional management. Good Open Access Policy Practices http://bit.ly/goodoa Copyright Click on the heading above. Essential Reading (Only available online) 2014 - WRO - GROWTH OF OPEN ACCESS REPOSITORIES 2005 TO 2012 2014 - BREMBS - CONFLICTS OF INTEREST EVEN FOR "GOOD" PUBLISHERS [7] 2014 - C LONG - TO BE PUBLISHED OR TO BE READ [8] 2014 - RICHARD POYNDER - THE STATE OF OPEN ACCESS [9] 2014 - SCAP - COSTS AND BENEFITS OF OPEN ACCESS PUBLISHING - A GUIDE FOR MANAGERS IN SOUTHERN AFRICAN HIGHER EDUCATION 2013 - UNESCO - OPEN ACCESS POLICY VERSION 2 2013 - PETER SUBER - HARVARD WIKI - GOOD PRACTICES FOR UNIVERSITY OPEN ACCESS POLICIES [10] 2013 - PETER SUBER - HARVARD OPEN ACCESS WIKI [11] 2013 - SPARC/PLOS/OSAPA - HOW OPEN IS IT? 2013 - MEDOANET - GUIDELINES FOR IMPLEMENTING AN OPEN ACCESS POLICY 2012 - REPORT TO OAUK - BENEFITS OF OPEN ACCESS FOR THE PUBLIC SECTOR 2012 - REPORT TO OAUK - FINAL 2012 - JISC - OPEN ACCESS AND VCS REPORT - FINAL 16. SUNScholar/Open Access 12 2012 - FINCH GROUP - EXECUTIVE SUMMARY - FINAL VERSION 2012 - PETER SUBER - OPEN ACCESS BOOK 2011 - AN OPEN LETTER 2011 - REPORT TO OAUK - BENEFITS OF OPEN ACCESS FOR THE PRIVATE SECTOR 2010 - VIMEO - R2RC - THE DIGITAL NATIVES ARE GETTING RESTLESS: THE STUDENT VOICE OF THE OPEN ACCESS MOVEMENT [12] 2008 - THE COST OF KNOWLEDGE 2008 - AARON SWARTZ - THE GUERILLA OPEN ACCESS MANIFESTO [13] 2003 - ARL - CLIFFORD LYNCH - INSTITUTIONAL REPOSITORIES: ESSENTIAL INFRASTRUCTURE FOR SCHOLARSHIP IN THE DIGITAL AGE Founding Open Access Statements The Budapest Open Access Initiative The Berlin Declaration Conceptual Origins http://en.wikipedia.org/wiki/Memex http://en.wikipedia.org/wiki/Standing_on_the_shoulders_of_giants http://en.wikipedia.org/wiki/Great_Conversation http://en.wikipedia.org/wiki/Tragedy_of_the_commons http://en.wikipedia.org/wiki/Knowledge_commons National Policies http://www.arc.gov.au/applicants/open_access.htm Registry of Policies http://roarmap.eprints.org Advocacy http://www.openaccessbutton.org or http://en.wikipedia.org/wiki/Open_Access_Button Communities of Practice Wenger, et al (2002) defines a Community of Practice (COP) as a group of people who share a common interest and who come together to fulfil both individual and group goals. http://www.openaire.eu http://www.fosteropenscience.eu http://www.libereurope.eu http://aoasg.org.au http://open-access.org.uk http://www.ciard.net Current News http://paper.li/SPARC_EU/1333818336 http://openaccess.eprints.org http://scholarlykitchen.sspnet.org Berlin Conferences http://www.berlin11.org http://www.berlin10.org http://www.berlin9.org http://www.berlin8.org http://www.berlin7.org 17. SUNScholar/Open Access 13 http://www.berlin6.org http://www.berlin5.org Open Access applied at Stellenbosch University SUNScholar [1] SUNJournals [2] SUNConferences [14] Overview in the scholarly life cycle With reference to: http://www.cfses.com/EI-ASPM/SCLCM-V7/dgm13715.htm References http://bit.ly/oa-overview http://www.arl.org/sparc/openaccess/why-oa.shtml http://www.digital-scholarship.org/cwb/WhatIsOA.pdf http://www.digital-scholarship.org/cwb/OALibraries2.pdf http://www.eprints.org/openaccess http://www.connotea.org/tag/oa.impact http://www.dlib.org/dlib/march05/harnad/03harnad.html http://www.ifla.org/strategic-plan/key-initiatives/digital-content/oa http://www.openaccessweek.org/profiles/blogs/iflas-open-access-task-force-established Graphics 18. SUNScholar/Open Access 14 Timeline of significant events leading up to the adoption of open access academic repositories 19. SUNScholar/Open Access 15 Date Initiative 1994/06 Steven Harnard's Subversive Proposal [3] 2002/02 Budapest Open Access Initiative (BOAI) [15] 2002/05 Trusted Digital Repositories [16] 2002/06 Open Archives Initiative (OAI) Version 2 [17] 2003/10 Berlin Declaration on Open Access to Knowledge in the Sciences and Humanities 2007/01 The Scientific Communication Life-Cycle Model [18] 2008/04 NISO Good Digital Collections Framework [19] 2009/08 The Open Archival Information System (OAIS) [20] 2010/06 Managing Digital Collections [21] 2010/07 MOU on Trusted Digital Repositories [22] 2010/10 Stellenbosch University Library Open Access Seminar [23] 2011/06 Education and Training for Digital Repository Manager [24] 2011/09 Trustworthy Repositories Audit and Certification (TRAC) [25] 2011/10 Stellenbosch University Library Open Access Seminar [26] 2012/06 SCECSAL Resolution [27] 2012/09 Budapest Open Access Initiative Recommendations (BOAIR) - Updated from 2002/02 2012/09 Levels of Digital Preservation - Draft V2 [28] 2012/09 Good practices for university open-access policies [10] 2012/10 Policy guidelines for the development and promotion of open access [29] 2012/11 Stellenbosch University Berlin 10 Open Access Conference - Workshop 2 [30] References [1] http://scholar.sun.ac.za [2] http://www.journals.ac.za [3] http://en.wikipedia.org/wiki/Subversive_Proposal [4] http://en.wikipedia.org/wiki/Serials_crisis [5] http://en.wikipedia.org/wiki/Open_access [6] http://en.wikipedia.org/wiki/Institutional_repository [7] http://bjoern.brembs.net/2014/04/should-we-stop-supporting-open-access-publishers [8] http://www.cplong.org/2014/03/to-be-published-or-to-be-read [9] http://poynder.blogspot.co.uk/2014/03/the-state-of-open-access.html [10] http://cyber.law.harvard.edu/hoap/Good_practices_for_university_open-access_policies [11] http://cyber.law.harvard.edu/hoap/Open_Access_(the_book) [12] http://vimeo.com/15061659# [13] http://archive.org/stream/GuerillaOpenAccessManifesto/Goamjuly2008_djvu.txt [14] http://conferences.sun.ac.za [15] http://www.soros.org/openaccess/read [16] http://wiki.lib.sun.ac.za/images/e/e1/Tdr-oclc.pdf [17] http://en.wikipedia.org/wiki/Open_Archives_Initiative 20. SUNScholar/Open Access 16 [18] http://www.sciencemodel.net [19] http://wiki.lib.sun.ac.za/images/6/68/Framework3.pdf [20] http://en.wikipedia.org/wiki/OAIS [21] http://wiki.lib.sun.ac.za/images/5/51/Managing_Digital_Collections.pdf [22] http://www.trusteddigitalrepository.eu/Site/Trusted%20Digital%20Repository.html [23] http://scholar.sun.ac.za/handle/10019.1/4806 [24] http://wiki.lib.sun.ac.za/images/e/e8/217-repanovici-en.pdf [25] http://en.wikipedia.org/wiki/Trustworthy_Repositories_Audit_%26_Certification [26] http://scholar.sun.ac.za/handle/10019.1/17764 [27] http://wiki.lib.sun.ac.za/images/f/fb/Scecsal2012_resolutions_.pdf [28] http://wiki.lib.sun.ac.za/images/d/dd/Levels-of-Digital-Preservation-draft-handout-v3.pdf [29] http://www.unesco.org/new/en/communication-and-information/resources/publications-and-communication-materials/publications/ full-list/policy-guidelines-for-the-development-and-promotion-of-open-access [30] http://www.berlin10.org/workshops/16-workshops/72-w02.html SUNScholar/Repository Preservation Back to Guidelines - Step 1 Formulation The repository preservation plan (RPP) is usually for the repository director/manager to formulate in collaboration with the institutions IT department [1] . Considerations Currently in the academic literature, much is being said about digital curation/preservation, however this distracts from the strategic imperative of preserving the repository itself and the contents of the repository on the internet, in the same way that libraries and the contents of libraries in buildings, are preserved. There is a very subtle but very important distinction between digital curation and repository preservation. Preamble - Essential Reading Priority 1 - Repository Long Term Support Priority 2 - Preservable Digital Objects Priority 3 - Electronic Citation Preservation Preservation Services http://www.portico.org/digital-preservation http://www.clockss.org Contributions From Denise Nicholson http://libguides.wits.ac.za/digitalpreservation http://digi.nrf.ac.za/publ/Managing%20Digital%20Collections.pdf Ohio State University Library Ohio State University Library [2] (OSUL) Documentation Examples http://wiki.lib.sun.ac.za/images/6/61/Osul-digital-preservation-policy-framework.pdf http://wiki.lib.sun.ac.za/images/8/87/Osul-digital-initiatives-program.pdf http://library.osu.edu/projects-initiatives/digital-projects/standards Ohio State University Library [2] (OSUL) Links 21. SUNScholar/Repository Preservation 17 http://library.osu.edu/blogs/digitalscholarship http://library.osu.edu/documents/digital-projects/OAIS_Report.pdf http://library.osu.edu/projects-initiatives/digital-projects/standards/outside-resources http://library.osu.edu/projects-initiatives/osu-records-management/ records-information-management-resorces Ohio State University Library [2] (OSUL) Contacts https://portal.lib.ohio-state.edu/intranet/staff/group/pres https://portal.lib.ohio-state.edu/intranet/staff/group/DCS https://portal.lib.ohio-state.edu/intranet/staff/group/infrastructure Keep clicking on the images to zoom in, to the maximum extent. References [1] http://it.sun.ac.za [2] http://library.osu.edu 22. 18 Step 2 SUNScholar/Guidelines/Step 2 Back to Guidelines Step 2 - Marketing Friendly Persistent URL and Preservable Digital Objects While developing your open access policy and repository preservation plan, take time to consider the following as very important strategic imperatives at all times, for a very long term successful repository. Marketing Friendly Persistent URL Decide on a marketing friendly persistent (URL) for the repository. This name should be short and simple to remember, easy to type into documentation and good for marketing/branding. Ensure the name will never change and that it has a clean URL with no forward slash redirect. The marketing friendly persistent URL is vital for electronic citation persistence on the web in the long term and for repository marketing/branding. http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_Ubuntu/S02 http://wiki.lib.sun.ac.za/index.php/SUNScholar/Repository_Website_Metrics http://mashable.com/2014/03/10/domain-names-history http://www.commoncraft.com/video/domain-names-and-hosting Good Examples http://scholar.sun.ac.za http://digital.lib.sun.ac.za Bad Examples http://uctscholar.uct.ac.za - Double use of UCT is very confusing for marketing. http://researchspace.csir.co.za/dspace - Uses a forward slash URL something, also bad for marketing and internet harvesters. http://digitalknowledge.cput.ac.za:8081/jspui - Uses a port number AND forward slash URL something, very bad for internet interoperability. 23. SUNScholar/Guidelines/Step 2 19 Preservable Digital Objects Ensure you only deposit preservable digital objects into the repository. Preservable digital objects are vital for access by future researchers and for data interoperability. http://wiki.lib.sun.ac.za/index.php/SUNScholar/Preservable_Digital_Objects http://wiki.lib.sun.ac.za/index.php/SUNScholar/Digitisation/Digital_Formats/Open http://www.documentliberation.org Click on the image below to zoom in and click on it again to zoom in further. You are welcome to download it and use it for open digital object formats advocacy. PREVIOUS NEXT 24. 20 Step 3 SUNScholar/Guidelines/Step 3 Back to Guidelines Step 3 - Employ Repository Management Personnel The development and implementation of your open access policy and repository preservation plan should point to the fact that your organisation needs to assign the following persons to the project. To be appointed permanently, repository librarians and a repository manager/director. To be consulted or appointed permanently, an experienced IT Ubuntu Linux [1] system administrator for installation, optimisation and upgrades. To be consulted or appointed permanently, an experienced web 2.0 developer for website programming, customisation, and styling. http://wiki.lib.sun.ac.za/index.php/SUNScholar/Capacity_Building http://wiki.lib.sun.ac.za/index.php/SUNScholar/Repository http://wiki.lib.sun.ac.za/index.php/SUNScholar/Repository_Information http://wiki.lib.sun.ac.za/index.php/OpenCampus PREVIOUS NEXT 25. SUNScholar/Guidelines/Step 3 21 References [1] http://ubuntu.sun.ac.za SUNScholar/Capacity Building/Digital Repository Systems Management Back to Capacity Building One man's 'magic' is another man's engineering. Robert A. Heinlein Essential Reading (Only available online) 2014 - RHT - SALARY GUIDE 2013 - CAMPUS TECHNOLOGY - IT PAY: CAN HIGHER EDUCATION COMPETE? 2013 - DICE - LINUX JOBS REPORT 2012 - IAI - SALARY SURVEY DSpace and Ubuntu require expert technical support for long term sustainability. Technology is expanding at ever faster rates, therefore it is wise to find persons experienced in specialised areas to do systems management. Think of any other field that has expanded and become specialised, the same applies to technology and systems management today and definitely in the very near future. Persons with the following skills are desirable. They can be hired part-time or employed full-time depending on the amount of resources available to you and the amount of work to be done. Web 2.0 Software Technologist or Java Webapp Developer [1] Expert Java [2] programming skills Expert XML [3] programming skills Professional SQL [4] programming skills Professional HTML [5] programming skills Professional CSS [6] programming skills Professional PHP [7] programming skills Familiarity with the Tomcat [8] java webapp server Familiarity with the LAMP [1] stack webapp server Web 2.0 Hardware Technologist or Ubuntu Linux System Administrator [9] Expert with the Ubuntu [3] Linux server operating system Expert with the Tomcat [8] java webapp server Expert with the LAMP [1] stack webapp server Expert with virtualization [10] and cloud [11] services Professional BASH [12] programming skills Professional TCP/IP [13] networking skills Familiarity with a major vendors server hardware [14] Familiarity with a major vendors networking hardware [15] 26. SUNScholar/Capacity Building/Digital Repository Systems Management 22 Example Job Advertisement The (name of institution) is seeking candidates to fill the positions of Java web app developer and Ubuntu Linux system administrator for the open scholarship office. The candidates should have at least 2 years experience and optionally supply certification and accreditation where available. In-depth Information How to find persons with these skills Try the following links to able to source persons with these skills from the community in your area. http://community.ubuntu.com http://en.wikipedia.org/wiki/Linux_user_group http://en.wikipedia.org/wiki/Computer_User_Group http://www.linkedin.com http://www.linuxrecruit.co.uk Remuneration http://iainstitute.org/en/learn/research/salary_survey.php http://www.roberthalftechnology.com Skills Surveys http://www.computerworld.com/s/article/9242548/8_hot_IT_skills_for_2014 http://www.computerworld.com/s/article/9231486/10_hot_IT_skills_for_2013 Technologist Jobs http://jobs.code4lib.org/jobs/dspace http://jobs.code4lib.org/jobs/apache-tomcat http://jobs.code4lib.org/jobs/java http://jobs.code4lib.org/jobs/xml Organisations http://www.usenix.org/lisa http://www.opsschool.org http://devcsi.ukoln.ac.uk/local-developer-impact Certification http://www.icdl.org.za http://www.lpi.org http://www.linuxcertification.co.za 27. SUNScholar/Capacity Building/Digital Repository Systems Management 23 References http://en.wikipedia.org/wiki/Web_developer http://en.wikipedia.org/wiki/System_administrator http://en.wikipedia.org/wiki/DevOps http://langpop.com Comment http://www.itworld.com/it-management/361516/9-reasons-sys-admins-hate-you http://www.informit.com/store/devops-troubleshooting-linux-server-best-practices-9780321832047 http://jamesclear.com/goals-systems Sample CV's http://staff.lib.sun.ac.za/~hgibson/docs/cv/cv.html Salaries according to RHT in the USA Currency convertor: http://www.xe.com Year Linux System Admin Java Web Developer 2014 $ 64500 - $ 89500 $ 65750 - $ 95250 2013 $ 62000 - $ 86000 $ 62000 - $ 89750 A Good Geek What a good geek does, is AUTOMATE, INNOVATE and ANNOTATE. References [1] https://www.google.co.za/search?q=Java+Webapp+Developer&oq=Java+Webapp+Developer&aqs=chrome..69i57& sourceid=chrome&ie=UTF-8 [2] http://en.wikipedia.org/wiki/Java_%28programming_language%29 [3] http://en.wikipedia.org/wiki/Xml [4] http://en.wikipedia.org/wiki/Sql [5] http://en.wikipedia.org/wiki/Html [6] http://en.wikipedia.org/wiki/Css [7] http://en.wikipedia.org/wiki/PHP [8] http://en.wikipedia.org/wiki/Apache_Tomcat [9] https://www.google.co.za/search?q=Ubuntu+Linux+System+Administrator&oq=Ubuntu+Linux+System+Administrator& aqs=chrome..69i57j69i64&sourceid=chrome&ie=UTF-8 [10] http://en.wikipedia.org/wiki/Virtualization [11] http://en.wikipedia.org/wiki/Cloud_computing [12] http://en.wikipedia.org/wiki/Bash_%28Unix_shell%29 [13] http://en.wikipedia.org/wiki/Tcp/ip [14] http://en.wikipedia.org/wiki/Server_(computing) [15] http://en.wikipedia.org/wiki/Networking_hardware 28. SUNScholar/Capacity Building/Digital Repository Content Management 24 SUNScholar/Capacity Building/Digital Repository Content Management Back to Capacity Building Introduction *** After the system has been built *** you will require persons who have the following skills to manage the content of the digital repository. *** You CANNOT do good content management without an experienced systems manager/team. *** Essential Reading (Only available online) 2014 - ERASMUS - JUST GOOGLE IT 2014 - CARNEGIE - CONTINUING PROFESSIONAL DEVELOPMENT (CPD) 2014 - ARL - SALARY SURVEY SPREADSHEET 2014 - FSU - LIBRARIAN, HEAL THY SELF: A SCHOLARLY COMMUNICATION ANALYSIS OF LIS JOURNALS 2013 - LIBRARIES SUPPORTING ROLES: RESEARCH THROUGH NEW METHODS OF SCHOLARLY COMMUNICATION [1] 2013 - ARL - NEW ROLES FOR NEW TIMES - TRANSFORMING LIAISON ROLES IN RESEARCH LIBRARIES 2011 - RSP UK - REPOSITORY STAFF AND SKILL SET 2011 - IFLA - EDUCATION AND TRAINING FOR DIGITAL REPOSITORY MANAGERS 2010 - NRF - SOUTH AFRICA - MANAGING DIGITAL COLLECTIONS Example Job Advertisement The (name of institution) is seeking candidates to fill the positions of director, manager and librarian for the open scholarship office. The candidates should have at least 2 years experience and optionally supply certification and accreditation where available. The minimum required skill sets are listed below. Directors Excellent written and verbal communication skills. Doctorate in library science. Academic journal publication and/or institutional policy development about "open access digital academic publishing". Expert understanding of open access digital repository content management. Expert with metadata standards for academic publishing. Professional understanding of web 2.0 communication technologies. Familiarity with DSpace software [4] . Familiarity with desktop computer operations. Familiarity with digital object formats and identifiers. Familiarity with digitisation technologies. Familiarity with open access digital repository systems management. 29. SUNScholar/Capacity Building/Digital Repository Content Management 25 Familiarity with the operations of the internet and how to use it securely. [2] Managers Excellent written and verbal communication skills. Bachelors degree in library science. Major or Masters in "open access digital academic publishing systems". Expert understanding of open access digital repository content management. Expert with metadata standards for academic publishing. Professional understanding of web 2.0 communication technologies. Professional understanding of DSpace software [4] . Familiarity with open access digital repository systems management. Familiarity with desktop computer operations. Familiarity with digital object formats and identifiers. Familiarity with digitisation technologies. Familiarity with the operations of the internet and how to use it securely. [2] Librarians Professional written and verbal communication skills. Technology certificate in library science. Major in "open access digital academic publishing systems". Expert with DSpace software [4] . Expert with desktop computer operations. Expert with digital object formats and identifiers. Expert with digitisation technologies. Expert with metadata standards for academic publishing. Professional understanding of open access digital repository content management. Professional understanding of the operations of the internet and how to use it securely. [2] Professional understanding of web 2.0 communication technologies. Familiarity with open access digital repository systems management. Library Schools http://www.liasa.org.za/node/467 Library Jobs http://www.liasa.org.za/careers http://joblist.ala.org Web Literacy http://en.wikipedia.org/wiki/Technology_acceptance_model http://en.wikipedia.org/wiki/Digital_literacy http://en.wikipedia.org/wiki/Diffusion_of_innovations http://www.jisc.ac.uk/guides/developing-students-digital-literacy http://www.jiscinfonet.ac.uk/infokits/digital-literacies 30. SUNScholar/Capacity Building/Digital Repository Content Management 26 Technology See: http://en.wikipedia.org/wiki/Technology_acceptance_model Simple answers to technophobia [3] . 31. SUNScholar/Capacity Building/Digital Repository Content Management 27 References [1] http://www.infotoday.eu/Articles/Editorial/Featured-Articles/ Library-roles-supporting-research-through-new-methods-of-scholarly-communication-93398.aspx [2] http://en.wikipedia.org/wiki/Internet [3] http://en.wikipedia.org/wiki/Technophobia 32. 28 Step 4 SUNScholar/Guidelines/Step 4 Back to Guidelines Step 4 - Build Repository IT Infrastructure With the system personnel you hired or consulted from the previous step, budget for and purchase the necessary server hardware resources and also plan for server replacement when the supplier warranty expires. You may also want to consider using cloud [1] or virtualised servers, either public or private. Speak to your campus IT cloud/virtual services administrator. Enterprise Cloud Services in South Africa Essential Reading (Only available online) 2014 - WEF - STATE OF INFORMATION TECHNOLOGY REPORT 2014 2014 - AKAMI - STATE OF THE INTERNET REPORT [2] 2014 - COAR - TOWARD A SEAMLESS GLOBAL INFRASTRUCTURE FOR REPOSITORIES 2013 - DLIB - A VISION TOWARDS SCIENTIFIC COMMUNICATION INFRASTRUCTURES 2013 - IDRC - CONNECTING ICT TO DEVELOPMENT 2013 - MDPI - THE IMPORTANCE OF OPEN SOURCE SOFTWARE AND STANDARDS IN MODERN SCIENTIFIC PUBLISHING 2013 - AAUPNET - LIBRARY AND UNIVERSITY PRESS COLLABORATION 2013 - A4AI - INTERNET AFFORDABILITY REPORT 2013 - DEPARTMENT OF COMMUNICATIONS - SOUTH AFRICA - BROADBAND POLICY 2012 - BOAI - ON INFRASTRUCTURE AND SUSTAINABILITY 2011 - LSE - TOTAL COST OF OWNERSHIP OF OPEN SOURCE SOFTWARE http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_Ubuntu/S01#Hardware http://wiki.lib.sun.ac.za/index.php/SUNScholar/Reference_Architecture http://wiki.lib.sun.ac.za/index.php/SUNScholar/DSpace/Why_Ubuntu_Server http://wiki.lib.sun.ac.za/index.php/SUNScholar/Upgrading/Hardware http://wiki.lib.sun.ac.za/index.php/SUNScholar/Disaster_Recovery With reference to: http:/ / www. cfses. com/ EI-ASPM/ SCLCM-V7/ actuse12576. htm and http:/ / www. sciencemodel.net 33. SUNScholar/Guidelines/Step 4 29 PREVIOUS NEXT References [1] http://www.aaron-helton.com/2013/02/installing-dspace-in-amazon-aws [2] http://uk.akamai.com/stateoftheinternet 34. 30 Step 5 SUNScholar/Guidelines/Step 5 Back to Guidelines Step 5 - Install Repository Software Please note It is assumed that you will be applying due diligence to learn some Linux skills, so that you can install and maintain an Ubuntu linux server. If you cannot and you still want to use an Ubuntu linux server, then click here to find out how you might find an Ubuntu linux person locally, to assist you. http://wiki.lib.sun.ac.za/index.php/SUNScholar/DSpace - Installation of Ubuntu server and DSpace software. http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S11 - Important after DSpace installation tasks. Essential Reading (Only available online) 2014 - GURU 99 - LINUX TUTORIAL [1] 2013 - SHOTTS,W E JNR - THE LINUX COMMAND LINE BOOK 2013 - DURASPACE - DSPACE 4: COMMAND LINE OPERATIONS [2] 2013 - EAST WEST UNIVERSITY - DSPACE 3.2 INSTALLATION ON DEBIAN WHEEZY 7.10 [3] 2012 - VALENCIA POLYTECH UNIVERSITY - DSPACE AND UBUNTU INSTALLATION DSpace Vision https://wiki.duraspace.org/display/DSPACE/DSpace+2013+Vision+Document DSpace Documentation https://wiki.duraspace.org/display/DSDOC/All+Documentation https://wiki.duraspace.org/display/DSPACE/EndUserFaq Software Versions http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_Ubuntu/S01 http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S02 35. SUNScholar/Guidelines/Step 5 31 PREVIOUS NEXT References [1] http://www.guru99.com/unix-linux-tutorial.html [2] https://wiki.duraspace.org/display/DSDOC4x/Command+Line+Operations [3] http://www.slideshare.net/rafiqur83/dspace-32-installation-on-debian-wheeze-710 SUNScholar/Install Ubuntu PROCEDURE: 1 - INSTALL UBUNTU PROCEDURE INDEX NEXT PROCEDURE Introduction It is fairly easy to install the Ubuntu LTS server software. The following procedures apply to any LTS version of the Ubuntu server software. It is good best practice to develop installation skills on a test server first, before doing a production server installation. 36. SUNScholar/Prepare Ubuntu 32 SUNScholar/Prepare Ubuntu PROCEDURE: 2 - PREPARE UBUNTU PREVIOUS PROCEDURE NEXT PROCEDURE SUNScholar/Install DSpace PROCEDURE: 3 - INSTALL DSPACE PREVIOUS PROCEDURE Requirements This procedure assumes that your server is open on the campus firewall OR proxy server. This is needed to be able to download Java packages from various websites during the build of the DSpace web application. Install DSpace/S04/3.2 Back to Step 4 Requirements http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S03 Procedure With the release of DSpace 3.2 came a new way of configuring DSpace. The critical core elements of the old "dspace.cfg" file have been superseded by a "build.properties" file. The idea is to put all the custom configs in the "config" folder and use the build.properties file for the core "building" of DSpace. To edit the build.properties file, type the following: nano /home/dspace/source/build.properties See example below. Replace all the places with a pair of percent signs (%something%), with the settings for your system. 1.1. Be careful to NOT comment out any settings, leave them as they are with blanks!! 2. Check the 1.8.2 config help for important comments about critical settings. # DSpace build.properties # This file should be customised to suit your build environment. # Note that not all configuration is handled here, only the most common # properties that tend to differ between build environments. 37. Install DSpace/S04/3.2 33 # For adjusting global settings or more complex settings, edit the relevant config file. # # IMPORTANT: Do not remove or comment out settings in build.properties # When you edit the "build.properties" file (or a custom *.properties file), # take care not to remove or comment out any settings. Doing so, may cause # your final "dspace.cfg" file to be misconfigured with regards to that # particular setting. Instead, if you wish to remove/disable a particular # setting, just clear out its value. For example, if you don't want to be # notified of new user registrations, ensure the "mail.registration.notify" # setting has no value, e.g. "mail.registration.notify=" # ########################## # SERVER CONFIGURATION # ########################## # DSpace installation directory. This is the location where you want # to install DSpace. NOTE: this value will be copied over to the # "dspace.dir" setting in the final "dspace.cfg" file. It can be # modified later on in your "dspace.cfg", if needed. dspace.install.dir = %/home/dspace% # DSpace hostname. dspace.hostname = %localhost% # DSpace URL. dspace.baseUrl = %http://localhost% # Name of the site dspace.name = %DSpace at My University% # Solr server solr.server = %http://localhost/solr% # Default language for metadata values default.language = %en_ZA% ########################## # DATABASE CONFIGURATION # ########################## # Database name ("oracle", or "postgres") db.name=postgres # Uncomment the appropriate block below for your database. # postgres 38. Install DSpace/S04/3.2 34 db.driver=org.postgresql.Driver db.url=jdbc:postgresql://localhost:5432/dspace db.username=%dspace% db.password=%dspace% # oracle #db.driver= oracle.jdbc.OracleDriver #db.url=jdbc:oracle:thin:@//localhost:1521/xe #db.username=dspace #db.password=dspace # Schema name - if your database contains multiple schemas, you can avoid problems with # retrieving the definitions of duplicate object names by specifying # the schema name here that is used for DSpace by uncommenting the following entry db.schema = # Maximum number of DB connections in pool db.maxconnections = %300% # Maximum time to wait before giving up if all connections in pool are busy (milliseconds) db.maxwait = 5000 # Maximum number of idle connections in pool (-1 = unlimited) db.maxidle = -1 # Determine if prepared statement should be cached. (default is true) db.statementpool = true # Specify a name for the connection pool (useful if you have multiple applications sharing Tomcat's dbcp) # If not specified, defaults to 'dspacepool' db.poolname = dspacepool ####################### # EMAIL CONFIGURATION # ####################### # SMTP mail server mail.server = %smtp.example.com% # SMTP mail server authentication username and password (if required) # mail.server.username = myusername # mail.server.password = mypassword mail.server.username= mail.server.password= # SMTP mail server alternate port (defaults to 25) mail.server.port = 25 39. Install DSpace/S04/3.2 35 # From address for mail mail.from.address = %dspace-from-email-address@myu.edu% # Currently limited to one recipient! mail.feedback.recipient = %dspace-feedback@myu.edu% # General site administration (Webmaster) e-mail mail.admin = %dspace-admin@myu.edu% # Recipient for server errors and alerts #mail.alert.recipient = email-address-here mail.alert.recipient = %dspace-alert@myu.edu% # Recipient for new user registration emails #mail.registration.notify = email-address-here mail.registration.notify = %dspace-registration-notify@myu.edu% ######################## # HANDLE CONFIGURATION # ######################## # Canonical Handle URL prefix # # By default, DSpace is configured to use http://hdl.handle.net/ # as the canonical URL prefix when generating dc.identifier.uri # during submission, and in the 'identifier' displayed in JSPUI # item record pages. # # If you do not subscribe to CNRI's handle service, you can change this # to match the persistent URL service you use, or you can force DSpace # to use your site's URL, eg. #handle.canonical.prefix = ${dspace.url}/handle/ # # Note that this will not alter dc.identifer.uri metadata for existing # items (only for subsequent submissions), but it will alter the URL # in JSPUI's 'identifier' message on item record pages for existing items. # # If omitted, the canonical URL prefix will be http://hdl.handle.net/ handle.canonical.prefix = http://hdl.handle.net/ # CNRI Handle prefix handle.prefix = 123456789 ####################### # PROXY CONFIGURATION # 40. Install DSpace/S04/3.2 36 ####################### # uncomment and specify both properties if proxy server required # proxy server for external http requests - use regular hostname without port number http.proxy.host = # port number of proxy server http.proxy.port = NANO Editor Help CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.wikipedia.org/wiki/Nano_(text_editor) References https://wiki.duraspace.org/display/DSDOC3x/Configuration#Configuration-Thebuild. propertiesConfigurationPropertiesFile https://github.com/DSpace/DSpace/blob/master/build.properties 41. Install DSpace/S04/1.8.2 37 Install DSpace/S04/1.8.2 Back to Step 4 Edit "dspace.cfg" file Type the following to edit the DSpace (dspace.cfg) config file: nano /home/dspace/source/dspace/config/dspace.cfg Replace all the places with a pair of percent signs (%something%), with the settings for your system. Please read the notes about each specification very carefully DSpace Folder This must NOT point to /dspace as per the default DSpace documentation. Please review the disk partition setup when preparing an Ubuntu server for the DSpace installation. A separate /home disk partition is created for the DSpace user, application and assetstore! dspace.dir = /home/dspace Server Hostname dspace.hostname = %hostname% dspace.url = http://%hostname% dspace.baseUrl = http://%hostname% An example %hostname% is: scholar.sun.ac.za and NOT http://scholar.sun.ac.za.''' The "http://" part specifies a TCP/IP protocol [13] and is therefore a URL specification, not a hostname only specification. See: Hostname selection before installation for more details. Title dspace.name = %DSpace for My University% Database Connection db.name = postgres db.url = jdbc:postgresql://localhost:5432/dspace db.driver = org.postgresql.Driver Credentials db.username = dspace db.password = %db_user_password% Connections db.maxconnections = 300 db.maxwait = 5000 42. Install DSpace/S04/1.8.2 38 db.maxidle = -1 Email Before setting this up, please read the notes here http://wiki.lib.sun.ac.za/index.php/SUNScholar/Prepare_Ubuntu/S07'' Mail Delivery Server mail.server = %my_university_email_server_address% mail.server.username = %email-user-name% mail.server.password = %email-user-password% Email Addresses mail.from.address = %my_email_address% feedback.recipient = %my_email_address% mail.admin = %my_email_address% alert.recipient = %my_email_address% registration.notify = %my_email_address% Language Specifications default.language = en_ZA OAI URL dspace.oai.url = http://%hostname%/oai The full OAI URL then becomes http://%hostname%/oai/request NANO Editor Help CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.wikipedia.org/wiki/Nano_(text_editor) 43. Install DSpace/S04/1.8.2 39 Example config setup %hostname% = scholar.sun.ac.za %DSpace for My University% = Stellenbosch University Research Repository %db_user_password% = my very secret PostgreSQL DB password %my_university_email_server_address% = mail.sun.ac.za %my_email_address% = scholar@sun.ac.za #---------------------------------------------------------------# #------------------GENERAL CONFIGURATIONS-----------------------# #---------------------------------------------------------------# # These configs are used by underlying DSpace API, and are # # therefore applicable to all interfaces # #---------------------------------------------------------------# ##### Basic information ###### # DSpace installation directory dspace.dir = /home/dspace # DSpace host name - should match base URL. Do not include port number dspace.hostname = scholar.sun.ac.za # DSpace base host URL. Include port number etc. dspace.baseUrl = http://scholar.sun.ac.za # DSpace base URL. Include port number etc., but NOT trailing slash # Change to xmlui if you wish to use the xmlui as the default, or remove 44. Install DSpace/S04/1.8.2 40 # "/jspui" and set webapp of your choice as the "ROOT" webapp in # the servlet engine. dspace.url = http://scholar.sun.ac.za # Name of the site dspace.name = Stellenbosch University SUNScholar ##### Database settings ##### # Database name ("oracle", or "postgres") # db.name = postgres db.name = postgres #db.name = oracle # URL for connecting to database #db.url = jdbc:postgresql://localhost:5432/dspace db.url = jdbc:postgresql://localhost:5432/dspace # JDBC Driver #db.driver = org.postgresql.Driver db.driver = org.postgresql.Driver # Database username and password #db.username = dspace #db.password = dspace db.username = XXXXXX db.password = XXXXXX # Schema name - if your database contains multiple schemas, you can avoid problems with # retrieving the definitions of duplicate object names by specifying # the schema name here that is used for DSpace by uncommenting the following entry # db.schema = # Connection pool parameters # Maximum number of DB connections in pool db.maxconnections = 300 # Maximum time to wait before giving up if all connections in pool are busy (milliseconds) db.maxwait = 5000 # Maximum number of idle connections in pool (-1 = unlimited) db.maxidle = -1 # Determine if prepared statement should be cached. (default is true) db.statementpool = true 45. Install DSpace/S04/1.8.2 41 # Specify a name for the connection pool (useful if you have multiple applications sharing Tomcat's dbcp) # If not specified, defaults to 'dspacepool' # db.poolname = dspacepool ##### Email settings ###### # SMTP mail server mail.server = mail.sun.ac.za # SMTP mail server authentication username and password (if required) # mail.server.username = myusername # mail.server.password = mypassword # SMTP mail server alternate port (defaults to 25) # mail.server.port = 25 # From address for mail mail.from.address = scholar@sun.ac.za # Currently limited to one recipient! feedback.recipient = scholar@sun.ac.za # General site administration (Webmaster) e-mail mail.admin = scholar@sun.ac.za # Recipient for server errors and alerts alert.recipient = hgibson@sun.ac.za # Recipient for new user registration emails registration.notify = scholar@sun.ac.za # Set the default mail character set. This may be over ridden by providing a line # inside the email template "charset: ", otherwise this default is used. #mail.charset = UTF-8 # A comma separated list of hostnames that are allowed to refer browsers to email forms. # Default behaviour is to accept referrals only from dspace.hostname #mail.allowed.referrers = localhost # Pass extra settings to the Java mail library. Comma separated, equals sign between # the key and the value. #mail.extraproperties = mail.smtp.socketFactory.port=465,# mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory,# mail.smtp.socketFactory.fallback=false # An option is added to disable the mailserver. By default, this property is set to false # By setting mail.server.disabled = true, DSpace will not send out emails. 46. Install DSpace/S04/1.8.2 42 # It will instead log the subject of the email which should have been sent # This is especially useful for development and test environments where production data is used when testing functionality. #mail.server.disabled = false # Default language for metadata values default.language = en_ZA 47. 43 Step 6 SUNScholar/Guidelines/Step 6 Back to Guidelines Step 6 - Repository System Backup & Monitoring Plan for disaster recovery, this is vital for long term system sustainability, its as simple as that. http://wiki.lib.sun.ac.za/index.php/SUNScholar/Disaster_Recovery With reference to: http:/ / www. cfses. com/ EI-ASPM/ SCLCM-V7/ actuse12576. htm and http:/ / www. sciencemodel.net PREVIOUS NEXT 48. SUNScholar/Disaster Recovery/Backups/Client Setup 44 SUNScholar/Disaster Recovery/Backups/Client Setup Back to Disaster Recovery Backups SUNScholar/Disaster Recovery/Backups/Server Setup Back to Disaster Recovery Backups Enable "rsync" connections to the backup server Install the firewall service: sudo apt-get install ufw Add a firewall rule for secure remote connections: sudo ufw allow ssh Enable the firewall as follows: sudo ufw enable Create a firewall rule for each client to be backed up as follows: sudo ufw allow from %client-ipaddress% to any Now test your rsync connection to each client as follows: sudo rsync %client-ipaddress%::backup You should get a listing of the backup files in the clients /var/backup folder. Install "backuppc" server If the above is successful then install backuppc on the server as follows: sudo apt-get install backuppc BackupPC has a web interface which you enable as follows: sudo apt-get install apache2 sudo cd /etc/apache2/conf.d sudo ln -s /etc/backuppc/apache.conf backuppc sudo /etc/init.d/apache2 restart Now we add an admin backuppc user as follows: sudo htpasswd /etc/backuppc/htpasswd backuppc 49. SUNScholar/Disaster Recovery/Backups/Server Setup 45 You will prompted to enter a password twice. Setup "backuppc" server Now open a web browser and type the following into the address bar: http://%my-backup-server/backuppc You will be prompted for the username and password that you set up above. After logging in and clicking on "Host Summary", you should be presented with a screen like the following: Now setup backuppc by adding host configurations. There is plenty of backuppc documentation on the internet. However, below is an example screenshot of the critical configuration, Xfer settings, that are done per host. Check out highlighted boxes in red. 50. SUNScholar/Disaster Recovery/Backups/Server Setup 46 Continue to setup backuppc as needed. That's it. 51. 47 Step 7 SUNScholar/Guidelines/Step 7 Back to Guidelines Step 7 - Repository Launch and Registration with Harvesters 1. Plan for an official launch, preferably during Open Access week [1] where your institution signs the Open Access Berlin Declaration [2] . 2.2. Register your repository with as many harvesters as you can, to improve your ranking and internet visibility. http://wiki.lib.sun.ac.za/index.php/SUNScholar/Web_Analytics http://wiki.lib.sun.ac.za/index.php/SUNScholar/Ranking http://www.openarchives.org/Register/ValidateSite Repository Registeries http://www.re3data.org http://registry.duraspace.org http://roar.eprints.org http://www.opendoar.org PREVIOUS NEXT References [1] http://oa.sun.ac.za [2] http://oa.sun.ac.za/?page_id=27 52. 48 Step 8 SUNScholar/Guidelines/Step 8 Back to Guidelines Step 8 - Capture Research Records Submit Research Items Now that your repository system management team have built and helped to launch the repository, it is up to the repository content management team to fill the repository with research outputs. Try to submit as many peer-reviewed articles as possible by asking researchers to supply a copy of published articles to submit to the repository. Ask the campus research office to supply details of research output in an interoperable digital format such as CSV [1] and submit the core metadata to the repository. Extract thesis and disseration records from your library catalogue in an interoperable digital format such as CSV [1] and submit the core metadata to the repository. This will greatly increase the web visibility of the repository and therefore the impact via the internet, of your campus researchers! http://wiki.lib.sun.ac.za/index.php/SUNScholar/Researcher_ID http://wiki.lib.sun.ac.za/index.php/SUNScholar/Copyright http://wiki.lib.sun.ac.za/index.php/SUNScholar/How_do_I_submit_items http://wiki.lib.sun.ac.za/index.php/SUNScholar/Asset_Submissions http://wiki.lib.sun.ac.za/index.php/SUNScholar/Populating http://wiki.lib.sun.ac.za/index.php/SUNScholar/Digitisation http://wiki.lib.sun.ac.za/index.php/SUNScholar/Metadata http://wiki.lib.sun.ac.za/index.php/OpenScholar http://scholar.sun.ac.za/handle/10019.1/265 With reference to: http:/ / www. cfses. com/ EI-ASPM/ SCLCM-V7/ dgm13281. htm and http:/ / www. sciencemodel.net 53. SUNScholar/Guidelines/Step 8 49 PREVIOUS NEXT References [1] http://en.wikipedia.org/wiki/Comma-separated_values SUNScholar/Populating Since SUNScholar is an institutional repository, it belongs to all at Stellenbosch University. It is at the same time an organizational commitment towards preserving our most valuable assets - our research output. Therefore we need everybody's help in populating our repository. Some strategies that can be followed: Research reports Submit full text articles by tracking them from the annual University research report. It is recommended that one works retrospectively according to a specific department. Download the full text from the database in which an article was published. Please contact your faculty librarian for help in this regard. Always first check whether the article hasn't already been submitted to SUNScholar. If it has been submitted, but belongs to more than one department, it can be mapped to various Collections. Please contact scholar@sun.ac.za for assistance. The research reports are available from: http://www0.sun.ac.za/research/en/research-report 54. SUNScholar/Populating 50 Scopus Conduct an "Affiliation" search within Scopus. Use: "Stellenbosch University" The search can be narrowed down to a specific journal, author, etc. Please contact your faculty librarian for help in this regard. Download the full text files, and use the metadata to submit your item to SUNScholar. The metadata lists can also be exported in .csv format, and imported into SUNScholar. The full text will still need to be attached to each individual item. Please contact scholar@sun.ac.za for assistance. Publishers Articles by BioMed Central are deposited in SUNScholar using the SWORD interface. See http://www. biomedcentral.com/info/libraries/sword.In future SUNScholar will be automatically updated once one of our researchers publishes an article with BioMed Central. Contact: Matt Brown E-mail: matt.brown@biomedcentral.com If you are a publisher and would like to batch deposit articles in our repository, please contact scholar@sun.ac.za. Individuals If you have a copy (preprint, galley proof [1] copy, postprint) of an article you want to submit, please continue to do so. Please remember to always first check whether the article hasn't already been submitted to SUNScholar. Blog Posts http://www.openaire.eu/en/component/content/article/76-highlights/ 467-sustainable-practices-for-populating-repositories Back to Scholar Help Back to Guidelines References [1] http://en.wikipedia.org/wiki/Galley_proof 55. 51 Step 9 SUNScholar/Guidelines/Step 9 Back to Guidelines Step 9 - Repository Self-Help and News Start a self-help guide using a wiki or add pages to your library guides for normal users of the repository. Start a news blog to keep all users informed about the latest happenings regarding your repository. News Blog [1] PREVIOUS NEXT References [1] http://blogs.sun.ac.za/sunscholar 56. 52 Step 10 SUNScholar/Guidelines/Step 10 Back to Guidelines Step 10 - Engage Research Partners Remote research institutions or divisions can deposit items, harvest items or receive alerts for new items on the institutional repository. This open interoperability can be achieved with DSpace. Click on one of the following links to find out how. Application Programming Interface (API) http://wiki.lib.sun.ac.za/index.php/SUNScholar/Researcher_ID PREVIOUS NEXT 57. 53 Step 11 SUNScholar/Guidelines/Step 11 Back to Guidelines Step 11 - Continuous System Improvement and Maintenance System Audit PREVIOUS NEXT SUNScholar/Optimisations Back to After Installation Tasks Introduction This wiki page details the major optimisations of the system performed at Stellenbosch University in order to create a truly production optimised version of DSpace. Java Click on the heading above. Tomcat Click on the heading above. Reduce system log sizes Click on the heading above. Email error logs Click on the heading above XMLUI Use XMLUI exclusively to reduce the memory load. http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S08 Database Fix "browse index" configuration to reduce the PostgreSQL database server query load. 58. SUNScholar/Optimisations 54 http://wiki.lib.sun.ac.za/index.php/SUNScholar/Browse_Indexes Vacumn the database regularly http://wiki.lib.sun.ac.za/index.php/SUNScholar/Daily_Admin Bitstream checker Modified bitstream checker settings as follows to reduce database size. #### Checksum Checker Settings #### # Default dispatcher in case none specified plugin.single.org.dspace.checker.BitstreamDispatcher=org.dspace.checker.SimpleDispatcher # check history retention checker.retention.default=1y checker.retention.CHECKSUM_MATCH=2w References https://wiki.duraspace.org/display/DSDOC4x/Validating+CheckSums+of+Bitstreams Monit monitor service In case the Tomcat service halts or hangs due to whatever... , I installed monit to restart the service and then alert me. See an example of my config below, added to the bottom of the /etc/monit/monitrc file. dspace@ir1:/etc/monit$ sudo cat /etc/monit/monitrc set daemon 60 set logfile syslog facility log_daemon set mailserver localhost set mail-format { from: monit@ez.sun.ac.za } set alert root@localhost set httpd port 2812 allow %username%:%password% check process sshd with pidfile /var/run/sshd.pid start = "/usr/sbin/service ssh start" stop = "/usr/sbin/service ssh stop" if failed port 22 protocol ssh with timeout 5 seconds then restart alert hgibson@sun.ac.za check process tomcat6 with pidfile /var/run/tomcat6.pid start = "/usr/sbin/service tomcat6 restart" stop = "/usr/sbin/service tomcat6 stop" if failed port 80 protocol http with timeout 300 seconds then restart alert hgibson@sun.ac.za alert wklap@sun.ac.za All confidential information has been replaced with % signs or captial X's. 59. SUNScholar/Optimisations 55 References https://wiki.duraspace.org/display/DSDOC18/Performance+Tuning+DSpace http://www.turnkeylinux.org/tomcat http://www.tecmint.com/how-to-install-and-setup-monit-linux-process-and-services-monitoring-program http://www.tecmint.com/command-line-tools-to-monitor-linux-performance 60. 56 Step 12 SUNScholar/Repository Information Back to Guidelines Essential Reading (Only available online) 2014 - OXFORD - OPENING ACCESS TO RESEARCH 2014 - WRO - GROWTH OF OPEN ACCESS REPOSITORIES 2005 TO 2012 2014 - ARL - DEVELOPING DIGITAL SCHOLARSHIP SERVICES ON A SHOESTRING BUDGET [1] 2009 - NRGL - SURVEY OF IR SOFTWARE SYSTEMS 2008 - NAGPS - FEDERAL RESEARCH PUBLIC ACCESS ACT AND OPEN ACCESS 2008 - JISC - SIRUIS REPORT - INSTITUTIONAL REPOSITORIES 2003 - ARL - CLIFFORD LYNCH - INSTITUTIONAL REPOSITORIES: ESSENTIAL INFRASTRUCTURE FOR SCHOLARSHIP IN THE DIGITAL AGE Open Society Guide to Repository Software [2] Creating an Institutional Repository: LEADIRS Workbook [3] - Barton & Waters - 2004 Institutional Repository Deployment in the United States as of Early 2005 [4] - CNI - Joan K. Lippincott - 2005 Development and implementation of an institutional repository within a science, engineering and technology environment [5] - CSIR - van der Merwe, A - 2008 Open Access and how it affects your citations [6] - University of Pretoria - Kuhn, Johanna - 2012 Repository Examples Below are links to repositories that have started to take a system approach to repository management by supplying a help wiki and a news blog. In addition they have short clean memorable URL's. Unfortunately policies have yet to be published. http://scholar.sun.ac.za - Wiki and blog. Registered with harvesters. http://uir.unisa.ac.za - Blog, no wiki and registered with harvesters. http://cadmus.eui.eu - Fantastic XMLUI style etc... http://repository.uneca.org - Wiki and blog. Not registered with harvesters. http://hub.hku.hk - Unique researcher profiles Below are links to repositories used for digital collections. http://digital.lib.sun.ac.za http://digital.unam.na 61. SUNScholar/Repository Information 57 Repository Support African DSpace Support http://lists.lib.sun.ac.za/mailman/listinfo/irtalk http://lists.lib.sun.ac.za/pipermail/irtalk This is a discussion list to discuss, communicate, share information on all open access and institutional repositories related issues in Africa and South Africa. International DSpace Support Before posting a request, please see: https://wiki.duraspace.org/display/DSPACE/Mailing+List+Etiquette first. DSpace General [7] DSpace Technical [8] DSpace Change Log [9] International Open Access Discussion http://mailman.ecs.soton.ac.uk/mailman/listinfo/goal''' The Global Open Access List (GOAL) is the successor of the American Scientist Open Access (AmSci) Forum, which was the first Open Access Forum, begun in 1998 and hosted for 13 years (1998-2011) by Sigma Xi. http:// amsci-forum.amsci.org/archives/American-Scientist-Open-Access-Forum.html Open Access is no longer just an American or a Scientific Matter. It is a global movement with the goal of making all 2.5 million articles published annually in the planet's 25,000 peer-reviewed journals -- in all scholarly and scientific fields, and in all languages -- freely accessible online to anyone on the Web. GOAL is accordingly dedicated to the discussion of Open Access practice and policy-making by the worldwide research community (in no order: researchers, universities, research institutions, research funding agencies, governmental research policy-makers and commercial entities) with the aim of enabling concrete, practical steps to be taken to achieve Open Access. Chief among these goals are techniques for increasing the amount of Open Access, as well as metrics of research usage and impact. Documentation http://aoasg.org.au http://repo.rsp.ac.uk http://www.openaire.eu/en/support/faq http://digitalcommons.bepress.com/repository-research http://www.coar-repositories.org/working-groups/repository-and-repository-networks-support-and-training/ resources http://www.coar-repositories.org/activities/support-and-training/resources/ http://www.jiscinfonet.ac.uk/infokits/repositories http://wikieducator.org/Institutional_Repository 62. SUNScholar/Repository Information 58 Consultants http://www.dspace.org/service-providers http://www.lyncode.com - Repository Styling http://www.gstudio.co.za - Repository Styling http://www.jumpingbean.co.za - Java webapps http://atmire.com - Full range of repository DSpace software services Repository Policy Dr Reggie Raju - University of Cape Town - reggie.raju@uct.ac.za [10] Michelle Willmers - University of Cape Town - michelle.willmers@uct.ac.za [11] Elsabe Olivier - University of Pretoria - elsabe.olivier@up.ac.za [12] Repository Management Ina Smith - Stellenbosch University - ismith@sun.ac.za [7] Hettie Groenewald - University of Pretoria - hettie.groenewald@up.ac.za [13] Allison Fullard - University of the Western Cape - afullard@uwc.ac.za [14] Denise Nicholson - University of the Witwatersrand - denise.nicholson@wits.ac.za [15] Ansie van der Westhuizen - University of South Africa - Watkiapj@unisa.ac.za [16] Lazarus Matizirofa - University of Johannesburg - lmatizirofa@uj.ac.za [17] Repository Librarians Paulette Talliard - Stellenbosch University - plt@sun.ac.za [18] Ricardo Davids - Stellenbosch University - rddavids@sun.ac.za [19] Repository Systems Administrators Hilton Gibson - hilton.gibson@gmail.com [9] Bravismore Mumanyi - bravismore@unam.na [20] Lighton Phiri - lighton.phiri@gmail.com [21] Lewatle Phaladi - Lewatle.Phaladi@wits.ac.za [22] Barrie Swanepoel - barries@uj.ac.za [23] Sean Carte - sean.carte@gmail.com [24] Solomon Kapfunde - skapfunde@uwc.ac.za [25] Thato Mahlatji - t.tmahlatji@gmail.com [26] Sakhi Louw - selouw@uwc.ac.za [27] Darryn Francesco - darryn.francesco@gmail.com [28] Stellenbosch University Library Systems The above guidelines were used to build the following systems: http://scholar.sun.ac.za http://www.journals.ac.za http://conferences.sun.ac.za http://digital.lib.sun.ac.za http://ar1.sun.ac.za http://aj1.sun.ac.za 63. SUNScholar/Repository Information 59 References [1] http://crln.acrl.org/content/75/4/187.full [2] http://www.budapestopenaccessinitiative.org/resources/guide-to-institutional-repository-software [3] http://hdl.handle.net/1721.1/26698 [4] http://www.dlib.org/dlib/september05/lynch/09lynch.html [5] http://hdl.handle.net/10204/2504 [6] http://hdl.handle.net/2263/19210 [7] http://lists.sourceforge.net/lists/listinfo/dspace-general [8] http://lists.sourceforge.net/lists/listinfo/dspace-tech [9] http://lists.sourceforge.net/lists/listinfo/dspace-changelog [10] mailto:rraju@sun.ac.za [11] mailto:michelle.willmers@uct.ac.za [12] mailto:elsabe.olivier@up.ac.za [13] mailto:hettie.groenewald@up.ac.za [14] mailto:afullard@uwc.ac.za [15] mailto:denise.nicholson@wits.ac.za [16] mailto:Watkiapj@unisa.ac.za [17] mailto:lmatizirofa@uj.ac.za [18] mailto:plt@sun.ac.za [19] mailto:rddavids@sun.ac.za [20] mailto:bravismore@unam.na [21] mailto:lighton.phiri@gmail.com [22] mailto:Lewatle.Phaladi@wits.ac.za [23] mailto:barries@uj.ac.za [24] mailto:sean.carte@gmail.com [25] mailto:skapfunde@uwc.ac.za [26] mailto:t.tmahlatji@gmail.com [27] mailto:selouw@uwc.ac.za [28] mailto:darryn.francesco@gmail.com 64. 60 XMLUI SUNScholar/XMLUI Theme Back to Theme This page describes the method for customising DSpace using the Manakin (XMLUI) interface with the supplied Mirage theme. This procedure is much easier to achieve if you build yourself an Ubuntu desktop computer [1] to use first. Step 1 - Read the "Tutorial" Step 2 - Create "MyTheme" Step 3 - Modify "MyTheme" Step 4 - Rebuild DSpace to compile and then activate the new theme as a "module" overlay Step 5 - View new look Type the following in the address bar and then press F5 on the keyboard to refresh your internet browser cache. http://%hostname% Replace %hostname% with the hostname of your server. SUNScholar/XMLUI Theme/Tutorial Back to XMLUI Theme Introduction The XMLUI is one of the web user interfaces available to DSpace, the other is the JSPUI. The XMLUI is based on Manakin using COCOON pipelines and the DRI schema to render the HTML web pages. This wiki page provides a brief overview of the technical properties of the XMLUI. Theme Definition 1.1. The Tomcat server is configured to use port 80 and 443. 2.2. The Tomcat server is configured to use the XMLUI interface as default. 3. The aspects (functionality) to be used are defined in the xmlui.xconf file. 4. The XMLUI theme to be used is defined in the xmlui.xconf file. 5. The XMLUI theme is rendered using a pipeline, expressed simply as: DRI => XML => XSL => XHTML => CSS. 65. SUNScholar/XMLUI Theme/Tutorial 61 Theme Transformation Pipeline Sequence A Java file per aspect is created to form the DRI in an XML format. ls -lR /home/dspace/source/dspace-xmlui/src/main/java/org/dspace/app/xmlui/aspect The DRI XML is transformed via XSL to XHTML, using global transformers. nano /home/dspace/source/dspace-xmlui/src/main/webapp/sitemap.xmap The XML is further transformed via XSL to XHTML, using localised transformers, assuming you selected to use the clean "template" theme. nano /home/dspace/source/dspace-xmlui/src/main/webapp/themes/template/sitemap.xmap The XHTML files are styled per theme using CSS files. ls -lR /home/dspace/source/dspace-xmlui/src/main/webapp/themes/template/lib/ Official Help View the following for official DSpace Manakin help. https://wiki.duraspace.org/display/DSPACE/Manakin+theme+tutorial https://wiki.duraspace.org/label/DSPACE/manakinhowto View the following for a better understanding of XMLUI Mirage theme design using the "modules" overlay method: http://www.slideshare.net/tdonohue/making-dspace-xmlui-your-own 66. SUNScholar/XMLUI Theme/Tutorial 62 Development Tools DRI (Digital Repository Interface) Schema The DRI XML Document consists of the root element document and three top-level elements that contain two major types of elements. The three top-level containers are meta, body, and options. Detailed Information https://wiki.duraspace.org/display/DSDOC4x/DRI+Schema+Reference https://wiki.duraspace.org/display/DSDOC3x/DRI+Schema+Reference https://wiki.duraspace.org/display/DSDOC18/DRI+Schema+Reference https://wiki.duraspace.org/display/DSDOC17/DRI+Schema+Reference DRI2XHTML Transformers The DRI is transformed into XHTML using XSL templates. There are two main base templates you can use when creating an XMLUI Theme: dri2xhtml - used in the generation of default Reference, Classic and Kubrick themes dri2xhtml-alt - used in the generation of default Mirage theme You only should use one of these two templates, based on which seems easier to you. 67. SUNScholar/XMLUI Theme/Tutorial 63 Theme path A new feature in DSpace 1.5 is the ability to try out different themes on a particular page without having to mess with the xmlui.xconf file or needing to restart Tomcat. Two things need to be done in order to apply a theme to any page you are currently looking at. 1. The following setting in dspace.cfg must be set to true: xmlui.theme.allowoverrides=true 2.2. The "themepath" value should be appended to the end of the url. See examples below. http://scholar.sun.ac.za/?themepath=Classic/ http://scholar.sun.ac.za/?themepath=Reference/ http://scholar.sun.ac.za/?themepath=Mirage/ http://scholar.sun.ac.za/?themepath=Kubrick/ http://scholar.sun.ac.za/?themepath=mobile/ Now check all themes rendering the discovery search page. http://scholar.sun.ac.za/discover?themepath=Classic/ http://scholar.sun.ac.za/discover?themepath=Reference/ http://scholar.sun.ac.za/discover?themepath=Mirage/ http://scholar.sun.ac.za/discover?themepath=Kubrick/ http://scholar.sun.ac.za/discover?themepath=mobile/ DRI Expression You can view the DRI (Digital Repository Interface) elements as follows per page by prepending DRI/. http://scholar.sun.ac.za/DRI/discover http://scholar.sun.ac.za/DRI/statistics-home XML Expression You can view the XML elements as follows per page by appending ?XML. http://scholar.sun.ac.za/discover?XML http://scholar.sun.ac.za/statistics-home?XML Combined Expression Now lets combine expressions as follows. http://scholar.sun.ac.za/DRI/?themepath=Classic/ http://scholar.sun.ac.za/DRI/discover?themepath=Classic/ http://scholar.sun.ac.za/DRI/statistics-home?themepath=Classic/ Getting at the raw XHTML Moving further down the pipeline, once the XSL templates have been applied and DRI has been converted into XHTML, CSS rules can be applied to the result in order to impart a specific look and feel to the theme. This is the point where Tier 1 development usually begins. When editing the CSS, Manakin theme development is much like any Web development project. You start out with XHTML, a blank CSS and possibly a design in mind, and work with the CSS until the results are satisfactory. Getting at the raw XHTML output of the XSL processor is easy: all browsers allow the user to look at the page source and save a copy. While the underlying HTML varies for any given DSpace page, the top-level structures like body and header remain consistent. One technique is to go through DSpace page by page, look at the HTML, and 68. SUNScholar/XMLUI Theme/Tutorial 64 create CSS rules as necessary. Alternatively, you can extend the Reference theme that contains CSS selectors for nearly all elements encountered in the HTML structures of Manakin DSpace. CSS Tips and Tricks Firefox Download and install the latest version of Firefox from: http://www.mozilla.org/en-US/firefox/new/ Determining current style elements used Right-click on any part of the website to view the CSS element detail. You can change things in real time per item, in the right hand pane, to see what it will look like. See screenshots below. 69. SUNScholar/XMLUI Theme/Tutorial 65 Theme Repository Check out the following theme repositories. http://web.lib.sun.ac.za/style/sunscholar/theme :- DS32 = DSpace 3.2, DS182 = DSpace 1.8.2, DS172 = DSpace 1.7.2 https://wiki.duraspace.org/display/DSPACE/Repository+of+XMLUI+themes References https://wiki.duraspace.org/display/DSDOC4x/XMLUI+Configuration+and+Customization https://wiki.duraspace.org/display/DSPACE/Manakin+theme+tutorial Development https://atmire.com/website/?q=content/fresh-look-and-feel-dspace-4 Tips http://www.slideshare.net/bramluyten/dspace-3-xml https://wiki.duraspace.org/display/DSPACE/XMLUI+How+To+Guides https://wiki.duraspace.org/display/DSPACE/ TechnicalFaq#TechnicalFaq-HowdoIremovethesearchboxfromthefrontpageinXMLUI https://wiki.duraspace.org/pages/viewpage.action?pageId=19006130 http://design.ubuntu.com/assets/colour-palette http://design.ubuntu.com/assets/ubuntu-font-family 70. SUNScholar/XMLUI Theme/Creation 66 SUNScholar/XMLUI Theme/Creation Back to XMLUI Theme Requirements Please see: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S03 Make sure you have correctly "symlinked" to the source code, see step 3.2 above. The default folder is: /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/[custom-theme-dir] Method We will be using the "modules" overlay method to create a custom theme. You can replace "Mytheme" with a theme name of your choice for all of the following instructions. Step 1 - Copy the "Mirage" reference theme to a custom "Mytheme" Type the following to create your own custom theme folder and files using the reference "Mirage" theme. mkdir /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes mkdir /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme cd /home/dspace/source/dspace-xmlui/dspace-xmlui-webapp/src/main/webapp/themes cp -R Mirage /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme Step 2 - Modify the "xmlui.xconf" file to use "Mytheme" Type the following to go to your DSpace config directory. cd /home/dspace/source/dspace/config Type the following to edit the DSpace XMLUI config file. nano xmlui.xconf Add the following to "xmlui.xconf" file in the themes section using copy and paste with firefox and nano. Make sure to comment out all other theme references !! NANO Editor Help 71. SUNScholar/XMLUI Theme/Creation 67 CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.wikipedia.org/wiki/Nano_(text_editor) Step 3 - Modify the "sitemap.xmap" file to use "Mytheme" Type the following to change directory to the "Mytheme" folder. cd /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme Modify the sitemap.xmap config file for your new theme by typing the following. nano sitemap.xmap Change the "theme-path" and "theme-name" parameters in the sitemap.xmap file using the "nano" editor. MythemeMytheme NANO Editor Help CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.wikipedia.org/wiki/Nano_(text_editor) 72. SUNScholar/XMLUI Theme/Creation 68 Step 4 - Rename the "Mirage.xsl" file to "Mytheme.xsl" Type the following. cd /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme Rename the "Mirage.xsl" file to "Mytheme.xsl" by typing the following. mv Mirage.xsl Mytheme.xsl SUNScholar/XMLUI Theme/Modify Back to XMLUI Theme Below are links to wiki help pages dealing with the major sections of custom styling your repository website. SUNScholar/XMLUI Theme/Page Content Back to XMLUI Theme Modification Upload your own header logo Upload your repositories logo to the following images folder. /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme/images Overwrite or create a file called logo.png and make sure that the CSS stylesheets refer to your custom logo header image file. Customise the front page introduction Type the following. nano /home/dspace/source/dspace/config/news-xmlui.xml Use the following tags for content markup: Bold text... Italic text... Title etc..

.....

for paragraphs. BOAI Section 3 for hyperlinks to other online content. NANO Editor Help 73. SUNScholar/XMLUI Theme/Page Content 69 CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.wikipedia.org/wiki/Nano_(text_editor) Customise the page footer Type the following. nano /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme/lib/xsl/core/page-structure.xsl Search for "footer" around line 557 approx by typing CTL+W and modify accordingly. See modified example below.

DSpace 1.8.2 | Ubuntu 10.04 | CopyrightStellenbosch University

NANO Editor Help CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.wikipedia.org/wiki/Nano_(text_editor) 74. SUNScholar/XMLUI Theme/Page Content 70 Enable public view of item counts Edit the DSpace config file as follows: nano /home/dspace/source/dspace/config/dspace.cfg Change the following to true: webui.strengths.show = true webui.strengths.cache = true Use unique icons for digital format types in item view Go to the folder containing the item view xsl file. cd /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme/lib/xsl/aspect/artifactbrowser Edit the following file. nano item-view.xsl Find the following section; Copy and paste the following EXACTLY above the section mentioned above. Make sure to correctly indent items. 75. SUNScholar/XMLUI Theme/Page Content 71 76. SUNScholar/XMLUI Theme/Page Content 72 NANO Editor Help CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.wikipedia.org/wiki/Nano_(text_editor) Icon design by: http://www.iconarchive.com/artist/treetog.html'' Download the icons compressed tarball (tar.gz) from the following web folder to your themes images folder as follows. cd /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme/images wget http://web.lib.sun.ac.za/style/icons/icons.tar.gz tar -xzvf icons.tar.gz rm icons.tar.gz cd icons chmod 0777 * You can browse the individual icons by going to: http://web.lib.sun.ac.za/style/icons Finally add the following common formats to DSpace. 77. SUNScholar/XMLUI Theme/Page Content 73 Tips https://wiki.duraspace.org/pages/viewpage.action?pageId=19006388 - Modify item metadata display https://wiki.duraspace.org/pages/viewpage.action?pageId=19006367 - Make author and subject links clickable SUNScholar/XMLUI Theme/Page Structure Back to XMLUI Theme Modification Remove the "Register" link from the right navigation box In the DSpace config file, set the following and rebuild. xmlui.user.registration=false Remove duplicate "Community" browse link from the right navigation box Go to the following folder: cd /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme/lib/xsl/core Open the following file: nano navigation.xsl Add the following to the top of the file: 78. SUNScholar/XMLUI Theme/Page Structure 74 NANO Editor Help CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.wikipedia.org/wiki/Nano_(text_editor) Remove duplicate "Search" input from the right navigation box Go to the following folder: cd /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme/lib/xsl/core Open the following file: nano navigation.xsl Go to line 55 approx and comment out as follows or you can simply delete the text: NANO Editor Help CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.wikipedia.org/wiki/Nano_(text_editor) Remove duplicate "Login" link above the top banner logo Go to the following folder: cd /home/dspace/source/dspace/modules/xmlui/src/main/webapp/themes/Mytheme/lib/xsl/core Open the following file: nano page-structure.xsl Go to line 337 approx and comment out as follows or you can simply delete the text: NANO Editor Help CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.wikipedia.org/wiki/Nano_(text_editor) 82. SUNScholar/XMLUI Theme/Page Structure 78 Create custom navigation list Hi Charlene, In navigation.xsl, in the dri:options template, instead of: You should just be able to do: If you have any other custom lists, youll need to be sure to select for those as well. Jacob Brown SUNScholar/XMLUI Theme/Language Back to XMLUI Theme Modification Step 1 - Create custom "messages.xml" file A custom "messages.xml" is created using the modules overlay method with the XMLUI web user interface. mkdir /home/dspace/source/dspace/modules/xmlui/src/main/webapp/i18n cd /home/dspace/source/dspace/modules/xmlui/src/main/webapp/i18n cp /home/dspace/source/dspace-xmlui/dspace-xmlui-webapp/src/main/webapp/i18n/messages.xml . nano /home/dspace/source/dspace/modules/xmlui/src/main/webapp/i18n/messages.xml Modify the "messages.xml" file as desired using "nano". NANO Editor Help 83. SUNScholar/XMLUI Theme/Language 79 CTL+O = Save the file and then press Enter CTL+X = Exit "nano" CTL+K = Delete line CTL+U = Undelete line CTL+W = Search for $string$ CTL+ = Search for and replace $string$ ALT+C = Show line numbers More info = http://en.w