=============
Commands List
=============

.. |dash| unicode:: U+2014 .. EM DASH SIGN

This list provides an alphabetic summary of all the
:ref:`commands <command-concept>` specific to **protograf**.

    Remember that using certain commands with a **lowercase initial**
    defers their activation to later in the script!

This list is not intended to be used for learning, but just provides
a handy cross-reference to the detailed information for that command.

.. HINT::

  :doc:`protograf <index>` is a small, specialised tool; but its part of a much
  greater Python language "ecosystem", and so commands and tools from the
  :doc:`Python language <python_commands>` |dash| or other
  `Python packages <https://pypi.org>`_  |dash| can be used to further enhance
  your own script.

-  :ref:`Arc <arc-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Arrow <arrow-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Blueprint <blueprint-command>` - a grid of lines that can be drawn on a page
   (see also further :ref:`customisation options <blueprintIndex>`)
-  :ref:`Bezier <bezier-command>` * - a geometric shape that can be drawn on a page
-  :ref:`BGG <the-bgg-command>` - access boardgame data from BGG (typically for display
   on one or more :ref:`cards <the-card-command>`)
-  :ref:`Card <the-card-command>`  - details for a card that is part of a
   :ref:`deck <the-deck-command>`
-  :ref:`Circle <circle-command>` * - a geometric shape that can be drawn on a page
   (see also further :ref:`customisation options <circleIndex>`)
-  :ref:`Chord <chord-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Common <the-common-command>` - set the properties that will be exactly the
   same for any shape using them  (see also :ref:`Default <the-default-command>`)
-  :ref:`Counter <the-countersheet-command>`  - details for a counter that is part
   of a :ref:`countersheet <the-countersheet-command>`
-  :ref:`countersheet <the-countersheet-command>`  - details for a
   countersheet, containing one or more counters
-  :ref:`Create <create-command>` - start of a script; define the
   paper size, output filename, margins, units, fill color etc.
-  :ref:`Cross <cross-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Cube <cube-object>` * - create isometric and shaded view of a cube
-  :ref:`Data <the-data-command>` - provides a set of information for
   a :ref:`deck <the-deck-command>` of :ref:`cards <the-card-command>`
   :ref:`countersheet <the-countersheet-command>` - typically sourced from a CSV or
   Excel file, or a Google Sheet
-  :ref:`D6 <d6-object>` * - create top-down view of a six-sided die
-  :ref:`Deck <the-deck-command>`  - details for a deck, containing one or
   more :ref:`cards <the-card-command>`
-  :ref:`Default <the-default-command>` - set the properties that can be used by
   any number of shapes and overridden by them (see also
   :ref:`Common <the-common-command>`)
-  :doc:`DiamondLocations <layouts_diamond>`- defines an ordered series of
   row and column locations that create a diamond grid of shapes - the grid itself
   is not displayed; it is used in a :ref:`Layout <layout-command>` command
-  :ref:`Domino <domino-object>` * - create top-down view of a domino
-  :ref:`Dot <dot-command>` * - a geometric shape that can be drawn on a page
-  :ref:`DotGrid <dotgrid-command>` - a set, or group, of dots that can be drawn on a page
-  :ref:`Ellipse <ellipse-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Extract <the-extract-command>` - allows portions of pages to be extracted as PNG images
-  :ref:`Font <the-font-command>` - set the font properties for any
   :ref:`Text <text-command>` drawn on a page
-  :ref:`IconFont <the-iconfont-command>` - set the font properties for any
   referenced Unicode symbols embedded in subsequent :ref:`Text <text-command>`
-  :ref:`Grid <grid-command>` - a set, or group, of lines that can be drawn on a page
-  :ref:`group <group-function>` - a way to  reference a stack of shapes that
   all need to be drawn together on a :ref:`card <the-card-command>`
-  :ref:`Hexagon <hexagon-command>` * - a geometric shape that can be drawn on a page
   (see also further :ref:`customisation options <hexIndex>`)
-  :ref:`Hexagons <hexagons-command>` - a set, or group, of hexagons that can be
   drawn on a page (see also :doc:`hexagonal grids <hexagonal_grids>`)
