├── Samples
    ├── 1-basic_component
    │   ├── embedded
    │   │   ├── basic_template
    │   │   │   ├── mimetype
    │   │   │   ├── EPUB
    │   │   │   │   ├── img
    │   │   │   │   │   └── cover.jpg
    │   │   │   │   ├── xhtml
    │   │   │   │   │   ├── cover.xhtml
    │   │   │   │   │   ├── toc.xhtml
    │   │   │   │   │   └── chapter1.xhtml
    │   │   │   │   ├── components
    │   │   │   │   │   └── component_author
    │   │   │   │   │   │   └── component_name
    │   │   │   │   │   │       ├── css
    │   │   │   │   │   │           └── style.css
    │   │   │   │   │   │       ├── xhtml
    │   │   │   │   │   │           ├── fallback.xhtml
    │   │   │   │   │   │           └── component.xhtml
    │   │   │   │   │   │       └── js
    │   │   │   │   │   │           └── main.js
    │   │   │   │   ├── css
    │   │   │   │   │   └── style.css
    │   │   │   │   └── package.opf
    │   │   │   └── META-INF
    │   │   │   │   └── container.xml
    │   │   ├── embedded_basic_template.epub
    │   │   └── README.md
    │   └── packaged
    │   │   ├── basic_template
    │   │       ├── mimetype
    │   │       ├── META-INF
    │   │       │   └── container.xml
    │   │       └── EPUB
    │   │       │   ├── css
    │   │       │       └── style.css
    │   │       │   ├── xhtml
    │   │       │       ├── fallback.xhtml
    │   │       │       ├── component.xhtml
    │   │       │       └── toc.xhtml
    │   │       │   ├── js
    │   │       │       └── main.js
    │   │       │   └── package.opf
    │   │   ├── packaged_basic_template.epub
    │   │   └── README.md
    ├── 2-nested_component
    │   ├── packaged
    │   │   └── README.md
    │   └── embedded
    │   │   └── README.md
    └── 3-messaging_component
    │   ├── packaged
    │       └── README.md
    │   └── embedded
    │       └── README.md
├── LICENSE
└── README.md


/Samples/1-basic_component/embedded/basic_template/mimetype:
--------------------------------------------------------------------------------
1 | application/epub+zip


--------------------------------------------------------------------------------
/Samples/1-basic_component/packaged/basic_template/mimetype:
--------------------------------------------------------------------------------
1 | application/epub+zip


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/embedded_basic_template.epub:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/IDPF/scriptable-components/HEAD/Samples/1-basic_component/embedded/embedded_basic_template.epub


--------------------------------------------------------------------------------
/Samples/1-basic_component/packaged/packaged_basic_template.epub:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/IDPF/scriptable-components/HEAD/Samples/1-basic_component/packaged/packaged_basic_template.epub


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/EPUB/img/cover.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/IDPF/scriptable-components/HEAD/Samples/1-basic_component/embedded/basic_template/EPUB/img/cover.jpg


--------------------------------------------------------------------------------
/Samples/2-nested_component/packaged/README.md:
--------------------------------------------------------------------------------
1 | # Nested Componenet Sample
2 | 
3 | This is the future home to the nested Scriptable Component in it's packaged form. 
4 | Meaning that the SC will a stand-alone EPUB utilizing SC metadata to identify itself and it's parts for toolchain ingestion.
5 | 
6 | 


--------------------------------------------------------------------------------
/Samples/3-messaging_component/packaged/README.md:
--------------------------------------------------------------------------------
1 | # Messaging Componenet Sample
2 | 
3 | This is the future home to the messaging Scriptable Component in it's packaged form. 
4 | Meaning that the SC will a stand-alone EPUB utilizing SC metadata to identify itself and it's parts for toolchain ingestion.
5 | 
6 | 


--------------------------------------------------------------------------------
/Samples/1-basic_component/packaged/README.md:
--------------------------------------------------------------------------------
1 | # Basic "Packaged" Component Sample
2 | 
3 | This basic "Hello World" Scriptable Component (SC) uses a Fixed Layout viewport and appropriate accessible metadata for keyboard control. This sample is purely a packaging example showing the before and after embedding states of the SC.
4 | 


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/META-INF/container.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8" standalone="yes"?>
2 | <container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
3 |     <rootfiles>
4 |         <rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
5 |     </rootfiles>
6 | </container>
7 | 


