## WickedDocs Documentation ##


### Features ###


### Command-Line Parameters ###

The GUI application can accept being opened with files from the command-line. You can run it for example with a list of (or one) files to open:

/Applications/WickedDocs.app/Contents/MacOS/WickedDocs ./file1.md ./file2.md


### Files ###

On macOS, files are by default saved to ~/Documents/WickedDocs/Markdown.
Templates are saved to ~/Documents/WickedDocs/Templates,
Styles are saved to ~/Documents/WickedDocs/Styles,
and Projects are saved to ~/Documents/WickedDocs/Projects


### Templates ###

Coordinate system: Top left is 0,0 with x and y increasing to the right and towards the bottom respectively.

Templates are lists of template items. These items are usually objects that are drawn to each PDF page. The list is ordered by the order they should be drawn, with later items in the list overlapping over items earlier in the list.

Each item has a type. The different supported types are Defaults, Polygon, Label, Background, Image and Unknown.

Defaults are the set of parameters which are the defaults for each item. An item of type defaults doesn't result in anything being drawn, but it changes how new items are created and changes how items are saved. If an item's properties are the same as the defaults, then when it is saved, only the item's properties which are different from the defaults are written to the file.

Polygon type items are for drawing shapes. The Polygon item will be drawn using the Points property which is a list of x,y coordinates. The polygon is drawn with the pen and fill properties. The pen color and pen width are used for drawing the outline of the shape and the fill color property is used for the color to fill the inside of the shape. The alpha property is also used to adjust the transparency of the item.

Label type items are for drawing text. The Label item will be drawn using the Text property which is a string of text. The Label is drawn with the pen and fill properties and alpha property as described above. The position of the text is according to the Position property. This is relative to the Page Align property. The Page Align can be top|center|bottom,left|center|right. For example if Align is set to "top,left", then the position is relative to 0,0, so it is positioned absolutely. If Page Align is set to "center,center", the Position property is relative to the center of the page. The text will be position starting at the center of the page. However there is also the Text Relative Align property which is how the position is relative to the bounds of the text. The Text Relative Align property has the same possible values as Page Align. A value of "center,center" will position the text with the center of the text where the page align and Position relative position places it. So with Page Align and Text Relative Align both set to "center,center" and with a Position property of 0,0 will place the text centered in the middle of the page. With both alignments set to "top,left" and Position of 0,0 will place the top,left corner of the text in the top,left corner of the page. The text is drawn using the given font and font size property.

Image type items are for drawing images. The Image File property is used to specify the image to be drawn. The path can be an absolute path or can be relative to where the template file is saved.



### Supported Markdown Markups ###

all the regular ones

tables with GitHub format for tables

task lists with '- [ ] text' for a not completed task
and '- [X] text' for a completed task

page breaks with '--<<>>--' to start a new page

TODO: fill in
etc