Extension:Page Forms/Guide de démarrage rapide

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:Page Forms/Quick start guide and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎dansk • ‎français • ‎italiano • ‎polski • ‎čeština • ‎فارسی • ‎中文 • ‎日本語

Ainsi, vous avez installé tous les logiciels sur votre site. Et maintenant ? Il est temps de créer les structures qui contiendront, afficheront et permettront d'ajouter et de modifier vos données ; heureusement tout ceci peut être fait simplement en créant différentes page wiki.

La première étape va être de définir la structure de vos données. Quels types de pages figureront sur votre site ? Quelles données contiendra chaque type ? Vous pourrez changer tout cela plus tard mais vous devez avoir un plan pour commencer. Une fois que vous avez cela (idéalement écrit sur un papier) vous pouvez passer à la création des pages wiki nécessaires. Vous devrez créer ou modifier les pages des modèles et des formulaires, probablement celles des catégories aussi, ainsi que les propriétés (si vous utilisez Semantic MediaWiki).

Vous pouvez créer tout ceci en partant de rien, bien que des formulaires d'assistance existent par ailleurs afin de vous aider dans vos créations. L'approche convenable dépend des autres extensions que vous utilisez :

Avec Cargo

Manière la plus directe - Special:CreateClass

La page Special:CreateClass définie par Page Forms, fournit en un même lieu, un unique formulaire d'aide pour définir tout ce qu'il faut concernant une « classe » de données. Si vous remplissez les champs et cliquez sur « Soumettre », la page créera automatiquement le modèle, le formulaire et les pages de catégorie nécessaires. Vous pouvez ensuite aller sur la page du formulaire créée, et commencer à saisir les données.

Si toutes les pages ne semblent pas être créées, il se peut que votre file d'attente de travaux manque de mémoire. Voir l'élément relatif à la file des tâches ici pour la manière d'ajouter davantage de mémoire.

Manière la plus raisonnable

Exécutez les étapes suivantes :

  • Create templates. Un modèle définit l'affichage des données sur une page, contient le balisage pour stocker les données dans les tables Cargo et définit (souvent) la page comme appartenant à une certaine catégorie, et donc à un certain type de page. Il y aura généralement un modèle par type de page, bien que parfois un seul type de page contienne plus d'un modèle. Un modèle peut également être utilisé pour l'agrégation, en affichant une liste de toutes les autres pages qui ont une certaine relation avec cette page. Créer les modèles en allant sur la page Special:CreateTemplate.
  • Create forms. Vous pouvez maintenant créer des formulaires pour permettre aux utilisateurs d'ajouter et de modifier facilement des pages de différents types. Il devrait y avoir un formulaire par type de page; le formulaire remplira le ou les modèles contenus dans ce type de page. Comme auparavent, il existe une page spéciale pour créer les nouveaux formulaires : Special:CreateForm.
  • Create categories. Un modèle dans chaque formulaire doit baliser chaque article que le formulaire crée comme faisant partie d'une certaine catégorie. Vous devez créer une page pour chacune de ces catégories et lui spécifier un formulaire par défaut, pour que chaque article soit automatiquement modifiable avec le même formulaire qui l'a créé. La manière la plus facile de faire cela est d'utiliser la page Special:CreateCategory .
  • Enable links to forms. Outre la création de catégories qui ont un formulaire par défaut, vous devez suivre d'autres étapes pour permettre aux utilisateurs d'accéder aux formulaires que vous avez créés. Celles-ci comprennent notamment l'ajout de liens pour ajouter des données dans la barre latérale et ailleurs, et d'utiliser #formredlink pour avoir des liens rouges vers des pages inexistantes pointant vers un formulaire pour les créer. Ces actions sont toutes expliquées dans la section « Lier les formulaires » .
  • Add links on sidebar and elsewhere. Vous pouvez modifier la barre latérale (qui pour les wikis en langue anglaise est modifiable à la page « MediaWiki:Sidebar » ) afin qu'elle garde les liens pour ajouter chacuns des types de données. Vous pouvez également ajouter un lien vers la page Special:Drilldown qui est une page définie par Cargo et qui fournit un moyen facile de voir toutes les données du wiki d'un simple coup d'oeil. Vous pouvez aussi inclure de tels liens sur la page d'accueil ou ailleurs.
  • Add data. Maintenant vous pouvez commencer à saisir les données ! Allez simplement sur les pages des formulaires et commencez à créer les pages.
  • Customize. Une fois que la structure est en place, vous pouvez personnaliser tout ce que vous voulez - modifier l'aspect et le comportement du wiki dans sa totalité, celui des différents modèles ou des formulaires, ajouter ou modifier des champs, ou encore ajouter ou modifier des requêtes.