--------------------------------------------------------------------------------
/Samples/1-basic_component/packaged/basic_template/META-INF/container.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8" standalone="yes"?>
2 | <container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
3 |     <rootfiles>
4 |         <rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
5 |     </rootfiles>
6 | </container>
7 | 


--------------------------------------------------------------------------------
/Samples/2-nested_component/embedded/README.md:
--------------------------------------------------------------------------------
1 | # Nested Componenet Sample
2 | 
3 | This is the future home to the nested Scriptable Component in it's embedded form. 
4 | Meaning that the SC will be a child to a parent EPUB utilizing the `<collection>` manifest item and `<iframe>` content document approach.
5 | The nested SC means that it will be an SC with a child SC via nested `<collection>` and `<iframe>` elements.
6 | 
7 | 


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/README.md:
--------------------------------------------------------------------------------
1 | # Basic "Embedded" Component Sample
2 | 
3 | This basic "Hello World" Scriptable Component (SC) contains rudimentary metadata for a reflowable EPUB parent with a Fixed
4 | Layout SC and appropriate accessible metadata for keyboard control. This sample is purely a packaging example showing the use of the parent EPUB `<collection>` element denoting the child SC then manually positioned in the parent templated content document via the `<iframe>` "landing zone".
5 | 


--------------------------------------------------------------------------------
/Samples/3-messaging_component/embedded/README.md:
--------------------------------------------------------------------------------
1 | # Messaging Componenet Sample
2 | 
3 | This is the future home to the messaging Scriptable Component in it's embedded form. 
4 | Meaning that the SC will be a child to a parent EPUB utilizing the `<collection>` manifest item and `<iframe>` content document approach.
5 | The messaging SC means that it will be an SC with a child SC via nested `<collection>` and `<iframe>` elements and that these two components are then able to communicate various status messages via the ESC Comms API.


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/EPUB/xhtml/cover.xhtml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
 3 |     <head>
 4 |         <title>Cover</title>
 5 |         <style type="text/css">
 6 |             img { max-width:100%; }
 7 |         </style>
 8 |     </head>
 9 |     <body>
10 |         <figure id="cover_image">
11 |             <img src="../img/cover.jpg" alt="Author Name's 3rd Edition — Subject of Interest" />
12 |         </figure>
13 |     </body>
14 | </html>


--------------------------------------------------------------------------------
/Samples/1-basic_component/packaged/basic_template/EPUB/css/style.css:
--------------------------------------------------------------------------------
 1 | html {
 2 |     height: 100%;
 3 |     font-size: 100%;
 4 | }
 5 | 
 6 | body {
 7 |     font-family: Arial,Helvetica,sans-serif;
 8 |     font-size: 1em;
 9 |     margin: 0;
10 |     padding: 0;
11 |     width: 100%;
12 |     overflow: hidden;
13 | }
14 | 
15 | .center {
16 |     text-align: center;
17 | }
18 | 
19 | button:focus {
20 |     outline: 0.25em solid #FD9F10;
21 | }
22 | 
23 | .screen_reader_only {
24 |     position: absolute !important;
25 |     top: auto;
26 |     left: -3000px;
27 |     width: 1px;
28 |     height: 1px;
29 |     overflow: hidden;
30 | }


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/EPUB/components/component_author/component_name/css/style.css:
--------------------------------------------------------------------------------
 1 | html {
 2 |     height: 100%;
 3 |     font-size: 100%;
 4 | }
 5 | 
 6 | body {
 7 |     font-family: Arial,Helvetica,sans-serif;
 8 |     font-size: 1em;
 9 |     margin: 0;
10 |     padding: 0;
11 |     width: 100%;
12 |     overflow: hidden;
13 | }
14 | 
15 | .center {
16 |     text-align: center;
17 | }
18 | 
19 | button:focus {
20 |     outline: 0.25em solid #FD9F10;
21 | }
22 | 
23 | .screen_reader_only {
24 |     position: absolute !important;
25 |     top: auto;
26 |     left: -3000px;
27 |     width: 1px;
28 |     height: 1px;
29 |     overflow: hidden;
30 | }


