Anshorei
/
squib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Documenting all the shorthands I know of

dev
Andy Meneely 5 years ago
parent
b304bf39e4
commit
24c9fbd0bf
12 changed files with 39 additions and 39 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      docs/args/wh.rst
  2. 4
      docs/args/xy.rst
  3. 4
      docs/args/xywhbox.rst
  4. 16
      docs/dsl/curve.rst
  5. 4
      docs/dsl/cut_zone.rst
  6. 4
      docs/dsl/grid.rst
  7. 8
      docs/dsl/line.rst
  8. 4
      docs/dsl/png.rst
  9. 10
      docs/dsl/safe_zone.rst
  10. 4
      docs/dsl/svg.rst
  11. 4
      docs/dsl/text.rst
  12. 12
      docs/dsl/triangle.rst

4
docs/args/wh.rst
Unescape View File

@ -3,10 +3,10 @@
width
default: ``:deck`` (the width of the deck)
the width of the box. Supports :doc:`/units`.
the width of the box. Supports :doc:`/units` and :doc:`/shorthands`.
height
default: ``:deck`` (the height of the deck)
the height of the box. Supports :doc:`/units`. Also can be ``:center`` or ``:middle`` for half the height of the deck. Supports :doc:`/units`.
the height of the box. Supports :doc:`/units`. Also can be ``:center`` or ``:middle`` for half the height of the deck. Supports :doc:`/units` and and :doc:`/shorthands`.

4
docs/args/xy.rst
Unescape View File

@ -3,10 +3,10 @@
x
default: ``0``
the x-coordinate to place, relative to the upper-left corner of the card and moving right as it increases. Supports :doc:`/units`.
the x-coordinate to place, relative to the upper-left corner of the card and moving right as it increases. Supports :doc:`/units` and :doc:`/shorthands`.
y
default: ``0``
the y-coordinate to place, relative to the upper-left corner of the card and moving downward as it increases. Supports :doc:`/units`.
the y-coordinate to place, relative to the upper-left corner of the card and moving downward as it increases. Supports :doc:`/units` and :doc:`/shorthands`.

4
docs/args/xywhbox.rst
Unescape View File

@ -3,7 +3,7 @@
x
default: ``0``
the x-coordinate to place, relative to the upper-left corner of the card and moving right as it increases. Supports :doc:`/units`.
the x-coordinate to place, relative to the upper-left corner of the card and moving right as it increases. Supports :doc:`/units` and :doc:`/shorthands`.
Also can be ``:center`` or ``:middle`` for half the width of the deck.
@ -11,6 +11,6 @@ x
y
default: ``0``
the y-coordinate to place, relative to the upper-left corner of the card and moving downward as it increases. Supports :doc:`/units`.
the y-coordinate to place, relative to the upper-left corner of the card and moving downward as it increases. Supports :doc:`/units` and :doc:`/shorthands`.
Also can be ``:center`` or ``:middle`` for half the height of the deck.

16
docs/dsl/curve.rst
Unescape View File

@ -10,49 +10,49 @@ Options
x1
default: ``0``
the x-coordinate of the first endpoint. Supports :doc:`/units`.
the x-coordinate of the first endpoint. Supports :doc:`/units` and :doc:`/shorthands`..
y1
default: ``0``
the y-coordinate of the first endpoint. Supports :doc:`/units`.
the y-coordinate of the first endpoint. Supports :doc:`/units` and :doc:`/shorthands`..
x2
default: ``5``
the x-coordinate of the second endpoint. Supports :doc:`/units`.
the x-coordinate of the second endpoint. Supports :doc:`/units` and :doc:`/shorthands`..
y2
default: ``5``
the y-coordinate of the second endpoint. Supports :doc:`/units`.
the y-coordinate of the second endpoint. Supports :doc:`/units` and :doc:`/shorthands`..
cx1
default: ``0``
the x-coordinate of the first control point. Supports :doc:`/units`.
the x-coordinate of the first control point. Supports :doc:`/units` and :doc:`/shorthands`..
cy1
default: ``0``
the y-coordinate of the first control point. Supports :doc:`/units`.
the y-coordinate of the first control point. Supports :doc:`/units` and :doc:`/shorthands`..
cx2
default: ``5``
the x-coordinate of the second control point. Supports :doc:`/units`.
the x-coordinate of the second control point. Supports :doc:`/units` and :doc:`/shorthands`..
cy2
default: ``5``
the y-coordinate of the second control point. Supports :doc:`/units`.
the y-coordinate of the second control point. Supports :doc:`/units` and :doc:`/shorthands`..
.. include:: /args/draw.rst