Avec Semantic MediaWiki

La manière facile - Special:CreateClass

La page Special:CreateClass définie par Page Forms, fournit un formulaire unique d'assistant pour déclarer à un seul endroit tout ce qui concerne une donnée de type « classe ». Si vous remplissez les champs et cliquez sur « Envoyer », la page va créer automatiquement toutes les propriétés nécessaires, le modèle, le formulaire et les pages de catégories. Ensuite vous pouvez aller sur la page du formulaire qui a été créé et commencer à saisir les données.

Si toutes les pages semblent ne pas avoir été créées, c'est peut être parce que la file d'attente des tâches manque de mémoire. Voyez ici l'élément associé de la file d'attente des tâches pour savoir comment ajouter davantage de mémoire.

Manière la plus raisonnable

Vous devez réaliser les étapes suivantes :

  • Create properties. Les blocs de construction de base de tout site sémantique sont les connexions entre les données, qui dans Semantic MediaWiki s'appellent les propriétés. Une propriété est utilisée pour spécifier un élément unique d'information à propos du sujet de cette page. Chaque propriété doit être définie sur votre wiki, par une page de l'espace de noms «  Property: » . Créer chaque propriété en allant sur la page Special:CreateProperty.
  • Create templates. Un modèle définit l'affichage des données sur une page, possède le balisage pour représenter ces données dans la forme d'information sémantique appropriée, et (souvent) définit la page comme appartenant à une certaine catégorie, et faisant donc partie d'un certain type de pages. Il y aura généralement un modèle par type de page, bien que parfois un seul type de page contienne plus d'un modèle. Un modèle peut également être utilisée pour l'aggrégation, en affichant une liste des toutes les autres pages uqi ont une certaine relation avec cette page (voir la documentation des requêtes en ligne pour en savoir davantage sur le sujet). Créer les modèles en allant sur la page Special:CreateTemplate .
  • Create forms. Maintenant vous pouvez créer des formulaires pour permettre aux utilisateurs d'ajouter ou de modifier facilement les pages de différents types. Il faut avoir un formulaire par type de page; le formulaire va populer le ou les modèles que cette page contient. Comme précédemment, il existe une page spéciale pour créer les nouveaux formulaires : Special:CreateForm.
  • Create categories. Un modèle dans chaque formulaire doit marquer chaque article créé par ce formulaire, comme faisant partie d'une catégorie donnée. Vous devez créer une page pour chacune de ces catégories et spécifier un formulaire par défaut pour que chaque article soit automatiquement modifiable avec le même formulaire qui l'a créé. La manière la plus facile de faire cela est d'utiliser la page Special:CreateCategory .
  • Enable links to forms. En plus de créer des catégories qui possèdent un formulaire par défaut, il existe d'autres étapes à suivre pour permettre aux utilisateurs de pouvoir accéder aux formulaires que vous avez créés. Ceci comprend l'ajout de liens pour ajouter des données dans la barre latérale et ailleurs, et l'utilisation de #formredlink pour obtenir des liens en rouge lorsque les pages pointées n'existent pas et qui permettent de les créer en cliquant simplement sur ces liens. Ces actions sont toutes expliquées dans la section « Pointer vers les formulaires » .
  • Add links on sidebar and elsewhere. La barre latérale (qui pour les wikis en langue anglaise peut être modifiée sur la page « MediaWiki:Sidebar ») doit contenir des liens vers chacun des types de données, et également vers les catégories associées à ces types. Vous pouvez aussi inclure de tels liens sur la page d'accueil et ailleurs.
  • Add data. Maintenant vous pouvez commencer à saisir les données ! Allez simplement sur les pages des formulaires et commencez à créer les pages.
  • Customize. Une fois la structure en place, vous pouvez personnaliser tout ce que vous voulez - modifier l'apparence et le comportement du wiki dans sa totalité, celui des modèles et des formulaires, ajouter ou modifier des champs, ajouter ou modifier des requêtes en ligne.

