Coversheets - Revision history

Drn@ecs.soton.ac.uk: need to download pdfbox to bin/tools as well and updated to latest version (2.0.24)

2021-10-06T11:31:15Z

need to download pdfbox to bin/tools as well and updated to latest version (2.0.24)

← Older revision		Revision as of 11:31, 6 October 2021
Line 30:		Line 30:
	Once installed download the latest pdf-app-2.x.x JAR file from https://pdfbox.apache.org/download.cgi#20x, e.g.:		Once installed download the latest pdf-app-2.x.x JAR file from https://pdfbox.apache.org/download.cgi#20x, e.g.:

	cd /opt/eprints3/archives/example/bin/		cd /opt/eprints3/archives/example/bin/tools/
	wget http://mirror.ox.ac.uk/sites/rsync.apache.org/pdfbox/2.0.6/pdfbox-app-2.0.6.jar		wget http://mirror.ox.ac.uk/sites/rsync.apache.org/pdfbox/2.0.24/pdfbox-app-2.0.24.jar

	Now create the stitching Bash script that uses the PDFBox JAR file under the filename '''stitchPDFs''' in your archives bin/tools/ directory and add the following ''(provided by Jonathan Green / University of Nottingham)'':		Now create the stitching Bash script that uses the PDFBox JAR file under the filename '''stitchPDFs''' in your archives bin/tools/ directory and add the following ''(provided by Jonathan Green / University of Nottingham)'':

Drn@ecs.soton.ac.uk: Use bin/tools/ directory rather than bin for stitchPDFs.

2021-10-06T11:28:45Z

Use bin/tools/ directory rather than bin for stitchPDFs.

← Older revision		Revision as of 11:28, 6 October 2021
Line 33:		Line 33:
	wget http://mirror.ox.ac.uk/sites/rsync.apache.org/pdfbox/2.0.6/pdfbox-app-2.0.6.jar		wget http://mirror.ox.ac.uk/sites/rsync.apache.org/pdfbox/2.0.6/pdfbox-app-2.0.6.jar

	Now create the stitching Bash script that uses the PDFBox JAR file under the filename '''stitchPDFs''' in your archives bin/ directory and add the following ''(provided by Jonathan Green / University of Nottingham)'':		Now create the stitching Bash script that uses the PDFBox JAR file under the filename '''stitchPDFs''' in your archives bin/tools/ directory and add the following ''(provided by Jonathan Green / University of Nottingham)'':

	#/bin/bash		#/bin/bash
Line 48:		Line 48:
	Modify the permissions on this files so it can be executed:		Modify the permissions on this files so it can be executed:

	chmod a+x bin/stitchPDFs		chmod a+x bin/tools/stitchPDFs

Drn@ecs.soton.ac.uk: Added instructions for using LibreOffice and unoconv

2021-07-05T15:10:12Z

Added instructions for using LibreOffice and unoconv

@@ Line 110: / Line 110: @@
 * ''N.B. For 32-bit versions remove '-64' from each of the lines above.''  You can check this by running the following command.  If it returns something with '64' in it, it is 64-bit, if it does not, it is almost certainly 32-bit.
    uname -i
 == Installing Coversheets ==

Drn@ecs.soton.ac.uk: Added LibreOffice as an alternative to OpenOffice

2021-07-05T14:33:31Z

Added LibreOffice as an alternative to OpenOffice

