Encyclopédie de la création de jeux

Documentation de la syntaxe

Les articles de l’Encyclopédie sont écrits en Markdown, une syntaxe simple et populaire, également utilisée sur notre forum, Discord, GitHub, et bien d’autres services.

Parfois, Markdown est insuffisant, par exemple pour ajouter des légendes aux images, ou afficher une vidéo. Dans ces cas-là, il est possible d’écrire du HTML brut, mais c’est en contradiction avec la simplicité du Markdown qui rend accessible à tous l’édition des pages. C’est pourquoi nous utilisons des shortcodes, écrits {{< shortcode >}}, afin d’utiliser des fonctionnalités avancées sans impacter la lisibilité.

Mise en forme du contenu

Titres

Pour créer un titre, ajoutez un ou plusieurs # avant le texte.

# Titre d'article
## Titre de section
### Titre de sous-section

Le premier niveau de titre s’affiche comme le titre d’une page en orange. Pour éditer le contenu d’un article, on utilise donc des titres de deuxième ou troisième niveau.

Emphases

StyleSyntaxe
Italique*Italique*
Gras**Gras**
Italique et gras***Italique et gras***

Listes

Un élément de liste non ordonnée peut commencer par - ou *.

- George Washington
- John Adams
- Thomas Jefferson

Pour ordonner une liste, précédez les éléments d’un nombre.

1. George Washington
2. John Adams
3. Thomas Jefferson

Citations

Une citation commence par >.

William Shakespeare disait :

> Être ou ne pas être...

Morceaux de code

Entourez un texte d’accents graves ` pour qu’il soit affiché dans une police monospace et sans formatage.

La balise `<h1>` est un titre en HTML.

Pour afficher du texte dans un bloc distinct du paragraphe, utilisez trois accents graves.

Voici un exemple de code :
```ruby
class Scene_Tuto
  puts "Coucou"