Exemple

Prenons un exemple spécifique de création d'un wiki basé sur Page Forms en partant de rien et d'une manière complète. Disons que vous voulez créer un wiki qui affiche tous les livres que vous avez chez vous. Nous passerons ensuite par les étapes précédentes spécifiées, avec certaines parties différentes pour Cargo avec Semantic MediaWiki.

1. Définir la structure de données. Vous voulez deux types de pages sur votre wiki: une pour les livres et une autre pour les auteurs. Chaque page de livre doit contenir un titre, un nom d'auteur (ou des noms), un genre (ou des genres), une année de publication et un certain nombre de pages. Chaque page d'auteur doit contenir le nom de l'auteur, son pays d'origine et une liste de tous les livres qu'ils ont écrits et que vous possédez.

2. Créer les propriétés.

Avec Cargo Avec SMW
Il n'existe pas d'équivalent pour Cargo. Pour les livres, il n'est pas nécessaire de créer une propriété pour le titre, car le titre de chaque page représentant un livre sera le titre de ce livre.

Ce qui laisse quatre champs :

  • Auteur(s) - en utilisant la page "Créer une propriété" (sur Special:CreateProperty), vous allez créer une propriété appelée "A été écrit par", de type "Page" (car chaque auteur doit avoir sa propre page).
  • Genre - vous créez une propriété appelée "Has genre", de type "Text", et lui donnez des valeurs prédéfinies telles que : "Art, Cookbook, Fiction, History, Poetry, Science".
  • Year of publication - vous créez une propriété appelée "Was published in year", de type "Number".
  • Number of pages - vous créez une propriété appelée "Has number of pages", de type "Number".

Pour les pages des auteurs, il vous suffit de créer une propriété supplémentaire :

  • Country of origin - vous créez une propriété appelée "Is from country", de type "Text".

3. Créer les modèles. Vous devez créer deux modèles : un pour les livres, et un pour les auteurs; tous deux avec la page "Create a template" sur Special:CreateTemplate.

D'abord commencer par les livres :

Avec Cargo Avec SMW
Sur Special:CreateTemplate, entrez "Book" pour le nom du modèle, et "Books" pour la catégorie.

Vous y ajoutez quatre champs et pour chacun d'eux, vous spécifiez au moins trois valeurs : son nom de champ dans le code source du modèle, son libellé d'affichage sur chaque page, et son type. Il existe quelques autres valeurs que vous pouvez définir, mais elles ne seront pas nécessaires pour la plupart de ces champs.

  1. Dans le premier nom de champ mettez "Authors", pour le libellé "Author(s)" et pour le type "Page". Vous devez également cocher la case indiquant que ce champ peut contenir une liste de valeurs (puisqu'un livre peut avoir plus d'un auteur).
  2. Cliquez sur Ajouter un champ puis pour le second champ, les trois valeurs "Genres", "Genre(s)" et "String". Vous devez à nouveau cocher la case indiquant que ce champ peut contenir une liste de valeurs. Vous devez ensuite spécifier l'ensemble des valeurs autorisées; cela peut être fait soit comme une simple liste, soit comme une hiérarchie. Vous pouvez définir une liste simple comme « art, cuisine, fiction, histoire, poésie, science », etc. ; ou vous pouvez définir une hiérarchie complète, qui pourrait ressembler à :
