Types de pages

Timdoc contient quatre types de pages: list, article, exercice et tool. Le type d'une page est déterminé par la valeur de la propriété @type dans le DOCBLOCK de l'entête du template.

list

Le type list est utilisé pour créer une liste à deux colones. Il est généralement utilisé pour lister les pages enfants.

Exemple:

<?php /** * @type list * @title Manuel * @icon images/icon.png * @abstract Installation et développement */ ?> <children></children> article

Le type article est le type le plus utilisé. Il sert à créer des articles (no shit) avec une table des matières automatiquement liée au composantes <grostitre></grostitre>.

Exemple:

<?php /** * @type article * @title Types de pages * @icon images/icon.png * @abstract Liste, article, exercice, outil */ ?> <grostitre>Type</grostitre> exercice

Un peu comme le type article, le type exercice est présenté avec une table des matières. Lors du rendu, un fichier exercice.json est aussi créé avec les informations de page. Ce fichier permet d'obtenir les infos à partir d'une page afin de l'embeder avec la composante <exercice></exercice>.

Exemple:

<?php /** * @type exercice * @title Flexbox - Scrabble Potter * @icon images/thumb.jpg * @abstract Déplacer les lettres d’un jeu de Scrabble */ ?> <grostitre>Exercice</grostitre>

Une propriété supplémentaire @url peut aussi être ajoutée si l'exercice est un lien externe. Exemple:

<?php /** * @type exercice * @title Flexbox Zombie - Chapitre 1 * @icon images/thumb.jpg * @url https://mastery.games/flexboxzombies/chapter/1/level/1 * @abstract Les rudiments de l'arbaliète. */ ?> <script>location.href = '<?php echo $PAGE->url; ?>';</script> tool

Le type de page tool est identique au type exercice à la différence que le fichier généré est nommé tool.json et le monde de présentation est différent avec la composante <tool></tool>.

Exemple:

<?php /** * @type tool * @title CSS Gradient * @icon images/thumb.jpg * @url https://cssgradient.io/ * @abstract Générateur de dégradés. */ ?> <script>location.href = '<?php echo $PAGE->url; ?>';</script> wiki

Le wiki permet de créer un endroit pour regrouper l'information de votre cours.

Exemple:

<?php /** * @type wiki * @title wiki - nom du cours * @icon images/icon.png * @abstract Nom du cours */ ?> <wiki-page name="Cours 01"> </wiki-page>

L'ajout de la date permet de dévoiler les pages à des moments précis. Avant la date, les informations contenues dans ce bloc ne seront pas accessibles:

<wiki-page name="Cours 01" date="2023-02-22"> </wiki-page>

Composantes utiles

Lien vers un document pdf ou source url:

Lien vers une page de timdoc: