|
1 | 1 | [](https://github.com/w3c/epubcheck/releases/latest) [](https://github.com/w3c/epubcheck/releases/) [](https://travis-ci.org/w3c/epubcheck/)
|
2 | 2 |
|
3 | 3 |
|
4 |
| -EpubCheck |
| 4 | +EPUBCheck |
5 | 5 | =========
|
6 | 6 |
|
7 |
| -EpubCheck is a tool to validate EPUB files. It can detect many |
8 |
| -types of errors in EPUB. OCF container structure, OPF and OPS mark-up, |
9 |
| -and internal reference consistency are checked. EpubCheck can be run |
10 |
| -as a standalone command-line tool or used as a Java library. |
| 7 | +EPUBCheck is a tool to validate the conformance of EPUB publications against the EPUB specifications. |
| 8 | +EPUBCheck can be run as a standalone command-line tool or used as a Java library. |
| 9 | + |
| 10 | +EPUBCheck is open source software, maintained by the [DAISY Consortium](http://www.daisy.org) for the [W3C](https://www.w3.org/publishing/epubcheck_fundraising). |
| 11 | + |
11 | 12 |
|
12 | 13 | **We Need Your Support!!**
|
13 | 14 | Financial support is critical to the development of EPUBCheck, the tool we all use to validate EPUB files.
|
14 | 15 | We need to make sure that the resources are adequate to both update the tool and provide for its continued maintenance over the next two years;
|
15 |
| -please [help us fund and support EPUBCheck](https://www.w3.org/publishing/epubcheck_fundraising)! |
| 16 | +please [help us fund and support EPUBCheck](https://www.w3.org/publishing/epubcheck_fundraising), and join the [list of donators](#donators)! |
16 | 17 |
|
17 | 18 |
|
18 | 19 | ## Downloads
|
19 | 20 |
|
20 | 21 | Check the [releases page](https://github.com/w3c/epubcheck/releases) to get the latest distribution.
|
21 | 22 |
|
22 |
| -[EpubCheck 4.0.2](https://github.com/w3c/epubcheck/releases/tag/v4.0.2) is the latest recommended version to validate both EPUB 2 and 3 files. |
| 23 | +[EPUBCheck 4.0.2](https://github.com/w3c/epubcheck/releases/tag/v4.0.2) is the latest recommended version to validate both EPUB 2 and 3 files. |
23 | 24 |
|
24 | 25 |
|
25 | 26 | ## Documentation
|
26 | 27 |
|
27 |
| -Documentation on how to **use** EpubCheck, to **contribute** to the project or to **translate** messages is available on the [EpubCheck wiki](https://github.com/w3c/epubcheck/wiki). |
28 |
| - |
29 |
| -Technical discussions are held on our public [email list](https://lists.w3.org/Archives/Public/public-epubcheck/). To subscribe to the email list, send an email with subject `subscribe` to public-epubcheck-request@w3.org. To participate in the discussion, simply send an email to public-epubcheck@w3.org. |
30 |
| - |
31 |
| -Historical archives of discussions prior to October 2017 are stored at the old [EpubCheck Google Group](https://lists.w3.org/Archives/Public/public-epubcheck/). An archive of the email list beginning in October 2017 can be found at https://lists.w3.org/Archives/Public/public-epubcheck/. |
| 28 | +Documentation on how to **use** EPUBCheck, to **contribute** to the project or to **translate** messages is available on the [EPUBCheck wiki](https://github.com/w3c/epubcheck/wiki). |
32 | 29 |
|
| 30 | +Technical discussions are held on our public [mailing list](https://lists.w3.org/Archives/Public/public-epubcheck/). To subscribe to the mailing list, send an email with subject `subscribe` to [public-epubcheck-request@w3.org](mailto:public-epubcheck-request@w3.org?subject=subscribe). To participate in the discussion, simply send an email to [public-epubcheck@w3.org](mailto:public-epubcheck-request@w3.org). |
33 | 31 |
|
34 |
| -## Development |
| 32 | +Historical archives of discussions prior to October 2017 are stored at the old [EPUBCheck Google Group](https://groups.google.com/forum/#!forum/epubcheck). |
35 | 33 |
|
36 |
| -The EpubCheck project is coordinated by the W3C [EPUB 3 Community Group](https://www.w3.org/publishing/groups/epub3-cg/). The lead developers on this projects are: |
| 34 | +## Building EPUBCheck |
37 | 35 |
|
38 |
| -* [Romain Deltour](https://github.com/rdeltour) |
39 |
| -* [Tobias Fischer](https://github.com/tofi86) |
40 |
| - |
41 |
| -There is currently a **severe shortage of developers** working on the tool, however. The project only has approximately 1/3 FTE in developer time allocated to its maintenance and development through its leads. This is barely enough to handle critical bug fixes, and not nearly enough to undertake the necessary upgrades needed to keep the tool relevant, such as developing support for EPUB 3.2. |
| 36 | +To build epubcheck from the sources you need Java Development Kit (JDK) 1.7 or above and [Apache Maven](http://maven.apache.org/) 3.0 or above installed. |
42 | 37 |
|
43 |
| -If you, or your organization, benefits from the ability to check your EPUB publications against the standards, please consider contributing to the development of this important tool. |
| 38 | +You will also need Python to be able to run the BookReporter and related tools. |
44 | 39 |
|
45 |
| -For more information on how to get involved, please see the [wiki page on contributing](https://github.com/w3c/epubcheck/wiki/Contribute). |
| 40 | +Build and run tests: |
46 | 41 |
|
| 42 | +``` |
| 43 | +$ mvn install |
| 44 | +``` |
| 45 | +Will copy `.*jar` files and packages to `target/` folder... |
47 | 46 |
|
48 | 47 | ## Credits
|
49 | 48 |
|
50 |
| -Most of the EpubCheck functionality comes from the schema validation tool [Jing](http://www.thaiopensource.com/relaxng/jing.html) and schemas that were developed by [IDPF](http://www.idpf.org/) and [DAISY](http://www.daisy.org/). Initial EpubCheck development was largely done at [Adobe Systems](http://www.adobe.com/). |
51 |
| - |
52 |
| -Initial (pre 2012) authors and contributors to EpubCheck include: |
53 |
| -> Peter Sorotokin, Garth Conboy, Markus Gylling, Piotr Kula, Paul Norton, Jessica Hekman, Liza Daly, George Bina, Bogdan Iordache, Ionut-Maxim Margelatu |
| 49 | +Most of the EPUBCheck functionality comes from the schema validation tool [Jing](http://www.thaiopensource.com/relaxng/jing.html) and schemas that were developed by [IDPF](http://www.idpf.org/) and [DAISY](http://www.daisy.org/). Initial EPUBCheck development was largely done at [Adobe Systems](http://www.adobe.com/). |
54 | 50 |
|
55 |
| -EpubCheck 4.0 was largely developed by |
56 |
| -* [DAISY](http://www.daisy.org/), namely: |
57 |
| - > Romain Deltour |
58 |
| -* [Barnes & Noble](https://www.barnesandnoble.com), namely: |
59 |
| - > Steve Antoch, Arwen Pond |
| 51 | +Initial (pre 2012) authors and contributors to EPUBCheck include: Peter Sorotokin, Garth Conboy, Markus Gylling, Piotr Kula, Paul Norton, Jessica Hekman, Liza Daly, George Bina, Bogdan Iordache, Ionut-Maxim Margelatu |
60 | 52 |
|
61 |
| -Regular contributors between 2012 and 2017 include: |
62 |
| -> Romain Deltour, Tobias Fischer, Markus Gylling, Thomas Ledoux, Masayoshi Takahashi, Satoshi KOJIMA |
| 53 | +EPUBCheck 4.0 was largely developed by |
| 54 | +* [DAISY](http://www.daisy.org/), namely: Romain Deltour, Markus Gylling |
| 55 | +* [Barnes & Noble](https://www.barnesandnoble.com), namely: Steve Antoch, Arwen Pond |
63 | 56 |
|
64 |
| -Many thanks are also extended to the numerous people who have contributed to the evolution of EpubCheck through bug reports and patches. |
| 57 | +Regular contributors between 2012 and 2017 include: Romain Deltour, Tobias Fischer, Markus Gylling, Satoshi KOJIMA, Thomas Ledoux, Masayoshi Takahashi |
65 | 58 |
|
| 59 | +Many thanks are also extended to the numerous people who have contributed to the evolution of EPUBCheck through bug reports and patches! |
66 | 60 |
|
67 |
| -## License |
68 |
| - |
69 |
| -EpubCheck is made available under the terms of the [New BSD License](http://opensource.org/licenses/BSD-3-Clause) |
70 |
| - |
71 |
| ----- |
72 |
| - |
73 |
| -## Building EpubCheck |
| 61 | +## Donators |
74 | 62 |
|
75 |
| -To build epubcheck from the sources you need Java Development Kit (JDK) 1.7 or above and [Apache Maven](http://maven.apache.org/) 3.0 or above installed. |
76 |
| -On Windows, you should build in a git bash shell (see http://github.com help) |
77 |
| - |
78 |
| -You will also need Python to be able to run the BookReporter and related tools. |
| 63 | +The following organizations are supporting the development of EPUBCheck by their contribution to the [fundraising initiative](https://www.w3.org/publishing/epubcheck_fundraising): |
79 | 64 |
|
| 65 | +<p float="left"> |
| 66 | + <a href="http://daisy.org"><img alt="DAISY" src="https://github.com/w3c/publishing/blob/master/donators_logos/daisy_high.jpg?raw=true" width="100" hspace="20" align="middle"/></a> |
| 67 | + <a href="https://pubhub.dk"><img alt="Publizon A/S" src="https://github.com/w3c/publishing/blob/master/donators_logos/publizon-logo.jpg?raw=true" width="100" hspace="20" align="middle"/></a> |
| 68 | + <a href="https://www.wiley.com"><img alt="Wiley" src="https://github.com/w3c/publishing/blob/master/donators_logos/Wiley_Wordmark_black.png?raw=true" width="200" hspace="20" align="middle"/></a> |
| 69 | + <a href="https://www.hachette.com"><img alt="Hachette Livre" src="https://github.com/w3c/publishing/blob/master/donators_logos/Hachette%20Livre.jpg?raw=true" width="300" hspace="20" align="middle"/></a> |
| 70 | + <a href="https://www.learningmate.com"><img alt="LearningMate Solutions Inc" src="https://github.com/w3c/publishing/blob/master/donators_logos/LearningMate%20Logo.png?raw=true" width="100" hspace="20" align="middle"/></a> |
| 71 | + <a href="https://www.voyager.co.jp"><img alt="Voyager Japan, Inc." src="https://github.com/w3c/publishing/blob/master/donators_logos/rectangle_VJstar_logo_512.jpg?raw=true" width="100" hspace="20" align="middle"/></a> |
| 72 | + <a href="https://wwnorton.com"><img alt="W. W. Norton" src="https://github.com/w3c/publishing/blob/master/donators_logos/NortonLogo_notagline.jpg?raw=true" width="100" hspace="20" align="middle"/></a> |
| 73 | + <a href="https://luminadatamatics.com"><img alt="Lumina Datamatics, Inc." src="https://github.com/w3c/publishing/blob/master/donators_logos/Datamatics_logo.jpg?raw=true" width="100" hspace="20" align="middle"/></a> |
| 74 | +</p> |
80 | 75 |
|
81 |
| -Build and run tests: |
| 76 | +## License |
82 | 77 |
|
83 |
| -``` |
84 |
| -$ mvn install |
85 |
| -``` |
86 |
| -Will copy `.*jar` files and packages to `target/` folder... |
| 78 | +EPUBCheck is made available under the terms of the [New BSD License](http://opensource.org/licenses/BSD-3-Clause) |
0 commit comments