4
docs/dsl/cut_zone.rst
Unescape View File

@ -68,12 +68,12 @@ cap
x
default: ``margin`` (whatever the margin was set to)
the x-coordinate to place, relative to the upper-left corner of the card and moving right as it increases. Supports :doc:`/units`.
the x-coordinate to place, relative to the upper-left corner of the card and moving right as it increases. Supports :doc:`/units`and :doc:`/shorthands`.
y
default: ``margin`` (whatever the margin was set to)
the y-coordinate to place, relative to the upper-left corner of the card and moving downward as it increases. Supports :doc:`/units`.
the y-coordinate to place, relative to the upper-left corner of the card and moving downward as it increases. Supports :doc:`/units`and :doc:`/shorthands`.
.. include:: /args/range.rst
.. include:: /args/layout.rst

4
docs/dsl/grid.rst
Unescape View File

@ -14,13 +14,13 @@ Options
width
default: ``:deck`` (the width of the deck)
the spacing between vertical gridlines. Supports :doc:`/units`.
the spacing between vertical gridlines. Supports :doc:`/units` and :doc:`/shorthands`.
height
default: ``:deck`` (the height of the deck)
the spacing between horizontal gridlines. Supports :doc:`/units`.
the spacing between horizontal gridlines. Supports :doc:`/units` and :doc:`/shorthands`.
.. include:: /args/draw.rst

8
docs/dsl/line.rst
Unescape View File

@ -10,25 +10,25 @@ Options
x1
default: ``0``
the x-coordinate to place. Supports :doc:`/units/`
the x-coordinate to place. Supports :doc:`/units/` and :doc:`/shorthands`.
y1
default: ``0``
the y-coordinate to place. Supports :doc:`/units/`
the y-coordinate to place. Supports :doc:`/units/` and :doc:`/shorthands`.
x2
default: ``50``
the x-coordinate to place. Supports :doc:`/units/`
the x-coordinate to place. Supports :doc:`/units/` and :doc:`/shorthands`.
y2
default: ``50``
the y-coordinate to place. Supports :doc:`/units/`
the y-coordinate to place. Supports :doc:`/units/` and :doc:`/shorthands`.
.. include:: /args/draw.rst
.. include:: /args/range.rst

4
docs/dsl/png.rst
Unescape View File

@ -17,12 +17,12 @@ file
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`).
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`). Supports :doc:`/units` and :doc:`/shorthands`.
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`).
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`). Supports :doc:`/units` and :doc:`/shorthands`.
alpha
default: 1.0

10
docs/dsl/safe_zone.rst
Unescape View File

@ -17,13 +17,13 @@ margin
width
default: ``width - margin`` (the width of the deck minus the margin)
the width of the box. Supports :doc:`/units`.
the width of the box. Supports :doc:`/units` and :doc:`/shorthands`.
height
default: ``height - margin`` (the height of the deck minus the margin)
the height of the box. Supports :doc:`/units`.
the height of the box. Supports :doc:`/units` and :doc:`/shorthands`.
fill_color
default: ``'#0000'`` (fully transparent)
@ -68,7 +68,7 @@ join
default: ``:mitre``
Specifies how to render the junction of two lines when stroking. Options are ``:mitre``, ``:round``, and ``:bevel``.
dash
default: ``'3 3'`` (no dash pattern set)
@ -82,12 +82,12 @@ cap
x
default: ``margin`` (whatever the margin was set to)
the x-coordinate to place, relative to the upper-left corner of the card and moving right as it increases. Supports :doc:`/units`.
the x-coordinate to place, relative to the upper-left corner of the card and moving right as it increases. Supports :doc:`/units` and :doc:`/shorthands`.
y
default: ``margin`` (whatever the margin was set to)
the y-coordinate to place, relative to the upper-left corner of the card and moving downward as it increases. Supports :doc:`/units`.
the y-coordinate to place, relative to the upper-left corner of the card and moving downward as it increases. Supports :doc:`/units` and :doc:`/shorthands`.
.. include:: /args/range.rst
.. include:: /args/layout.rst