--------------------------------------------------------------------------------
/Samples/1-basic_component/packaged/basic_template/EPUB/xhtml/fallback.xhtml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
 3 |     <head>
 4 |         <title>Hello World — Static Fallback</title>
 5 |         <link href="../css/style.css" rel="stylesheet"/>
 6 |         <meta name="viewport" content="width=480, height=320"/>
 7 |     </head>
 8 |     <body class="center" aria-describedby="description">
 9 |         <h1 class="screen_reader_only">Hello World — Static Fallback</h1>
10 |         <p id="description" class="screen_reader_only">A basic packaged EPUB Scriptable Component.</p>
11 |         
12 |         <p id="message">Hello World</p>
13 |     </body>
14 | </html>


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/EPUB/components/component_author/component_name/xhtml/fallback.xhtml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
 3 |     <head>
 4 |         <title>Hello World — Static Fallback</title>
 5 |         <link href="../css/style.css" rel="stylesheet"/>
 6 |         <meta name="viewport" content="width=480, height=320"/>
 7 |     </head>
 8 |     <body class="center" aria-describedby="description">
 9 |         <h1 class="screen_reader_only">Hello World — Static Fallback</h1>
10 |         <p id="description" class="screen_reader_only">A basic packaged EPUB Scriptable Component.</p>
11 |         
12 |         <p id="message">Hello World</p>
13 |     </body>
14 | </html>


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/EPUB/xhtml/toc.xhtml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
 3 |     <head>
 4 |         <title>Author Name's 3rd Edition — Subject of Interest</title>
 5 |         <link rel="stylesheet" type="text/css" href="../css/style.css" />
 6 |     </head>
 7 |     <body>
 8 |         <h1>Author Name's 3rd Edition — Subject of Interest</h1>
 9 |         <nav id="toc" epub:type="toc">
10 |             <h2>Table of Contents</h2>
11 |             <ol>
12 |                 <li><a href="chapter1.xhtml">Chapter 1</a>
13 |                     <ol>
14 |                         <li><a href="chapter1.xhtml#c1_s1_h1">Heading 1</a></li>
15 |                         <li><a href="chapter1.xhtml#c1_s2_h1">Heading 2</a></li>
16 |                     </ol>
17 |                 </li>
18 |             </ol>
19 |         </nav>
20 |     </body>
21 | </html>
22 | 


--------------------------------------------------------------------------------
/Samples/1-basic_component/packaged/basic_template/EPUB/xhtml/component.xhtml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
 3 |     <head>
 4 |         <title>Hello World</title>
 5 |         <link href="../css/style.css" rel="stylesheet"/>
 6 |         <meta name="viewport" content="width=480, height=320"/>
 7 |     </head>
 8 |     <body class="center" aria-describedby="description">
 9 |         <h1 class="screen_reader_only">Hello World</h1>
10 |         <p id="description" class="screen_reader_only">A basic packaged EPUB Scriptable Component.</p>
11 |         
12 |         <p id="message" aria-live="polite" aria-relevant="additions removals">Hello World</p>
13 |         
14 |         <button onclick="buttonHandler(event)" onkeyup="buttonHandler(event)" aria-controls="message">Update message</button>
15 |         
16 |         <script src="../js/main.js"></script>
17 |     </body>
18 | </html>


--------------------------------------------------------------------------------
/Samples/1-basic_component/packaged/basic_template/EPUB/js/main.js:
--------------------------------------------------------------------------------
 1 | /***
 2 |  * @name buttonHandler
 3 |  * @desc Unified button click and keyboard handler
 4 |  * @public
 5 |  */
 6 | function buttonHandler(event) {
 7 |     // Older browsers may still be clinging to the charCode or keyCode implementation
 8 |     var charCode = event.which ? event.which : event.charCode ? event.charCode : event.keyCode ? event.keyCode : 0,
 9 |         message = document.getElementById("message");
10 |     
11 |     if ( charCode === 1 || charCode === 32 ) {
12 |         // As a unified click and key handler we do NOT map charCode === 10 ("Enter" key). UIEvent "keyup" default action is to call a "click" event with the "Enter" key, thus resulting in a double "press" scenario.
13 |         
14 |         if ( message.innerHTML === "Hello World" ) {
15 |             message.innerHTML = "Hello World Again";
16 |         } else {
17 |             message.innerHTML = "Hello World";
18 |         }
19 |         
20 |         event.preventDefault();
21 |     }
22 | }


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/EPUB/components/component_author/component_name/xhtml/component.xhtml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
 3 |     <head>
 4 |         <title>Hello World</title>
 5 |         <link href="../css/style.css" rel="stylesheet"/>
 6 |         <meta name="viewport" content="width=480, height=320"/>
 7 |     </head>
 8 |     <body class="center" aria-describedby="description">
 9 |         <h1 class="screen_reader_only">Hello World</h1>
