mizuho 0.9.10 → 0.9.11

data/asciidoc/examples/website/slidy-example.txt

@@ -0,0 +1,167 @@
+Slidy Example Slideshow
+=======================
+:author:    Joe Bloggs
+:copyright: Foobar Inc.
+:backend:   slidy
+:max-width: 45em
+:data-uri:
+:icons:
+
+
+This preamble will appear on a separate slide.
+
+
+AsciiDoc Elements
+-----------------
+Sagittis in vestibulum. Habitasse ante nulla enim bibendum nulla. Odio
+sed pede litora.
+
+[float]
+=== Titles inside delimited blocks must be floated
+Porta nisl metus. Justo porttitor vel. Cras consequat tincidunt id sed
+conubia. Feugiat felis justo. Nunc amet nulla. Eu ac orci mollis.
+
+.Tiger
+image::images/tiger.png[]
+
+
+Incremental Elements
+--------------------
+The remaining elements on this page are incremental, press the space
+bar to reveal them.
+
+[role="incremental"]
+- Rhoncus pede justo.
+- Velit pede dolor.
+- Iaculis commodo et.
+- Volutpat tristique nec.
+
+[role="incremental"]
+--
+Sagittis in vestibulum. Habitasse ante nulla enim bibendum nulla. Odio
+sed pede litora.
+--
+
+[role="incremental"]
+. Rhoncus pede justo.
+. Velit pede dolor.
+. Iaculis commodo et.
+. Volutpat tristique nec.
+
+
+Outline Elements
+----------------
+The following list is a Slidy 'outline' list -- nested bulleted or
+numbered lists are expanded when the enclosing list item (the ones
+with blue bullet points or numbers) are clicked.
+
+[role="outline"]
+- Rhoncus pede justo.
+  * Rhoncus pede justo.
+  * Velit pede dolor.
+
+- Velit pede dolor.
+  * Iaculis commodo et.
++
+NOTE: 'Note' admonition paragraph.
+
+  * Volutpat tristique nec.
++
+image::images/tiger.png[]
+  * Iaculis commodo et.
+  * Volutpat tristique nec.
+
+- Iaculis commodo et.
+[role="outline"]
+  . Rhoncus pede justo.
+  ** Velit pede dolor.
+  ** Iaculis commodo et.
+  . Volutpat tristique nec.
+
+- Volutpat tristique nec.
+
+
+AsciiDoc Elements
+-----------------
+NOTE: 'Note' admonition paragraph.
+
+IMPORTANT: 'Important' admonition paragraph.
+
+.Sidebar
+*********************************************************************
+Faucibus sagittis commodo sed et eu. Quam nullam ornare. Sed vel est.
+Mauris urna lobortis interdum placerat per id magnis enim.
+*********************************************************************
+
+
+AsciiDoc Elements
+-----------------
+A quote block:
+
+[quote, Bertrand Russell, The World of Mathematics (1956)]
+____________________________________________________________________
+A good notation has subtlety and suggestiveness which at times makes
+it almost seem like a live teacher.
+____________________________________________________________________
+
+A verse block:
+
+[verse, William Blake, from Auguries of Innocence]
+__________________________________________________
+To see a world in a grain of sand,
+And a heaven in a wild flower,
+Hold infinity in the palm of your hand,
+And eternity in an hour.
+__________________________________________________
+
+
+AsciiDoc Elements
+-----------------
+.Horizontal and vertical source data
+[width="80%",cols="3,^2,^2,10",options="header"]
+|=========================================================
+|Date |Duration |Avg HR |Notes
+
+|22-Aug-08 |10:24 | 157 |
+Worked out MSHR (max sustainable heart rate) by going hard
+for this interval.
+
+|22-Aug-08 |23:03 | 152 |
+Back-to-back with previous interval.
+
+|24-Aug-08 |40:00 | 145 |
+Moderately hard interspersed with 3x 3min intervals (2min
+hard + 1min really hard taking the HR up to 160).
+
+|=========================================================
+
+
+Filters
+-------
+[source,python]
+.Python source
+---------------------------------------------------------------------
+''' A multi-line
+    comment.'''
+def sub_word(mo):
+    ''' Single line comment.'''
+    word = mo.group('word')     # Inline comment
+    if word in keywords[language]:
+        return quote + word + quote
+    else:
+        return word
+---------------------------------------------------------------------
+
+[music]
+.Music
+---------------------------------------------------------------------
+\version "2.10.0"
+\paper {
+  ragged-right = ##t
+}
+{
+  \time 3/4
+  \clef bass
+  c2 e4 g2. f4 e d c2 r4
+}
+---------------------------------------------------------------------

