Skip to content

Commit dfd7fd2

Browse files
committed
docs: branding tweaks
- change the project name’s case to "EPUBCheck" - add a "maintained by DAISY" notice to the README - add logos of the donators to the fundraising to the README
1 parent 91ccd2f commit dfd7fd2

File tree

29 files changed

+103
-111
lines changed

29 files changed

+103
-111
lines changed

README.md

+40-48
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,78 @@
11
[![Current Release](https://img.shields.io/github/release/w3c/epubcheck.svg)](https://github.com/w3c/epubcheck/releases/latest) [![Github All Releases Downloads](https://img.shields.io/github/downloads/w3c/epubcheck/total.svg?colorB=A9A9A9)](https://github.com/w3c/epubcheck/releases/) [![Build Status](https://travis-ci.org/w3c/epubcheck.svg?branch=master)](https://travis-ci.org/w3c/epubcheck/)
22

33

4-
EpubCheck
4+
EPUBCheck
55
=========
66

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+
1112

1213
**We Need Your Support!!**
1314
Financial support is critical to the development of EPUBCheck, the tool we all use to validate EPUB files.
1415
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)!
1617

1718

1819
## Downloads
1920

2021
Check the [releases page](https://github.com/w3c/epubcheck/releases) to get the latest distribution.
2122

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.
2324

2425

2526
## Documentation
2627

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).
3229

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).
3331

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).
3533

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
3735

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.
4237

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.
4439

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:
4641

42+
```
43+
$ mvn install
44+
```
45+
Will copy `.*jar` files and packages to `target/` folder...
4746

4847
## Credits
4948

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/).
5450

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
6052

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
6356

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
6558

59+
Many thanks are also extended to the numerous people who have contributed to the evolution of EPUBCheck through bug reports and patches!
6660

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
7462

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):
7964

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>
8075

81-
Build and run tests:
76+
## License
8277

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)

pom.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515

1616
<packaging>jar</packaging>
1717

18-
<name>EpubCheck :: Validation Tool for EPUB</name>
19-
<description>EpubCheck is a tool to validate IDPF EPUB files. It can detect many types of errors in EPUB.
18+
<name>EPUBCheck :: Validation Tool for EPUB</name>
19+
<description>EPUBCheck is a tool to validate IDPF EPUB files. It can detect many types of errors in EPUB.
2020
OCF container structure, OPF and OPS mark-up, and internal reference consistency are checked.
21-
EpubCheck can be run as a standalone command-line tool, installed as a Java server-side web application
21+
EPUBCheck can be run as a standalone command-line tool, installed as a Java server-side web application
2222
or used as a Java library.</description>
2323
<url>http://code.google.com/p/epubcheck/</url>
2424
<inceptionYear>2007</inceptionYear>
@@ -129,7 +129,7 @@
129129
</developers>
130130
<mailingLists>
131131
<mailingList>
132-
<name>EpubCheck discussion</name>
132+
<name>EPUBCheck discussion</name>
133133
<subscribe>mailto:public-epubcheck-request@w3.org?subject=subscribe</subscribe>
134134
<unsubscribe>mailto:public-epubcheck-request@w3.org?subject=unsubscribe</unsubscribe>
135135
<post>public-epubcheck@w3.org</post>

src/build/transifex-pull.sh

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# pulled transifex properties files
55
#
66
# Author: Tobias Fischer (https://github.com/tofi86)
7-
# Project: IDPF/EpubCheck (https://github.com/IDPF/epubcheck)
7+
# Project: IDPF/EPUBCheck (https://github.com/IDPF/epubcheck)
88
#
99
# Date: 2018-08-25
1010
# License: MIT License
@@ -89,13 +89,13 @@ if [[ -z ${param1} || ${param1} == "--help" ]] ; then
8989
# Pull ALL translations
9090
elif [ ${param1} == "--all" ] ; then
9191
minimum_percent_translated=$(awk -F "=" '/minimum_perc/ {print $2}' .tx/config)
92-
echo "Pulling ALL EpubCheck translations (>${minimum_percent_translated}% done) from Transifex..."
92+
echo "Pulling ALL EPUBCheck translations (>${minimum_percent_translated}% done) from Transifex..."
9393
echo ""
9494
tx pull -f | tee /dev/stderr | grep "> [a-z][a-z]: " | awk '{print $NF}' | while read f; do processFile ${f}; done
9595