10 |         <p id="description" class="screen_reader_only">A basic packaged EPUB Scriptable Component.</p>
11 |         
12 |         <p id="message" aria-live="polite" aria-relevant="additions removals">Hello World</p>
13 |         
14 |         <button onclick="buttonHandler(event)" onkeyup="buttonHandler(event)" aria-controls="message">Update message</button>
15 |         
16 |         <script src="../js/main.js"></script>
17 |     </body>
18 | </html>


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/EPUB/components/component_author/component_name/js/main.js:
--------------------------------------------------------------------------------
 1 | /***
 2 |  * @name buttonHandler
 3 |  * @desc Unified button click and keyboard handler
 4 |  * @public
 5 |  */
 6 | function buttonHandler(event) {
 7 |     // Older browsers may still be clinging to the charCode or keyCode implementation
 8 |     var charCode = event.which ? event.which : event.charCode ? event.charCode : event.keyCode ? event.keyCode : 0,
 9 |         message = document.getElementById("message");
10 |     
11 |     if ( charCode === 1 || charCode === 32 ) {
12 |         // As a unified click and key handler we do NOT map charCode === 10 ("Enter" key). UIEvent "keyup" default action is to call a "click" event with the "Enter" key, thus resulting in a double "press" scenario.
13 |         
14 |         if ( message.innerHTML === "Hello World" ) {
15 |             message.innerHTML = "Hello World Again";
16 |         } else {
17 |             message.innerHTML = "Hello World";
18 |         }
19 |         
20 |         event.preventDefault();
21 |     }
22 | }


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2015 International Digital Publishing Forum
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/EPUB/css/style.css:
--------------------------------------------------------------------------------
 1 | @charset "utf-8";
 2 | @namespace epub "http://www.idpf.org/2007/ops";
 3 | 
 4 | html {
 5 |     height: 100%;
 6 |     font-size: 100%;
 7 | }
 8 | 
 9 | body {
10 |     font-family: "Times New Roman",Times,serif;
11 |     font-size: 1em;
12 |     margin: 0;
13 |     padding: 0;
14 |     width: 100%;
15 | }
16 | 
17 | h1 {
18 |     font-family: Arial,Helvetica,sans-serif;
19 |     font-size: 1.5em;
20 |     font-weight: bold;
21 |     margin-top: 0.75em;
22 | }
23 | 
24 | h2 {
25 |     font-family: Arial,Helvetica,sans-serif;
26 |     font-size: 1.3em;
27 |     font-weight: bold;
28 |     color: #FD9F10;
29 |     margin: 0.75em 0 0.5em 0;
30 | }
31 | 
32 | h1, h2, h3, h4 {
33 |     -epub-hyphens: none;
34 |     -webkit-hyphens: none;
35 |     -moz-hyphens: none;
36 |     hyphens: none;
37 | }
38 | 
39 | p {
40 |     margin: 0.5em 0 0 0;
41 | }
42 | 
43 | ol, ul {
44 |     margin: 0 0 0 1em;
45 |     padding: 0;
46 | }
47 | 
48 | iframe {
49 |     border: none;
50 |     margin: 0;
51 |     padding: 0;
52 | }
53 | 
54 | figure {
55 |     margin: 1em 0 1em 0;
56 |     border: 2px solid #FD9F10;
57 |     max-width: 800px;
58 | }
59 | 
60 | figure figcaption {
61 |     padding: 0.5em;
62 |     border-top: 2px solid #FD9F10;
63 |     background: #EFEFF8;
64 |     line-height: 1.1em;
65 | }
66 | 
67 | figcaption .fig_title, figcaption .fig_enum {
68 |     font-weight: bold;
69 | }
70 | 
71 | figcaption .fig_title:after {
72 |     content: " — ";
73 | }
74 | 
75 | #toc ol {
76 |     list-style-type: none;
77 | }


