idpf / epub3-samples Goto Github PK

EPUB 3 Sample Documents

Home Page: http://idpf.github.io/epub3-samples/

HTML 99.58% CSS 0.35% PLSQL 0.02% JavaScript 0.04% Shell 0.01% Batchfile 0.01%

epub3-samples's Introduction

EPUB 3 Samples

This repository contains the source for a variety of EPUB 3 sample documents. The collection is intended to showcase features of the EPUB standard, and to provide testing materials for Reading System developers. It is maintained by the W3C's EPUB 3 Community Group.

For quick access to the samples, please see the samples table and feature matrix.

Please see the project page for more general information about the samples.

Licensing

Unless specified otherwise in the sample table, all samples are licensed under CC-BY-SA 3.0

Compiling

All of the latest samples are available for download from the sample table.

If needed, you can also create EPUB publications directly from the samples source. There are two sets of shell and batch scripts available at the root of the repository.

The first, pack-all, will build all of the samples:

pack-all.sh

The second script, pack-single, is used to build individual samples:

pack-single.sh 30/accessible_epub_3

The argument to this script is the relative path to the sample you want to build.

Note: The batch script can be run on Windows OSes; there is no difference in functionality or how it is called.

Want to contribute?

If you want to contribute to this project, there are several options:

Reporting Issues

We want to make sure all samples provided here are conformant, pristine, and employ best practices consistently. If you spot an issue while reviewing and/or testing the content, report it to the issue tracker.

Contributing new samples

If you want to contribute sample(s), please contact the project owners. After an initial discussion, they will either give you write access to the repository, or arrange some other means of getting the content into the repository. Note that all submitted content is by default subject to CC-BY-SA 3.0 licensing.

This site does not list attribution for samples. As a contributor, you may specify attribution metadata only within the submitted EPUB Publication.

Note also that the project owners may suggest or even require modifications to your submissions to be done in order to meet the desired quality level.

Contributing variations / improvements to existing samples

If you want to contribute to an existing sample by adding to or varying some aspect of it, use the issue tracker and submit your patch as an attachment. Note that your submission must adhere to the same open source license as the containing sample.

epub3-samples's People

Contributors

Stargazers

Watchers

Forkers

adityasingh93 henriapperloo ernestnuclear educhenm stevenio chrisdwarner 3rdred yetone rogerwetherall lbehnke senthilmm miranz alsd joseleio leenagour wookyworks faulfish rmenke goutham1 dreamermx prempratap1 whpao machadolopes j-a-vizcaino draytonbenner kerasking vs0uz4 renura grantblue ccritten munirnour maheshchari jimk66 mwasa virtualtam ivaa00 jaco30 zkenstein moneyapi gogonana3 montrealist juwanpark spratmannc nimsothea water-air-flash britodfbr gimox irpagnossin scorpionjacky crq74804 cnikolakakos nikolas menondj raquelcordeiro ashrafhamdy i49 lgm-adrianhum austinpernell fydexx aljazerzen xgeo itumelengtease johngtait wkee googed won21kr android-development-repositories ways2read pavanyogi beaudaignault vigneshkumarelumalai svcarlsen johnlourdusamy maseehkat kewlbear river418 trx1138 alesbona sheetalkashid madyshravan avandergrinten escapiststupor dlehmann655 jamessa breezr simplyhodi plmelchi steedbrownd2d neil-buckley erossini hesusruiz ajayk0719 matilde-oliveros yasin-yilmaz linxinglu majester ggg3000 indigobloom edgarschouten daworks

epub3-samples's Issues

ePubCheck-Warning Message: CharisSILB, CharisSILBIm, CharisSILI and CharisSILR Fonts

Dear All,

I am getting warning message while using the Charis fonts. Can I remove these fonts from the ePub. This will have an impact in the quality of rendering of contents in readers?

Is there any vital reason for using these Charis fonts in the ePub?

Thanks,
Sudhakar

Example `haruko-ahl` does not validate (Region-Based Navigation)

With epubcheck 4.0.0 which is claims to support "EPUB Region-Based Navigation 1.0" I get errors like:

Undefined property: 'panel'.
Undefined property: 'ballon'.

