breaking: New annotation plugin replaces others
This wraps up the initial work on a new annotations plugin that replaces other plugins that provide annotations. As a result, the following plugins are now no longer available: - plugin-banner - plugin-bartack - plugin-buttons - plugin-cutonfold - plugin-dimension - plugin-grainine - plugin-logo - plugin-notches - plugin-scalebox - plugin-title The new plugin-annotations package provides all these plugins used to provide. In addition, it also includes the following new macros: - bannerbox - pleat - sewTogether
This commit is contained in:
joostdecock
parent
ad18463e2a
commit
d0447c0f77
39 changed files with 655 additions and 926 deletions
61
markdown/dev/reference/plugins/annotations/en.md
Normal file
61
markdown/dev/reference/plugins/annotations/en.md
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
---
|
||||
title: plugin-annotations
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-annotations][1], this plugin provides a
|
||||
variety of macros and snippets to annotate designs.
|
||||
|
||||
The annotations plugin provides the following snippets:
|
||||
|
||||
- [button](/reference/snippets/button)
|
||||
- [buttonhole](/reference/snippets/button)
|
||||
- [buttonhole-start](/reference/snippets/button)
|
||||
- [buttonhole-end](/reference/snippets/button)
|
||||
- [logo](/reference/snippets/logo)
|
||||
- [notch](/reference/snippets/button)
|
||||
- [bnotch](/reference/snippets/button)
|
||||
|
||||
The annotations plugin provides the following macros:
|
||||
|
||||
- [banner](/reference/macros/banner)
|
||||
- [bannerbox](/reference/macros/bannerbox)
|
||||
- [bartack](/reference/macros/bartack)
|
||||
- [bartackAlong](/reference/macros/bartackalong)
|
||||
- [bartackFractionAlong](/reference/macros/bartackfractionalong)
|
||||
- [crossbox](/reference/macros/crossbox)
|
||||
- [cutonfold](/reference/macros/cutonfold)
|
||||
- [hd](/reference/macros/hd)
|
||||
- [ld](/reference/macros/ld)
|
||||
- [rmad](/reference/macros/rmad)
|
||||
- [rmd](/reference/macros/rmd)
|
||||
- [pd](/reference/macros/pd)
|
||||
- [pleat](/reference/macros/pleat)
|
||||
- [scalebox](/reference/macros/scalebox)
|
||||
- [sewTogether](/reference/macros/setogether)
|
||||
- [title](/reference/macros/title)
|
||||
- [vd](/reference/macros/vd)
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-annotations
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugin](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { annotationsPlugin } from '@freesewing/plugin-banner'
|
||||
// or
|
||||
import { pluginAnnotations } from '@freesewing/plugin-banner'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The annotations plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-annotations
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
---
|
||||
title: plugin-banner
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-banner][1], this plugin provides [the banner
|
||||
macro](/reference/macros/banner) which allows you to add repeating text
|
||||
along a path.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-banner
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { bannerPlugin } from '@freesewing/plugin-banner'
|
||||
// or
|
||||
import { pluginBanner } from '@freesewing/plugin-banner'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The banner plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-banner
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
---
|
||||
title: plugin-bartack
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-bartack][1], this plugin provides
|
||||
the [bartack](/reference/macros/bartack),
|
||||
[bartackAlong](/reference/macros/bartackalong), and
|
||||
the [bartackFractionAlong](/reference/macros/bartackfractionalong) macros
|
||||
which allows you to add bartacks — a set
|
||||
of tight zig-zag stitches used to enforce a seam — to your design.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-bartack
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { bartackPlugin } from '@freesewing/plugin-bartack'
|
||||
// or
|
||||
import { pluginBartack } from '@freesewing/plugin-bartack'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The bartack plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-bartack
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: plugin-buttons
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-buttons][1], this plugin provides the following
|
||||
[snippets](/reference/snippets):
|
||||
|
||||
- [button](/reference/snippets/button)
|
||||
- [buttonhole](/reference/snippets/buttonhole)
|
||||
- [buttonhole-start](/reference/snippets/buttonhole-start)
|
||||
- [buttonhole-end](/reference/snippets/buttonhole-end)
|
||||
- [snap-stud](/reference/snippets/snap-stud)
|
||||
- [snap-socket](/reference/snippets/snap-socket)
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-buttons
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { buttonsPlugin } from '@freesewing/plugin-buttons'
|
||||
// or
|
||||
import { pluginButtons } from '@freesewing/plugin-buttons'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The buttons plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-buttons
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
---
|
||||
title: plugin-cutonfold
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-cutonfold][1], this plugin provides [the
|
||||
cutonfold macro](/reference/macros/cutonfold) which adds a _cut on fold_
|
||||
indicator to your design.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-cutonfold
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { cutonfoldPlugin } from '@freesewing/plugin-cutonfold'
|
||||
// or
|
||||
import { pluginCutonfold } from '@freesewing/plugin-cutonfold'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The cutonfold plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-cutonfold
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: plugin-dimension
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-dimension][1], this plugin provides the
|
||||
following macros:
|
||||
|
||||
- [hd](/reference/macros/hd) : Adds a horizontal dimension
|
||||
- [vd](/reference/macros/vd) : Adds a vertical dimension
|
||||
- [ld](/reference/macros/ld) : Adds a linear dimension
|
||||
- [pd](/reference/macros/pd) : Adds a dimension along a path
|
||||
- [rmd](/reference/macros/rmd) : Removes a dimension
|
||||
- [rmad](/reference/macros/rmad) : Removes all dimensions with a default prefix
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-dimension
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { dimensionPlugin } from '@freesewing/plugin-dimension'
|
||||
// or
|
||||
import { pluginDimension } from '@freesewing/plugin-dimension'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The dimension plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-dimension
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
---
|
||||
title: plugin-grainline
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-grainline][1], this plugin provides [the
|
||||
grainline macro](/reference/macros/grainline) which adds a _grainline_
|
||||
indicator to your design.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-grainline
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { grainlinePlugin } from '@freesewing/plugin-grainline'
|
||||
// or
|
||||
import { pluginGrainline } from '@freesewing/plugin-grainline'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The grainline plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-grainline
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
---
|
||||
title: plugin-logo
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-logo][1], this plugin provides [the logo
|
||||
macro](/reference/macros/logo) which adds FreeSewing's logo to your
|
||||
design.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-logo
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { logoPlugin } from '@freesewing/plugin-logo'
|
||||
// or
|
||||
import { pluginLogo } from '@freesewing/plugin-logo'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The logo plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-logo
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
---
|
||||
title: plugin-notches
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-notches][1], this plugin provides the
|
||||
[notch](/reference/snippets/notch) and
|
||||
[bnotch](/reference/snippets/bnotch) snippets.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-notches
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { notchesPlugin } from '@freesewing/plugin-notches'
|
||||
// or
|
||||
import { pluginNotches } from '@freesewing/plugin-notches'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The notches plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-notches
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: plugin-scalebox
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-scalebox][1], this plugin provides the
|
||||
[scalebox](/reference/macros/scalebox) and
|
||||
[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
|
||||
scale.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-scalebox
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { scaleboxPlugin } from '@freesewing/plugin-scalebox'
|
||||
// or
|
||||
import { pluginScalebox } from '@freesewing/plugin-scalebox'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
This plugin by default includes FreeSewing branding, but you can
|
||||
override that when calling the `scalebox` macro in case you want to
|
||||
generate your own branded designs.
|
||||
|
||||
The scalebox plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-scalebox
|
||||
45
markdown/dev/reference/plugins/timing/en.md
Normal file
45
markdown/dev/reference/plugins/timing/en.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
title: plugin-timing
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-timing][1], this plugin measures
|
||||
detailed timing information while drafting a design and keeps it in the
|
||||
pattern store.
|
||||
|
||||
It is intended to be used for developers trying to indicate which parts
|
||||
of their code are slow, or in general provide insights into the speed
|
||||
at which a design can be drafted.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-timing
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { timingPlugin } from '@freesewing/plugin-mirror'
|
||||
// or
|
||||
import { pluginTiming } from '@freesewing/plugin-mirror'
|
||||
```
|
||||
|
||||
<Fixme>
|
||||
|
||||
##### Provide in-depth example
|
||||
|
||||
This is currently not used, but that will change once v3 gets closer to release.
|
||||
At that point, we should provide an in-depth example here.
|
||||
|
||||
</Fixme>
|
||||
|
||||
## Notes
|
||||
|
||||
The mirror plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-timing
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
---
|
||||
title: plugin-title
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-title][1], this plugin provides [the title
|
||||
macro](/reference/macros/title) which facilitates adding part titles to
|
||||
your designs.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-title
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { titlePlugin } from '@freesewing/plugin-title'
|
||||
// or
|
||||
import { pluginTitle } from '@freesewing/plugin-title'
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The title plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-title
|
||||
Loading…
Add table
Add a link
Reference in a new issue