← Older revision		Revision as of 14:33, 5 July 2021
Line 6:		Line 6:
	Coversheets work by using a user-defined [https://www.openoffice.org/ Apache OpenOffice] coversheet template uploaded to your EPrints repository. This template is then populated with the predefined attributes for the particular EPrint, before being attached to the front (or if specified, back) of any PDF documents uploaded for that EPrint. To do this a number of dependencies need to be installed:		Coversheets work by using a user-defined [https://www.openoffice.org/ Apache OpenOffice] coversheet template uploaded to your EPrints repository. This template is then populated with the predefined attributes for the particular EPrint, before being attached to the front (or if specified, back) of any PDF documents uploaded for that EPrint. To do this a number of dependencies need to be installed:
	* '''PDFBox''' or '''Ghostscript''': Either of these can be used to attach the coversheet to the rest of the PDF document.		* '''PDFBox''' or '''Ghostscript''': Either of these can be used to attach the coversheet to the rest of the PDF document.
	* '''Apache OpenOffice''': This is used to open up the coversheet template, so that a coversheet for a particular EPrint can be created.		* '''Apache OpenOffice''' or '''LibreOffice''': This is used to open up the coversheet template, so that a coversheet for a particular EPrint can be created.
	* '''Perl Modules''': Needed for EPrints to interact with OpenOffice.		* '''Perl Modules''': Needed for EPrints to interact with OpenOffice.

Drn@ecs.soton.ac.uk: Added specific Install section for installing required plugins through the Bazaar.

2021-05-04T08:50:10Z

Added specific Install section for installing required plugins through the Bazaar.

← Older revision		Revision as of 08:50, 4 May 2021
Line 111:		Line 111:
	uname -i		uname -i

			== Installing Coversheets ==
			* Go to the "EPrints Bazaar" (e.g. https://example.eprints.org/cgi/users/home?screen=Admin%3A%3AEPM) page of your EPrints repository (navigatable via the "System Tools" tab of the "Admin" page). Under the "Available" tab, first install the "OpenOffice Toolkit" Bazaar plugin. As well as the green box saying the plugin installed successfully, there should also be a green box under the newly installed plugin saying:
			OpenOffice is ready to be used on your system. To start or stop OpenOffice, go to the Admin page, under 'System Tools'.
			If this is the case, again from the "Available" tab install the "Coversheets" Bazaar plugin.

	== Enabling Coversheets ==		== Enabling Coversheets ==

Drn@ecs.soton.ac.uk: Removed stuff about Oracle Java. This is not needed

2017-06-02T13:40:57Z

Removed stuff about Oracle Java. This is not needed

← Older revision		Revision as of 13:40, 2 June 2017
Line 7:		Line 7:
	* '''PDFBox''' or '''Ghostscript''': Either of these can be used to attach the coversheet to the rest of the PDF document.		* '''PDFBox''' or '''Ghostscript''': Either of these can be used to attach the coversheet to the rest of the PDF document.
	* '''Apache OpenOffice''': This is used to open up the coversheet template, so that a coversheet for a particular EPrint can be created.		* '''Apache OpenOffice''': This is used to open up the coversheet template, so that a coversheet for a particular EPrint can be created.
	* '''Oracle (Sun) Java''': This is required to run the script to interact with OpenOffice and replace the templates tags with the appropriate EPrint attributes (title, authors, etc.).
	* '''Perl Modules''': Needed for EPrints to interact with OpenOffice.		* '''Perl Modules''': Needed for EPrints to interact with OpenOffice.

Line 61:		Line 60:
	If you installed EPrints using the DEB or RPM package, it is likely many if not all of these packages will already be installed.		If you installed EPrints using the DEB or RPM package, it is likely many if not all of these packages will already be installed.

			Oracle (Sun) Java is required to make use of the Coversheets package work with Ghostcript. By default this is not available in the standard package repositories of most Linux distributions. Follow the instructions below (as the root user or with sudo) to install Oracle (Sun) Java on your Linux distribution:
	~~===Oracle (Sun) Java===~~
	Oracle (Sun) Java is required to make use of the Coversheets package. By default this is not available in the standard package repositories of most Linux distributions. Follow the instructions below (as the root user or with sudo) to install Oracle (Sun) Java on your Linux distribution:

	* '''Debian/Ubuntu'''		* '''Debian/Ubuntu'''

Drn@ecs.soton.ac.uk at 13:31, 2 June 2017

2017-06-02T13:31:50Z

← Older revision		Revision as of 13:31, 2 June 2017
Line 121:		Line 121:
	* If the Coversheets package successfully installed. Click on the '''Admin''' link in the top menu bar and under the '''System Tools''' tab click on '''Start OpenOffice'''.		* If the Coversheets package successfully installed. Click on the '''Admin''' link in the top menu bar and under the '''System Tools''' tab click on '''Start OpenOffice'''.
	* If you are us PDFBox, you will need to edit your archive's cfg/cfg.d/z_coversheets.pl file and change the '''$c->{gs_pdf_stitch_cmd}''' to the following		* If you are us PDFBox, you will need to edit your archive's cfg/cfg.d/z_coversheets.pl file and change the '''$c->{gs_pdf_stitch_cmd}''' to the following
	$c->{gs_pdf_stich_cmd} = $c->{~~base_path~~} . "~~/site_lib~~/bin/tools/stitchPDFs ";		$c->{gs_pdf_stich_cmd} = $c->{archiveroot} . "/bin/tools/stitchPDFs ";
	* When the page reloads next click on '''Start Indexer''', if t is not already started.		* When the page reloads next click on '''Start Indexer''', if t is not already started.
	* Coversheets should now be installed and ready to go. You can test this by following the instructions under '''[[#Deploying Coversheets\|Deploying Coversheets]]'''.		* Coversheets should now be installed and ready to go. You can test this by following the instructions under '''[[#Deploying Coversheets\|Deploying Coversheets]]'''.

Drn@ecs.soton.ac.uk: Changed to recommend using PDFBox over Ghostscript

2017-06-02T13:05:30Z

Changed to recommend using PDFBox over Ghostscript

@@ Line 5: / Line 5: @@
 Coversheets work by using a user-defined [https://www.openoffice.org/ Apache OpenOffice] coversheet template uploaded to your EPrints repository.  This template is then populated with the predefined attributes for the particular EPrint, before being attached to the front (or if specified, back) of any PDF documents uploaded for that EPrint.  To do this a number of dependencies need to be installed:
-* '''Ghostscript''' or '''PDFtk''':  Either of these can be used to attach the coversheet to the rest of the PDF document.
+* '''PDFBox''' or '''Ghostscript''':  Either of these can be used to attach the coversheet to the rest of the PDF document.
 * '''Apache OpenOffice''': This is used to open up the coversheet template, so that a coversheet for a particular EPrint can be created.
 * '''Oracle (Sun) Java''': This is required to run the script to interact with OpenOffice and replace the templates tags with the appropriate EPrint attributes (title, authors, etc.).
@@ Line 14: / Line 14: @@
 ==Installing Dependencies==
-===GhostScript or PDFtk===
+===PDFBox or GhostScript===
-The Coversheets Bazaar package requires either '''PDFtk''' or '''Ghostscript''' to attach the generated coversheet to the rest of the PDF document.  For the more recent Linux distributions (e.g. Ubuntu 14.04, Debian 7 and RedHat/CentOS 7) Ghostscript is recommended as this is easier to install and more reliable, (e.g. it can reliably attach the coversheet without breaking the character encoding of the rest of the document, so you can still copy and paste out sections of the document).  However, it may be less straightforward to get Ghostscript working for Coversheets on earlier distributions of Linux (e.g. pre Ubuntu 12.04 and RedHat/CentOS 6)
+The Coversheets Bazaar package requires either '''PDFBox''' or '''GhostScript''' to attach the generated coversheet to the rest of the PDF document.  For the more recent Linux distributions (e.g. Ubuntu 14.04+, Debian 7 and RedHat/CentOS 7) PDFBox is recommended as this is more reliable and robust, (i.e. it is less likely for a coversheet task to fail or take up a lot or resources for a long period of time).  Using PDFBox or GhostScript on earlier versions of Linux may be difficult, it is likely any packages you may need to install may not be present by default or have different names because they are earlier versions.
-====Ghostscript====
+====PDFBox====
-Installing Ghostscript just requires a number of Linux packages.  As root or with sudo run the appropriate following command:
+Installing PDFBox requires Java to be installed.  As root or with sudo this can be done by running the appropriate following command:
 * Debian/Ubuntu:
    apt-get install ghostscript gsfonts gsfonts-other libgs9 libgs9-common
@@ Line 25: / Line 60: @@
 If you installed EPrints using the DEB or RPM package, it is likely many if not all of these packages will already be installed.
@@ Line 103: / Line 120: @@
 * If the OpenOffice Toolkit package installs successfully, click on '''Enable''' next the '''Coversheets''' package.
 * If the Coversheets package successfully installed.  Click on the '''Admin''' link in the top menu bar and under the '''System Tools''' tab click on '''Start OpenOffice'''.
 * When the page reloads next click on '''Start Indexer''', if t is not already started.
 * Coversheets should now be installed and ready to go.  You can test this by following the instructions under '''[[#Deploying Coversheets|Deploying Coversheets]]'''.

Drn@ecs.soton.ac.uk: fixed some typos

2016-05-05T01:12:57Z

fixed some typos

← Older revision		Revision as of 01:12, 5 May 2016
Line 75:		Line 75:

	'''N.B.'''		'''N.B.'''
	# If you have not had to install any CPAN modules up to now ,you may be prompted to configure CPAN before installing these modules, if so always choose the default ~~option provided~~.		# If you have not had to install any CPAN modules up to now, you may be prompted to configure CPAN before installing these modules, if so always choose the default options suggested.
	# For Archive::Zip it is recommended to use the specific version 1.30 tarball (as specified above). CPAN will download this specific tarball as part of the installation, like it would for non-version specific modules. The reason for using this specific version is, that as of at least 28th April 2015 the latest CPAN module has a bug, which means it does not work as required for EPrints Coversheet purposes.		# For Archive::Zip it is recommended to use the specific version 1.30 tarball (as specified above). CPAN will download this specific tarball as part of the installation, like it would for non-version specific modules. The reason for using this specific version is, that as of at least 28th April 2015 the latest CPAN module has a bug, which means it does not work as required for EPrints Coversheet purposes.

Line 108:		Line 108:

	== Deploying Coversheets ==		== Deploying Coversheets ==
	* Logged in as an adminstrator, click on '''Manage records''' then '''Coversheets'''. If you cannot find the the '''Manage records''' link you can go straight to the list of coversheet records at (substituting '''example.eprints.org''' for the hostname of you ~~Eprints~~ repository):		* Logged in as an adminstrator, click on '''Manage records''' then '''Coversheets'''. If you cannot find the the '''Manage records''' link you can go straight to the list of coversheet records at (substituting '''example.eprints.org''' for the hostname of you EPrints repository):
	http://example.eprints.org/cgi/users/home?screen=Listing&dataset=coversheet		http://example.eprints.org/cgi/users/home?screen=Listing&dataset=coversheet
	* Under the Coversheets page, click on '''Create New Coversheet'''. Fill in the '''Name''' and Description fields under '''Apply to''' checked the types you want to use a coversheet for.and set '''Priority''' to '''1'''. If you wish to apply the coversheet to other types make sure they are checked as well.		* Under the Coversheets page, click on '''Create New Coversheet'''. Fill in the '''Name''' and Description fields under '''Apply to''' checked the types you want to use a coversheet for.and set '''Priority''' to '''1'''. If you wish to apply the coversheet to other types make sure they are checked as well.
Line 153:		Line 153:
	=== Troubleshooting whilst Designing your own Coversheet Template ===		=== Troubleshooting whilst Designing your own Coversheet Template ===
	==== Adding and formatting tags on your Coversheet Template ====		==== Adding and formatting tags on your Coversheet Template ====
	Make sure when you add tags (e.g. ##title##) to your coversheet template you type the whole string in one go. Try to avoid copying and pasting tags about, especially avoid ~~copy~~ parts of tags. Also be careful when changing the formatting (e.g. font size, colour, etc.) of a tag, making sure you change the format for the whole tag.		Make sure when you add tags (e.g. ##title##) to your coversheet template you type the whole string in one go. Try to avoid copying and pasting tags about, especially avoid copying parts of tags. Also be careful when changing the formatting (e.g. font size, colour, etc.) of a tag, making sure you change the format for the whole tag. Not doing these things could lead to the underlying representing of the whole tag being broken up by styling elements, meaning that the coversheet package will not be able to find these tags to substitute them with the appropriate attribute from the EPrint. So when you come to look at the coversheet for your document, you will see the tag rather than the substituted attribute.

	Not doing these things could lead to the underlying representing of the whole tag being broken up by styling elements, meaning that the coversheet package will no be able to find these tags to substitute them with the appropriate attribute from the EPrint. So when you come to look at the coversheet for your document, you will see the tag rather than the substituted attribute.

	===Known issue with Centos 7===		===Known issue with Centos 7===

Drn@ecs.soton.ac.uk: /* Designing your own Coversheet Template */

2016-02-18T12:41:24Z

Designing your own Coversheet Template

← Older revision		Revision as of 12:41, 18 February 2016
Line 139:		Line 139:
	** ##creators## (list of authors/editors of the EPrint)		** ##creators## (list of authors/editors of the EPrint)
	** ##doi_url##		** ##doi_url##
	* Once you have finished your design, before saving make you do not have any white space at the end of the document, as this may cause a blank page to be added between your coversheet and main document.		* Once you have finished your design, before saving make sure you do not have any white space at the end of the document, as this may cause a blank page to be added between your coversheet and main document.
	* After saving the file, you can upload to your EPrints repository as described in '''[[#Deploying Coversheets\|Deploying Coversheets]]'''.		* After saving the file, you can upload to your EPrints repository as described in '''[[#Deploying Coversheets\|Deploying Coversheets]]'''.


	== Tips and Tricks ==		== Tips and Tricks ==