From 24c9fbd0bf2c0e645fdf4339ae123170b5a041e6 Mon Sep 17 00:00:00 2001 From: Andy Meneely Date: Tue, 17 Nov 2020 22:32:12 -0500 Subject: [PATCH] Documenting all the shorthands I know of --- docs/args/wh.rst | 4 ++-- docs/args/xy.rst | 4 ++-- docs/args/xywhbox.rst | 4 ++-- docs/dsl/curve.rst | 16 ++++++++-------- docs/dsl/cut_zone.rst | 4 ++-- docs/dsl/grid.rst | 4 ++-- docs/dsl/line.rst | 8 ++++---- docs/dsl/png.rst | 4 ++-- docs/dsl/safe_zone.rst | 10 +++++----- docs/dsl/svg.rst | 4 ++-- docs/dsl/text.rst | 4 ++-- docs/dsl/triangle.rst | 12 ++++++------ 12 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/args/wh.rst b/docs/args/wh.rst index c35e1ba..11bfa20 100644 --- a/docs/args/wh.rst +++ b/docs/args/wh.rst @@ -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`. diff --git a/docs/args/xy.rst b/docs/args/xy.rst index c791413..b34433e 100644 --- a/docs/args/xy.rst +++ b/docs/args/xy.rst @@ -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`. diff --git a/docs/args/xywhbox.rst b/docs/args/xywhbox.rst index 787b7a9..43e9f08 100644 --- a/docs/args/xywhbox.rst +++ b/docs/args/xywhbox.rst @@ -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. diff --git a/docs/dsl/curve.rst b/docs/dsl/curve.rst index eae5d89..8280eca 100644 --- a/docs/dsl/curve.rst +++ b/docs/dsl/curve.rst @@ -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 diff --git a/docs/dsl/cut_zone.rst b/docs/dsl/cut_zone.rst index 584ce05..44b37e8 100644 --- a/docs/dsl/cut_zone.rst +++ b/docs/dsl/cut_zone.rst @@ -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 diff --git a/docs/dsl/grid.rst b/docs/dsl/grid.rst index af0fbe3..2040302 100644 --- a/docs/dsl/grid.rst +++ b/docs/dsl/grid.rst @@ -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 diff --git a/docs/dsl/line.rst b/docs/dsl/line.rst index b21eeb0..871c98f 100644 --- a/docs/dsl/line.rst +++ b/docs/dsl/line.rst @@ -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 diff --git a/docs/dsl/png.rst b/docs/dsl/png.rst index 8cbc1c4..ece1bee 100644 --- a/docs/dsl/png.rst +++ b/docs/dsl/png.rst @@ -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 diff --git a/docs/dsl/safe_zone.rst b/docs/dsl/safe_zone.rst index 7745932..0a6e64f 100644 --- a/docs/dsl/safe_zone.rst +++ b/docs/dsl/safe_zone.rst @@ -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 diff --git a/docs/dsl/svg.rst b/docs/dsl/svg.rst index feab207..4d45759 100644 --- a/docs/dsl/svg.rst +++ b/docs/dsl/svg.rst @@ -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`` diff --git a/docs/dsl/text.rst b/docs/dsl/text.rst index 6f2f307..241e972 100644 --- a/docs/dsl/text.rst +++ b/docs/dsl/text.rst @@ -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`` diff --git a/docs/dsl/triangle.rst b/docs/dsl/triangle.rst index 2fdf012..74bcd8e 100644 --- a/docs/dsl/triangle.rst +++ b/docs/dsl/triangle.rst @@ -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