chore(markdown): Updated links for v3
This commit is contained in:
parent
df02504ef7
commit
7cc37ea150
25 changed files with 44 additions and 44 deletions
|
@ -4,7 +4,7 @@ order: 40
|
||||||
---
|
---
|
||||||
|
|
||||||
Apart from the pattern options that you configure for your pattern,
|
Apart from the pattern options that you configure for your pattern,
|
||||||
all FreeSewing patterns have a set of [draft settings](/reference/api/settings) that can be tweaked
|
all FreeSewing patterns have a set of [draft settings](/reference/settings) that can be tweaked
|
||||||
by the user.
|
by the user.
|
||||||
|
|
||||||
While many of these will automatically be handled by FreeSewing, there are some
|
While many of these will automatically be handled by FreeSewing, there are some
|
||||||
|
@ -12,19 +12,19 @@ that you should take into account while developing your pattern. They are:
|
||||||
|
|
||||||
## Complete
|
## Complete
|
||||||
|
|
||||||
The [complete](/reference/api/settings/complete) setting is a boolean that is either true or false.
|
The [complete](/reference/settings/complete) setting is a boolean that is either true or false.
|
||||||
Its goal is to determine whether we should draft a _complete_ pattern, or merely the outline.
|
Its goal is to determine whether we should draft a _complete_ pattern, or merely the outline.
|
||||||
|
|
||||||
## Paperless
|
## Paperless
|
||||||
|
|
||||||
The [paperless](/reference/api/settings/paperless) setting is a boolean that is either true or false.
|
The [paperless](/reference/settings/paperless) setting is a boolean that is either true or false.
|
||||||
|
|
||||||
A _paperless_ pattern is a pattern that has extra dimensions so users can trace the
|
A _paperless_ pattern is a pattern that has extra dimensions so users can trace the
|
||||||
paper on fabric or paper without having the need to print it.
|
paper on fabric or paper without having the need to print it.
|
||||||
|
|
||||||
## Seam allowance
|
## Seam allowance
|
||||||
|
|
||||||
The [sa](/reference/api/settings/sa) setting is a number that controls the seam allowance.
|
The [sa](/reference/settings/sa) setting is a number that controls the seam allowance.
|
||||||
|
|
||||||
Unless `sa` is zero, you should add the requested seam allowance to your pattern.
|
Unless `sa` is zero, you should add the requested seam allowance to your pattern.
|
||||||
|
|
||||||
|
|
|
@ -5,16 +5,16 @@ order: 60
|
||||||
|
|
||||||
A **hook** is a lifecycle event. The available hooks are:
|
A **hook** is a lifecycle event. The available hooks are:
|
||||||
|
|
||||||
- [preRender](/reference/api/hooks/prerender/): Called at the start of [`Pattern.render()`](/reference/api/pattern/render)
|
- [preRender](/reference/hooks/prerender/): Called at the start of [`Pattern.render()`](/reference/api/pattern/render)
|
||||||
- [postRender](/reference/api/hooks/postrender/): Called at the end of [`Pattern.render()`](/reference/api/pattern/render)
|
- [postRender](/reference/hooks/postrender/): Called at the end of [`Pattern.render()`](/reference/api/pattern/render)
|
||||||
- [insertText](/reference/api/hooks/inserttext/): Called when inserting text
|
- [insertText](/reference/hooks/inserttext/): Called when inserting text
|
||||||
- [preDraft](/reference/api/hooks/predraft/): Called at the start of [`Pattern.draft()`](/reference/api/pattern/draft)
|
- [preDraft](/reference/hooks/predraft/): Called at the start of [`Pattern.draft()`](/reference/api/pattern/draft)
|
||||||
- [postDraft](/reference/api/hooks/postdraft/): Called at the end of [`Pattern.draft()`](/reference/api/pattern/draft)
|
- [postDraft](/reference/hooks/postdraft/): Called at the end of [`Pattern.draft()`](/reference/api/pattern/draft)
|
||||||
- [preSample](/reference/api/hooks/presample/): Called at the start of [`Pattern.sample()`](/reference/api/pattern/sample)
|
- [preSample](/reference/hooks/presample/): Called at the start of [`Pattern.sample()`](/reference/api/pattern/sample)
|
||||||
- [postSample](/reference/api/hooks/postsample/): Called at the end of [`Pattern.sample()`](/reference/api/pattern/sample)
|
- [postSample](/reference/hooks/postsample/): Called at the end of [`Pattern.sample()`](/reference/api/pattern/sample)
|
||||||
|
|
||||||
You can register a method for a hook. When the hook is triggered, your method will be
|
You can register a method for a hook. When the hook is triggered, your method will be
|
||||||
called. It will receive two parameters:
|
called. It will receive two parameters:
|
||||||
|
|
||||||
- An object relevant to the hook. See the [hooks API reference](/reference/api/hooks/) for details.
|
- An object relevant to the hook. See the [hooks API reference](/reference/hooks/) for details.
|
||||||
- Data passed when the hook was registered (optional)
|
- Data passed when the hook was registered (optional)
|
||||||
|
|
|
@ -7,6 +7,6 @@ about: Shows how you can use macros within your pattern
|
||||||
Macros are a way to facilitate pattern design by bundling a bunch of individual actions
|
Macros are a way to facilitate pattern design by bundling a bunch of individual actions
|
||||||
into a little routine. Macros are provided by [plugins](/reference/plugins/).
|
into a little routine. Macros are provided by [plugins](/reference/plugins/).
|
||||||
|
|
||||||
Refer to the [macros documentation](/reference/api/macros/) for details on how to use macros,
|
Refer to the [macros documentation](/reference/macros/) for details on how to use macros,
|
||||||
and the [plugins](/reference/plugins/) documentation for info on how to create your
|
and the [plugins](/reference/plugins/) documentation for info on how to create your
|
||||||
own macros.
|
own macros.
|
||||||
|
|
|
@ -40,7 +40,7 @@ macro('sprinkle', {
|
||||||
|
|
||||||
<Tip>
|
<Tip>
|
||||||
|
|
||||||
Refer to [the sprinkle macro documentation](/reference/api/macros/sprinkle) for details on how
|
Refer to [the sprinkle macro documentation](/reference/macros/sprinkle) for details on how
|
||||||
to use this macro
|
to use this macro
|
||||||
|
|
||||||
</Tip>
|
</Tip>
|
||||||
|
|
|
@ -61,7 +61,7 @@ Below is a complete example.
|
||||||
const svg = new Aaron({
|
const svg = new Aaron({
|
||||||
sa: 10, // Seam allowance
|
sa: 10, // Seam allowance
|
||||||
paperless: true, // Enable paperless mode
|
paperless: true, // Enable paperless mode
|
||||||
// More settings, see: https://FreeSewing.dev/reference/api/settings
|
// More settings, see: https://FreeSewing.dev/reference/settings
|
||||||
measurements: { // Pass in measurements
|
measurements: { // Pass in measurements
|
||||||
biceps: 387,
|
biceps: 387,
|
||||||
chest: 1105,
|
chest: 1105,
|
||||||
|
|
|
@ -65,7 +65,7 @@ console.log(svg)
|
||||||
##### Remarks on the example code
|
##### Remarks on the example code
|
||||||
|
|
||||||
- We are using `@freesewing/aaron` as the design, but you could use any design
|
- We are using `@freesewing/aaron` as the design, but you could use any design
|
||||||
- You probably want to [use your own measurements](/reference/api/settings/measurements)
|
- You probably want to [use your own measurements](/reference/settings/measurements)
|
||||||
or you could use `@freesewing/models` to load measurements from [our sizing grid](https://freesewing.org/sizes/)
|
or you could use `@freesewing/models` to load measurements from [our sizing grid](https://freesewing.org/sizes/)
|
||||||
- We are using `@freesewing/plugin-theme` to theme our SVG, but you
|
- We are using `@freesewing/plugin-theme` to theme our SVG, but you
|
||||||
could [pass in your own CSS](/guides/plugins/using-hooks-without-plugin)
|
could [pass in your own CSS](/guides/plugins/using-hooks-without-plugin)
|
||||||
|
|
|
@ -34,7 +34,7 @@ function fromAbs(millimeter, settings) {
|
||||||
|
|
||||||
The first parameter is the desired value in millimeter (for example
|
The first parameter is the desired value in millimeter (for example
|
||||||
`130` for `13cm`).
|
`130` for `13cm`).
|
||||||
The second parameter is the pattern's [settings](/reference/api/settings) object
|
The second parameter is the pattern's [settings](/reference/settings) object
|
||||||
which holds -- among other things -- the measurements provided by the user.
|
which holds -- among other things -- the measurements provided by the user.
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
|
@ -24,7 +24,7 @@ function toAbs(percentage, settings) {
|
||||||
|
|
||||||
The first parameter is the percentage value provided by the user (for example
|
The first parameter is the percentage value provided by the user (for example
|
||||||
`0.5` for `50%`).
|
`0.5` for `50%`).
|
||||||
The second parameter holds the pattern's [settings](/reference/api/settings) object
|
The second parameter holds the pattern's [settings](/reference/settings) object
|
||||||
which holds -- among other things -- the measurements provided by the user.
|
which holds -- among other things -- the measurements provided by the user.
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
|
@ -16,7 +16,7 @@ import { Florence } from "@freesewing/florence"
|
||||||
const pattern = new Florence()
|
const pattern = new Florence()
|
||||||
```
|
```
|
||||||
|
|
||||||
You probably want to create a pattern using your own [settings](/reference/api/settings):
|
You probably want to create a pattern using your own [settings](/reference/settings):
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { Florence } from "@freesewing/florence"
|
import { Florence } from "@freesewing/florence"
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-banner
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-banner][1], this plugin provides [the banner
|
Published as [@freesewing/plugin-banner][1], this plugin provides [the banner
|
||||||
macro](/reference/api/macros/banner) which allows you to add repeating text
|
macro](/reference/macros/banner) which allows you to add repeating text
|
||||||
along a path.
|
along a path.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
|
@ -3,9 +3,9 @@ title: plugin-bartack
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-bartack][1], this plugin provides
|
Published as [@freesewing/plugin-bartack][1], this plugin provides
|
||||||
the [bartack](/reference/api/macros/bartack),
|
the [bartack](/reference/macros/bartack),
|
||||||
[bartackAlong](/reference/api/macros/bartackalong), and
|
[bartackAlong](/reference/macros/bartackalong), and
|
||||||
the [bartackFractionAlong](/reference/api/macros/bartack) macros
|
the [bartackFractionAlong](/reference/macros/bartack) macros
|
||||||
which allows you to add bartacks — a set
|
which allows you to add bartacks — a set
|
||||||
of tight zig-zag stitches used to enforce a seam — to your design.
|
of tight zig-zag stitches used to enforce a seam — to your design.
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-cutonfold
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-cutonfold][1], this plugin provides [the
|
Published as [@freesewing/plugin-cutonfold][1], this plugin provides [the
|
||||||
cutonfold macro](/reference/api/macros/cutonfold) which adds a cut-on-fold
|
cutonfold macro](/reference/macros/cutonfold) which adds a cut-on-fold
|
||||||
indicator to your design.
|
indicator to your design.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
|
@ -5,12 +5,12 @@ title: plugin-dimension
|
||||||
Published as [@freesewing/plugin-dimension][1], this plugin provides the
|
Published as [@freesewing/plugin-dimension][1], this plugin provides the
|
||||||
following macros:
|
following macros:
|
||||||
|
|
||||||
- [hd](/reference/api/macros/hd) : Adds a horizontal dimension
|
- [hd](/reference/macros/hd) : Adds a horizontal dimension
|
||||||
- [vd](/reference/api/macros/vd) : Adds a vertical dimension
|
- [vd](/reference/macros/vd) : Adds a vertical dimension
|
||||||
- [ld](/reference/api/macros/ld) : Adds a linear dimension
|
- [ld](/reference/macros/ld) : Adds a linear dimension
|
||||||
- [pd](/reference/api/macros/pd) : Adds a dimension along a path
|
- [pd](/reference/macros/pd) : Adds a dimension along a path
|
||||||
- [rmd](/reference/api/macros/rmd) : Removes a dimension
|
- [rmd](/reference/macros/rmd) : Removes a dimension
|
||||||
- [rmad](/reference/api/macros/rmad) : Removes all dimensions with a default prefix
|
- [rmad](/reference/macros/rmad) : Removes all dimensions with a default prefix
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-flip
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-flip][1], this plugin provides [the flip
|
Published as [@freesewing/plugin-flip][1], this plugin provides [the flip
|
||||||
macro](/reference/api/macros/flip) which flips (mirrors) an entire part
|
macro](/reference/macros/flip) which flips (mirrors) an entire part
|
||||||
vertically around the Y-axis. It's typically used to create a right and left
|
vertically around the Y-axis. It's typically used to create a right and left
|
||||||
pattern part from the same basis.
|
pattern part from the same basis.
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-gore
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-gore][1], this plugin provides [the gore
|
Published as [@freesewing/plugin-gore][1], this plugin provides [the gore
|
||||||
macro](/reference/api/macros/gore) which allows you to generate [gore
|
macro](/reference/macros/gore) which allows you to generate [gore
|
||||||
segments](https://en.wikipedia.org/wiki/Gore_\(segment\)); 2D panels to create
|
segments](https://en.wikipedia.org/wiki/Gore_\(segment\)); 2D panels to create
|
||||||
a sphehrical shape as used in hats for example.
|
a sphehrical shape as used in hats for example.
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-grainline
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-grainline][1], this plugin provides [the
|
Published as [@freesewing/plugin-grainline][1], this plugin provides [the
|
||||||
grainline macro](/reference/api/macros/grainline) which adds a _grainline_
|
grainline macro](/reference/macros/grainline) which adds a _grainline_
|
||||||
indicator to your design.
|
indicator to your design.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-logo
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-logo][1], this plugin provides [the logo
|
Published as [@freesewing/plugin-logo][1], this plugin provides [the logo
|
||||||
macro](/reference/api/macros/logo) which adds FreeSewing's logo to your
|
macro](/reference/macros/logo) which adds FreeSewing's logo to your
|
||||||
design.
|
design.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-mirror
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-mirror][1], this plugin provides [the mirror
|
Published as [@freesewing/plugin-mirror][1], this plugin provides [the mirror
|
||||||
macro](/reference/api/macros/mirror) which facilitates mirroring a number of
|
macro](/reference/macros/mirror) which facilitates mirroring a number of
|
||||||
points and/or paths around a given mirror line.
|
points and/or paths around a given mirror line.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
|
@ -3,8 +3,8 @@ title: plugin-notches
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-notches][1], this plugin provides the
|
Published as [@freesewing/plugin-notches][1], this plugin provides the
|
||||||
[notch](/reference/api/snippets/notch) and
|
[notch](/reference/snippets/notch) and
|
||||||
[bnotch](/reference/api/snippets/bnotch) snippets.
|
[bnotch](/reference/snippets/bnotch) snippets.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-round
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-round][1], this plugin provides [the round
|
Published as [@freesewing/plugin-round][1], this plugin provides [the round
|
||||||
macro](/reference/api/macros/round) which helps you round corners on your
|
macro](/reference/macros/round) which helps you round corners on your
|
||||||
designs.
|
designs.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
|
@ -3,8 +3,8 @@ title: plugin-scalebox
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-scalebox][1], this plugin provides the
|
Published as [@freesewing/plugin-scalebox][1], this plugin provides the
|
||||||
[scalebox](/reference/api/macros/scalebox) and
|
[scalebox](/reference/macros/scalebox) and
|
||||||
[miniscale](/reference/api/macros/miniscale) macros which add a (mini) scalebox
|
[miniscale](/reference/macros/miniscale) macros which add a (mini) scalebox
|
||||||
to your design, so users can verify that the pattern is printed at the correct
|
to your design, so users can verify that the pattern is printed at the correct
|
||||||
scale.
|
scale.
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-sprinkle
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-sprinkle][1], this plugin provides [the
|
Published as [@freesewing/plugin-sprinkle][1], this plugin provides [the
|
||||||
sprinkle macro](/reference/api/macros/sprinkle) which is a faster way to add
|
sprinkle macro](/reference/macros/sprinkle) which is a faster way to add
|
||||||
several of the same snippets to your designs (think of it as _sprinkling_ them
|
several of the same snippets to your designs (think of it as _sprinkling_ them
|
||||||
onto your design).
|
onto your design).
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-title
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-title][1], this plugin provides [the title
|
Published as [@freesewing/plugin-title][1], this plugin provides [the title
|
||||||
macro](/reference/api/macros/title) which facilitates adding part titles to
|
macro](/reference/macros/title) which facilitates adding part titles to
|
||||||
your designs.
|
your designs.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
|
@ -27,7 +27,7 @@ const pattern = new Aaron({
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
This is ignored if [settings.complete](/reference/api/settings/complete) is `false`
|
This is ignored if [settings.complete](/reference/settings/complete) is `false`
|
||||||
|
|
||||||
<Comment by="joost">
|
<Comment by="joost">
|
||||||
This is not strictly enforced and left of to the designer, so different designs
|
This is not strictly enforced and left of to the designer, so different designs
|
||||||
|
|
|
@ -17,7 +17,7 @@ tedious. There are macros to add titles to your pattern, or grainline
|
||||||
indicators, a scalebox, and there's a macro to round corners. The `round`
|
indicators, a scalebox, and there's a macro to round corners. The `round`
|
||||||
macro.
|
macro.
|
||||||
|
|
||||||
<Note> You can find more information on the `round` macro in [the macros docs](/reference/api/macros/round/).</Note>
|
<Note> You can find more information on the `round` macro in [the macros docs](/reference/macros/round/).</Note>
|
||||||
|
|
||||||
We need a half circle here, but the `round` macro works on 90° angles, so
|
We need a half circle here, but the `round` macro works on 90° angles, so
|
||||||
you'll use it twice. As such, we'll add some points to guide the macro, and
|
you'll use it twice. As such, we'll add some points to guide the macro, and
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue