squib 0.12.0 → 0.13.0

data/docs/dsl/mm.rst

@@ -1,19 +0,0 @@
-mm
-------
-
-Given millimeters, returns the number of pixels according to the deck's DPI.
-
-Parameters
-^^^^^^^^^^
-
-n
-  the number of mm
-
-
-Examples
-^^^^^^^^
-
-.. code-block:: ruby
-
-  mm(1)         # 11.811px (for default Deck::dpi of 300)
-  mm(2) + mm(1) # 35.433ox (for default Deck::dpi of 300)

data/docs/dsl/png.rst

@@ -1,49 +0,0 @@
-png
-===
-
-Renders PNG images.
-
-Options
--------
-.. include:: /args/expansion.rst
-
-file
-  default: ``''`` (empty string)
-
-  file(s) to read in. As in :doc:`/arrays`, if this a single file, then it's use for every card in range. If the parameter is an Array of files, then each file is looked up for each card. If any of them are nil or '', nothing is done for that card.
-
-.. include:: /args/xy.rst
-
-width
-  default: ``:native``
-
-  the pixel width that the image should scale to. Supports :doc:`/units`. When set to ``:native``, uses the DPI and units of the loaded SVG document. Using ``:deck`` will scale to the deck width. Using ``:scale`` will use the ``height`` to scale and keep native the aspect ratio. Scaling PNGs is not recommended for professional-looking cards, and up-scaling a PNG will throw a warning in the console (see :doc:`/config`).
-
-height
-  default: ``:native``
-
-  the pixel height that the image should scale to. Supports :doc:`/units`. When set to ``:native``, uses the DPI and units of the loaded SVG document. Using ``:deck`` will scale to the deck height. Using ``:scale`` will use the ``width`` to scale and keep native the aspect ratio. Scaling PNGs is not recommended for professional-looking cards, and up-scaling a PNG will throw a warning in the console (see :doc:`/config`).
-
-alpha
-  default: 1.0
-
-  the alpha-transparency percentage used to blend this image. Must be between ``0.0`` and ``1.0``
-
-blend
-  default: ``:none``
-
-  the composite blend operator used when applying this image. See Blend Modes at http://cairographics.org/operators.
-  The possibilties include :none, :multiply, :screen, :overlay, :darken, :lighten, :color_dodge, :color_burn, :hard_light, :soft_light, :difference, :exclusion, :hsl_hue, :hsl_saturation, :hsl_color, :hsl_luminosity. String versions of these options are accepted too.
-
-mask
-  default: ``nil``
-
-  Accepts a color (see :doc:`/colors`). If specified, the image will be used as a mask for the given color/gradient. Transparent pixels are ignored, opaque pixels are the given color. Note: the origin for gradient coordinates is at the given x,y, not at 0,0 as it is most other places.
-
-.. include:: /args/transform.rst
-
-.. include:: /args/range.rst
-.. include:: /args/layout.rst
-
-Examples
---------

data/docs/dsl/polygon.rst

@@ -1,28 +0,0 @@
-polygon
--------
-
-Draw an n-sided regular polygon, centered at x,y.
-
-Options
-^^^^^^^
-.. include:: /args/expansion.rst
-
-.. include:: /args/xy.rst
-
-radius
-  default: 0
-
-  the distance from the center of the star to the inner circle of its points. Supports :doc:`/units`.
-
-angle
-  default: 0
-
-  the angle at which to rotate the star
-
-
-.. include:: /args/draw.rst
-.. include:: /args/range.rst
-.. include:: /args/layout.rst
-
-Examples
-^^^^^^^^

data/docs/dsl/rect.rst

@@ -1,22 +0,0 @@
-rect
-----
-
-Draw a rounded rectangle
-
-Options
-^^^^^^^
-.. include:: /args/expansion.rst
-
-.. include:: /args/xy.rst
-.. include:: /args/wh.rst
-.. include:: /args/draw.rst
-.. include:: /args/range.rst
-.. include:: /args/layout.rst
-
-angle
-  default: 0
-
-  the angle at which to rotate the rectangle about it's upper-left corner
-
-Examples
-^^^^^^^^

data/docs/dsl/save.rst

