Antisèche Markdown#

Danger

La présente page est un travail en cours !

Avertissement

La présente page n’est pas détaillée. Il en existe une version développée.

1.  Mise en forme de texte basique#

1.1.  Gras#

**gras**

gras

1.2.  Italique#

*italique*

italique

1.3.  À chasse fixe#

`à chasse fixe`

à chasse fixe

1.4.  Combinaison#

***`combinaison`***

combinaison

1.5.  Indice et exposant#

{sub}`indices` et {sup}`exposants`

indices et exposants

1.6.  Rature#

~~rature~~

rature

1.7.  Paragraphes#

Un paragraphe.

Un autre paragraphe.

Un paragraphe.

Un autre paragraphe.

2.  Liste#

2.1.  Non ordonnée#

- Un premier élément.
- Un deuxième élément.
  - Un premier sous-élément.
- Un troisième élément.
  • Un premier élément.

  • Un deuxième élément.

    • Un premier sous-élément.

  • Un troisième élément.

2.2.  Ordonnée#

1. Le premier élément.
2. Le deuxième élément.
   1. Un premier sous-élément.
3. Un troisième élément.
  1. Le premier élément.

  2. Le deuxième élément.

    1. Un premier sous-élément.

  3. Un troisième élément.

2.3.  De description#

:Objet 1: Description 1
:Objet 2: Description 2
:Objet 3: Description 3 très longue, très longue, très longue, très longue, très
  longue, très longue, très longue, très longue, très longue, très longue, très
  longue, très longue, très longue.

  Éventuellement sur plusieurs paragraphes et contenant par exemple des listes :

  - Le premier élément.
  - Le second élément.
  - Le autre élément.
Objet 1:

Description 1

Objet 2:

Description 2

Objet 3:

Description 3 très longue, très longue, très longue, très longue, très longue, très longue, très longue, très longue, très longue, très longue, très longue, très longue, très longue.

Éventuellement sur plusieurs paragraphes et contenant par exemple des listes :

  • Le premier élément.

  • Le second élément.

  • Le autre élément.

2.4.  De définition#

Terme 1
: Définition

Terme 2
: Définition plus longue

  Avec plusieurs paragraphes

  - Et des items de listes
Terme 1

Définition

Terme 2

Définition plus longue

Avec plusieurs paragraphes

  • Et des items de listes

3.  Structuration#

3.1.  Rubriques#

# Titre de niveau 1
Du texte.

## Titre de niveau 2
Essai.

3.2.  Coupures thématiques#

Avant une coupure thématique.

***

Après une coupure thématique.

Avant une coupure thématique.


Après une coupure thématique.

4.  Blocs de code informatique#

```
Ceci est un bloc de code avec des caractères spéciaux :
- # ^ <-- > % *coucou*
```

4.1.  Blocs de codes compilables et éditables#

```
\documentclass[french]{article}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{lmodern}
\usepackage[a4paper]{geometry}
\usepackage{babel}
\begin{document}
Test.
\end{document}
```
\documentclass[french]{article}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{lmodern}
\usepackage[a4paper]{geometry}
\usepackage{babel}
\begin{document}
Test.
\end{document}
```
%!TEX engine=lualatex
\documentclass{article}
\begin{document}
$\pi=\directlua{tex.sprint(math.pi)}$
\end{document}
```
%!TEX engine=lualatex
\documentclass{article}
\begin{document}
$\pi=\directlua{tex.sprint(math.pi)}$
\end{document}

Différents « préambules » commençant par « %!TEX » sont mis à disposition par latexcgi, ces derniers permettant de choisir le moteur de compilation ou d’activer différentes fonctionnalités (glossaires, index, affichages de certains fichiers).

```
\color{red}%
Pas de préambule, pas d'environnement \verb|document|.
```
\color{red}%
Pas de préambule, pas d'environnement \verb|document|.

4.2.  Blocs de codes non compilables et non éditables#

