VSinerva/freesewing
1
0
Fork 0
Code Activity
freesewing/markdown/dev/howtos/code/adding-instructions/en.md
Joost De Cock 265ad404da chore(markdown): Linting of dev docs
2022-02-19 08:04:25 +01:00

1.7 KiB
Raw Blame History

title for about
Add instructions to your design developers While documentation is good, sometimes you want to add some instructions to your design itself
See this example in our source code

Adding instructions to your pattern is just a matter of adding text. The tricky part is to make sure your text can be translated.

Below is a rather involved example from Aaron:

points.bindinAnchor = new Point(points.armhole.x / 4, points.armhole.y)
  .attr('data-text', 'cutTwoStripsToFinishTheArmholes')
  .attr('data-text', ':\n')
  .attr('data-text', 'width')
  .attr('data-text', ':')
  .attr('data-text', units(sa * 6 || 60))
  .attr('data-text', '\n')
  .attr('data-text', 'length')
  .attr('data-text', ':')
  .attr('data-text', units(armholeLength * 0.95 + 2 * sa))
  .attr('data-text', '\n \n')
  .attr('data-text', 'cutOneStripToFinishTheNeckOpening')
  .attr('data-text', ':\n')
  .attr('data-text', 'width')
  .attr('data-text', ':')
  .attr('data-text', units(sa * 6))
  .attr('data-text', '\n')
  .attr('data-text', 'length')
  .attr('data-text', ':')
  .attr('data-text', units(neckOpeningLength * 2 * 0.95 + 2 * sa))
  .attr('data-text-lineheight', 6)

If you want to add text along a path, you can do that too:

paths.breakLine.attr('data-text', 'breakLine').attr('data-text-class', 'center')
paths.flb.attr('data-text', 'facingLiningBoundary')

Refer to the sprinkle macro documentation for details on how to use this macro