Utilisation de l'infrastructure de développement web

L'aiguilleur se présente sous la forme suivante :

Les principales variables sont :

• $root contient le répertoire dans lequel se trouve l'aiguilleur. Il ne devrait jamais être nécessaire de modifier cette ligne.
• $web indique où se trouve la partie web relativement à root. Dans notre cas, la partie web se trouve en '../infra-web-cours'.
• $module donne le nom du module. Cette information est nécessaire pour créer le bandeau en haut de la page et pour générer le titre de la page.
• $planning donne le planning de l'année en cours (voir l'aide ici).
• Finalement, la variable $nav indique le fichier de navigation du module sans l'extension '.php' (voir après) et la variable $main la page par défaut du module sans l'extension '.php' (dans notre cas la page example).

Le fichier de navigation sert d'abord à générer les menus. Le fichier de navigation utilisé dans cette aide est donné ici :

Les menus et sous-menus sont donnés par les listes (<ul> et <li>). Outre le fait qu'elle est affichée en tant que menu, la liste <ul> avec la classe chapitres a aussi un rôle particulier. Chaque élément de cette liste définit un chapitre (une séance). Ces chapitres permettent de :

• Générer le page contenant tous les TPs an agrégeant tous les contenus associés aux balises <a> ayant la classe all-in-one dans le fichier de navigation. Vous pouvez voir le résultat de cette agréagation ici. Le code de cette page qui agrège l'ensemble des sujets est assez simple :
  <all-in-one></all-in-one>
  
• Générer un tableau contenant le séquencement pédagogique du module (voir la suite).

Par défaut, un chapitre est donc affiché à la fois en tant que sous-menu et dans la page de séquencement. On peut changer ce comportement avec deux attributs qu'on peut adjoindre à une balise <li> :

• L'attribut ignore indique que le chapitre <li> doit être totalement ignoré, comme dans :
  <li ignore>Ma partie du cours que je ne veux pas rendre visible</li>
  Cet attribut permet de masquer certaines parties du cours si on souhaite ne les rendre visibles qu'au fur et à mesure de la progression du cours.
• L'attribut only-schedule permet d'indiquer que le chapitre doit apparaître dans la page schedule, mais pas dans les menus, ce qui permet d'alléger les menus, ou de traiter différemment des chapitres à faire en hors présentiel.
• L'attribut only-nav a le comportement inverse, le chapitre ne sera affiché que dans le menu.

On peut aussi facilement gérer l'affichage de certains éléments en jouant avec les classes current-week et min-week. Le fichier de navigation donné en exemple illustre le fonctionnement : seules les balises avec une classe min-week avec un attribut data-min-week supérieur à 2 (c'est-à-dire supérieur à l'attribut data-current-week de la balise avec la classe current-week) sont affichées.

Pour illustrer, voici le séquencement pédagogique associé au fichier de navigation donné en exemple :

• Sujets
  Supports
  Notions clés
• C1
  Installation
  • Cours
  • Test avec PhP
  • Installation complète avec Apache
• C2
  Création d'un cours
  Création d'un cours complet
  • Cours
  • Création d'un cours complet
  • Fonctionnement de l'aiguilleur
• C3
  Les balises
  • Cours
  • Un petit exemple
  • Liste de toutes les balises
• C4
  Gérer des planning
  • Cours
  • Générer et afficher des plannings
• C5
  Informations diverses
  • Cours
  • Gestion des chemins dans les cours
  • Configuration avancée de l'affichage
• 

  A1
  Exemple avancé
  Exemple avancé avec un titre mega long car j'aime bien les titres longs
  • Le cours (pas de lien, c'est normal)
    – 20mn
  • TP (pas de lien, c'est normal)
    – 15mn + 1h25
  Le format de la case notion est totalement libre.
• CI42
  Chapitre qui n'apparaît que dans schedule et pas dans le menu
  • Une ressource
    – 20mn
  L'attribut schedule-only

Le code permettant de générer ce séquencement est le suivant :

Les balises chapitre-* servent à générer le séquencement et les menus. Les informations données dans chapitre-id et chapitre-title servent à générer le menu de premier niveau dans Supports et la liste donnée dans la balise chapitre-content le menu de deuxième niveau.

Vous avez enfin deux balises optionnelles qui vous sont proposées pour les parties séquencements :

• Si vous voulez un titre court dans le menu et un titre long dans le séquencement, il suffit d'ajouter une balise chapter-short comme dans l'exemple.
• Si vous voulez afficher des informations complémentaires dans le séquencement mais pas dans le menu de navigation, vous pouvez utiliser la balise expanded-version comme dans l'exemple.

L'aiguilleur prend jusqu'à trois arguments :

• page=fichier : indique le fichier qu'on souhaite afficher à l'intérieur de l'aiguilleur. Le chemin du fichier est relatif au répertoire racine ($root) et le suffixe .php est implicite. Si ce paramètre est omis, il prend la valeur $main
• soluce=[true|false] : indique si on souhaite afficher la solution. Si ce paramètre est omis, soluce vaut false
• wrap=[true|false] : indique si on souhaite afficher les solutions déjà déroulées ou si on souhaite n'afficher qu'un bouton permettant d'afficher les solutions. J'ai fait un chouette contre-sens quand j'ai conçu l'infrastructure, wrap à vrai indique qu'un menu est déroulé :). Pour une présentation d'une solution aux étudiants, on préférera laisser ce paramètre à false, alors que pour imprimer un corrigé, on préférera passer ce paramètre à true. Si ce paramètre est omis, il vaut false par défaut.
• preprint=[true|false] : déroule automatiquement les balises details et tip, ce qui est utile pour l'impression d'un fascicule.

Pour une utilisation de tous les jours :

• &page=ma-page : pour les étudiants quand ils surfent (pas de corrigé, détails/tip pas déroules),
• &page=ma-page&soluce=true : pour les enseignants en version vidéo-projeté quand on veut pouvoir faire apparaître les détails, tips et solutions au fur et à mesure (bouton solution, solutions/details/tip pas déroulés),
• &page=ma-page&preprint=true : fascicule de l'étudiant à imprimer (pas de corrigé, détails/tip déroulés),
• &page=ma-page&preprint=true&soluce=true&wrap=true : fascicule de l'enseignant à imprimer (corrigés, détails et tips sont tous déroulés).

Le projet infra-web-cours est constitué de deux sous-parties. La première, appelée sous-partie wordpress, est utilisée à la fois par l'infrastructure pour les cours, mais aussi par le wordpress du département de façon à unifier la présentation des sites webs des équipes avec celles des pages de cours. La seconde, appelée sous-partie cours, ajoute des spécificités pour gérer les cours (typiquement la balise <schedule>).

Si on suppose que le chemin vers la racine du projet infra-web-cours est défini dans la variable INFRA_WEB_COURS, alors $INFRA_WEB_COURS/wp contient la sous-partie wordpress et $INFRA_WEB_COURS/infra-web-cours contient la sous-partie cours. Comme la sous-partie cours repose sur la sous-partie wordpress, la sous-partie cours trouve le chemin vers la sous-partie wordpress dans la variable wppath. Par défaut, cette variable pointe vers la sous-partie wordpress se trouvant dans le projet, ce qui devrait correspondre à 99% des cas d'utilisations. Toutefois, si par hasard vous avez besoin de stocker la sous-partie wordpress dans un répertoire différent, il faut alors modifier wppath. Pour cela, il suffit de copier le fichier config.sample.php se trouvant dans le répartoire $INFRA_WEB_COURS/infra-web-cours/current en config.php dans le même répertoire et d'ajuster la variable wppath en fonction de votre abroescence.