Difference between revisions of "EpubCheck"

From COPTR
Jump to navigation Jump to search
(Added Release and Activity Feed)
Line 17: Line 17:
 
EpubCheck is a tool to validate EPUB files. It is also able to extract technical characteristics and embedded metadata from an EPUB file. Both the EPUB 2 and EPUB 3 formats are supported. It can detect many types of errors in EPUB. OCF container structure, OPF and OPS mark-up, and internal reference consistency are checked. EpubCheck can be run as a standalone command-line tool or used as a Java library.
 
EpubCheck is a tool to validate EPUB files. It is also able to extract technical characteristics and embedded metadata from an EPUB file. Both the EPUB 2 and EPUB 3 formats are supported. It can detect many types of errors in EPUB. OCF container structure, OPF and OPS mark-up, and internal reference consistency are checked. EpubCheck can be run as a standalone command-line tool or used as a Java library.
 
Development of this tool is supported by the [http://idpf.org/ International Digital Publishing Forum] (IDPF), which also publishes the EPUB standards. Most of the EpubCheck functionality comes from the schema validation tool [http://www.thaiopensource.com/relaxng/jing.html/ Jing] and schemas that were developed by [http://www.idpf.org/ IDPF] and [http://www.daisy.org/ DAISY]. Initial EpubCheck development was largely done at [http://blogs.adobe.com/digitaleditions/2007/12/epubchecker.html/ Adobe Systems].  
 
Development of this tool is supported by the [http://idpf.org/ International Digital Publishing Forum] (IDPF), which also publishes the EPUB standards. Most of the EpubCheck functionality comes from the schema validation tool [http://www.thaiopensource.com/relaxng/jing.html/ Jing] and schemas that were developed by [http://www.idpf.org/ IDPF] and [http://www.daisy.org/ DAISY]. Initial EpubCheck development was largely done at [http://blogs.adobe.com/digitaleditions/2007/12/epubchecker.html/ Adobe Systems].  
 
+
 
 
===Contributors===
 
===Contributors===
 
Authors and contributors to EpubCheck include:
 
Authors and contributors to EpubCheck include:
Line 36: Line 36:
 
* Masayoshi Takahashi
 
* Masayoshi Takahashi
 
* Satoshi Kojima
 
* Satoshi Kojima
 
+
 
 
+
===Documentation and user support===
==Documentation and user support==
 
 
<!-- Link to documentation and/or User Guide, if available. If not available, make a note to that effect. (optional) -->
 
<!-- Link to documentation and/or User Guide, if available. If not available, make a note to that effect. (optional) -->
 
Using EPubCheck as command line tool, all detected errors are simply printed to stderr output stream.
 
Using EPubCheck as command line tool, all detected errors are simply printed to stderr output stream.
Line 44: Line 43:
 
• [http://www.pagina-online.de/produkte/epub-checker/ pagina EPUB-Checker] for Windows / Mac / Linux
 
• [http://www.pagina-online.de/produkte/epub-checker/ pagina EPUB-Checker] for Windows / Mac / Linux
 
• [https://itunes.apple.com/us/app/epub-checker/id453480324/ ePub Checker] for iPad/iPod/iPhone (iTunes Store App)
 
• [https://itunes.apple.com/us/app/epub-checker/id453480324/ ePub Checker] for iPad/iPod/iPhone (iTunes Store App)
 
+
 
 
===Platform===
 
===Platform===
 
<!-- required -->
 
<!-- required -->
Line 50: Line 49:
 
* EPubCheck can be used as part of Java library.  
 
* EPubCheck can be used as part of Java library.  
 
* Build tool require Java Development Kit JDK (1.6 or above)
 
* Build tool require Java Development Kit JDK (1.6 or above)
 
+
 
 
===Online version of EpubCheck ===
 
===Online version of EpubCheck ===
 
* http://validator.idpf.org/
 
* http://validator.idpf.org/
 
* http://epubvalidator.com/
 
* http://epubvalidator.com/
+
 
 
===Releases===
 
===Releases===
 
Check the [https://github.com/IDPF/epubcheck/releases/ release page] on IDPF to get the latest distribution.  
 
Check the [https://github.com/IDPF/epubcheck/releases/ release page] on IDPF to get the latest distribution.  
 
[https://github.com/IDPF/epubcheck/releases/tag/v3.0.1/ EpubCheck 3.0.1] is the latest recommended version to validate both EPUB 2 and 3 files.
 
[https://github.com/IDPF/epubcheck/releases/tag/v3.0.1/ EpubCheck 3.0.1] is the latest recommended version to validate both EPUB 2 and 3 files.
 +
 
 
===Documentation===
 
===Documentation===
 
* Documentation on how to use or how to contribute is available on the [https://github.com/IDPF/epubcheck/wiki/ EpubCheck wiki].
 
* Documentation on how to use or how to contribute is available on the [https://github.com/IDPF/epubcheck/wiki/ EpubCheck wiki].
 
* Technical discussions are hosted on the [https://groups.google.com/forum/#%21forum/epubcheck/ EpubCheck Google Group].
 
* Technical discussions are hosted on the [https://groups.google.com/forum/#%21forum/epubcheck/ EpubCheck Google Group].
 
+
  
 
= User Experiences =
 
= User Experiences =
Line 67: Line 67:
 
* [https://blog.safaribooksonline.com/2010/12/16/running-epubcheck-on-your-computer/ Running EPubCheck] (SafariBooks)
 
* [https://blog.safaribooksonline.com/2010/12/16/running-epubcheck-on-your-computer/ Running EPubCheck] (SafariBooks)
 
* [http://opensource.com/life/14/9/open-source-tools-prepare-your-ebooks-publication/ Open Source Tools for ebooks] (OpenSource.com)  
 
* [http://opensource.com/life/14/9/open-source-tools-prepare-your-ebooks-publication/ Open Source Tools for ebooks] (OpenSource.com)  
 
+
 
===EPubCheck standard on Smashwors publishing===
 
===EPubCheck standard on Smashwors publishing===
 
Self-publishing site, Smashwords, requires author to pass EPubCheck in order to get their publication to Apple Bookstore [http://www.smashwords.com/epubcheck/ HOW TO FIX EPUBCHECK ERRORS]
 
Self-publishing site, Smashwords, requires author to pass EPubCheck in order to get their publication to Apple Bookstore [http://www.smashwords.com/epubcheck/ HOW TO FIX EPUBCHECK ERRORS]
 
+
 
+
 
= Development Activity =
 
= Development Activity =
 
<!-- Provide *evidence* of development activity of the tool. For example, RSS feeds for code issues or commits. -->
 
<!-- Provide *evidence* of development activity of the tool. For example, RSS feeds for code issues or commits. -->
  
 
For tool updates and development, check https://github.com/IDPF/epubcheck
 
For tool updates and development, check https://github.com/IDPF/epubcheck
 
+
 
+
=== Release Feed ===
<!-- Add the Ohloh.com ID for the tool, if known. -->
+
Below the last 3 release feeds:
{{Infobox_tool_details
+
<rss max=3>https://github.com/IDPF/epubcheck/releases.atom</rss>
|ohloh_id=epubcheck
+
 
}}
+
=== Activity Feed===
 +
Below the last 5 commits:
 +
<rss max=5>https://github.com/IDPF/epubcheck/commits/master.atom</rss>

Revision as of 09:40, 8 January 2015

Validator for EPUB files
Homepage:https://github.com/IDPF/epubcheck
License:New BSD License
Platforms:Any OS with Java (1.6 or above)


Description

EpubCheck is a tool to validate EPUB files. It is also able to extract technical characteristics and embedded metadata from an EPUB file. Both the EPUB 2 and EPUB 3 formats are supported. It can detect many types of errors in EPUB. OCF container structure, OPF and OPS mark-up, and internal reference consistency are checked. EpubCheck can be run as a standalone command-line tool or used as a Java library. Development of this tool is supported by the International Digital Publishing Forum (IDPF), which also publishes the EPUB standards. Most of the EpubCheck functionality comes from the schema validation tool Jing and schemas that were developed by IDPF and DAISY. Initial EpubCheck development was largely done at Adobe Systems.

Contributors

Authors and contributors to EpubCheck include:

  • Peter Sorotokin
  • Garth Conboy
  • Markus Gylling
  • Piotr Kula
  • Paul Norton
  • Jessica Hekman
  • Liza Daly
  • George Bina
  • Bogdan Iordache
  • Romain Deltour
  • Thomas Ledoux
  • Tobias Fischer
  • Steve Antoch
  • Arwen Pond
  • Masayoshi Takahashi
  • Satoshi Kojima

Documentation and user support

Using EPubCheck as command line tool, all detected errors are simply printed to stderr output stream. There is no native graphical user interface (GUI) for the tool. However, there are some third-party apps offering a GUI for Windows/Mac/Linux platforms: • pagina EPUB-Checker for Windows / Mac / Linux • ePub Checker for iPad/iPod/iPhone (iTunes Store App)

Platform

  • EPubCheck is a command line tool that can be run on any operating system (OS).
  • EPubCheck can be used as part of Java library.
  • Build tool require Java Development Kit JDK (1.6 or above)

Online version of EpubCheck

Releases

Check the release page on IDPF to get the latest distribution. EpubCheck 3.0.1 is the latest recommended version to validate both EPUB 2 and 3 files.

Documentation


User Experiences

EPubCheck standard on Smashwors publishing

Self-publishing site, Smashwords, requires author to pass EPubCheck in order to get their publication to Apple Bookstore HOW TO FIX EPUBCHECK ERRORS


Development Activity

For tool updates and development, check https://github.com/IDPF/epubcheck

Release Feed

Below the last 3 release feeds: Failed to load RSS feed from https://github.com/IDPF/epubcheck/releases.atom: Error parsing XML for RSS

Activity Feed

Below the last 5 commits: Failed to load RSS feed from https://github.com/IDPF/epubcheck/commits/master.atom: There was a problem during the HTTP request: 404 Not Found