data/asciidoc/examples/website/slidy.txt

@@ -0,0 +1,113 @@
+Slidy backend for AsciiDoc
+==========================
+:author:    Stuart Rackham
+:backend:   slidy
+:max-width: 45em
+:data-uri:
+:icons:
+
+
+Use the following command to create this document (`slidy.html`):
+
+  asciidoc slidy.txt
+
+Press the 'Space' key or the 'Left Arrow' key to continue the
+slideshow.
+
+
+Overview
+--------
+AsciiDoc has a 'slidy' backend for generating self contained 'Slidy'
+HTML slideshows.
+
+- An overview of 'Slidy' can be found here:
+  http://www.w3.org/Talks/Tools/Slidy2/
+- AsciiDoc ships with the Slidy JavaScript a customised Slidy CSS
+  file.
+- Use the 'asciidoc' `--backend slidy` command-line option to generate
+  browser viewable HTML slideshow. Example:
+
+  asciidoc --backend slidy slidy-example.txt
+
+- By default, 'asciidoc' creates a self contained distributable HTML
+  document which includes all necessary CSS and JavaScripts.  Use the
+  'asciidoc' `--attribute linkcss` command-line option if you prefer
+  to link (rather than embed) external CSS and JavaScript files.
+
+
+How Slidy uses AsciiDoc markup
+------------------------------
+- The document header is displayed as the first page of the slideshow.
+- If the document has a 'preamble' (the content between the header and
+  the first section) it will be displayed on the second page.
+- Each top level section is displayed as a separate slide.
+- If the AsciiDoc 'incremental' attribute is defined then all lists
+  and OpenBlock elements are treated as 'incremental' i.e. Slidy
+  exposes their child elements one at a time as you progress through
+  the slideshow.
+- You can explicitly set an element as incremental by setting its
+  'role' attribute to 'incremental'. Example:
+
+  [role="incremental"]
+  Sagittis in vestibulum. Habitasse ante nulla enim bibendum nulla.
+  Odio sed pede litora.
+
+
+Slidy Specific Attributes
+-------------------------
+incremental::
+If this attribute is defined then all lists and OpenBlock elements are
+classed as incremental i.e. Slidy will expose them one at a time as
+you progress through the slideshow.  The default behavior is for the
+show to progress a full slide at at time.  Elements that have been
+explicitly classed as 'incremental' with the 'role' attribute are
+always displayed incrementally.
+
+duration::
+Set this to the estimated number of minutes that your presentation
+will take and Slidy will display a countdown timer at the bottom right
+of the slideshow. For example, this 'asciidoc' command-line option
+`--attribute duration=5` sets the duration to five minutes.
+
+copyright::
+If you set the 'copyright' attribute it will be displayed in the Slidy
+menu bar at the bottom of the slide. If the 'copyright' attribute is
+not define then the author name, if it is defined, will be displayed.
+
+outline::
+Setting the 'role' attribute to 'outline' in a bulleted or numbered
+list allows nested lists to be expanded and collapsed using the mouse.
+Nested lists are expanded when an enclosing list item (the ones with
+blue bullet points or numbers) is clicked.
+
+
+Stylesheets
+-----------
+- 'slidy' loads the 'asciidoc.css' stylesheet followed by 'slidy.css':
+  * `asciidoc.css` contains content presentational styles.
+  * The customized `slidy.css` stylesheet contains Slidy specific
+    styles (table of contents, menu and transition related).
+- You can use AsciiDoc CSS themes. For example, the 'asciidoc'
+  `--attribute theme=volnitsky` command-line option will substitute
+  the `asciidoc.css` stylesheet for the distributed Volnitsky
+  `volnitsky.css` stylesheet.
+- An additional stylesheet can be specified by setting the
+  'stylesheet' attribute. For example, the `--attribute
+  stylesheet=myslidy.css` will load `myslidy.css` after the standard
+  CSS files.
+
+
+Tips
+----
+- The Slidy 'help?' and 'contents?' links at the bottom left are your
+  friends.
+- Use the AsciiDoc 'data-uri' attribute to embed images in your
+  slideshow -- add this attribute entry to your document's header:
+
+  :data-uri:
+
+- Use the AsciiDoc 'max-width' attribute to set the document display
+  width. For example, add this attribute entry to your document's
+  header:
+
+  :max-width: 45em