-  :ref:`Image <image-command>` - an external image to be shown on a page or card
-  :ref:`L <the-lookup-command>` - short for *Lookup*; a way to access data in a set
   from another :ref:`card <the-card-command>` in a :ref:`deck <the-deck-command>`
-  :ref:`Layout <layout-command>` -  used in conjuction with a location-based
   grid and specifies the shapes that are to be drawn at that grid's locations
-  :ref:`Line <line-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Lines <lines-command>` - a set, or group, of lines that can be drawn on a page
-  :ref:`LinkLine <linkline-command>` - a line joining one or more hexagons inside a
   hexagonal grid
-  :ref:`Load <load-command>` - at the start of a script; define an existing
   PDF file to be loaded
-  :ref:`Matrix <the-matrix-command>` - a way to create a set of data, inside a script,
   for use in a :ref:`deck <the-deck-command>` of :ref:`cards <the-card-command>`
-  :ref:`PageBreak <pagebreak-command>` - set the start of a new page in
   the document; not required for a :ref:`Deck <the-deck-command>`
-  :ref:`Pentomino <pentominoesOver>` * - a compound shape made up of five squares
-  :ref:`Pod <pod-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Point <point-command>` - a command to set both x- and y- values for a position
-  :ref:`Polygon <polygon-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Polyline <polyline-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Polyomino <polyominoesOver>` * - a compound shape made up of one or more squares
-  :ref:`Polyshape <polyshape-command>` * - an irregular geometric shape that can be drawn on a page
-  :ref:`Random <random-command>` - generate a random number within a range
-  :doc:`Repeat <layouts_repeat>` - repeat the drawing of a shape across a rectangular grid pattern
-  :ref:`Rectangle <rectangle-command>` * - a geometric shape that can be drawn on a page
   (see also further :ref:`customisation options <rectangleIndex>`)
-  :ref:`Rectangles <rectangles-command>` - a set, or group, of rectangles that can be drawn on a page
-  :doc:`RectangularLocations <layouts_rectangular>` - defines an ordered series of
   row and column locations that create a rectangular grid of shapes - the grid itself
   is not displayed; it is used in a :ref:`Layout <layout-command>` command.
-  :ref:`Rhombus <rhombus-command>` * - a geometric shape that can be drawn on a page
-  :ref:`S <the-selection-command>` - short for *Selection*; the way to draw a
   shape on a :ref:`card <the-card-command>` depending on a condition
-  :ref:`Save <save-command>` - end of a script; set the export
   image file type and filenames, as well as resolution
-  :ref:`Sector <sector-command>` * - a geometric shape that can be drawn on a page
-  :doc:`Sequence <layouts_sequence>` - lay out a number of items in a straight line
-  :ref:`Square <square-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Stadium <stadium-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Star <star-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Starfield <starfield-command>` - a set, or group, of dots that can be drawn on a page
-  :ref:`T <the-template-command>` - short for *Template*; the way to access an
   item in a column from a set of :ref:`data <the-data-command>` for a
   :ref:`card <the-card-command>`
-  :ref:`Table <table-command>` - a grid of rectangles that can be drawn on a page
   and used to display :ref:`Text <text-command>` or :ref:`Images <image-command>`
-  :ref:`Tetromino <tetrominoesOver>` * - a compound shape made up of four squares
-  :ref:`Text <text-command>` * - a shape containing text that can be displayed on a page
-  :ref:`Today <the-today-command>` - display - as text - the current date and time
-  :doc:`Track <layouts_track>` - draw any number of shapes at the vertices of another shape
-  :ref:`Trapezoid <trapezoid-command>` * - a geometric shape that can be drawn on a page
-  :ref:`Triangle <triangle-command>` * - a geometric shape that
   can be drawn on a page
-  :doc:`TriangularLocations <layouts_triangular>`- defines an ordered series of
   row and column locations that create a triangular grid of shapes - the grid itself
   is not displayed; it is used in a :ref:`Layout <layout-command>` command

.. IMPORTANT::

   Commands marked with an asterisk (``*``) can be given with a uppercase or
   lowercase initial (``Commmand`` vs ``command``); the former meaning that
   the shape should be drawn directly at that point in the script; and the
   latter that it should be "stored" to be drawn later. This is especially
   relevant when specifying card designs.