Epubgen: Creating epub files from Elsevier dataset - Revision history

Cvr: /* How to contact */

2009-10-21T09:59:47Z

How to contact

← Older revision		Revision as of 15:29, 21 October 2009
Line 78:		Line 78:

	==How to contact==		==How to contact==
	~~suggestions~~, recommendations, bug reports, etc can be send to [mailto:latex.support@river-valley.com Support]. Bugs can also be filed at the [https://gna.org/bugs/?func=additem&group=epubgen Bugtracker], but you need to login at [http://gna.org http://gna.org].		Suggestions, recommendations, feature requests, bug reports, etc can be send to [mailto:latex.support@river-valley.com Support]. Bugs can also be filed at the [https://gna.org/bugs/?func=additem&group=epubgen Bugtracker], but you need to login at [http://gna.org http://gna.org].

Cvr: /* Project home page */

2009-10-21T09:58:53Z

Project home page

← Older revision		Revision as of 15:28, 21 October 2009
Line 68:		Line 68:
	--level or -l Level of table of contents to be included in the toc.ncx file of epub. Default is 3		--level or -l Level of table of contents to be included in the toc.ncx file of epub. Default is 3

	===Project home page===		==Project home page==
	This project is hosted in gna.org. The URL is:		This project is hosted in gna.org. The URL is:

Line 76:		Line 76:

	[https://gna.org/svn/?group=epubgen https://gna.org/svn/?group=epubgen]		[https://gna.org/svn/?group=epubgen https://gna.org/svn/?group=epubgen]

			==How to contact==
			suggestions, recommendations, bug reports, etc can be send to [mailto:latex.support@river-valley.com Support]. Bugs can also be filed at the [https://gna.org/bugs/?func=additem&group=epubgen Bugtracker], but you need to login at [http://gna.org http://gna.org].

Cvr: /* How to create epub files? */

2009-10-21T09:49:37Z

How to create epub files?

← Older revision		Revision as of 15:19, 21 October 2009
Line 26:		Line 26:
	Firstly, edit the <code>epub.conf</code> file to set the path of <code>Java</code>. Even if Java path is set properly in your system variables, setting this path in <code>epub.conf</code> is also necessary. For both Linux and Windows, seperate variables are given. If you are a Linux user, then set the variable for Linux and comment out the variable for Windows and vice versa.		Firstly, edit the <code>epub.conf</code> file to set the path of <code>Java</code>. Even if Java path is set properly in your system variables, setting this path in <code>epub.conf</code> is also necessary. For both Linux and Windows, seperate variables are given. If you are a Linux user, then set the variable for Linux and comment out the variable for Windows and vice versa.

	===How to create epub files?===		==How to create epub files?==
	Unzip the CONTRAST-OUT dataset to any folder and use the following syntax:		Unzip the CONTRAST-OUT dataset to any folder and use the following syntax:

Line 52:		Line 52:
	epubgen.pl -d e:\my-dataset\EWX00001158 -p e:\my-epub-files\		epubgen.pl -d e:\my-dataset\EWX00001158 -p e:\my-epub-files\

	====List of options====		===List of options===
	--valid or -v Validate the epub file produced. Default is to validate		--valid or -v Validate the epub file produced. Default is to validate

Cvr: /* How to create epub files? */

2009-10-21T09:48:05Z

How to create epub files?

← Older revision		Revision as of 15:18, 21 October 2009
Line 32:		Line 32:

	<font color="green">Syntax</font>		<font color="green">Syntax</font>
	epubgen.sh -d [Options] [name of folder where dataset.xml resides] -p [folder where epub file should be generated]		epubgen.sh -d [Options] [name of folder where dataset.xml resides] \
			-p [folder where epub file should be generated]

	<font color="green">Example</font>		<font color="green">Example</font>
Line 42:		Line 43:

	<font color="green">Syntax</font>		<font color="green">Syntax</font>
	epubgen.sh -d [Options] [name of folder where dataset.xml resides] -p [folder where epub file should be generated]		epubgen.sh -d [Options] [name of folder where dataset.xml resides]
	epubgen.pl -d [Options] [name of folder where dataset.xml resides] -p [folder where epub file should be generated]		-p [folder where epub file should be generated]
			epubgen.pl -d [Options] [name of folder where dataset.xml resides]
			-p [folder where epub file should be generated]

	<font color="green">Example</font>		<font color="green">Example</font>

Cvr: /* Software dependencies */

2009-10-21T09:45:35Z

Software dependencies

← Older revision		Revision as of 15:15, 21 October 2009
Line 11:		Line 11:

	===Software dependencies===		===Software dependencies===
	# epubcheck (version 1.0.4 or higher) which is a parser for epub files.		# <code>epubcheck</code> (version 1.0.4 or higher) which is a parser for epub files.
	# Perl 5.8.8 or higher		# <code>Perl 5.8.8</code> or higher
	# xsltproc		# <code>xsltproc</code>
	# saxon (ver. 9 or higher)		# <code>saxon</code> (ver. 9 or higher)
	# xmllint		# <code>xmllint</code>
	# convert (ImageMagick 6.3.7 or higher)		# <code>convert</code> (ImageMagick 6.3.7 or higher)
	# zip. The ePub file is actually a zip file with extension <code>.epub</code>.		# <code>zip</code>. The ePub file is actually a <code>zip</code> file with extension <code>.epub</code>.
	# Java 1.6 or higher.		# <code>Java 1.6</code> or higher.
	# Cygwin is required for Windows.		# <code>Cygwin</code> is required for Windows.

	===Installation===		===Installation===

Cvr: /* Features */

2009-10-21T09:43:51Z

Features

← Older revision		Revision as of 15:13, 21 October 2009
Line 5:		Line 5:

	===Features===		===Features===
	# A single dataset may contain a collection of issues or books. By default each ~~issues~~/~~books~~ will be ~~seperate~~ ePub file. But if epub files of each item (ie, article/book) is needed, then you can split the files.		# A single dataset may contain a collection of issues or books. By default each issue/book will be separate <code>ePub</code> file. But if <code>epub</code> files of each item (ie, article/book) is needed, then you can split the files.
	# In the XML file, both MathML code and as an alternative, stripins (images of MathML code) are available. This program is now set in such a way that you can select to render MathML or view the images or SVG or all of them.		# In the XML file, both MathML code and as an alternative, stripins (images of MathML code) are available. This program is now set in such a way that you can select to render MathML or view the images or SVG or all of them.
	# You can select the level of the table of contents using the command line switch. Default is 3.		# You can select the level of the table of contents using the command line switch. Default is 3.
	# This tool will work both in Linux and Windows ~~Platform~~.		# This tool will work both in Linux and Windows Platforms.

	===Software dependencies===		===Software dependencies===

Cvr: /* What is epubgen? */

2009-10-21T09:41:17Z

What is epubgen?

← Older revision		Revision as of 15:11, 21 October 2009
Line 1:		Line 1:
	=='''What is epubgen?'''==		=='''What is epubgen?'''==
	epubgen is a tool for generating [http://en.wikipedia.org/wiki/EPUB ePub] files from Elsevier's Journal and Book (Stand-alone and Book-Series) CONTRAST-out datasets. epubgen is created as a [http://en.wikipedia.org/wiki/Command-line_interface command line interface (CLI)] tool. This tool is compatible to both Linux and Windows platforms. The input is Elsevier's CONTRAST-OUT dataset and the output is ~~ofcourse~~ the epub file. A dataset is actually an archive (in other terms a container of files). This archive may contain, the PDF, XML, stripins (gif images of MathML code), figures and ~~mainly~~ a dataset.xml. dataset.xml is the entry point to the dataset which ~~may contain~~ the details ~~of the files~~ including path names of the files ~~which are~~ in the dataset.		epubgen is a tool for generating [http://en.wikipedia.org/wiki/EPUB ePub] files from Elsevier's Journal and Book (Stand-alone and Book-Series) CONTRAST-out datasets. epubgen is created as a [http://en.wikipedia.org/wiki/Command-line_interface command line interface (CLI)] tool. This tool is compatible with both Linux and Windows platforms. The input is Elsevier's CONTRAST-OUT dataset and the output is the epub file. A dataset is actually an archive (in other terms a container of files). This archive may contain, the PDF, XML, stripins (gif images of MathML code), figures and a <code>dataset.xml</code>. <code>dataset.xml</code> is the entry point to the dataset which contains the details including path names of the files in the dataset.

	This program is ~~issued~~ under the GNU General Public License.		This program is released under the GNU General Public License.

	===Features===		===Features===

Rishi: /* Software dependencies */

2009-10-21T08:51:59Z

Software dependencies

← Older revision		Revision as of 14:21, 21 October 2009
Line 18:		Line 18:
	# convert (ImageMagick 6.3.7 or higher)		# convert (ImageMagick 6.3.7 or higher)
	# zip. The ePub file is actually a zip file with extension <code>.epub</code>.		# zip. The ePub file is actually a zip file with extension <code>.epub</code>.
	# Java 1.6 or higher ~~for parsing~~.		# Java 1.6 or higher.
	# Cygwin is required for Windows.		# Cygwin is required for Windows.

Rishi: /* Software dependencies */

2009-10-21T08:50:54Z

Software dependencies

← Older revision		Revision as of 14:20, 21 October 2009
Line 11:		Line 11:

	===Software dependencies===		===Software dependencies===
			# epubcheck (version 1.0.4 or higher) which is a parser for epub files.
	# Perl 5.8.8 or higher		# Perl 5.8.8 or higher
	# xsltproc		# xsltproc

Rishi: /* Software dependencies */

2009-10-21T08:48:02Z

Software dependencies

← Older revision		Revision as of 14:18, 21 October 2009
Line 12:		Line 12:
	===Software dependencies===		===Software dependencies===
	# Perl 5.8.8 or higher		# Perl 5.8.8 or higher
	# xsltproc ~~for Linux~~. ~~For windows this program has been included in the archive~~. ~~This is required to convert XML files to ePub format using XSLT stylesheets~~.		# xsltproc
	# zip ~~program for Linux. For windows this program has been included in the archive~~. The ePub file is actually a zip file with extension <code>.epub</code>.		# saxon (ver. 9 or higher)
			# xmllint
			# convert (ImageMagick 6.3.7 or higher)
			# zip. The ePub file is actually a zip file with extension <code>.epub</code>.
	# Java 1.6 or higher for parsing.		# Java 1.6 or higher for parsing.
	# Cygwin is required for Windows.		# Cygwin is required for Windows.