VSinerva/freesewing
1
0
Fork 0
Code Activity

Revert "chore: Linting for markdown and js"

Browse source 
This reverts commit 1c92e0f655.
This commit is contained in:
joostdecock 2021-10-17 18:26:00 +02:00
parent 994874fa72
commit cba1ab19c8
6627 changed files with 25791 additions and 24211 deletions
Download patch file Download diff file Expand all files Collapse all files

27
markdown/dev/reference/hooks/inserttext/en.md
View file

@ -1,16 +1,16 @@
***
## title: insertText
---
title: insertText
---
The `insertText` hook is called when text is about to be inserted during rendering.
Methods attached to the `insertText` hook will receive 2 parameters:
* `locale` : The language code of the language requested by the user (defaults to `en`)
* `text`: The text to be inserted
- `locale` : The language code of the language requested by the user (defaults to `en`)
- `text`: The text to be inserted
Unlike most hooks that receive an object that you can make changes to,
for this hook you need to return a string.
Unlike most hooks that receive an object that you can make changes to,
for this hook you need to return a string.
This hook is typically used for translation, as is the case
in [our i18n plugin](/reference/plugins/i18n/).
@ -20,8 +20,8 @@ in [our i18n plugin](/reference/plugins/i18n/).
When we say that *this hook is called when text is about to be inserted*, that is a simplified view.
In reality, this hook is called:
* For every value set on data-text
* For the combined result of these values, joined together with spaces
- For every value set on data-text
- For the combined result of these values, joined together with spaces
Let's use an example to clarify things:
@ -33,14 +33,15 @@ points.example
For the example point above, the `insertText` hook will end up being called 3 times:
* First it will pass `seamAllowance` to the plugin
* Then it will pass `: 1cm` to the plugin
* Finally it will pass `seamAllowance : 1cm` to the plugin
- First it will pass `seamAllowance` to the plugin
- Then it will pass `: 1cm` to the plugin
- Finally it will pass `seamAllowance : 1cm` to the plugin
Having the `insertText` hook only run once with `Seam allowance: 1cm` would be problematic because
the seam allowance may differ, or perhaps we're using imperial units, and so on.
Instead, you can (and should) divide your text into chunks that need translating, and chunks that do not.
This is also why we're not inserting **Seam allowance** but rather **seamAllowance**;
This is also why we're not inserting **Seam allowance** but rather **seamAllowance**;
It is merely a key to indicate what translation we want to replace this text with.