asciidoctor-epub3 1.0.0.alpha.1

data/data/samples/asciidoctor-js-extension.adoc

@@ -0,0 +1,46 @@
+[[asciidoctor-js-extension]]
+= Asciidoctor.js browser extension: _Preview_ AsciiDoc in your browser
+Guillaume Grossetie <https://github.com/mogztter>
+2013-09-18
+:username: mogztter
+:gh-chrome-repo: https://github.com/asciidoctor/asciidoctor-chrome-extension
+:gh-ff-repo: https://github.com/asciidoctor/asciidoctor-firefox-addon
+:gh-adjs-repo: https://github.com/asciidoctor/asciidoctor.js
+:gh-ad-repo: https://github.com/asciidoctor/asciidoctor
+:download-chrome-extension: https://chrome.google.com/webstore/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia
+:download-ff-addon: https://addons.mozilla.org/fr/firefox/addon/asciidoctorjs-live-preview/
+:markitup-site: http://markitup.jaysalvat.com/
+:experimental:
+
+I'd like to introduce you to the easiest way to render any AsciiDoc file, local or remote, as HTML directly in your browser!
+All you need to do is install the {download-chrome-extension}[Chrome extension] or the {download-ff-addon}[Firefox add-on].
+Then you can preview any AsciiDoc file as HTML just by visiting it!
+
+== How it works
+
+The Chrome extension and the Firefox add-on use {gh-adjs-repo}[Asciidoctor.js] to render AsciiDoc as HTML inside your browser.
+Both provide a toggle button to switch between HTML output and AsciiDoc source.
+
+Here you can see a local AsciiDoc file rendered inside of Chrome.
+
+.Asciidoctor.js Chrome extension in action
+image::asciidoctor-js-chrome-extension.png[]
+
+TIP: You can view any AsciiDoc file on GitHub through the lens of Asciidoctor.js with this extension!
+Simply navigate to the file in the GitHub web interface (try https://github.com/asciidoctor/asciidoctor.org/blob/master/news/introducing-asciidoctor-js-live-preview.adoc[this blog post]) and click the btn:[Raw] button that appears above the file preview.
+Looks much better, doesn't it?
+
+== Future
+
+Currently, we are using {gh-adjs-repo}[Asciidoctor.js] based on {gh-ad-repo}[Asciidoctor] 0.1.2.
+We planned to cross-compile the newly-released {gh-ad-repo}[Asciidoctor] 0.1.4 to Javascript, to support the latest and greatest features!
+
+We are also working on adding some cool new features :
+
+ * browser-based editor using {markitup-site}[MarkItUp!]
+ * live reload to automatically refresh on local file changes
+ * and many more...
+
+== Contributing
+
+We're always open for patches, better documentation, feature requests, evangelizing or any help you're able to provide.

data/data/samples/asciidoctor-js-introduction.adoc

@@ -0,0 +1,91 @@
+[[asciidoctor-js]]
+= Asciidoctor.js: AsciiDoc in your _browser_
+Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
+v1.0, 2013-05-21
+:username: mojavelinux
+
+We've combined http://asciidoctor.org[Asciidoctor] and http://opalrb.org[Opal] to bring AsciiDoc rendering to the browser!
+
+== Introduction
+
+https://github.com/asciidoctor/asciidoctor.js[Asciidoctor.js] uses the http://opalrb.org[Opal] Ruby-to-JavaScript cross compiler to generate a direct JavaScript port of http://asciidoctor.org[Asciidoctor], an implementation of AsciiDoc.
+The result is AsciiDoc rendering in the browser!
+
+The project consists primarily of a Rake build script that executes the Opal compiler on the Asciidoctor source code to produce the Asciidoctor.js script.
+
+Opal parses the Ruby code and any required libraries, then rewrites the code into JavaScript under the Opal namespace.
+The resulting JavaScript can be executed in any JavaScript runtime environment, such as a browser or node.js application.
+
+== Proving the concept
+
+When I first discovered Opal, I thought to myself, ``Sure, this could work.''
+Little did I know that achieving this proof of concept was more than a small task.
+
+The effort involved filling gaps in Opal to support all the features of the Ruby standard library that Asciidoctor uses, as well as changes in Asciidoctor to make it compatible with constraints imposed by JavaScript (such as immutable strings).
+
+While there are still some shortcomings, I'm proud to say that Asciidoctor.js can successfully render the complete AsciiDoc User Guide (a document that has served as a compliance benchmark throughout the development of Asciidoctor).
+
+== The scripts
+
+There are two scripts generated by the Rake build that are needed to run Asciidoctor in the browser:
+
+[itemized%brief]
+opal.js:: The Ruby runtime in JavaScript
+asciidoctor.js:: The JavaScript port of Asciidoctor
+
+[WARNING]
+====
+Don't fret over the large size of these files.
+We haven't even started to optimize, having only just achieved the proof of concept.
+
+With that said, both files gzip rather nicely, bringing Asciidoctor.js down from over 500K to under 100K.
+As we learn to optimize Opal, the size of the generated files should become quite acceptable.
+====
+
+You need to load both files into your JavaScript environment to use Asciidoctor.
+For instance, in an HTML page, add these two +<script>+ tags (ideally at the bottom of the page):
+
+[source,html]
+----
+<script src="opal.js"></script>
+<script src="asciidoctor.js"></script>
+----
+
+You can see these scripts in action by running the examples, described in the https://github.com/asciidoctor/asciidoctor.js#readme[README].
+
+== Usage
+
+To interact with the generated code, you either:
+
+[loweralpha]
+. Write code in Ruby that hooks into the native JavaScript environment, which Opal compiles into JavaScript
+. Invoke the JavaScript APIs that Opal generates directly from JavaScript
+
+Here's an example that shows how Ruby can interact with the native JavaScript environment to render a string of AsciiDoc in the browser:
+
+[source,ruby]
+----
+content = %(= Asciidoctor.js: AsciiDoc in your browser!
+Dan Allen
+2013-05-21
+
+We've combined http://asciidoctor.org[Asciidoctor] and
+http://opalrb.org[Opal] to bring AsciiDoc rendering to the browser!)
+
+$window.addEventListener 'DOMContentLoaded', proc {
+  html_doc = Asciidoctor.render(content, :safe => :safe,
+    :attributes => %w(notitle! anchors imagesdir=./images))
+  $document.getElementById('content').innerHTML = html_doc
+}, false
+----
+
+== Changes to Asciidoctor
+
+Some changes were necessary in Asciidoctor to get it to compile with Opal.
+These changes have been merged into the upstream and will be part of the Asciidoctor 1.5.0 release.
+
+== Go play!
+
+Now it's time to go play with Asciidoctor.js.
+Explore what you can do with it and how it can be improved.
+Then, get involved in either Asciidoctor or Opal to help make AsciiDoc in the browser the best it can be!

data/data/samples/i18n.adoc

@@ -0,0 +1,161 @@
+[[i18n]]
+= Asciidoctor Playground: _i18n_ Noto Šerif
+Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
+:username: mojavelinux
+:source: http://www.impallari.com/testing
+
+[abstract]
+Grumpy wizards make toxic brew for the evil Queen and Jack.
+But they feared not, for they had the many tongues of Noto Serif on their side.
+
+== Diacritics
+
+À Á Â Ã Ä Å Ā Ă Ą Ǻ Ȁ Ȃ Æ Ǽ Ć Ç Ĉ Ċ Č Ď Đ Ð Ḍ DZ Dz DŽ Dž È É Ê Ë Ē Ĕ Ė Ę Ẽ Ě Ẹ Ȅ Ȇ Ə Ǵ Ĝ Ğ Ġ Ģ Ĥ Ħ Ḥ Ĭ Ì Í Î Ï İ Ĩ Ī Į Ị Ȉ Ȋ IJ Ĵ Ķ Ĺ Ļ Ľ Ŀ Ł LJ Lj Ñ Ń Ņ Ň Ṅ Ŋ NJ Nj Ò Ó Ô Õ Ö Ō Ŏ Ő Ø Ǿ Ǫ Ọ Ȍ Ȏ Œ Þ Ŕ Ŗ Ř Ṛ Ȑ Ȓ Ś Ŝ Š Ș Ş Ṣ Ŧ Ť Ț Ţ Ṭ Ù Ú Û Ü Ũ Ū Ŭ Ů Ű Ų Ụ Ȕ Ȗ Ẁ Ẃ Ẅ Ŵ Ý Ŷ Ÿ Ỳ Ỹ Ź Ż Ž Ẓ
+à á â ã ä å ā ă ą ǻ ȁ ȃ æ ǽ ć ç ĉ ċ č ď đ ð ḍ dz dž è é ê ë ē ĕ ė ę ě ẽ ẹ ȅ ȇ ə ǵ ĝ ğ ġ ģ ĥ ħ ḥ ì í î ï ĩ ī į ĭ ị ȉ ȋ ij ĵ ķ ĸ ĺ ļ ľ ŀ ł lj ń ʼn ņ ň ñ ṅ ŋ nj ò ó ô õ ö ø ō ŏ ő ǿ ǫ ọ ȍ ȏ œ þ ŕ ŗ ř ṛ ȑ ȓ ś ŝ š ș ş ṣ ß ŧ ť ț ţ ṭ ù ú û ü ũ ū ŭ ů ű ų ụ ȕ ȗ µ μ ẁ ẃ ẅ ŵ ý ÿ ŷ ỳ ỹ ź ż ž ẓ
+
+[lowergreek]
+. one
+. two
+. three
+
+=== Azeri
+
+Zəfər, jaketini də papağını da götür, bu axşam hava çox soyuq olacaq.
+ 
+=== Catalan
+
+Jove xef, porti whisky amb quinze glaçons d'hidrogen, coi!
+ 
+=== Croatian
+
+Gojazni đačić s biciklom drži hmelj i finu vatu u džepu nošnje.
+ 
+=== Czech
+
+Nechť již hříšné saxofony ďáblů rozzvučí síň úděsnými tóny waltzu, tanga a quickstepu
+ 
+=== Danish
+
+Høj bly gom vandt fræk sexquiz på wc
+ 
+=== Dutch
+
+Lynx c.q. vos prikt bh: dag zwemjuf!
+ 
+=== Esperanto
+
+Eble ĉiu kvazaŭ-deca fuŝĥoraĵo ĝojigos homtipon
+ 
+=== Estonian
+
+Põdur Zagrebi tšellomängija-följetonist Ciqo külmetas kehvas garaažis
+ 
+=== Filipino
+
+Ang buko ay para sa tao dahil wala nang pwedeng mainom na gatas.
+ 
+=== Finnish
+
+Törkylempijävongahdus Albert osti fagotin ja töräytti puhkuvan melodian
+ 
+=== French
+
+Buvez de ce whisky que le patron juge fameux
+ 
+=== West Frisian
+
+Alve bazige froulju wachtsje op dyn komst
+ 
+=== German
+
+Victor jagt zwölf Boxkämpfer quer über den großen Sylter Deich
+ 
+=== Hungarian
+
+Jó foxim és don Quijote húszwattos lámpánál ülve egy pár bűvös cipőt készít
+ 
+=== Icelandic
+
+Kæmi ný öxi hér, ykist þjófum nú bæði víl og ádrepa.
+ 
+=== Irish
+
+D'fhuascail Íosa Úrmhac na hÓighe Beannaithe pór Éava agus Ádhaimh
+ 
+=== Italian
+
+In quel campo si trovan funghi in abbondanza.
+ 
+=== Latvian
+
+Muļķa hipiji turpat brīvi mēģina nogaršot celofāna žņaudzējčūsku.
+ 
+=== Lithuanian
+
+Įlinkdama fechtuotojo špaga sublykčiojusi pragręžė apvalų arbūzą
+ 
+=== Norwegian
+
+Vår sære Zulu fra badeøya spilte jo whist og quickstep i min taxi.
+ 
+=== Polish
+
+Jeżu klątw, spłódź Finom część gry hańb!
+ 
+=== Portuguese
+
+Luís argüia à Júlia que «brações, fé, chá, óxido, pôr, zângão» eram palavras do português.
+ 
+=== Romanian
+
+Muzicologă în bej vând whisky și tequila, preț fix.
+ 
+=== Serbian (also applies to Croatian and Bosnian)
+
+Gojazni đačić s biciklom drži hmelj i finu vatu u džepu nošnje.
+ 
+=== Slovak
+
+Kŕdeľ ďatľov učí koňa žrať kôru.
+ 
+=== Slovenian
+
+Šerif bo za vajo spet kuhal domače žgance. Piškur molče grabi fižol z dna cezijeve hoste.
+ 
+=== Spanish
+
+El veloz murciélago hindú comía feliz cardillo y kiwi. ¡qué figurota exhibe! La cigüeña tocaba el saxofón ¿Detrás del palenque de paja?
+ 
+=== Swedish
+
+Yxskaftbud, ge vår WC-zonmö IQ-hjälp.
+ 
+=== Turkish
+
+Fahiş bluz güvencesi yağdırma projesi çöktü.
+
+== More
+
+=== Bulgarian
+
+Ах чудна българска земьо, полюшквай цъфтящи жита.
+ 
+=== Greek
+
+Τάχιστη αλώπηξ βαφής ψημένη γη, δρασκελίζει υπέρ νωθρού κυνός
+ 
+=== Japanese
+
+いろはにほへと　ちりぬるを　わかよたれそ　つねならむ　うゐのおくやま　けふこえて　あさきゆめみし　ゑひもせす 色は匂へど　散りぬるを　我が世誰ぞ　常ならむ　有為の奥山　今日越えて　浅き夢見じ　酔ひもせず（ん）
+ 
+=== Korean
+
+키스의 고유조건은 입술끼리 만나야 하고 특별한 기술은 필요치 않다.
+ 
+=== Russian
+
+Съешь же ещё этих мягких французских булок, да выпей чаю.
+ 
+=== Ukrainian
+
+Жебракують філософи при ґанку церкви в Гадячі, ще й шатро їхнє п'яне знаємо.

data/data/samples/sample-book.adoc

@@ -0,0 +1,20 @@
+= Asciidoctor EPUB3: Sample Book
+Author Name
+v1.0, 2014-04-15
+:doctype: book
+:producer: Asciidoctor
+:keywords: Asciidoctor, samples, e-book, EPUB3, KF8, MOBI, Asciidoctor.js
+:copyright: CC-BY-SA 3.0
+:imagesdir: images
+
+ifeval::["{scripts}" == "multilingual"]
+include::i18n.adoc[]
+endif::[]
+
+include::asciidoctor-epub3-readme.adoc[]
+
+include::sample-content.adoc[]
+
+include::asciidoctor-js-introduction.adoc[]
+
+include::asciidoctor-js-extension.adoc[]

data/data/samples/sample-content.adoc

@@ -0,0 +1,168 @@
+[[sample-content]]
+= Asciidoctor Playground: Sample Content
+Sarah White <https://github.com/graphitefriction[@graphitefriction]>
+:username: graphitefriction
+:description: This guide describes the Asciidoctor attributes, values, and layout options available for producing a customized and polished document.
+:keywords: AsciiDoc, Asciidoctor, syntax, reference
+:language: asciidoc
+
+[abstract]
+This sample guide describes the some Asciidoctor attributes, values, and layout options available for producing a customized and polished document.
+
+== Block titles
+
+You can assign a title to any paragraph, list, delimited block, or block macro.
+In most cases, the title is displayed immediately above the content.
+If the content is a figure or image, the title is displayed below the content.
+
+A block title is defined on a line above the element.
+The line must begin with a dot (+.+) and be followed immediately by the title text with no spaces inbetween.
+
+Here's an example of a list with a title:
+
+.A titled list
+====
+.TODO list
+- Learn the AsciiDoc syntax
+- Install Asciidoctor
+- Write my novel
+====
+
+== Metadata
+
+In addition to a title, lists and blocks can be assigned metadata, including:
+
+* Id (i.e., anchor)
+* Style (first unnamed block attribute)
+* Named block attributes
+* Options
+
+Here's an example of a quote block with metadata:
+
+[source]
+----
+.Gettysburg Address <1>
+[[gettysburg]] <2>
+[quote, Abraham Lincoln, Soldiers' National Cemetery Dedication] <3> <4> <5>
+____
+Four score and seven years ago our fathers brought forth
+on this continent a new nation...
+
+Now we are engaged in a great civil war, testing whether
+that nation, or any nation so conceived and so dedicated,
+can long endure. ...
+____
+----
+<1> Title: Gettysburg Address
+<2> Id: gettysburg
+<3> Style: quote
+<4> attribution: Abraham Lincoln (Named block attribute)
+<5> citetitle: Dedication of the Soldiers' National Cemetery (Named block attribute)
+
+TIP: A block can have multiple block attribute lines.
+The attributes will be aggregated.
+If there is a name conflict, the last attribute defined wins.
+
+Some metadata is used as supplementary content, such as the title, whereas other metadata controls how the block is rendered, such as the style.
+
+== Delimited blocks
+
+The AsciiDoc syntax provides a set of components for including non-paragraph text--such as block quotes, source code listings, sidebars and tables--in your document.
+These components are referred to as _delimited blocks_ because they are surrounded by delimiter lines.
+
+Within the boundaries of a delimited block, you can enter any content or blank lines.
+The block doesn't end until the ending delimiter is found.
+The delimiters around the block determine the type of block, how the content is processed and rendered, and what elements are used to wrap the content in the output.
+
+=== Optional delimiters
+
+If the content is contiguous (not interrupted by blank lines), you can forgo the use of the block delimiters and instead use the block style above a paragraph to repurpose it as one of the delimited block types.
+
+NOTE: This format is often used for single-line listings or quotes.
+
+.Single line listing block
+[source]
+----
+[listing]
+sudo yum install asciidoc
+----
+
+.Single line quote block
+[source]
+----
+[quote]
+Never do today what you can put off 'til tomorrow.
+----
+
+== Admonitions
+
+There are certain statements that you may want to draw attention to by taking them out of the content's flow and labeling them with a priority.
+These are called admonitions.
+Asciidoctor provides five built-in admonition style labels:
+
+Tip:: Used for giving the reader helpful advice.
+Note:: Used to communicate related or follow-up information.
+Important:: Used to remind the reader to do a critical step or task.
+Warning:: Used to inform the reader of potential risks.
+Caution:: Also used to inform the reader of potential risks, take your pick.
+
+When you want to call attention to a single paragraph, start the first line of the paragraph with the label you want to use.
+The label must be uppercase and followed by a colon (+:+).
+
+WARNING: Wolpertingers are known to nest in server racks.
+Enter at your own risk.
+
+When you want to apply an admonition label to complex content, set the label as a style attribute on a delimited block.
+Admonition labels are commonly set on example blocks.
+This behavior is referred to as _masquerading_.
+The label must be uppercase when set as an attribute on a block.
+
+[IMPORTANT]
+.Feeding the Werewolves
+====
+While werewolves are hardy community members, keep in mind the following dietary concerns:
+
+. They are allergic to cinnamon.
+. More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens.
+. Celery makes them sad.
+====
+
+== Quotes, Prose Excerpts, and Verses
+
+Quotes, prose excerpts and verses share the same syntax structure, including:
+
+* style attribute, either +quote+ or +verse+ 
+* name of who the content is attributed to
+* biblographical information of the book, speech, play, etc., where the content was drawn from
+* excerpt text
+
+.Anatomy of a basic quote
+----
+[quote, attribution, citation title and information]
+Quote or excerpt text
+----
+
+For content that doesn't require the preservation of line breaks, set the +quote+ attribute in the first position of the attribute list.
+Next, set the attribution and relevant citation information.
+However, these positional attributes are optional.
+
+If the quote is a single line or paragraph, you can place the attribute list directly on top of the text.
+
+.after landing the cloaked Klingon bird of prey in Golden Gate park
+[quote, James Kirk, Star Trek IV: The Voyage Home]
+Everybody remember where we parked.
+
+For those of you who want a little bit of culture in this document, here's an excerpt of a poem by Carl Sandburg.
+
+[verse, Carl Sandburg, Fog]
+____
+The fog comes
+on little cat feet.
+
+It sits looking
+over harbor and city
+on silent haunches
+and then moves on.
+____
+
+That's all folks!