9696
# Pull translations for a 2-digit-language-code
9797
elif [ ${#param1} -eq 2 ] ; then
98-
echo "Pulling EpubCheck translation '${param1}' from Transifex..."
98+
echo "Pulling EPUBCheck translation '${param1}' from Transifex..."
9999
echo ""
100100
tx pull -f -l ${param1} | tee /dev/stderr | grep "${param1}: " | awk '{print $NF}' | while read f; do processFile ${f}; done
101101

src/main/assembly/README-dist.txt

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
This folder contains the distribution of EpubCheck project.
1+
This folder contains the distribution of EPUBCheck project.
22

3-
EpubCheck is a tool to validate EPUB files. It can detect many
3+
EPUBCheck is a tool to validate EPUB files. It can detect many
44
types of errors in EPUB. OCF container structure, OPF and OPS mark-up,
5-
and internal reference consistency are checked. EpubCheck can be run
5+
and internal reference consistency are checked. EPUBCheck can be run
66
as a standalone command-line tool, installed as a web application or
77
used as a Java library.
88

9-
EpubCheck project home: https://github.com/idpf/epubcheck
9+
EPUBCheck project home: https://github.com/idpf/epubcheck
1010

1111

1212
RUNNING
@@ -24,8 +24,8 @@ Print the commandline help with the --help argument:
2424

2525
USING AS A LIBRARY
2626

27-
You can also use EpubCheck as a library in your Java application. EpubCheck
28-
public interfaces can be found in com.adobe.epubcheck.api package. EpubCheck
27+
You can also use EPUBCheck as a library in your Java application. EPUBCheck
28+
public interfaces can be found in com.adobe.epubcheck.api package. EPUBCheck
2929
class can be used to instantiate a validation engine. Use one of its
3030
constructors and then call validate() method. Report is an interface that
3131
you can implement to get a list of the errors and warnings reported by the
@@ -72,7 +72,7 @@ Tzviya Siegman
7272
Martin Kraetke
7373

7474

75-
Most of the EpubCheck functionality comes from the schema validation tool Jing
76-
and schemas that were developed by IDPF and DAISY. Initial EpubCheck development
77-
was largely done at Adobe Systems. EpubCheck 4.0 was largely developed by
75+
Most of the EPUBCheck functionality comes from the schema validation tool Jing
76+
and schemas that were developed by IDPF and DAISY. Initial EPUBCheck development
77+
was largely done at Adobe Systems. EPUBCheck 4.0 was largely developed by
7878
DAISY and Barnes & Noble.

src/main/resources/com/adobe/epubcheck/schema/20/dtd/svg11.dtd

+1-1
Original file line numberDiff line numberDiff line change
@@ -2273,7 +2273,7 @@
22732273
<!ENTITY % SVG.style.attlist "INCLUDE" >
22742274
<![%SVG.style.attlist;[
22752275
<!--
2276-
EpubCheck bugfix #688
2276+
EPUBCheck bugfix #688
22772277
- https://github.com/IDPF/epubcheck/issues/688
22782278
Changing @type from #REQUIRED to #IMPLIED
22792279
fixes a bug in the original SVG 1.1 DTD

src/main/resources/com/adobe/epubcheck/schema/20/rng/svg/svg-style.rng

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
<ref name="SVG.Core.extra.attrib"/>
106106
<optional>
107107
<!--
108-
EpubCheck bugfix #688
108+
EPUBCheck bugfix #688
109109
- https://github.com/IDPF/epubcheck/issues/688
110110
Changing @type to <optional> fixes a bug
111111
in the original SVG 1.1 Schema

src/main/resources/com/adobe/epubcheck/util/messages.properties

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ epubcheck_completed=epubcheck completed
3333
error_creating_config_file=Error creating config file '%1$s'.
3434
expected_message_filename=Expected the Custom message file name, but found '%1$s'
3535
unrecognized_argument=Unrecognized argument: '%1$s'
36-
epubcheck_version_text=EpubCheck v%1$s
36+
epubcheck_version_text=EPUBCheck v%1$s
3737
incorrect_locale=Argument '%1$s' to the --locale option is %2$s.
3838
3939
help_text = \
40-
EpubCheck v%1$s\n\n\
40+
EPUBCheck v%1$s\n\n\
4141
When running this tool, the first argument should be the name (with the path)\n\
4242
of the file to check.\n\
4343
\n\
@@ -92,6 +92,6 @@ help_text = \
9292
\ or the console\n\
9393
-c, --customMessages [<file>] = override message severity levels as defined in the custom message file named <file>\n\
9494
\n\
95-
--version = displays the EpubCheck version\n\
95+
--version = displays the EPUBCheck version\n\
9696
\n\
9797
-h, -? or --help = displays this help message\n

0 commit comments

Comments
 (0)