--------------------------------------------------------------------------------
/Samples/1-basic_component/packaged/basic_template/EPUB/xhtml/toc.xhtml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
 3 |     <head>
 4 |         <title>component_name</title>
 5 |         <style>
 6 | @charset "utf-8";
 7 | @namespace epub "http://www.idpf.org/2007/ops";
 8 | 
 9 | html {
10 |     height: 100%;
11 |     font-size: 100%;
12 | }
13 | 
14 | body {
15 |     font-family: "Times New Roman",Times,serif;
16 |     font-size: 1em;
17 |     margin: 0;
18 |     padding: 0;
19 |     width: 100%;
20 | }
21 | 
22 | h1 {
23 |     font-family: Arial,Helvetica,sans-serif;
24 |     font-size: 1.5em;
25 |     font-weight: bold;
26 |     margin-top: 0.75em;
27 | }
28 | 
29 | h2 {
30 |     font-family: Arial,Helvetica,sans-serif;
31 |     font-size: 1.3em;
32 |     font-weight: bold;
33 |     color: #FD9F10;
34 |     margin: 0.75em 0 0.5em 0;
35 | }
36 | 
37 | h1, h2, h3, h4 {
38 |     -epub-hyphens: none;
39 |     -webkit-hyphens: none;
40 |     -moz-hyphens: none;
41 |     hyphens: none;
42 | }
43 | 
44 | p {
45 |     margin: 0.5em 0 0 0;
46 | }
47 | 
48 | ol, ul {
49 |     margin: 0 0 0 1em;
50 |     padding: 0;
51 | }
52 | 
53 | #toc ol {
54 |     list-style-type: none;
55 | }
56 |         </style>
57 |     </head>
58 |     <body>
59 |         <h1>component_name</h1>
60 |         <nav id="toc" epub:type="toc">
61 |             <h2>Table of Contents</h2>
62 |             <ol>
63 |                 <li><a href="component.xhtml">component_name</a></li>
64 |             </ol>
65 |         </nav>
66 |     </body>
67 | </html>
68 | 


--------------------------------------------------------------------------------
/Samples/1-basic_component/packaged/basic_template/EPUB/package.opf:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <package version="3.0" xml:lang="en" unique-identifier="esc-id"
 3 |     xmlns="http://www.idpf.org/2007/opf"
 4 |     prefix="epubsc: http://idpf.org/epub/vocab/sc/#">
 5 |     <!-- EPUBCheck 4.0.0 Alpha11 no longer requires - prefix="rendition: http://www.idpf.org/vocab/rendition/#" -->
 6 | 
 7 |     <metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
 8 |         <dc:type>scriptable-component</dc:type>
 9 |         