* Fiction
** Science fiction
*** Cyberpunk
** Historical fiction
...et ainsi de suite.
3. Cliquez sur Ajouter un champ puis, pour le troisième champ, entrez les valeurs "Year", "Year of publication" et "Date" (un choix meilleur que "Integer").
4. Cliquez sur Ajouter un champ puis, pour le quatrième champ, entrez "Number of pages", "Number of pages" et "Integer".
5. Cliquer sur le bouton Enregistrer la page.
Sur Special:CreateTemplate, entrez le nom du modèle "Book", ainsi que le nom de la catrégorie "Books".

Vous y ajoutez quatre champs et pour chaque champ, vous spécifiez trois valeurs: son nom de champ dans le code source du modèle, son libellé d'affichage sur chaque page et la propriété sémantique qu'il remplit.

  1. Pour le premier champ, déclarez le nom du champ à « Auteurs » , le libellé à « Auteur(s) » et la propriété sémantique à « A été écrit par » et cochez la case indiquant que ce champ peut contenir une liste de valeurs (puisqu'un livre peut avoir plus d'un auteur);
  2. Cliquez sur Ajouter un champ puis pour le second champ entrez les trois valeurs "Genres", "Genre(s)" et "Has genre", et cochez également la case s'il s'agit d'une liste de valeurs;
  3. Cliquez sur Ajoutez un champpuis pour le troisième champ entrez les valeurs "Year", "Year of publication" et "Was published in year";
  4. Cliquez sur Ajouter un champ puis pour le quatrième champ entrez les valeurs "Number of pages", "Number of pages" et "Has number of pages".
  5. Cliquez sur le bouton Créer .

Ensuite, créez le modèle Authors pour les auteurs - en utilisant la page "Créer un modèle" , vous créez le modèle appelé "Author", et vous le rattachez à la catégorie définie "Authors".

Avec Cargo Avec SMW
  1. Ajoutez simplement un champ à ce modèle

pour auquel vous attribuerez trois valeurs "Country", "Country of origin" et "Page".

  1. Cliquez sur le bouton Enregistrer la page.
  1. Ajoutez simplement un champ à ce modèle

pour auquel vous attribuerez trois valeurs "Country", "Country of origin" et "Is from country".

  1. Pour ce modèle, vous remplirez également les champs "Aggregation" du formulaire, car vous voulez que chaque page d'auteur puisse afficher tous les livres que l'auteur a écrits. Sous "Semantic property", sélectionnez "Was written by", et pour "Title for list" mettez "Books by this author".
  2. Cliquez sur le bouton « Enregistrer la page ».

4. Créer les formulaires. Vous devez créer deux formulaires, un pour les livres et un pour les auteurs :

  • Books - en utilisant la page "Créer un formulaire" (sur Special:CreateForm), vous créez un formulaire qui s'appelle "Book", sélectionnez le modèle "Book" et cliquez sur le bouton Ajouter. Vos pouvez aussi si vous le désirez ajouter une section pour l'intrigue du livre - pour cela, ajoutez une section (pas un modèle) appelé "Plot". Vous ne faites aucun personnalisation supplémentaire sur ce formulaire, mais vous l'enregistrez simplement une fois que vous l'avez créé.
  • Authors - en utilisant la page "Créer un formulaire" , vous créez un formulaire appelé "Author", et vous lui ajoutez le modèle "Author". Comme précédemment, ne faites aucune personnalisation supplémentaire - enregistrez simplement la page.

5. Créer les catégories. Vous devez créer deux catégories: une pour les livres et une pour les auteurs; vous avez déjà fourni ces noms de catégories précédemment :

  • Books - en utilisant la page "Créer une catégorie" (sur Special:CreateCategory), vous créez une catégorie appelée "Books", et vous lui attribuez le formulaire par défaut "Book".
  • Authors - en utilisant la page "Créer une catégorie" , vous créez une catégorie appelée "Authors", et vous lui attribuez le formulaire par défaut "Author".

