Aller au contenu

Créer un Fichier de Base

English | Français | 한국어 | 日本語

Cette page décrit les règles de création d'un fichier de base.

Résumé

MMG lit les fichiers markdown ou les cellules markdown dans le notebook jupyter et classe le contenu. Pour ce faire, MMG utilise les commentaires markdown spéciaux suivants.

  • En-tête
    • <!-- multilingual suffix: keyword1, keyword2, keyword3 -->: Déclarez quels mots-clés utiliser à l'avenir.
    • <!-- no suffix: keyword -->: Ne pas ajouter de suffixe au fichier créé pour le mot-clé spécifié.
  • Macro
    • <!-- [[ multilingual toc: level=2~3 ]] -->: Génère automatiquement une table des matières pour chaque mot-clé à l'emplacement spécifié.
  • Corps
    • <!-- [keyword] -->: Déclarez à quel mot-clé appartient la section.
    • <!-- [common] -->: Déclarez le contenu qui sera commun à toutes les langues.
    • <!-- [ignore] -->: Ignorez la section.

Note

Dans les documents MMG, les termes «mot-clé» et «balise» sont utilisés indifféremment. Dans le code source, il est également appelé comme nom de variable suffix ou lang_tags. Ils signifient tous la même chose.

En-tête

Note

À partir de la version 2.0.0, les en-têtes peuvent être déclarés n'importe où dans le document. Cependant, dans la version 1.x.x, les en-têtes doivent être déclarés avant le corps.

Déclarez les mots-clés à utiliser

Déclarez les mots-clés à utiliser. Les mots-clés sont séparés par des virgules. Vous pouvez utiliser des étiquettes de langue IETF pour les mots-clés.

<!-- multilingual suffix: en, kr, fr, es, jp, cn -->

Ne pas ajouter de suffixe au fichier créé (facultatif)

Si vous ne souhaitez pas ajouter de suffixe au fichier créé, vous pouvez le déclarer comme suit. Par exemple, si vous définissez no suffix: en, fichier.en.md ne sera pas créé, mais fichier.md sera créé. Dans GitHub, le README principal n'est pas reconnu si un suffixe est attaché, il est donc recommandé de définir no suffix pour le fichier devant être le README principal.

<!-- no suffix: en -->

Macro

Macro de table des matières

Les méthodes existantes pour générer une table des matières ne fonctionnent pas pour les fichiers de base dont le contenu provient de plusieurs mots-clés. C'est pourquoi MMG fournit une macro pour le faire automatiquement.

<!-- [[ multilingual toc: level=2~3 ]] -->

Option de niveau

Précautions

  • L'option level est obligatoire. Si vous omettez level, MMG traitera cette macro comme un commentaire normal.
  • La macro de table des matières est implicitement supposée appartenir à <!-- [common] -->. Ainsi, lorsque vous utilisez la macro de table des matières, le mot-clé actuel est automatiquement modifié en common.

Il existe quatre façons de spécifier le level à afficher.

  • level=2: Seuls les titres de niveau 2 sont affichés dans la table des matières.
  • level=2~: Les titres de niveau 2 à 9 sont affichés dans la table des matières.
  • level=~4: Les titres de niveau 1 à 4 sont affichés dans la table des matières.
  • level=2~4: Les titres de niveau 2 à 4 sont affichés dans la table des matières.

Options de suppression des émoticônes

Parfois, vous souhaiterez peut-être ajouter des émoticônes au titre mais les supprimer de la table des matières. Si vous êtes dans cette situation, appliquez l'option no-emoji comme indiqué ci-dessous.

<!-- [[ multilingual toc: level=2~3 no-emoji ]] -->

Si no-emoji est appliqué, seuls les titres sans émojis seront affichés dans la table des matières.

**Table of Contents**

1. [Heading 1](#heading-1-)
2. [Heading 2](#heading-2-)

# Heading 1 💎
# Heading 2 ❤️

**Table of Contents**

1. [Heading 1 💎](#heading-1-)
2. [Heading 2 ❤️](#heading-2-)

# Heading 1 💎
# Heading 2 ❤️

Corps

Une fois qu'un mot-clé est reconnu, le contenu suivant sera reconnu avec ce mot-clé jusqu'à ce qu'un autre mot-clé apparaisse.

Mot-clé défini par l'utilisateur

En utilisant les mots-clés déclarés dans l'en-tête, vous pouvez déclarer à quel mot-clé appartient la section. Si vous utilisez par erreur un mot-clé non défini ou si le nombre de mots-clés ne correspond pas, MMG vous informera d'une erreur via la fonction de validation.

<!-- [en] -->
<!-- [ko] -->
<!-- [fr] -->
<!-- [es] -->
<!-- [ja] -->
<!-- [cn] -->
...

Section commune

Vous pouvez déclarer le contenu qui sera commun à toutes les langues.

<!-- [common] -->
Ce contenu sera affiché dans tous les fichiers.

Section ignorée

Parfois, vous souhaiterez peut-être ignorer une section, comme des commentaires ou des mémos mineurs, du fichier créé. Dans ce cas, utilisez le mot-clé ignore.

<!-- [ignore] -->
Cette section ne sera pas incluse dans le fichier créé.