L’exemple précédent a illustré la capacité de latexcgi à compléter automatiquement des fragments de code La version PDF de cette FAQ ne dispose pas de cette capacité et vérifie donc que \documentclass fasse partie du code avant de tenter une compilation. Il faut donc marquer spécialement par {noedit} en particulier les blocs de code incomplets mais comportant un \documentclass.

```{noedit}
\documentclass[french]{article}
```
\documentclass[french]{article}

4.3.  Blocs de codes autres#

```python
from a import b
c = "string"
```
from a import b
c = "string"
```text
This is pdfTeX, Version 3.141592653-2.6-1.40.25 (TeX Live 2023) (preloaded format=pdflatex)
 restricted \write18 enabled.
**
```
This is pdfTeX, Version 3.141592653-2.6-1.40.25 (TeX Live 2023) (preloaded format=pdflatex)
 restricted \write18 enabled.
**
`` `Coucou !` ``

````text
```
Coucou !
```
````

`Coucou !`

```
Coucou !
```

4.4.  Numérotation et mise en évidence des lignes#

```{noedit}
:emphasize-lines : 1,6
:lineno-start : 1

\documentclass[french]{article}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{lmodern}
\usepackage[a4paper]{geometry}
\usepackage{babel}
\begin{document}
Test.
\end{document}
```
1\documentclass[french]{article}
2\usepackage[T1]{fontenc}
3\usepackage[utf8]{inputenc}
4\usepackage{lmodern}
5\usepackage[a4paper]{geometry}
6\usepackage{babel}
7\begin{document}
8Test.
9\end{document}

4.5.  Légendes#

```{noedit}
:caption: Ceci est une légende
:emphasize-lines : 1,6
:lineno-start : 1

\documentclass[french]{article}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{lmodern}
\usepackage[a4paper]{geometry}
\usepackage{babel}
\begin{document}
Test.
\end{document}
```
Ceci est une légende#
1\documentclass[french]{article}
2\usepackage[T1]{fontenc}
3\usepackage[utf8]{inputenc}
4\usepackage{lmodern}
5\usepackage[a4paper]{geometry}
6\usepackage{babel}
7\begin{document}
8Test.
9\end{document}

5.  Extraits de code informatique#

- Pas coloré syntaxiquement : `\documentclass{article}` ;
- Coloré syntaxiquement : `\documentclass{article}`{l=latex}.
  • Pas coloré syntaxiquement : \documentclass{article} ;

  • Coloré syntaxiquement : \documentclass{article}.

6.  Éléments de code variables#

Système d’exploitation

Raccourci pour

Raccourci pour

GNU/Linux

Ctrl + Shift + u27e8

Ctrl + Shift + u27e9

macOS

⌥ + 27e8

⌥ + 27e9

Windows

Alt + 10216

Alt + 10217

```{noedit}
\documentclass{⟨classe LaTeX⟩}
```
\documentclass{⟨classe LaTeX⟩}

7.  Références croisées#

7.1.  Cibles#

Cibles explicites#

(identifiant-rubrique)=
### Rubrique

