VSinerva/freesewing
1
0
Fork 0
Code Activity

fix(docs): Update Guides documentation 2

Browse source
This commit is contained in:
Benjamin F 2022-12-25 21:13:48 -08:00
parent d0415b33a5
commit 7cb6f11882
31 changed files with 81 additions and 81 deletions
Download patch file Download diff file Expand all files Collapse all files

6
markdown/dev/guides/best-practices/go-counter-clockwise/en.md
View file

@ -3,7 +3,7 @@ title: Construct paths counter-clockwise
order: 70
---
Construct your paths counter-clockwise. You have to pick a direction anyway, and going
Construct your paths _counter-clockwise_ (anti-clockwise). You have to pick a direction anyway, and going
counter-clockwise is a bit of a convention.
This applies both to naming points (specifically the control points of curves)
@ -16,8 +16,8 @@ of (a part of) a garment.
So pick a point, and make your way around counter-clockwise.
When naming control points for curves, re-use the name of the point they are attached to
and add `Cp1` to the control point before and `Cp2` to the control point after the point if
, once again, you'd follow your path counter-clockwise.
and add `Cp1` to the control point before and `Cp2` to the control point after the point if,
once again, you follow your path counter-clockwise.
For example:

5
markdown/dev/guides/best-practices/reuse-css-classes/en.md
View file

@ -3,7 +3,8 @@ title: Re-use CSS classes
order: 30
---
While you can style your pattern however you want, try to re-use the CSS class names that
are in use in our default [theme plugin](/reference/plugins/theme).
While you can style your pattern however you want, try to re-use the
[CSS class names](/reference/css) that
are in use in our default `@freesewing/plugin-theme` plugin.
Doing so will ensure consistent styling for patterns.

12
markdown/dev/guides/best-practices/use-translation-keys/en.md
View file

@ -5,14 +5,14 @@ order: 60
Don't insert literal text in your patterns. Instead, insert a key that can then be translated.
For example, if you want to put _Finish with bias tape_ on your pattern, don't be
For example, if you want to put "_Finish with bias tape_" on your pattern, don't be
tempted to do this:
```js
path.seam.attr("data-text", "Finish with bias tape");
```
That (English) string is now hard-coded in your pattern. As freesewing supports
That (English) string is now hard-coded in your pattern. As FreeSewing supports
translation out of the box, it would be a real shame not to make use of it.
Instead, insert a key to identify the string:
@ -21,6 +21,10 @@ Instead, insert a key to identify the string:
path.seam.attr("data-text", "finishWithBiasTape");
```
This way, it can be translated.
This way, different strings for different languages can be associated with
the key, allowing translated text to be used.
You can find and browse the translations and available translation keys [in the freesewing/freesewing project](https://github.com/freesewing/freesewing/tree/develop/packages/i18n/src/locales).
You can find and browse the translations and available translation keys in the
[freesewing/freesewing project on GitHub][1].
[1]: https://github.com/freesewing/freesewing/tree/develop/packages/i18n/src/locales