10 |         <dc:identifier id="esc-id">urn:uuid:2748c9f9-7362-49e1-85fb-7715f6d23862</dc:identifier>
11 |         <meta refines="#esc-id" property="identifier-type" scheme="xsd:string">uuid</meta>
12 |         <meta property="dcterms:modified">2015-06-30T16:00:00Z</meta>
13 |         
14 |         <dc:title id="esc_title">component_name</dc:title><!-- Path concatenation part 2 -->
15 |         <meta refines="#esc_title" property="dcterms:alternative">Hello World</meta>
16 |         <dc:description>A basic packaged EPUB Scriptable Component.</dc:description>
17 |         <dc:language>en</dc:language>
18 |         
19 |         <dc:creator id="esc_creator">component_author</dc:creator><!-- Path concatenation part 1 -->
20 |         <meta refines="#esc_creator" property="dcterms:alternative">Darryl Lehmann</meta>
21 |         <meta refines="#esc_creator" property="file-as">Lehmann, Darryl</meta>
22 |         <dc:publisher id="esc_publisher">Imagineeringart.com, Inc</dc:publisher>            
23 |         <dc:rights>Copyright © Imagineeringart.com, Inc. 2015. All rights reserved.</dc:rights>
24 |         
25 |         <meta property="epubsc:version">1.0.1</meta>                                                
26 |         <meta property="rendition:layout">pre-paginated</meta>
27 |         <meta property="rendition:orientation">landscape</meta>
28 |         <meta property="rendition:spread">both</meta>
29 |         <meta property="rendition:viewport">width=480,height=320</meta>
30 |         
31 |         <meta property="schema:accessibilityAPI">ARIA</meta>
32 |         <meta property="schema:accessibilityControl">fullKeyboardControl</meta>
33 |         <meta property="schema:accessibilityControl">fullMouseControl</meta>
34 |     </metadata>
35 |     
36 |     <manifest>
37 |         <!-- generated TOC? -->
38 |         <item id="toc"             href="xhtml/toc.xhtml"             media-type="application/xhtml+xml" properties="nav"/>
39 |         
40 |         <!-- sc1 - Embedded Scripted Component 1 -->
41 |         <item id="sc1_main"     href="xhtml/component.xhtml"     media-type="application/xhtml+xml" properties="scripted" fallback="sc1_fallback"/>
42 |         <item id="sc1_fallback" href="xhtml/fallback.xhtml"     media-type="application/xhtml+xml"/>
43 |         <item id="sc1_style"     href="css/style.css"             media-type="text/css"/>
44 |         <item id="sc1_script"     href="js/main.js"                 media-type="text/javascript"/>
45 |     </manifest>
46 |     
47 |     <spine>
48 |         <itemref idref="sc1_main"/>
49 |     </spine>
50 | 
51 | </package>


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/EPUB/xhtml/chapter1.xhtml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
 3 |     <head>
 4 |         <title>Chapter 1</title>
 5 |         <link rel="stylesheet" type="text/css" href="../css/style.css" />
 6 |     </head>
 7 |     <body class="chapter1">
 8 |         <section id="c1_intro" class="chapter" title="Chapter 1" epub:type="chapter">
 9 |             <h2 class="title">Chapter 1</h2>