@@ -1,23 +0,0 @@
-save
-====
-
-Saves the given range of cards to either PNG or PDF. Wrapper method for other save methods.
-
-Options
--------
-
-This method delegates everything to :doc:`save_png` or :doc:`save_pdf` using the ``format`` option. All other options are passed along.
-
-format
-  default: ``[]`` (do nothing)
-
-  Use ``:png`` to save as a PNG, and ``:pdf`` to save as PDF. To save to both at once, use ``[:png, :pdf]``
-
-Examples
---------
-
-::
-
-  save format: :png, prefix: 'front_' # same as: save_png prefix: 'front_'
-  save format: :pdf, prefix: 'cards_' # same as: save_pdf prefix: 'cards_'
-  save format: [:png, :pdf]           # same as: save_png; save_pdf

data/docs/dsl/save_pdf.rst

@@ -1,89 +0,0 @@
-save_pdf
-========
-
-Lays out the cards in a gride and renders a PDF.
-
-Options
--------
-
-file
-  default: ``'output.pdf'``
-
-  the name of the PDF file to save. Will be overwritten without warning.
-
-dir
-  default: ``_output``
-
-  the directory to save to. Created if it doesn't exist.
-
-width
-  default: ``3300``
-
-  the height of the page in pixels. Default is 11in * 300dpi. Supports :doc:`/units`.
-
-height
-  default: ``2550``
-
-  the height of the page in pixels. Default is 8.5in * 300dpi. Supports :doc:`/units`.
-
-margin
-  default: ``75``
-
-  the margin around the outside of the page. Supports :doc:`/units`.
-
-gap
-  default: ``0``
-
-  the space in pixels between the cards. Supports :doc:`/units`.
-
-trim
-  default: ``0``
-
-  the space around the edge of each card to trim (e.g. to cut off the bleed margin for print-and-play). Supports :doc:`/units`.
-
-crop_marks
-  default: ``false``
-
-  When ``true``, draws lines in the margins as guides for cutting. Crop marks factor in the ``trim`` (if non-zero), and can also be customized via ``crop_margin_*`` options (see below). Has no effect if ``margin`` is 0.
-
-.. warning::
-
-  Enabling this feature will draw lines to the edge of the page. Most PDF Readers, by default, will recognize this and scale down the entire PDF to fit in those crop marks - throwing off your overall scale. To disable this, you will need to set Print Scaling "Use original" or "None" when you go to print (this looks different for different PDF readers). Be sure to test this out before you do your big print job!!
-
-crop_margin_bottom
-  default: 0
-
-  The space between the bottom edge of the (potentially trimmed) card, and the crop mark. Supports :doc:`/units`. Has no effect if ``crop_marks`` is ``false``.
-
-crop_margin_left
-  default: 0
-
-  The space between the left edge of the (potentially trimmed) card, and the crop mark. Supports :doc:`/units`. Has no effect if ``crop_marks`` is ``false``.
-
-crop_margin_right
-  default: ``0``
-
-  The space between the right edge of the (potentially trimmed) card, and the crop mark. Supports :doc:`/units`. Has no effect if ``crop_marks`` is ``false``.
-
-crop_margin_top
-  default: ``0``
-
-  The space between the top edge of the (potentially trimmed) card, and the crop mark. Supports :doc:`/units`. Has no effect if ``crop_marks`` is ``false``.
-
-crop_stroke_color
-  default: ``:black``
-
-  The color of the crop mark lines. Has no effect if ``crop_marks`` is ``false``.
-
-crop_stroke_dash
-  default: ``''``
-
-  Define a dash pattern for the crop marks. This is a special string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels or units. For example, ``'0.02in 0.02in'`` will be an equal on-and-off dash pattern. Supports :doc:`/units`. Has no effect if ``crop_marks`` is ``false``.
-
-crop_stroke_width
-  default: ``1.5``
-
-  Width of the crop mark lines. Has no effect if ``crop_marks`` is ``false``.
-
-Examples
---------

data/docs/dsl/save_png.rst

@@ -1,46 +0,0 @@
-save_png
-========
-
-Saves the given range of cards to a PNG
-
-Options
--------
-
-
-range
-  default ``:all``
-
-  the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-
-dir
-  default: ``'_output'``
-
-  the directory for the output to be sent to. Will be created if it doesn't exist.
-
-prefix
-  default ``'card_'``
-
-  the prefix of the file name to be printed.
-
-count_format
-  default: ``'%02d'``
-
-  the format string used for formatting the card count (e.g. padding zeros). Uses a Ruby format string (see the Ruby doc for ``Kernel::sprintf`` for specifics)
-
-rotate
-  default: ``false``
-
-  If ``true``, the saved cards will be rotated 90 degrees clockwise. Or, rotate by the number of radians. Intended to rendering landscape instead of portrait. Possible values: ``true``, ``false``, ``:clockwise``, ``:counterclockwise``
-
-trim
-  default: ``0``
-
-  the space around the edge of each card to trim (e.g. to cut off the bleed margin for print-and-play). Supports :doc:`/units`.
-
-trim_radius
-  default: ``0``
-
-  the rounded rectangle radius around the card to trim before saving.
-
-Examples
---------