4
docs/dsl/svg.rst
Unescape View File

@ -37,12 +37,12 @@ force_id
width
default: ``native``
the pixel width that the image should scale to. Setting this to ``:deck`` will scale to the deck height. ``:scale`` will use the width to scale and keep native the aspect ratio. SVG scaling is done with vectors, so the scaling should be smooth. When set to ``:native``, uses the DPI and units of the loaded SVG document.
the pixel width that the image should scale to. Setting this to ``:deck`` will scale to the deck height. ``:scale`` will use the width to scale and keep native the aspect ratio. SVG scaling is done with vectors, so the scaling should be smooth. When set to ``:native``, uses the DPI and units of the loaded SVG document. Supports :doc:`/units` and :doc:`/shorthands`.
height
default: ``:native``
the pixel width that the image should scale to. ``:deck`` will scale to the deck height. ``:scale`` will use the width to scale and keep native the aspect ratio. SVG scaling is done with vectors, so the scaling should be smooth. When set to ``:native``, uses the DPI and units of the loaded SVG document.
the pixel width that the image should scale to. ``:deck`` will scale to the deck height. ``:scale`` will use the width to scale and keep native the aspect ratio. SVG scaling is done with vectors, so the scaling should be smooth. When set to ``:native``, uses the DPI and units of the loaded SVG document. Supports :doc:`/units` and :doc:`/shorthands`.
blend
default: ``:none``

4
docs/dsl/text.rst
Unescape View File

@ -35,12 +35,12 @@ markup
width
default: ``:auto``
the width of the box the string will be placed in. Stretches to the content by default.. Supports :doc:`/units`.
the width of the box the string will be placed in. Stretches to the content by default.. Supports :doc:`/units` and :doc:`/shorthands`.
height
default: ``:auto``
the height of the box the string will be placed in. Stretches to the content by default. Supports :doc:`/units`.
the height of the box the string will be placed in. Stretches to the content by default. Supports :doc:`/units` and :doc:`/shorthands`.
wrap
default: ``:word_char``

12
docs/dsl/triangle.rst
Unescape View File

@ -10,36 +10,36 @@ Options
x1
default: ``100``
the first x-coordinate to place. Supports :doc:`/units/`
the first x-coordinate to place. Supports :doc:`/units/` and :doc:`/shorthands`.
y1
default: ``100``
the first y-coordinate to place. Supports :doc:`/units/`
the first y-coordinate to place. Supports :doc:`/units/` and :doc:`/shorthands`.
x2
default: ``150``
the second x-coordinate to place. Supports :doc:`/units/`
the second x-coordinate to place. Supports :doc:`/units/` and :doc:`/shorthands`.
y2
default: ``150``
the second y-coordinate to place. Supports :doc:`/units/`
the second y-coordinate to place. Supports :doc:`/units/` and :doc:`/shorthands`.
x3
default: ``100``
the third x-coordinate to place. Supports :doc:`/units/`
the third x-coordinate to place. Supports :doc:`/units/` and :doc:`/shorthands`.
y3
default: ``150``
the third y-coordinate to place. Supports :doc:`/units/`
the third y-coordinate to place. Supports :doc:`/units/` and :doc:`/shorthands`.
.. include:: /args/draw.rst

Write Preview
Loading…
Cancel
Save