{#identifiant-paragraphe}
Ceci est un paragraphe, avec un identifiant.

Ceci est une [« étendue » avec un identifiant]{#identifiant-etendue}.

- [Lien vers la rubrique](#identifiant-rubrique).
- [Lien vers le paragraphe](#identifiant-paragraphe).
- [Lien vers l’« étendue »](#identifiant-etendue).

Cibles implicites#

On peut faire référence à la [rubrique courante](#cibles-implicites).

On peut faire référence à la rubrique courante.

7.2.  Liens#

Danger

La présente rubrique « Liens » est un travail en cours !

URL « nues »#

- https://www.gutenberg-asso.fr
- www.gutenberg-asso.fr
- ftp://mirrors.ircam.fr/pub/CTAN/
- faq@gutenberg-asso.fr

URI entourés de < et >#

- <ctanpkg:tabularray>
- [](ctanpkg:tabularray)
- [le package `tabularray`](ctanpkg:tabularray)

Liens en ligne#

- [GUTenberg](https://gutenberg-asso.fr/)
- [GUTenberg](https://gutenberg-asso.fr/ "Association GUTenberg*)

Liens de référence#

- [Réseau complet d'archives TeX][ctan].
- [*Comprehensive TeX Archive Network*][ctan].
- [CTAN].

[ctan]: https://www.ctan.org/

Résolution de la destination par défaut#

La destination d’un lien peut être une cible :

  • soit externe, telle qu’une URL vers un autre site web ;

  • soit interne, telle qu’un fichier, une rubrique ou une figure du même projet.

Par défaut, MyST résout les destinations des liens selon les règles suivantes :

  1. Les destinations commençant par un schéma (par exemple xxx:) seront traitées selon ce schéma :

    1. Les destinations commençant par project: seront traitées comme des références internes au projet.

    2. Les destinations commençant par path: seront traitées comme des fichiers téléchargeables

    3. Les liens automatiques ou les destinations commençant par http:, https:, ftp:, ou mailto: seront traités comme des liens externes URL.

  2. Les destinations qui pointent vers un chemin d’accès à un fichier local sont traitées comme des liens vers ce fichier.

    1. Si la destination est un chemin relatif, elle est résolue par rapport au fichier actuel.

    2. Si la destination est un chemin absolu (commence par /), elle est résolue par rapport à la racine du projet (c’est-à-dire le répertoire source).

    3. Si ce chemin se rapporte à un autre document du projet (par exemple un fichier .md ou .rst), il renvoie à la première rubrique de ce document.

    4. Les liens vers les documents du projet peuvent également inclure un identifiant de fragment un identifiant de fragment #, pour renvoyer à une rubrique spécifique de ce document.

    5. Si le chemin d’accès est un fichier non source (par exemple un fichier .png ou .pdf), le lien renverra au fichier lui-même, par exemple pour le télécharger.

  3. Les destinations commençant par # seront traitées comme des références internes avec recherche des cibles selon l’odre suivant :

    1. cibles explicites dans le fichier en cours ;

    2. cibles implicites dans le fichier en cours ;

    3. cibles explicites dans l’ensemble du projet.

    Les cibles non trouvées font l’objet d’avertissements lors de la compilation et leurs destinations sont laissées en tant que liens externes.

URL propres à cette FAQ personnalisées#

La syntaxe des liens récurrents de la présente FAQ est simplifiée.

https://ctan.org/pkg/⟨package⟩ :

Raccourci :

- <ctanpkg:tabularray>
- [](ctanpkg:tabularray)
- [le package `tabularray`](ctanpkg:tabularray)
https://texdoc.net/pkg/⟨package⟩ :

Raccourci :

- <texdoc:tabularray>
- [](texdoc:tabularray)
- [la documentation du package `tabularray`](texdoc:tabularray)
https://texfaq.org/⟨FAQ⟩ :

Raccourci :

[*Getting started*](faquk:FAQ-startup)
https://fr.wikipedia.org/wiki/Donald_Knuth :

Raccourci :

[Donald Ervin Knuth](wpfr:Donald_Knuth)
https://en.wikipedia.org/wiki/Donald_Knuth :

Raccourci :

[Donald Ervin Knuth](wp:Donald_Knuth)
https://isbndb.com/book/⟨ISBN⟩

Raccourci :

[*The LaTeX Companion*](isbn:978-0-13-816648-9)
https://doi.org/⟨DOI⟩

Raccourci :

[La fonte de ce numéro : *Infini*](doi:10.60028/lettre.vi45.8)

Texte du lien explicite ou implicite#

Si le texte du lien est explicitement donné, par exemple [texte](#dest), alors le texte rendu sera celui-là. Ce texte peut contenir des balises en ligne imbriquées, comme [*accentuation*](#syntaxe/accentuation).

Si aucun texte n’est donné ou s’il s’agit d’un lien automatique, par exemple [](#dest) ou <projet:#dest>, MyST tentera de résoudre un texte implicite. Par exemple, si la destination est un titre, le texte du titre sera utilisé comme texte du lien, ou si la destination est une figure ou un tableau, la légende sera utilisée comme texte du lien. Dans le cas contraire, le texte du lien sera la destination elle-même.

Lien vers les pages internes de la FAQ#

Important

Pour créer un lien vers une page de la FAQ, on pourra utiliser le mécanisme de liens automatiques vers le fichier Markdown cible.

Par exemple, si on veut mettre un lien vers la page </1_generalites/bases/comment_faire_ses_premiers_pas.md> dont le fichier source Markdown se trouve, par rapport au dossier « racine » du projet, à l’emplacement 1_generalites/bases/comment_faire_ses_premiers_pas.mdde l’arborescence de la FAQ, il suffira d’écrire le code suivant:

[](/1_generalites/bases/comment_faire_ses_premiers_pas.md)

Important

Notez :

  • le / avant 1_generalites ;

  • l’affichage automatique du titre de la page visée.

Astuce

Si la cible n’est pas un fragment (une rubrique autre que le titre) d’une page, on peut omettre l’extension .md.

À faire

Ces exemples sont à revoir.

Ainsi, le lien :
1. [](/1_generalites/bases/comment_faire_ses_premiers_pas.md) est valide ;
2. [](/1_generalites/bases/comment_faire_ses_premiers_pas) est valide ;
3. [](/1_generalites/bases/comment_faire_ses_premiers_pas.md#avec-un-outil-dédié) est valide ;
4. `[](/1_generalites/bases/comment_faire_ses_premiers_pas#avec-un-outil-dédié)` **ne serait pas** valide.

Ainsi, le lien :

  1. Comment faire ses premiers pas ? est valide ;

  2. Comment faire ses premiers pas ? est valide ;

  3. Avec un outil dédié est valide ;

  4. [](/1_generalites/bases/comment_faire_ses_premiers_pas#avec-un-outil-dédié) ne serait pas valide.

Exemples#

Liens automatiques#
URL externe
: <https://example.com> ou https://example.com

Référence cible interne
: <project:#syntaxe/référencement>

Référence à un fichier interne
: <project:/index.md>

Référence à une rubrique de fichier interne
: <project:/index.md#les-questions>

Fichier téléchargeable
: <path:/_static/images/learnlatex.pdf>
URL externe

https://example.com ou https://example.com

Référence cible interne

Références croisées

Référence à un fichier interne

La FAQ francophone !

Référence à une rubrique de fichier interne

Les questions

Fichier téléchargeable

/_static/images/learnlatex.pdf

Liens en ligne avec texte implicite#
URL externe
: [](https://example.com)

Référence cible interne
: [](syntaxe/référencement)

Référence à un fichier interne
: [](/index.md)

Référence à une rubrique de fichier interne
: [](/index.md#les-questions)

Fichier téléchargeable
: [](/_static/images/learnlatex.pdf)
URL externe

Référence cible interne

Références croisées

Référence à un fichier interne

La FAQ francophone !

Référence à une rubrique de fichier interne

Les questions

Fichier téléchargeable

/_static/images/learnlatex.pdf

Liens en ligne avec texte explicite#
URL externe
: [Texte explicite](https://example.com)

Référence cible interne
: [Texte explicite](syntaxe/référencement)

Référence à un fichier interne
: [Texte explicite](/index.md)

Référence à une rubrique de fichier interne
: [Texte explicite](/index.md#les-questions)

Fichier téléchargeable
: [Texte explicite](/_static/images/learnlatex.pdf)
URL externe

Texte explicite

Référence cible interne

Texte explicite

Référence à un fichier interne

Texte explicite

Référence à une rubrique de fichier interne

Texte explicite

Fichier téléchargeable

Texte explicite

8.  Admonitions#

```{attention}
Ceci est une admonition de type `attention`.
```

Attention

Ceci est une admonition de type attention.

```{caution}
Ceci est une admonition de type `caution`.
```

Prudence

Ceci est une admonition de type caution.

```{danger}
Ceci est une admonition de type `danger`.
```

Danger

Ceci est une admonition de type danger.

```{error}
Ceci est une admonition de type `error`.
```

Erreur

Ceci est une admonition de type error.

```{hint}
Ceci est une admonition de type `hint`.
```

Indication

Ceci est une admonition de type hint.

```{important}
Ceci est une admonition de type `important`.
```

Important

Ceci est une admonition de type important.

```{note}
Ceci est une admonition de type `note`.
```

Note

Ceci est une admonition de type note.

```{seealso}
Ceci est une admonition de type `seealso`.
```

Voir aussi

Ceci est une admonition de type seealso.

```{tip}
Ceci est une admonition de type `tip`.
```

Astuce

Ceci est une admonition de type tip.

```{warning}
Ceci est une admonition de type `warning`.
```

Avertissement

Ceci est une admonition de type warning.

```{tip}
:name: label-astuce

Bla bla (astuce référençable).
```

[Référence à mon astuce](#label-astuce).

Astuce

Bla bla (astuce référençable).

Référence à mon astuce.

```{admonition} Titre d'admonition personnalisé
:class: tip

Bla bla.
```

Titre d’admonition personnalisé

Bla bla.

```{todo}
Bla bla.
```

À faire

Bla bla.

```{sources}
- Bla bla.
- Ble ble.
```
```{tip}
:class: dropdown

Bla bla.
```
::::{tab-set}

:::{tab-item} Onglet 1
Contenu 1
:::

:::{tab-item} Onglet 2
Contenu 2
:::

::::

Contenu 1

Contenu 2

:::{card} Titre de la "carte"
En-tête
^^^
Contenu de la "carte"
+++
Pied de page
:::

En-tête

Titre de la « carte »

Contenu de la « carte »

::::{grid} 3
:::{grid-item-card}  Titre 1
A
:::
:::{grid-item-card}  Titre 2
B
:::
:::{grid-item-card}  Titre 3
C
:::
::::
Titre 1

A

Titre 2

B

Titre 3

C

Danger

La suite de cette page n’a pas été travaillée !

9.  Tableaux#

9.1.  Syntaxe Markdown#

Pour construire un tableau, on utilise la syntaxe Markdown standard adaptée à Github :

  • dans chaque colonne, les lignes en-têtes de colonnes sont à séparer des lignes ordinaires par au moins trois tirets (---) ;

  • les colonnes sont séparées par des caractères « pipe » (|) ;

  • chaque extrémité de la ligne doit également être un caractères « pipe ».

| Entête 1    | Entête 2    |
|-------------|-------------|
| Cellule 1-1 | Cellule 1-2 |
| Cellule 2-1 | Cellule 2-2 |

Entête 1

Entête 2

Cellule 1-1

Cellule 1-2

Cellule 2-1

Cellule 2-2

Les cellules d’une colonne peuvent être alignées à l’aide du caractère : :

 | Gauche | Centre | Droite |
 |:-------|:------:|-------:|
 | a      | b      |      c |

Gauche

Centre

Droite

a

b

c

Note

L’alignement à droite des colonnes de tableaux est manifestement non fonctionnel. Cela a été signalé.

9.2.  Tableau avec légendes#

La table peut être utilisée pour créer un tableau avec une légende :

:::{table} Légende du tableau
:widths: auto
:align: center

| Entête 1    | Entête 2    |
|-------------|-------------|
| Cellule 1-1 | Cellule 1-2 |
| Cellule 2-1 | Cellule 2-2 |
:::
Légende du tableau#

Entête 1

Entête 2

Cellule 1-1

Cellule 1-2

Cellule 2-1

Cellule 2-2

Les options suivantes sont reconnues :

Liste des options du tableau

align : left, center, ou right

Alignement horizontal du tableau.

width : ⟨longueur⟩ ou ⟨pourcentage⟩`

La largeur du tableau à la ⟨longueur⟩ spécifiée ou au ⟨pourcentage⟩ de la largeur de la ligne (même unités et principe qu’avec ).

S’il est omis, le moteur de rendu détermine la largeur du tableau en fonction de son contenu ou de la largeur des colonnes.

widths : auto, grid, ou une liste d’⟨entiers⟩

Définit explicitement la largeur des colonnes. Spécifie les largeurs relatives si elle est utilisée avec l’option width.

auto délègue la détermination de la largeur des colonnes au moteur de rendu du backend.

grid détermine la largeur des colonnes à partir de la largeur des colonnes d’entrée (en caractères).

Danger

  • La documentation qui suit est un reste de celle de la syntaxe DokuWiki (plus utilisée dans cette FAQ nouvelle) et n’a pas encore été migrée vers celle de la syntaxe Markdown.

  • La documentation qui précède est un travail en cours.

10.  Images et figures#

Markdown (sauce MyST) permet d’inclure des images et des figures dans les documents, ainsi que d’y faire référence facilement.

10.1.  Images en ligne#

La syntaxe Markdown standard est la suivante.

![logofaq](/_static/logoFAQ-light-theme.*)

logofaq

\includegraphics{/_static/logoFAQ-light-theme}

10.2.  Figures#

Pour créer une figure, utilisez la directive figure :

```{figure} /_static/logoFAQ-light-theme.*
:width: 50%
:alt: Logo FAQ GUTenberg
:name: logo
:align: center
Ceci est la légende (facultative) de la figure. Il s'agit d'un simple paragraphe.
```
\begin{figure}
  \centering
  \includegraphics[width=.5\linewidth]{/_static/logoFAQ-light-theme}
  \caption{Ceci est la légende (facultative) de la figure. Il s'agit d'un simple paragraphe.}
  \label{logo}
\end{figure}

De nombreuses options permettent de modifier une telle figure :

Options des blocs images

alt : ⟨texte⟩

Texte alternatif : une courte description de l’image, nottament pour les personnes malvoyantes.

height : ⟨longueur⟩

Hauteur désirée pour l’image.

width : ⟨longueur⟩ ou ⟨pourcentage⟩ de la largeur de la ligne courante

Largeur désirée pour l’image.

scale : ⟨pourcentage entier⟩, compris entre 0 et 100 (le symbole % est optionel)

Le facteur d’échelle uniforme pour l’image. La valeur par défaut est de 100% (pas de facteur d’échelle).

align : top, middle, bottom, left, center, ou right

Les valeurs :

  • top, middle, et bottom contrôlent l’alignement vertical de l’image.

  • left, center, et right contrôlent l’alignement horizontale de l’image, et autorise l’image à flotter et à ce que le texte coule autour d’elle.

target : ⟨[URI] ou référence⟩

Fait de l’image un hyperlien clicable envoyant au lien souhaité.

name

Label en vue de référence croisée.

Voir aussi

Il est également de créer des figures qui utilisent la syntaxe Markdown native pour les images.

![Notre logo](/_static/logoFAQ-light-theme.*){width=200px align=right}

Ceci est une légende en *Markdown*. Remarquez comment le texte coule autour de
l'image (option `align=right`).

Lorem ipsum dolor sit amet, consectetur
adipiscing elit. Sed non risus. Suspendisse lectus tortor, dignissim sit amet,
adipiscing nec, ultricies sed, dolor. Cras elementum ultrices diam. Maecenas
ligula massa, varius a, semper congue, euismod non, mi. Proin porttitor, orci
nec nonummy molestie, enim est eleifend mi, non fermentum diam nisl sit amet
erat. Duis semper. Duis arcu massa, scelerisque vitae, consequat in, pretium a,
enim. Pellentesque congue. Ut in risus volutpat libero pharetra tempor.

Notre logo

Ceci est une légende en Markdown. Remarquez comment le texte coule autour de l’image (option align=right).

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non risus. Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor. Cras elementum ultrices diam. Maecenas ligula massa, varius a, semper congue, euismod non, mi. Proin porttitor, orci nec nonummy molestie, enim est eleifend mi, non fermentum diam nisl sit amet erat. Duis semper. Duis arcu massa, scelerisque vitae, consequat in, pretium a, enim. Pellentesque congue. Ut in risus volutpat libero pharetra tempor.

\documentclass{article}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{graphicx}
\usepackage{wrapfig2}
\begin{document}
\begin{wrapfigure}{r}{50mm}
  \centering
  \includegraphics[width=3cm]{example-image}
\end{wrapfigure}
Ceci est une légende en \textbf{\emph{Markdown}}. Remarquez comment le texte
coule autour de l'image (option \texttt{align=right}).

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non risus.
Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed,
dolor. Cras elementum ultrices diam. Maecenas ligula massa, varius a, semper
congue, euismod non, mi. Proin porttitor, orci nec nonummy molestie, enim est
eleifend mi, non fermentum diam nisl sit amet erat.  Duis semper. Duis arcu
massa, scelerisque vitae, consequat in, pretium a, enim. Pellentesque congue. Ut
in risus volutpat libero pharetra tempor.
\end{document}

11.  Commentaires#

Vous pouvez ajouter des commentaires (autrement dit, comme en des portions du fichier source n’apparaissant pas dans la page HTML générée). Pour ce faire, deux méthodes :

  1. placer le caractère % au début d’une ligne à commenter ;

  2. recourir à la syntaxe HTML (<!-- Ceci est un commentaire -->)

Par exemple, ce qui suit ne figurera pas dans le document final :

% Un commentaire...

<!-- et un autre commentaire. -->
% Un commentaire...

% et un autre commentaire.

12.  Notes de bas de page#

Les notes de bas de page utilisent la spécification pandoc. Leurs labels commencent par ^ et peuvent être n’importe quelle chaîne alphanumérique (sans espace), sans tenir compte des majuscules et des minuscules.

  • Si le label est un entier, le libellé affiché est cet entier (numérotation manuelle).

  • Sinon, les libellés affichés sont numérotés automatiquement dans l’ordre dans lequel les notes sont référencées, indépendamment des labels numérotés manuellement.

Les notes de bas de page sont rassemblées et affichées en bas de page (dans l’ordre où elles sont référencées). Les notes de bas de page non référencées ne sont pas affichées.

- Voici une note de bas de page numérotée manuellement[^3].
- Voici un renvoi à une note de bas de page automatiquement numérotée[^maref].

[^maref]: Il s'agit d'une définition de note de bas de page auto-numérotée.
[^3]: Il s'agit d'une définition de note de bas de page numérotée manuellement.
  • Voici une note de bas de page numérotée manuellement[3].

  • Voici un renvoi à une note de bas de page automatiquement numérotée[4].

\begin{itemize}
\item Voici une note de bas de page numérotée manuellement%
  \footnotemark[3]%
  \footnotetext[3]{Il s'agit d'une définition de note de bas de page numérotée
    manuellement.}.
\item Voici un renvoi à une note de bas de page automatiquement
  numérotée\footnote{Il s'agit d'une définition de note de bas de page
    auto-numérotée.}.
\end{itemize}

Tout texte suivant une définition de note de bas de page, indenté de quatre espaces ou plus, est également inclus dans la définition de la note de bas de page.

Une définition de note de bas de page sur plusieurs lignes[^malongueref].

[^malongueref]: Il s'agit de la _**définition de la note de bas de page**_.

    Elle se poursuit pour toutes les lignes indentées

    - même pour les autres éléments du bloc

    Plus toutes les lignes précédentes non indentées,
qui ne sont pas séparées par une ligne vide

Ceci ne fait pas partie de la note de bas de page.

Une définition de note de bas de page sur plusieurs lignes[5].

Ceci ne fait pas partie de la note de bas de page.

Important

À l’intérieur des s, bien que les notes de bas de page puissent sans problème être référencées (par exemple[4]), il est recommandé de ne pas les définir, à moins qu’elles ne soient référencées qu’à l’intérieur de cette même  : en effet, sinon, il se peut qu’elles ne soient référençables qu’à l’intérieur de cette particulière.

13.  Conversions textuelles#

Markdown peut convertir certains caractères ou chaînes de caractère prédéfinis en image, autre texte, ou HTML.

  1. Les guillemets standards (doublequotes) sont automatiquement convertis en leurs variantes ouvrante/fermante (conformes à la typographie française) :

    • "guillemets doubles" : « guillemets doubles » ;

    • 'guillemets simples' : “guillemets simples”.

  2. Certains textes typographiques et ligatures communs sont également automatiquement convertis :

Texte source

Texte converti

(c), (C)

©

(tm), (TM)

(r), (R)

®

+-

±

...

?....

?..

!....

!..

????????

???

!!!!!

!!!

,,,

,

--

---

14.  Citations#

Parfois vous souhaitez marquer du texte afin de montrer que c’est une réponse ou un commentaire. Vous pouvez utiliser la syntaxe suivante :

Je pense que nous devrions le faire.
> Non nous ne devrions pas.
>> Eh bien, je pense que si.
> Vraiment ?
>> Oui !
>>> Alors faisons-le !

Je pense que nous devrions le faire.

Non nous ne devrions pas.

Eh bien, je pense que si. Vraiment ? Oui !

Alors faisons-le !

15.  Mots clés#

Afin qu’elles soient bien indexées par les moteurs de recherche, les pages de la FAQ peuvent être enrichies de métadonnées, notamment de mots clés. Cela se fait au moyen de quelques lignes de code YAML (dont il n’est pas nécessaire de maîtriser la syntaxe), à placer obligatoirement en préambule (au début) du fichier source Markdown entre paire de triples tirets (---). Ainsi le fichier source de la page Comment obtenir des références croisées à partir de plusieurs sources ? commence-t-il par :

---
myst:
  html_meta:
    keywords: LaTeX,renvois,labels,références
---
\usepackage{hyperref}
\hypersetup{
  pdfkeywords={LaTeX,renvois,labels,références},
}

16.  Substitutions#

Il est possible de faire usage de substitutions, à la manière des macros personnelles sous Elles se définissent dans le préambule YAML d’un fichier source au moyen de paires clés/valeurs imbriquées dans la clé substitutions. Ainsi, on pourrait définir la substitution dek pour « Donald Ervin Knuth » qu’on emploierait ensuite dans le fichier Markdown au moyen de {{dek}} :

---
myst:
  substitutions:
    dek: "Donald Ervin Knuth"
---
À l’origine, {{dek}} a développé TeX (en `WEB`) notamment pour réaliser de beaux
documents et écrire des formules mathématiques.

À l’origine, Donald Ervin Knuth a développé (en WEB) notamment pour réaliser de beaux documents et écrire des formules mathématiques.

\newcommand{\dek}{Donald Ervin Knuth}
À l’origine, \dek{} a développé \TeX{} (en \texttt{WEB}) notamment pour réaliser
de beaux documents et écrire des formules mathématiques.

Note

Les substitutions définies dans le préambule YAML d’un fichier source Markdown sont locales à ce fichier. Il est également possible de définir des substitutions globales à toute la FAQ ; pour l’instant, aucune n’a été ainsi définie mais, si le besoin s’en fait sentir, n’hésitez pas à nous le signaler sur liste dédiée à la FAQ ou en ouvrant un « ticket » ici et nous ferons le nécessaire.

17.  Logos etc.#

Les logos tels que et sont mis en forme sans peine puisqu’il suffit de les saisir tels quels : ils sont « logoifiés » automatiquement au cours de la compilation de la FAQ. Leur liste exhaustive est la suivante :

Code

Résultat

(La)TeX

AmS-LaTeX

AmS-TeX

AmSLaTeX

AmSTeX

BibTeX

eTeX

e-TeX

LaTeX

LaTeX(2e)

LaTeX2e

LaTeXe

LuaLaTeX

LuaTeX

LyX

Metafont

Metapost

PiCTeX

SliTeX

teTeX

TeX

TeXLaTeX

Xe(La)TeX

XeLaTeX

XeTeX

18.  Canevas#

Lorsque vous créerez de nouvelles pages pour partager votre expérience avec vous pourrez vous aider du canevas suivant.

---
myst:
  html_meta:
    keywords: ⟨mot clé 1⟩, ⟨mot clé 2⟩
---
# ⟨Question⟩ ?

⟨Réponse(s)⟩

:::{sources}
Source(s)
:::