data/asciidoc/examples/website/source-highlight-filter.txt

@@ -0,0 +1,239 @@
+Source Code Highlight Filter
+============================
+
+The AsciiDoc distribution includes a source code syntax highlight
+filter (`source-highlight-filter.conf`).
+
+
+HTML Outputs
+------------
+The highlighter uses http://www.gnu.org/software/src-highlite/[GNU
+source-highlight] to highlight 'html4' and 'xhtml11' outputs. You also
+have the option of using the http://pygments.org/[Pygments] syntax
+highlighter for 'xhtml11' outputs.
+
+- The filter command must reside in the shell search 'PATH'.
+  'pygmentize' command in your 'PATH'.
+- To use Pygments you need to define an AsciiDoc attribute named
+  'pygments'.
+- You can customize Pygments CSS styles by editing
+  `./stylesheets/pygments.css`.
+- To make Pygments your default highlighter put the following line
+  your `~/.asciidoc/asciidoc.conf` file:
+
+  pygments=
+
+- The AsciiDoc 'encoding' attribute is passed to Pygments as a `-O`
+  command-line option.
+
+
+DocBook Outputs
+---------------
+AsciiDoc encloses the source code in a DocBook 'programlisting'
+element and leaves source code highlighting to the DocBook toolchain
+(dblatex has a particularly nice programlisting highlighter). The
+DocBook programlisting element is assigned two attributes:
+
+. The 'language' attribute is set to the AsciiDoc 'language'
+  attribute.
+. The 'linenumbering' attribute is set to the AsciiDoc 'src_numbered'
+  attribute ('numbered' or 'unnumbered').
+
+
+Block attributes
+----------------
+The following attributes can be included in source code block
+attribute lists.
+
+- 'style' and 'language' are mandatory.
+- 'style', 'language' and 'src_numbered' are the first three
+  positional attributes in that order.
+- The 'args' attribute allows the inclusion of arbitrary (highlighter
+  dependent) command options.
+
+//
+
+style::
+  Set to 'source'.
+language::
+  The source code language name.
+src_numbered::
+  Set to 'numbered' to include line numbers.
+src_tab::
+  Set tab size (GNU source-highlight only).
+args::
+  Include this attribute value in the highlighter command-line (GNU
+  source-highlight and pygmentize) or in the `programlisting` element
+  (DocBook).
+
+
+Testing
+-------
+Test the filter by converting the test file to HTML with AsciiDoc:
+
+  $ asciidoc -v ./filters/source/source-highlight-filter-test.txt
+  $ firefox ./filters/source/source-highlight-filter-test.html &
+
+
+Examples
+--------
+
+Source code paragraphs
+~~~~~~~~~~~~~~~~~~~~~~
+The `source` paragraph style will highlight a paragraph of source
+code. These three code paragraphs:
+
+---------------------------------------------------------------------
+[source,python]
+if n < 0: print 'Hello World!'
+
+:language: python
+
+[source]
+if n < 0: print 'Hello World!'
+
+[source,ruby,numbered]
+[true, false].cycle([0, 1, 2, 3, 4]) do |a, b|
+    puts "#{a.inspect} => #{b.inspect}"
+---------------------------------------------------------------------
+
+Render this highlighted source code:
+
+[source,python]
+if n < 0: print 'Hello World!'
+
+:language: python
+
+[source]
+if n < 0: print 'Hello World!'
+
+[source,ruby,numbered]
+[true, false].cycle([0, 1, 2, 3, 4]) do |a, b|
+    puts "#{a.inspect} => #{b.inspect}"
+
+
+Unnumbered source code listing
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This source-highlight filtered block:
+
+---------------------------------------------------------------------
+ [source,python]
+ ---------------------------------------------------------------------
+ ''' A multi-line
+     comment.'''
+ def sub_word(mo):
+     ''' Single line comment.'''
+     word = mo.group('word')   # Inline comment
+     if word in keywords[language]:
+         return quote + word + quote
+     else:
+         return word
+ ---------------------------------------------------------------------
+---------------------------------------------------------------------
+
+Renders this highlighted source code:
+
+[source,python]
+---------------------------------------------------------------------
+''' A multi-line
+    comment.'''
+def sub_word(mo):
+    ''' Single line comment.'''
+    word = mo.group('word')     # Inline comment
+    if word in keywords[language]:
+        return quote + word + quote
+    else:
+        return word
+---------------------------------------------------------------------
+
+Numbered source code listing with callouts
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This source-highlight filtered block:
+
+---------------------------------------------------------------------
+ [source,ruby,numbered]
+ ---------------------------------------------------------------------
+ #
+ # Useful Ruby base class extensions.
+ #
+
+ class Array
+
+   # Execute a block passing it corresponding items in
+   # +self+ and +other_array+.
+   # If self has less items than other_array it is repeated.
+
+   def cycle(other_array)  # :yields: item, other_item
+     other_array.each_with_index do |item, index|
+       yield(self[index % self.length], item)
+     end
+   end
+
+ end
+
+ if $0 == __FILE__                                 \<1>
+   # Array#cycle test
+   # true => 0
+   # false => 1
+   # true => 2
+   # false => 3
+   # true => 4
+   puts 'Array#cycle test'                         \<2>
+   [true, false].cycle([0, 1, 2, 3, 4]) do |a, b|
+     puts "#{a.inspect} => #{b.inspect}"
+   end
+ end
+ ---------------------------------------------------------------------
+
+ \<1> First callout.
+ \<2> Second callout.
+
+---------------------------------------------------------------------
+
+Renders this highlighted source code:
+
+[source,ruby,numbered]
+---------------------------------------------------------------------
+#
+# Useful Ruby base class extensions.
+#
+
+class Array
+
+  # Execute a block passing it corresponding items in
+  # +self+ and +other_array+.
+  # If self has less items than other_array it is repeated.
+
+  def cycle(other_array)  # :yields: item, other_item
+    other_array.each_with_index do |item, index|
+      yield(self[index % self.length], item)
+    end
+  end
+
+end
+
+if $0 == __FILE__                                 <1>
+  # Array#cycle test
+  # true => 0
+  # false => 1
+  # true => 2
+  # false => 3
+  # true => 4
+  puts 'Array#cycle test'                         <2>
+  [true, false].cycle([0, 1, 2, 3, 4]) do |a, b|
+    puts "#{a.inspect} => #{b.inspect}"
+  end
+end
+---------------------------------------------------------------------
+
+<1> First callout.
+<2> Second callout.
+
+[TIP]
+=====
+- If the source 'language' attribute has been set (using an
+  'AttributeEntry' or from the command-line) you don't have to specify
+  it in each source code block.
+- You may need to place callout markers inside source code comments to
+  ensure they are not misinterpreted and mangled by the highlighter.
+=====