VSinerva/freesewing
1
0
Fork 0
Code Activity

feat(markdown): New docs for various things

Browse source
This commit is contained in:
joostdecock 2023-10-29 17:20:35 +01:00
parent 9fe93e03ce
commit 6b147d81a0
93 changed files with 1274 additions and 589 deletions
Download patch file Download diff file Expand all files Collapse all files

15
markdown/dev/reference/macros/bartack/en.md
View file

@ -4,12 +4,15 @@ title: bartack
The `bartack` macro allows you to add a _bartack_ marker to your sewing
pattern.
It is provided by the [annotations plugin](/reference/plugins/annotations).
It is provided by [plugin-annotations](/reference/plugins/annotations), which is
part of [core-plugins](/reference/plugins/core) (so it is available by default).
## Signature
```js
macro('banner', {
String id='bartack',
Point anchor,
Number angle=0,
Number density=3,
@ -17,6 +20,7 @@ macro('banner', {
String prefix='',
String suffix='',
Number width=3,
Boolean force = false,
})
```
@ -43,13 +47,14 @@ macro('banner', {
| `anchor` | | `Point` | The point to start the bartack from |
| `angle` | `0` | `number` | The angle under which to draw the bartack |
| `density` | `3` | `number` | Controls how close the stitches are together |
| `id` | `bartack` | `string` | The ID of this macro instance |
| `length` | `15` | `number` | Length of the bartack |
| `prefix` | | `string` | A prefix to apply to the name of the generated path |
| `suffix` | | `string` | A suffix to apply to the name of the generated path |
| `width` | `3` | `number` | Width of the bartack |
| `force` | `false` | `boolean` | Set this to `true` to display the macro output even when `complete` is `false` |
## Result
## Notes
This macro takes the `complete` setting into account and won't output anything when both complete and `force` are `false`.
| Generated Element | Description |
|-------------------|-------------|
| `paths.${prefix}bartack${suffix}` | Path generated for the bartack marker |