end
```

Ecrire ruby, javascript ou un autre nom de langage est facultatif, et déclenche la coloration syntaxique.

Tableaux

Un tableau est toujours composé d’une ligne principale, séparée des autres lignes par des tirets -.

Jeux        | Auteurs
------------|-------------
Aëdemphia   | Sylvanor
OFF         | Mortis Ghost
To the Moon | Kan Gao

Liens et références

Créez un lien en entourant le texte cliquable de crochets [], puis en entourant l’URL de parenthèses ().

Voici le [serveur Discord](https://discord.gg/RrBppaj) de RMA.

Le shortcode ref génère un lien vers une page du wiki. Ecrivez directement le nom du fichier Markdown .md. Pour pointer vers un titre précis d’une page, ajoutez son ancre # comme elle apparait dans l’URL.

{{< ref "scripts.md" >}}              => https://wiki.rpgmakeralliance.com/scripts
{{< ref "scripts/fullscreen++.md" >}} => https://wiki.rpgmakeralliance.com/scripts/fullscreen++
{{< ref "jeux.md#laxius-power" >}}    => https://wiki.rpgmakeralliance.com/jeux#laxius-power

Combinez ce shortcode avec un lien Markdown pour obtenir un résultat agréable :

Choisissez le [déclencheur]({{< ref "evenements.md#declenchement" >}}) de votre évènement.

Images et figures

En Markdown, on crée une image en commençant par un point d’exclamation !, en entourant le texte alternatif de crochets [] et en entourant le lien vers l’image de parenthèses (). Le texte alternatif est utilisé lorsque l’image ne peut pas être affichée.

Les images sont à ajouter dans /static/images, où chaque page possède son propre dossier. Référencez ensuite votre image ainsi :

![Texte alternatif](/images/article/exemple.png)

Cependant, cette syntaxe est parfois insuffisante. En HTML, l’élément <figure> permet d’ajouter une légende sous l’image. Le shortcode suivant permet de générer facilement une figure :

{{< figure class="align-right" src="/images/article/exemple.png" alt="Texte alternatif" caption="Légende" >}}

Alignez l’image à gauche ou à droite avec class="align-left" ou class="align-right". Retirez ce paramètre pour garder l’image au centre. Affichez une légende sous la vidéo avec caption="Légende". Ajoutez un texte alternatif décrivant le contenu de l’image pour les malvoyants et les robots avec alt="Texte".

Vidéos et intégrations

Vous pouvez déposer vos vidéos dans le dossier /static/videos, où chaque page possède son propre sous-dossier. Trois formats sont supportés : mp4, webm, et ogg.

Par défaut, une vidéo est en lecture automatique et boucle sans le son (attributs autoplay muted loop). Cela permet d’imiter le comportement d’un gif animé, tout en profitant des avantages d’une vidéo : une meilleure qualité et un fichier plus léger. Vous pouvez consulter des exemples sur la page du script Scroll Pictures.

{{< video class="align-right" src="/videos/rpgmaker/scripts/scrollpictures/poussiere.mp4" caption="La poussière flotte dans la lumière de la fenêtre." >}}
{{< video src="/videos/rpgmaker/scripts/scrollpictures/fumee.mp4" alt="Capture d'écran de RPG Maker XP" caption="De la fumée dans un couloir." >}}

Vous pouvez aligner la vidéo à gauche ou à droite, avec class="align-left" ou class="align-right". Affichez une légende sous la vidéo avec caption="Légende". Ajoutez un texte alternatif décrivant le contenu de la vidéo pour les malvoyants et les robots avec alt="Texte".

En spécifiant vos propres attributs avec attr="…", vous remplacez les attributs par défaut autoplay muted loop. Dans le tutoriel de téléportation réaliste, l’attribut controls permet d’afficher d’ajouter un bouton pause et une barre de progression.

{{< video src="/videos/rpgmaker/tutoriels/teleportation/demo.webm" attr="autoplay muted loop controls" >}}

Les shortcodes suivants permettent d’intégrer des vidéos YouTube et Vimeo, des gists, des tweets et des images Instagram :

{{< youtube HKXL-0i7uAM >}}      => https://www.youtube.com/watch?v=HKXL-0i7uAM
{{< vimeo 146022717 >}}          => https://vimeo.com/channels/staffpicks/146022717
{{< gist spf13 7896402 >}}       => https://gist.github.com/spf13/7896402
{{< tweet 877500564405444608 >}} => https://twitter.com/spf13/status/877500564405444608
{{< instagram BWNjjyYFxVx >}}    => https://www.instagram.com/p/BWNjjyYFxVx/

Configuration des pages

Métadonnées

Au début de chaque fichier sont renseignées les métadonnées de la page : son titre, sa description, etc. La description, idéalement de deux ou trois phrases, est affichée lors du partage sur les réseaux sociaux, Discord, etc.

title: "Liste des scripts pour RPG Maker"
description: "Téléchargez des scripts pour ajouter
de nouvelles fonctionnalités à vos jeux RPG Maker."

L’Encyclopédie est divisée en portails, ce qui signifie que lorsque vous visitez une page consacrée à RPG Maker, seul le sommaire rpgmaker est affiché à gauche. Si rien n’est spécifié, le sommaire general est affiché.

portail: rpgmaker

Chaque sommaire est divisé en catégories. Par exemple, dans le cas du portail rpgmaker, il existe la catégorie « Scripts » dont l’identifiant est scripts. Vous pouvez afficher votre page dans un ou plusieurs sommaires ainsi :

menu:
  rpgmaker:                   # Nom du portail
    name: "Liste des scripts" # Titre affiché dans le sommaire (facultatif)
    parent: scripts           # Catégorie du sommaire
    weight: 2                 # Ordre au sein de la catégorie

Pour connaître le nom des portails et des catégories de sommaire, consultez la section suivante.

D’autres paramètres permettent de personnaliser les fonctionnalités du wiki pour une page spécifique :

Portails et sommaires

Les paramètres de l’en-tête et du menu de gauche sont renseignés dans le fichier config.toml. L’organisation des portails et des sommaires peut y être éditée.

L’en-tête est appelé global :

[[menu.global]]
name = "Forum"
weight = 5
identifier = "forum"
url = "https://rpgmakeralliance.com/"

Pour définir une catégorie « Scripts » dans le portail rpgmaker, on procède ainsi :

[[menu.rpgmaker]]
name = "Scripts"
weight = 30
identifier = "scripts"
url = "/scripts/"

On peut facilement créer de nouveaux portails dans ce fichier : pour créer le portail cool, il suffit d’écrire [[menu.cool]].

L’identifier est utilisé pour choisir un parent dans les métadonnées d’une page.

weight permet d’ordonner les éléments.

pre et post permettent d’insérer du code HTML dans l’élément.


Dernière mise à jour le 25 août 2018