Anyone knows if this is an issue with the sample or with epubcheck 4.0?

whats the best software to make an epub ?

i find indesign so hard to build creative reflowable epub . so is there any replacement ?

Invalid pageTarget type value?

The NCX file for the ePub 3 samples uses the XML Namespace at http://www.daisy.org/z3986/2005/ncx/

This says the following about the pageTarget element:

<!-- Revised, 3/31/2004:  Added pageTarget element -->
<!-- Revised, 4/5/2004:  Added description of value attribute to comment -->
<!-- Page Target -  Container for 
  text, audio, image, and content elements containing navigational 
  information for pages.  The "value" attribute is a positive integer representing 
the numeric value associated with a page. Combination of values of type and 
value attributes must be unique, when value attribute is present. 
-->
<!ELEMENT pageTarget (navLabel+, content)>
<!-- Revised, 4/5/2004:  Added class attribute -->
<!-- Revised, 4/5/2004:  Changed declaration of type attribute to enumerate values -->
<!-- Revised, 4/5/2004:  Added playOrder -->
<!ATTLIST pageTarget
   id       ID          #IMPLIED
   value    CDATA       #IMPLIED
   type     (front | normal | special)       #REQUIRED
   class    CDATA       #IMPLIED
   playOrder CDATA      #REQUIRED
>

If I'm reading this correctly, the only permitted values for the pageTarget's type attribute are front, normal, and special.

Some of the examples listed in this repository use values other than these. Using https://github.com/IDPF/epub3-samples/blob/master/30/childrens-literature/EPUB/toc.ncx as an example:

		<pageTarget type="body">
			<navLabel>
				<text>169</text>
			</navLabel>
			<content src="s04.xhtml#Page_169"/>
		</pageTarget>

Is my interpretation of the spec correct? What is the meaning of the "body" pageTarget type?

Linear Algebra download link misdirected

I just noticed that the link to download the Linear Algebra title on the samples page (https://github.com/IDPF/epub3-samples#linear-algebra) appears to be pointing at the Kusamakura title by accident.

Dave

incorrect Wasteland download link (obfuscated WOFF)

http://idpf.github.io/epub3-samples/samples.html
The last link for Wasteland is https://drive.google.com/uc?export=download&id=0B9g8D2Y-6aPLZ0s0cjFaZHJOYms which is the same as the one immediately above (non-obfuscated WOFF)

Forms example?

I'm looking for form/input example like...
http://www.idpf.org/accessibility/guidelines/content/script/forms.php
but can't find any.

Thanks.

Pagebreak in Children's Literature

In the Children's Literature example, the page break for pages 197, 212, 229 and 255 (and not the other pages) do not have the page number inside the span tags. The other page breaks do.

I assume this is just a mistake, rather than a test of how e-readers handle page breaks with optional elements present and absent.

Is there an drmed epub sample ?

Thank you .

I want to test this when I using an epub reader open it ( for example ibook, it tell me it is drmed ).

nav.xhtml file size greater than 300kb

How to handle the nav.xhtml if the size of the file is greater than 300 Kb

compatible with EPUB2 readers?

are these EPUB3 examples backward compatible with EPUB2 readers?

How compile an Epub project and test.

I very new to Epubs, I used the following command for the tress example (I use ubuntu):

pandoc -f html -t epub3 -o output.epub c1.xhtml c2.xhtml package.opf titlepage.xhtml style.css script/*

and then I tried to view the epub in the chrome readium app, and the javascript appears as text.

Am I supposed to do this differently? I can't find any explanation of how these project files should be compiled. Your help would be most welcome.

When converting an Epub that contains the quiz binding (multiple choice questions) to PDF using calibre, how do I "expand" the answers so that they show in the PDF file?

I tried checking "expand CSS" when converting using calibre, but it didn't work

incorrect link reference for moby-dick.mo

In your features matrix, the links to moby dick with overlays points to moby-dick.epub instead of moby-dick-mo.epub

Attribution within an XHTML content document?

According to the README.md, "As a contributor, you are able to specify attribution metadata only in the sample's package file." Does this mean that an XHTML or SVG content document cannot describe the owner, copyright, CC by SA, mail address, etc?