diff --git a/markdown/dev/reference/api/settings/complete/en.md b/markdown/dev/reference/api/settings/complete/en.md deleted file mode 100644 index 7950cd9c15c..00000000000 --- a/markdown/dev/reference/api/settings/complete/en.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: complete ---- - -The `complete` setting controls the level of details that's included on your pattern. -This has different uses, such as generating patterns to be cut out with a laser cutter. - -The default `complete` setting is `true`. -Set this to `false` to draft a base outline of the pattern, rather than a fully detailed pattern. - - -Setting this to `false` will force [sa](/reference/api/settings/sa) to be set to `false`. - - -```js -import Brian from "@freesewing/brian"; - -const pattern = new Brian({ - complete: false -}) -``` diff --git a/markdown/dev/reference/api/settings/en.md b/markdown/dev/reference/api/settings/en.md deleted file mode 100644 index 82eab54915e..00000000000 --- a/markdown/dev/reference/api/settings/en.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Settings -for: developers -about: Documents all the settings your pattern can receive, including the pattern options, measurmeents, and design options ---- - -Settings are what the user passes to your pattern at run-time. - -Don't confuse them with the [pattern configuration](/reference/config/) that is determined by -the designer at build-time. - -Below are the supported settings: - - diff --git a/markdown/dev/reference/api/hooks/en.md b/markdown/dev/reference/hooks/en.md similarity index 93% rename from markdown/dev/reference/api/hooks/en.md rename to markdown/dev/reference/hooks/en.md index db537d45549..873cb6b0784 100644 --- a/markdown/dev/reference/api/hooks/en.md +++ b/markdown/dev/reference/hooks/en.md @@ -1,10 +1,9 @@ --- -title: Hooks API -for: developers -about: Documents the available lifecycle hooks in Core and how to use them +title: Lifecycle hooks --- -A **hook** is a lifecycle event. +FreeSewing has **lifecycle hooks** that allow you extend its functionality by +hooking into a lifecycle event. You can register a method for a hook. When the hook is triggered, your method will be called. It will receive two parameters: diff --git a/markdown/dev/reference/api/hooks/inserttext/en.md b/markdown/dev/reference/hooks/inserttext/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/inserttext/en.md rename to markdown/dev/reference/hooks/inserttext/en.md diff --git a/markdown/dev/reference/api/hooks/postdraft/en.md b/markdown/dev/reference/hooks/postdraft/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/postdraft/en.md rename to markdown/dev/reference/hooks/postdraft/en.md diff --git a/markdown/dev/reference/api/hooks/postinit/en.md b/markdown/dev/reference/hooks/postinit/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/postinit/en.md rename to markdown/dev/reference/hooks/postinit/en.md diff --git a/markdown/dev/reference/api/hooks/postlayout/en.md b/markdown/dev/reference/hooks/postlayout/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/postlayout/en.md rename to markdown/dev/reference/hooks/postlayout/en.md diff --git a/markdown/dev/reference/api/hooks/postpartdraft/en.md b/markdown/dev/reference/hooks/postpartdraft/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/postpartdraft/en.md rename to markdown/dev/reference/hooks/postpartdraft/en.md diff --git a/markdown/dev/reference/api/hooks/postrender/en.md b/markdown/dev/reference/hooks/postrender/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/postrender/en.md rename to markdown/dev/reference/hooks/postrender/en.md diff --git a/markdown/dev/reference/api/hooks/postsample/en.md b/markdown/dev/reference/hooks/postsample/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/postsample/en.md rename to markdown/dev/reference/hooks/postsample/en.md diff --git a/markdown/dev/reference/api/hooks/postsetdraft/en.md b/markdown/dev/reference/hooks/postsetdraft/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/postsetdraft/en.md rename to markdown/dev/reference/hooks/postsetdraft/en.md diff --git a/markdown/dev/reference/api/hooks/predraft/en.md b/markdown/dev/reference/hooks/predraft/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/predraft/en.md rename to markdown/dev/reference/hooks/predraft/en.md diff --git a/markdown/dev/reference/api/hooks/preinit/en.md b/markdown/dev/reference/hooks/preinit/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/preinit/en.md rename to markdown/dev/reference/hooks/preinit/en.md diff --git a/markdown/dev/reference/api/hooks/prepartdraft/en.md b/markdown/dev/reference/hooks/prepartdraft/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/prepartdraft/en.md rename to markdown/dev/reference/hooks/prepartdraft/en.md diff --git a/markdown/dev/reference/api/hooks/prerender/en.md b/markdown/dev/reference/hooks/prerender/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/prerender/en.md rename to markdown/dev/reference/hooks/prerender/en.md diff --git a/markdown/dev/reference/api/hooks/presample/en.md b/markdown/dev/reference/hooks/presample/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/presample/en.md rename to markdown/dev/reference/hooks/presample/en.md diff --git a/markdown/dev/reference/api/hooks/presetdraft/en.md b/markdown/dev/reference/hooks/presetdraft/en.md similarity index 100% rename from markdown/dev/reference/api/hooks/presetdraft/en.md rename to markdown/dev/reference/hooks/presetdraft/en.md diff --git a/markdown/dev/reference/api/macros/banner/en.md b/markdown/dev/reference/macros/banner/en.md similarity index 100% rename from markdown/dev/reference/api/macros/banner/en.md rename to markdown/dev/reference/macros/banner/en.md diff --git a/markdown/dev/reference/api/macros/bartack/en.md b/markdown/dev/reference/macros/bartack/en.md similarity index 100% rename from markdown/dev/reference/api/macros/bartack/en.md rename to markdown/dev/reference/macros/bartack/en.md diff --git a/markdown/dev/reference/api/macros/bartackalong/en.md b/markdown/dev/reference/macros/bartackalong/en.md similarity index 100% rename from markdown/dev/reference/api/macros/bartackalong/en.md rename to markdown/dev/reference/macros/bartackalong/en.md diff --git a/markdown/dev/reference/api/macros/bartackfractionalong/en.md b/markdown/dev/reference/macros/bartackfractionalong/en.md similarity index 100% rename from markdown/dev/reference/api/macros/bartackfractionalong/en.md rename to markdown/dev/reference/macros/bartackfractionalong/en.md diff --git a/markdown/dev/reference/api/macros/cutonfold/en.md b/markdown/dev/reference/macros/cutonfold/en.md similarity index 100% rename from markdown/dev/reference/api/macros/cutonfold/en.md rename to markdown/dev/reference/macros/cutonfold/en.md diff --git a/markdown/dev/reference/api/macros/en.md b/markdown/dev/reference/macros/en.md similarity index 100% rename from markdown/dev/reference/api/macros/en.md rename to markdown/dev/reference/macros/en.md diff --git a/markdown/dev/reference/api/macros/flip/en.md b/markdown/dev/reference/macros/flip/en.md similarity index 100% rename from markdown/dev/reference/api/macros/flip/en.md rename to markdown/dev/reference/macros/flip/en.md diff --git a/markdown/dev/reference/api/macros/gore/en.md b/markdown/dev/reference/macros/gore/en.md similarity index 100% rename from markdown/dev/reference/api/macros/gore/en.md rename to markdown/dev/reference/macros/gore/en.md diff --git a/markdown/dev/reference/api/macros/grainline/en.md b/markdown/dev/reference/macros/grainline/en.md similarity index 100% rename from markdown/dev/reference/api/macros/grainline/en.md rename to markdown/dev/reference/macros/grainline/en.md diff --git a/markdown/dev/reference/api/macros/hd/en.md b/markdown/dev/reference/macros/hd/en.md similarity index 100% rename from markdown/dev/reference/api/macros/hd/en.md rename to markdown/dev/reference/macros/hd/en.md diff --git a/markdown/dev/reference/api/macros/ld/en.md b/markdown/dev/reference/macros/ld/en.md similarity index 100% rename from markdown/dev/reference/api/macros/ld/en.md rename to markdown/dev/reference/macros/ld/en.md diff --git a/markdown/dev/reference/api/macros/miniscale/en.md b/markdown/dev/reference/macros/miniscale/en.md similarity index 100% rename from markdown/dev/reference/api/macros/miniscale/en.md rename to markdown/dev/reference/macros/miniscale/en.md diff --git a/markdown/dev/reference/api/macros/mirror/en.md b/markdown/dev/reference/macros/mirror/en.md similarity index 100% rename from markdown/dev/reference/api/macros/mirror/en.md rename to markdown/dev/reference/macros/mirror/en.md diff --git a/markdown/dev/reference/api/macros/pd/en.md b/markdown/dev/reference/macros/pd/en.md similarity index 100% rename from markdown/dev/reference/api/macros/pd/en.md rename to markdown/dev/reference/macros/pd/en.md diff --git a/markdown/dev/reference/api/macros/rmad/en.md b/markdown/dev/reference/macros/rmad/en.md similarity index 100% rename from markdown/dev/reference/api/macros/rmad/en.md rename to markdown/dev/reference/macros/rmad/en.md diff --git a/markdown/dev/reference/api/macros/rmd/en.md b/markdown/dev/reference/macros/rmd/en.md similarity index 100% rename from markdown/dev/reference/api/macros/rmd/en.md rename to markdown/dev/reference/macros/rmd/en.md diff --git a/markdown/dev/reference/api/macros/round/en.md b/markdown/dev/reference/macros/round/en.md similarity index 100% rename from markdown/dev/reference/api/macros/round/en.md rename to markdown/dev/reference/macros/round/en.md diff --git a/markdown/dev/reference/api/macros/scalebox/en.md b/markdown/dev/reference/macros/scalebox/en.md similarity index 100% rename from markdown/dev/reference/api/macros/scalebox/en.md rename to markdown/dev/reference/macros/scalebox/en.md diff --git a/markdown/dev/reference/api/macros/sprinkle/en.md b/markdown/dev/reference/macros/sprinkle/en.md similarity index 100% rename from markdown/dev/reference/api/macros/sprinkle/en.md rename to markdown/dev/reference/macros/sprinkle/en.md diff --git a/markdown/dev/reference/api/macros/title/en.md b/markdown/dev/reference/macros/title/en.md similarity index 100% rename from markdown/dev/reference/api/macros/title/en.md rename to markdown/dev/reference/macros/title/en.md diff --git a/markdown/dev/reference/api/macros/vd/en.md b/markdown/dev/reference/macros/vd/en.md similarity index 100% rename from markdown/dev/reference/api/macros/vd/en.md rename to markdown/dev/reference/macros/vd/en.md diff --git a/markdown/dev/reference/settings/complete/en.md b/markdown/dev/reference/settings/complete/en.md new file mode 100644 index 00000000000..97a6ea88543 --- /dev/null +++ b/markdown/dev/reference/settings/complete/en.md @@ -0,0 +1,35 @@ +--- +title: complete +--- + +The `complete` setting controls the level of detail that is included on a +pattern. Set `complete` to `false` to limiting the level of detail on the +pattern. This has different uses, such as generating patterns to be cut out +with a laser cutter. + +## Signature + +```js +const settings = { + Boolean complete=true +} +``` + +The default `complete` setting is `true`. +Set this to `false` to draft a base outline of the pattern, rather than a fully detailed pattern. + + +## Example +```js +import Aaron from "@freesewing/aaron" + +const pattern = new Aaron({ + complete: false +}) +``` + +## Notes + +Setting `complete` to `false` will force [sa](/reference/api/settings/sa) to +also be set to `false`. + diff --git a/markdown/dev/reference/api/settings/embed/en.md b/markdown/dev/reference/settings/embed/en.md similarity index 50% rename from markdown/dev/reference/api/settings/embed/en.md rename to markdown/dev/reference/settings/embed/en.md index e229183a2e8..359f2b9b0ef 100644 --- a/markdown/dev/reference/api/settings/embed/en.md +++ b/markdown/dev/reference/settings/embed/en.md @@ -2,26 +2,35 @@ title: embed --- -The `embed` setting controls the properties of the SVG document. -Set it to `true` to make SVG output suitable for embedding in a web page. +The `embed` setting controls the properties of the SVG document. Set it to +`true` to make SVG output suitable for embedding in a web page by omitting the +`height` and `width` properties. + +## Signature + +```js +const settings = { + Boolean embed=false +} +``` The default for `embed` is `false` which will include the `width` and `height` attributes in the SVG tag, thereby making it suitable for printing. -When set to `true` the `width` and `height` attributes will not be added -which allows you to inject the SVG into an HTML document, where it will -responsively scale. +When set to `true` the `width` and `height` attributes will not be added which +allows you to inject the SVG into an HTML document, where it will responsively +scale. + +## Example ```js -import Brian from "@freesewing/brian"; +import Aaron from "@freesewing/aaron" -const pattern = new Brian({ +const pattern = new Aaron({ embed: true }) ``` - +## Notes Do **not** use this for SVGs you want to print. - - diff --git a/markdown/dev/reference/settings/en.md b/markdown/dev/reference/settings/en.md new file mode 100644 index 00000000000..199aca32232 --- /dev/null +++ b/markdown/dev/reference/settings/en.md @@ -0,0 +1,11 @@ +--- +title: Settings +about: Documents all the settings your pattern can receive, including the pattern options, measurements, and design options +--- + +FreeSewing is all about parametric design, and the settings are the parameters we pass to a pattern when drafting it. +Perhaps the most important of all settings are the measurements, but there's other settings too. + +Below is a complete list of all supported settings: + + diff --git a/markdown/dev/reference/api/settings/idprefix/en.md b/markdown/dev/reference/settings/idprefix/en.md similarity index 100% rename from markdown/dev/reference/api/settings/idprefix/en.md rename to markdown/dev/reference/settings/idprefix/en.md diff --git a/markdown/dev/reference/api/settings/layout/en.md b/markdown/dev/reference/settings/layout/en.md similarity index 100% rename from markdown/dev/reference/api/settings/layout/en.md rename to markdown/dev/reference/settings/layout/en.md diff --git a/markdown/dev/reference/api/settings/locale/en.md b/markdown/dev/reference/settings/locale/en.md similarity index 100% rename from markdown/dev/reference/api/settings/locale/en.md rename to markdown/dev/reference/settings/locale/en.md diff --git a/markdown/dev/reference/api/settings/margin/en.md b/markdown/dev/reference/settings/margin/en.md similarity index 100% rename from markdown/dev/reference/api/settings/margin/en.md rename to markdown/dev/reference/settings/margin/en.md diff --git a/markdown/dev/reference/api/settings/measurements/en.md b/markdown/dev/reference/settings/measurements/en.md similarity index 100% rename from markdown/dev/reference/api/settings/measurements/en.md rename to markdown/dev/reference/settings/measurements/en.md diff --git a/markdown/dev/reference/api/settings/only/en.md b/markdown/dev/reference/settings/only/en.md similarity index 100% rename from markdown/dev/reference/api/settings/only/en.md rename to markdown/dev/reference/settings/only/en.md diff --git a/markdown/dev/reference/api/settings/options/en.md b/markdown/dev/reference/settings/options/en.md similarity index 100% rename from markdown/dev/reference/api/settings/options/en.md rename to markdown/dev/reference/settings/options/en.md diff --git a/markdown/dev/reference/api/settings/paperless/en.md b/markdown/dev/reference/settings/paperless/en.md similarity index 100% rename from markdown/dev/reference/api/settings/paperless/en.md rename to markdown/dev/reference/settings/paperless/en.md diff --git a/markdown/dev/reference/api/settings/sa/en.md b/markdown/dev/reference/settings/sa/en.md similarity index 100% rename from markdown/dev/reference/api/settings/sa/en.md rename to markdown/dev/reference/settings/sa/en.md diff --git a/markdown/dev/reference/api/settings/scale/en.md b/markdown/dev/reference/settings/scale/en.md similarity index 100% rename from markdown/dev/reference/api/settings/scale/en.md rename to markdown/dev/reference/settings/scale/en.md diff --git a/markdown/dev/reference/api/settings/units/en.md b/markdown/dev/reference/settings/units/en.md similarity index 100% rename from markdown/dev/reference/api/settings/units/en.md rename to markdown/dev/reference/settings/units/en.md diff --git a/markdown/dev/reference/api/snippets/bnotch/en.md b/markdown/dev/reference/snippets/bnotch/en.md similarity index 100% rename from markdown/dev/reference/api/snippets/bnotch/en.md rename to markdown/dev/reference/snippets/bnotch/en.md diff --git a/markdown/dev/reference/api/snippets/button/en.md b/markdown/dev/reference/snippets/button/en.md similarity index 100% rename from markdown/dev/reference/api/snippets/button/en.md rename to markdown/dev/reference/snippets/button/en.md diff --git a/markdown/dev/reference/api/snippets/buttonhole-end/en.md b/markdown/dev/reference/snippets/buttonhole-end/en.md similarity index 100% rename from markdown/dev/reference/api/snippets/buttonhole-end/en.md rename to markdown/dev/reference/snippets/buttonhole-end/en.md diff --git a/markdown/dev/reference/api/snippets/buttonhole-start/en.md b/markdown/dev/reference/snippets/buttonhole-start/en.md similarity index 100% rename from markdown/dev/reference/api/snippets/buttonhole-start/en.md rename to markdown/dev/reference/snippets/buttonhole-start/en.md diff --git a/markdown/dev/reference/api/snippets/buttonhole/en.md b/markdown/dev/reference/snippets/buttonhole/en.md similarity index 100% rename from markdown/dev/reference/api/snippets/buttonhole/en.md rename to markdown/dev/reference/snippets/buttonhole/en.md diff --git a/markdown/dev/reference/api/snippets/en.md b/markdown/dev/reference/snippets/en.md similarity index 100% rename from markdown/dev/reference/api/snippets/en.md rename to markdown/dev/reference/snippets/en.md diff --git a/markdown/dev/reference/api/snippets/logo/en.md b/markdown/dev/reference/snippets/logo/en.md similarity index 100% rename from markdown/dev/reference/api/snippets/logo/en.md rename to markdown/dev/reference/snippets/logo/en.md diff --git a/markdown/dev/reference/api/snippets/notch/en.md b/markdown/dev/reference/snippets/notch/en.md similarity index 100% rename from markdown/dev/reference/api/snippets/notch/en.md rename to markdown/dev/reference/snippets/notch/en.md diff --git a/markdown/dev/reference/api/snippets/snap-socket/en.md b/markdown/dev/reference/snippets/snap-socket/en.md similarity index 100% rename from markdown/dev/reference/api/snippets/snap-socket/en.md rename to markdown/dev/reference/snippets/snap-socket/en.md diff --git a/markdown/dev/reference/api/snippets/snap-stud/en.md b/markdown/dev/reference/snippets/snap-stud/en.md similarity index 100% rename from markdown/dev/reference/api/snippets/snap-stud/en.md rename to markdown/dev/reference/snippets/snap-stud/en.md