6. Activer les liens vers les formulaires.

Avec Cargo Avec SMW
Dans le text du modèle Book (sur Template:Book), cherchez la portion d'affichage qui contient la balise :
{{{Authors|}}}

Remplacez ceci par quelque chose comme :

{{#arraymap:{{{Authors|}}}|,|x|{{#formredlink:target=x|form=Author}} }}
Le texte du modèle Book (sur Template:Book) contient en général une portion qui ressemble à ceci :
{{#arraymap:{{{Authors|}}}|,|x|[[Was written by::x]]}}

Remplacez ceci par quelque chose comme

{{#arraymap:{{{Authors|}}}|,|x|{{#formredlink:target=x|form=Author}}{{#set:Was written by=x}}}}

Ceci va créer des liens vers les pages des auteurs qui n'existent pas encore, et qui pointent vers les formulaires qui vont permettre de créer ces pages.

7. Ajouter des données. En utilisant le nouveau formulaire "Book" (sur Form:Book), créez quelques pages de livres; vérifiez pour être sûr qu'à la fois le formulaire et les pages de résultat sont cohérentes. Chaque page de livre affiche maintemant un lien en rouge pour l'auteur, qui doit pointer vers le formulaire "Author" permettant d'ajouter cet auteur (il est possible que vous deviez recharger la page pour afficher ce lien). Vous pouvez alors ajouter quelques auteurs, soit en utilisant ces liens, ou bien directement à partir de la page du formulaire, afin de vérifier que ces déclarations fonctionnent également correctement. Chaque page d'auteur créée doit afficher une liste de livres que vous avez enregistrés et pour lesquels cette personne est l'auteur.

8. Ajouter des liens dans la barre latérale et ailleurs. Vos structures sont maintenant toutes configurées, et vous pouvez ajouter des liens dans la barre latérale pour ajouter et afficher plus facilement, en modifiant la page MediaWiki:Sidebar (ou sont équivalent si vous utilisez une langue différente de l'anglais) Vous pouvez ajouter des liens vers les formulaires "Book" et "Author" pour vous aider à en ajouter de nouveaux. Vous pouvez aussi lier Special:Drilldown (si Cargo est installé), ou Special:BrowseData (si l'extension Semantic Drilldown est installée), pour permettre aux utilisateurs de voir l'ensemble des données d'un coup.

Utiliser Page Schemas

L'estension Page Schemas est particulièrement conçue pour la création automatique de structures de données, y compris celle des formulaires. Son gros avantage sur les formulaires des assistants Page Forms standards, est qu'elle peut être utilisée pour créer et modifier ces pages de structures de données plusieurs fois, pas simplement une fois à la création. Elle peut être utilisée seule, ou bien avec soit Cargo ou Semantic MediaWiki s'ils sont installés. Si Cargo et/ou Semantic MediaWiki sont installés, le formulaire Page Schemas contiendra beaucoup de champs supplémentaires permettant de créer les balises additionnelles nécessaires. Pour créer un schéma de page, vous devez aller à la page de catégorie (si elle a déjà été créée ou pas), aller sur l'onglet action pour créer le schéma de cette page, remplir le formulaire, puis aller sur l'onglet action pour générer des pages en se basant sur ce schéma. Pour plus d'information, voir la documentation Page Schemas .

Guides de référence rapides

Il existe deux guides de référence rapide, ou « aide-mémoire », formatés pour l'impression, contenant des informations utiles sur Page Forms (bien que dans les deux cas, ils se réfèrent toujours à cette extension sous le nom « Semantic Forms »), entre autres extensions :

  • Guide de référence rapide Cargo - dans les formats PNG et PDF
  • Guide de référence rapide de Semantic - est disponible ici, au format PNG (image), PDF ou SVG