data/docs/dsl/save_sheet.rst

@@ -1,55 +0,0 @@
-save_sheet
-==========
-
-Lays out the cards in range and renders a stitched PNG sheet
-
-Options
--------
-
-range
-  default: ``:all``
-
-  the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-
-columns
-  default: ``5``
-
-  the number of columns in the grid. Must be an integer
-
-rows
-  default: ``:infinite``
-
-  the number of rows in the grid. When set to :infinite, the sheet scales to the rows needed. If there are more cards than rows*columns, new sheets are started.
-
-prefix
-  default: ``card_``
-
-  the prefix of the file name(s)
-
-count_format
-  default: ``'%02d'``
-
-  the format string used for formatting the card count (e.g. padding zeros). Uses a Ruby format string (see the Ruby doc for ``Kernel::sprintf`` for specifics)
-
-dir
-  default: ``'_output'``
-
-  the directory to save to. Created if it doesn't exist.
-
-margin
-  default: ``0``
-
-  the margin around the outside of the sheet. Supports :doc:`/units`.
-
-gap
-  default ``0``
-
-  the space in pixels between the cards. Supports :doc:`/units`.
-
-trim
-  default ``0``
-
-  the space around the edge of each card to trim (e.g. to cut off the bleed margin for print-and-play). Supports :doc:`/units`.
-
-Examples
---------

data/docs/dsl/showcase.rst

@@ -1,76 +0,0 @@
-showcase
-========
-
-Renders a range of cards in a showcase as if they are sitting in 3D on a reflective surface.
-
-Options
--------
-
-.. include:: /args/trim.rst
-
-scale
-  default: ``0.8``
-
-  Percentage of original width of each (trimmed) card to scale to. Must be between 0.0 and 1.0, but starts looking bad around 0.6.
-
-offset
-  default: ``1.1``
-
-  Percentage of the scaled width of each card to shift each offset. e.g. 1.1 is a 10% shift, and 0.95 is overlapping by 5%
-
-fill_color
-  default: ``:white``
-
-  Backdrop color. Usually black or white. See :doc:`/colors`.
-
-reflect_offset
-  default: ``15``
-
-  The number of pixels between the bottom of the card and the reflection. See :doc:`/units`
-
-reflect_strength
-  default: ``0.2``
-
-  The starting alpha transparency of the reflection (at the top of the card). Percentage between 0 and 1. Looks more realistic at low values since even shiny surfaces lose a lot of light.
-
-reflect_percent
-  default: ``0.25``
-
-  The length of the reflection in percentage of the card. Larger values tend to make the reflection draw just as much attention as the card, which is not good.
-
-face
-  default: ``:left``
-
-  which direction the cards face. Anything but ``:right`` will face left
-
-margin
-  default: ``75``
-
-  the margin around the entire image. Supports :doc:`/units`
-
-fill_color
-  default: ``:white``
-
-  Backdrop color. Supports :doc:`/colors`.
-
-file
-  default: ``'showcase.png'``
-
-  The file to save relative to the current directory. Will overwrite without warning.
-
-.. include:: /args/output_dir.rst
-.. include:: /args/range.rst
-
-Examples
---------
-
-This sample `lives here <https://github.com/andymeneely/squib/tree/master/samples/saves>`_.
-
-.. literalinclude:: ../../samples/saves/_showcase.rb
-  :language: ruby
-  :linenos:
-
-.. raw:: html
-
-  <img src="../saves/showcase_expected.png" class="figure">
-  <img src="../saves/showcase2_expected.png" class="figure">

data/docs/dsl/star.rst

@@ -1,35 +0,0 @@
-star
-----
-
-Draw an n-pointed star, centered at x,y.
-
-Options
-^^^^^^^
-.. include:: /args/expansion.rst
-
-.. include:: /args/xy.rst
-
-inner_radius
-  default: 0
-
-  the distance from the center of the star to the inner circle of its points. Supports :doc:`/units`.
-
-
-outer_radius
-  default: 0
-
-  the distance from the center of the star to the outer circle of its points. Supports :doc:`/units`.
-
-
-angle
-  default: 0
-
-  the angle at which to rotate the star
-
-
-.. include:: /args/draw.rst
-.. include:: /args/range.rst
-.. include:: /args/layout.rst
-
-Examples
-^^^^^^^^