IDPF EPUB Scriptable Components code & samples

This repository is home to the EPUB Scriptable Components (ESC) Working Group (WG) code and samples. Contained herein are a set of samples of Scriptable Components (SC) based upon the ESC Packaging specification and ESC Communication API specification. The goal is to form a collection of standards-based Scriptable Components as a source implementation for inspection and validation from all aspects of the industries production chain; authoring, validation, ingestion, and representation. The guiding principle is to create usable samples focused on meaningful aspects of the ESC landscape. As a baseline the repository structure has been set as follows:

.
+-- LICENSE
+-- README.md
\---Samples
    +---1-basic_component
    |   +---embedded
    |   \---packaged
    +---2-nested_component
    |   +---embedded
    |   \---packaged
    \---3-messaging_component
        +---embedded
        \---packaged

Contributing to EPUB Scriptable Components code & samples

Looking to contribute something to EPUB Scriptable Components code & samples? Here's how you can help:

Reporting issues

Please read the following guidelines before opening any issue.

Search for existing issues. We get a lot of duplicate issues, and you'd help us out a lot by first checking if someone else has reported the same issue. Moreover, the issue may have already been resolved with a fix available.
Create an isolated and reproducible test case. Be sure the problem exists in EPUB Scriptable Components code & samples with a reduced test case that should be included in each bug report.
Include a live example. Make use of jsFiddle or jsBin to share your isolated test cases.
Share as much information as possible. Include operating system and version, browser and version, version of ePub Widget Framework, customized or vanilla build, etc. where appropriate. Also include steps to reproduce the bug.

Pull requests

Try not to pollute your pull request with unintended changes--keep them simple and small
Try to share which browsers your code has been tested in before submitting a pull request

Coding standards

JS

End all lines with a semi-colon
Comma last
Indent of 4 spaces, remove tabs.
Make it readable and attractive
Modern screens can handle vertical space, use brackets on their own lines for visual clarity of blocks
Please use jsDoc annotations/comments to add typing information.

HTML

Indent of 4 spaces, remove tabs.
Double quotes only, never single quotes
Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags)
Use CDNs and HTTPS for third-party JS when possible. We don't use protocol-relative URLs in this case because they break when viewing the page locally via file://

CSS

Adhere to the RECESS CSS property order
Multiple-line approach (one property and value per line)
Always a space after a property's colon (e.g., display: block; and not display:block;)
End all lines with a semi-colon
For multiple, comma-separated selectors, place each selector on its own line
Attribute selectors, like input[type="text"] should always wrap the attribute's value in double quotes, for consistency and safety (see this blog post on unquoted attribute values that can lead to XSS attacks)

License

By contributing your code, you agree to license your contribution under the MIT license.

License

IDPF/scriptable-components

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Packages