📝 /\t/ / in markdown docs

pull/1212/head
Alexandre Hajjar 2020-11-17 17:55:31 +01:00
parent dca09ac9d2
commit 4087bdd959
2 changed files with 29 additions and 29 deletions

View File

@ -145,13 +145,13 @@ mise en regard des calculs eux-mêmes.
Plusieurs propriétés sont reprises dans ces pages d'explications :
- le **titre**, qui s'affiche en haut de la page. Par défaut on utilise le nom
de la règle, mais la propriété `titre` permet de choisir un titre plus
approprié ;
de la règle, mais la propriété `titre` permet de choisir un titre plus
approprié ;
- la **description** qui peut être rédigée en Markdown et est généralement
affichée comme paragraphe d'introduction sur la page. On utilise le caractère
`>` pour indiquer au parseur Yaml que la description utilise du Markdown ;
affichée comme paragraphe d'introduction sur la page. On utilise le caractère
`>` pour indiquer au parseur Yaml que la description utilise du Markdown ;
- les **références** externes (documentation utile) affichées en
bas de page et qui sont constituées d'une liste de liens avec une description.
bas de page et qui sont constituées d'une liste de liens avec une description.
```yaml
ticket resto:
@ -194,7 +194,7 @@ différent, sans que cela entre en conflit:
```yaml
# Ceci n'entre pas dans le calcul de `prime de vacances` définie plus haut
autre prime . taux:
formule: 19%
formule: 19%
```
On dit que la formule de la règle `prime de vacances` fait référence à la
@ -205,7 +205,7 @@ nom complet de cette règle:
```yaml
prime de vacances v2:
formule: autre prime . taux * 1000 €
formule: autre prime . taux * 1000 €
```
Dans le cas d'espaces de noms imbriqués (à plus qu'un étage), le nom inscrit
@ -214,10 +214,10 @@ espaces de nom jusqu'à la racine.
```yaml
contrat salarié . rémunération . primes . prime de vacances:
formule: taux générique * 1000 €
formule: taux générique * 1000 €
contrat salarié . rémunération . taux générique:
formule: 10%
formule: 10%
```
Ici `contrat salarié . rémunération . primes . prime de vacances` va faire
@ -430,8 +430,8 @@ prime:
multiplication:
assiette: 1000€
taux:
définition: taux bonus
formule: 5%
définition: taux bonus
formule: 5%
super-prime:
remplace: prime . taux bonus

View File

@ -75,7 +75,7 @@ est utile pour préciser les paramètres spécifiques à une simulation.
```js
// Ici on change le prix des avocats
engine.setSituation({
'prix . avocat': '3€/avocat'
'prix . avocat': '3€/avocat'
})
```
@ -84,7 +84,7 @@ La valeur de `dépenses primeur` se base maintenant sur un avocat à 3€ :
```js
// On ré-évalue la règle dans la nouvelle situation
console.log(
`Nouveau prix ! Dépenses mises à jour: ${formatValue(engine.evaluate('dépenses primeur'))}.`
`Nouveau prix ! Dépenses mises à jour: ${formatValue(engine.evaluate('dépenses primeur'))}.`
)
```
@ -158,12 +158,12 @@ le composant dédié, et passer l'`engine` à afficher dans les props.
import { Documentation } from 'publicodes'
function MonApp() {
return (
<ReactRouter>
<Documentation engine={engine} documentationPath={'/documentation'} />
{/* Composants de l'app */}
</ReactRouter>
)
return (
<ReactRouter>
<Documentation engine={engine} documentationPath={'/documentation'} />
{/* Composants de l'app */}
</ReactRouter>
)
}
```
@ -174,16 +174,16 @@ Vous pourrez ensuite faire un lien vers la documentation avec le composant
import { RuleLink } from 'publicodes'
function MesDépenses() {
return (
<p>
Accéder aux{' '}
<RuleLink
dottedName={'dépenses primeur'}
engine={engine}
documentationPath={'/documentation'}
/>
</p>
)
return (
<p>
Accéder aux{' '}
<RuleLink
dottedName={'dépenses primeur'}
engine={engine}
documentationPath={'/documentation'}
/>
</p>
)
}
```