10 |             <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
11 |             
12 |             <section id="c1_s1" title="Heading 1" epub:type="part">
13 |                 <h2 id="c1_s1_h1" class="title">Heading 1</h2>
14 |                 <p>Labore excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
15 |                 <ul class="itemizedlist">
16 |                     <li class="listitem"><p>Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p></li>
17 |                     <li class="listitem"><p>Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.</p></li>
18 |                     <li class="listitem"><p>Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p></li>
19 |                 </ul>
20 |                 <p>Ipsum adipiscio sitta armetta, consectetur adipiscing elit, enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.</p>
21 |             </section>
22 |             
23 |             <section id="c1_s2" title="Heading 2" epub:type="part">
24 |                 <h2 id="c1_s2_h1" class="title">Heading 2</h2>
25 |                 <p>Consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
26 |                 <figure id="c1_s2_f1">
27 |                     <!-- ESC Drop point - START -->
28 |                     <iframe id="c1_s2_f1_sc1" width="480" height="320" style="width:100%;" src="../components/component_author/component_name/xhtml/component.xhtml"></iframe>
29 |                     <!-- ESC Drop point - END -->
30 |                     <figcaption><span class="fig_enum">Scriptable Component 1: </span><span class="fig_title">Hello World</span>A basic packaged EPUB Scriptable Component.</figcaption>
31 |                 </figure>
32 |                 <p>Dolore magna aliqua uta enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>                
33 |             </section>
34 |         </section>
35 |     </body>
36 | </html>


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # IDPF EPUB Scriptable Components code &amp; samples
 2 | 
 3 | This repository is home to the EPUB Scriptable Components (ESC) Working Group (WG) code and samples. 
 4 | Contained herein are a set of samples of Scriptable Components (SC) based upon the [ESC Packaging specification](http://www.idpf.org/epub/sc/pkg/) and [ESC Communication API specification](http://www.idpf.org/epub/sc/api/).
 5 | 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. 
 6 | 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:
 7 | ```
 8 | .
 9 | +-- LICENSE
10 | +-- README.md
11 | \---Samples
12 |     +---1-basic_component
13 |     |   +---embedded
14 |     |   \---packaged
15 |     +---2-nested_component
16 |     |   +---embedded
17 |     |   \---packaged
18 |     \---3-messaging_component
19 |         +---embedded
20 |         \---packaged		
21 | ```
22 | 		
23 | 
24 | 		
25 | ## Contributing to EPUB Scriptable Components code &amp; samples
26 | 
27 | Looking to contribute something to EPUB Scriptable Components code &amp; samples? **Here's how you can help:**
28 | 
29 | 
30 | 
31 | 
32 | ### Reporting issues
33 | 
34 | Please read the following guidelines before opening any issue.
35 | 
36 | 1. **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.
37 | 2. **Create an isolated and reproducible test case.** Be sure the problem exists in EPUB Scriptable Components code &amp; samples with a [reduced test case](http://css-tricks.com/reduced-test-cases/) that should be included in each bug report.
38 | 3. **Include a live example.** Make use of jsFiddle or jsBin to share your isolated test cases.
39 | 4. **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.
40 | 
41 | 
42 | 
43 | 
44 | ### Pull requests
45 | 
46 | - Try not to pollute your pull request with unintended changes--keep them simple and small
47 | - Try to share which browsers your code has been tested in before submitting a pull request
48 | 
49 | 
50 | 
51 | 
52 | ### Coding standards
53 | 
54 | #### JS
55 | 
56 | - End all lines with a semi-colon
57 | - Comma last
58 | - Indent of 4 spaces, remove tabs.
59 | - Make it readable and attractive
60 | - Modern screens can handle vertical space, use brackets on their own lines for visual clarity of blocks
61 | - Please use jsDoc annotations/comments to add typing information.
62 | 
63 | #### HTML
64 | 
65 | - Indent of 4 spaces, remove tabs.
66 | - Double quotes only, never single quotes
67 | - Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags)
68 | - 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://`
69 | 
70 | #### CSS
71 | 
72 | - Adhere to the [RECESS CSS property order](http://markdotto.com/2011/11/29/css-property-order/)
73 | - Multiple-line approach (one property and value per line)
74 | - Always a space after a property's colon (e.g., `display: block;` and not `display:block;`)
75 | - End all lines with a semi-colon
76 | - For multiple, comma-separated selectors, place each selector on its own line
77 | - 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](http://mathiasbynens.be/notes/unquoted-attribute-values) that can lead to XSS attacks)
78 | 
79 | 
80 | 
81 | 
82 | ### License
83 | 
84 | By contributing your code, you agree to license your contribution under the [MIT](http://opensource.org/licenses/MIT) license.
85 | 


--------------------------------------------------------------------------------
/Samples/1-basic_component/embedded/basic_template/EPUB/package.opf:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <package version="3.0" xml:lang="en" unique-identifier="pub-id"
 3 |     xmlns="http://www.idpf.org/2007/opf"
 4 |     prefix="epubsc: http://idpf.org/epub/vocab/sc/#">
 5 |     <!-- EPUBCheck 4.0.0 Alpha11 no longer requires - prefix="rendition: http://www.idpf.org/vocab/rendition/#" -->
 6 |     
 7 |     <metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
 8 |         <dc:identifier id="pub-id">urn:uuid:f4ec85a0-daf9-447b-d490-f458ca0aea0a</dc:identifier>
 9 |         <meta refines="#pub-id" property="identifier-type" scheme="xsd:string">uuid</meta>
10 |         <meta property="dcterms:modified">2015-06-30T16:00:00Z</meta>
11 |         
12 |         <dc:title id="title">Author Name's Nth Edition — Subject of Interest</dc:title>
13 |         <meta refines="#title" property="file-as">Subject of Interest, Author Name's, Nth Edition</meta>
14 |         <dc:description id="description">A useful brief description allowing for a reader to quickly discern the scope and scale of the product.</dc:description>
15 |         <dc:subject id="subject">Non-Fiction</dc:subject>
16 |         <dc:language id="language">en</dc:language>
17 |         <dc:date>2015-06-01</dc:date>
18 |         
19 |         <dc:creator id="author">Darryl Lehmann</dc:creator>
20 |         <meta refines="#author" property="file-as">Lehmann, Darryl</meta>
21 |         <dc:publisher id="publisher">Imagineeringart.com, Inc</dc:publisher>
22 |         <dc:rights id="rights">Copyright © Imagineeringart.com, Inc. 2015. All rights reserved.</dc:rights>
23 |         <meta name="cover" content="cover_image"/><!-- EPUB2 -->
24 |         
25 |         <meta property="rendition:layout">reflowable</meta>
26 |         <meta property="rendition:orientation">auto</meta>
27 |         <meta property="rendition:spread">none</meta>
28 |     </metadata>
29 |     
30 |     <manifest>
31 |         <!-- Parent EPUB -->        
32 |         <item id="cover"         href="xhtml/cover.xhtml"     media-type="application/xhtml+xml"/>
33 |         <item id="cover_image"     href="img/cover.jpg"         media-type="image/jpeg" properties="cover-image"/>
34 |         <item id="css"             href="css/style.css"         media-type="text/css"/>
35 |         <item id="toc"             href="xhtml/toc.xhtml"         media-type="application/xhtml+xml" properties="nav"/>        
36 |         <item id="chapter1"     href="xhtml/chapter1.xhtml" media-type="application/xhtml+xml"/>
37 |         
38 |         <!-- sc1 - Embedded Scripted Component 1 -->
39 |         <item id="sc1_main"     href="components/component_author/component_name/xhtml/component.xhtml" media-type="application/xhtml+xml" properties="scripted" fallback="sc1_fallback"/>
40 |         <item id="sc1_fallback" href="components/component_author/component_name/xhtml/fallback.xhtml"     media-type="application/xhtml+xml"/>
41 |         <item id="sc1_style"     href="components/component_author/component_name/css/style.css"         media-type="text/css"/>
42 |         <item id="sc1_script"     href="components/component_author/component_name/js/main.js"             media-type="text/javascript"/>
43 |     </manifest>
44 |     
45 |     <spine>
46 |         <itemref idref="cover" linear="no"/>
47 |         <itemref idref="chapter1"/>
48 |     </spine>
49 |     
50 |     <collection role="scriptable-component">
51 |         <metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
52 |             <dc:type>scriptable-component</dc:type>
53 |             
54 |             <dc:identifier id="esc-id">urn:uuid:2748c9f9-7362-49e1-85fb-7715f6d23862</dc:identifier>
55 |             <meta refines="#esc-id" property="identifier-type" scheme="xsd:string">uuid</meta>
56 |             <meta property="dcterms:modified">2015-06-30T16:00:00Z</meta>
57 |             
58 |             <dc:title id="esc_title">component_name</dc:title><!-- Path concatenation part 2 -->
59 |             <meta refines="#esc_title" property="dcterms:alternative">Hello World</meta>
60 |             <dc:description>A basic packaged EPUB Scriptable Component.</dc:description>
61 |             <dc:language>en</dc:language>
62 |             
63 |             <dc:creator id="esc_creator">component_author</dc:creator><!-- Path concatenation part 1 -->
64 |             <meta refines="#esc_creator" property="dcterms:alternative">Darryl Lehmann</meta>
65 |             <meta refines="#esc_creator" property="file-as">Lehmann, Darryl</meta>
66 |             <dc:publisher id="esc_publisher">Imagineeringart.com, Inc</dc:publisher>
67 |             <dc:rights>Copyright © Imagineeringart.com, Inc. 2015. All rights reserved.</dc:rights>
68 |             
69 |             <meta property="epubsc:version">1.0.1</meta>
70 |             <meta property="rendition:layout">pre-paginated</meta>
71 |             <meta property="rendition:orientation">landscape</meta>
72 |             <meta property="rendition:spread">both</meta>
73 |             <meta property="rendition:viewport">width=480,height=320</meta>
74 |             
75 |             <meta property="schema:accessibilityAPI">ARIA</meta>
76 |             <meta property="schema:accessibilityControl">fullKeyboardControl</meta>
77 |             <meta property="schema:accessibilityControl">fullMouseControl</meta>
78 |         </metadata>
79 |         <collection role="manifest">
80 |             <link href="#sc1_main"/>
81 |             <link href="#sc1_fallback"/>
82 |             <link href="#sc1_style"/>
83 |             <link href="#sc1_script"/>
84 |         </collection>
85 |         <link href="#sc1_main"/>
86 |     </collection>
87 |     
88 | </package>


--------------------------------------------------------------------------------