« Créer un nouvel article » : différence entre les versions

De Wiki Clubelek
Antoine.rochebois (discussion | contributions)
Aucun résumé des modifications
Clementin.granier (discussion | contributions)
mAucun résumé des modifications
 
(7 versions intermédiaires par un autre utilisateur non affichées)
Ligne 1 : Ligne 1 :
== Créer une nouvelle page (formulaire) ==
== Créer une nouvelle page ==
Pour créer une page, rien de plus simple, '''renseignez le nom de la page que vous souhaitez créer dans le champ ci-dessous puis rédigez une première version de votre page !''' (Attention, il n'est pas très facile de changer le titre d'une page...)
Pour créer une nouvelle page, rien de plus simple, '''renseignez le nom de la page que vous souhaitez créer dans le champ ci-dessous puis rédigez une première version !''' (Attention, il n'est pas très facile de changer le titre d'une page par la suite, choisissez bien votre titre)
 


<inputbox>
<inputbox>
Ligne 11 : Ligne 12 :
</inputbox>
</inputbox>


'''<u>Lisez les règles de bonnes pratiques/tutoriels de cette page</u>''' pour associer votre page à la bonne catégorie ou si vous souhaitez en restreindre l'accès à certains membres du Clubelek.


== Règles/tutoriel de conception propres au Wiki du Clubelek ==
 
'''<u>Lisez les règles de bonnes pratiques de cette page</u>''' pour associer votre page à la bonne catégorie et y inclure les bonnes informations.
 
Si vous souhaitez en restreindre l'accès (lecture/écriture) à certains membres du Clubelek, lisez également cette page.
 
 
 
== Règles de conception propres au Wiki du Clubelek ==


=== Une page Wiki n'est pas un "Readme" ! ===
=== Une page Wiki n'est pas un "Readme" ! ===
Un Wiki doit orienter vers toutes les ressources nécessaires pour comprendre un projet. Il ne s'agit pas d'un "pense bête" pour la génération courante mais '''d'un document qui doit être compris 10 ans après, par des personnes qui n'étaient pas sur le projet.'''
Un Wiki doit orienter vers toutes les ressources nécessaires pour comprendre un projet. Il centralise l'ensemble. Il ne s'agit pas d'un "pense bête" pour les personnes travaillant sur le projet mais '''d'un document qui doit être compris 10 ans après, par des personnes qui n'étaient pas sur le projet.''' Dans l'idéal, toutes les informations incluses (ou recensées) dans le Wiki, doivent permettre de reproduire entièrement le projet.
 
Il est donc demandé de '''<u>ne pas multiplier les pages courtes</u>''' mais d'en faire '''<u>une seule par projet</u>''', quitte à ce qu'elle soit très longue ! (e.g. une seule page par participation à la coupe de France de Robotique, avec mention de l'année dans le titre)


Il est donc demandé de '''ne pas multiplier les pages courtes''' mais d'en faire '''une seule par projet''', quitte à ce qu'elle soit très longue ! (e.g. une seule page par robot de la coupe de France de Robotique, avec mention de l'année dans le titre)
Dans l'idéal, '''une page Wiki héberge directement tous les fichiers de conception importants (s'ils ne sont pas trop lourds)''' afin de ne minimiser le risque de perte de données et faciliter l'archivage des données importantes de l'association. A défaut (ou en complément), elle propose les liens vers les repo Gitlab ou dossier Nextcloud des dites ressources.


Dans l'idéal, '''une page Wiki héberge directement tous les fichiers de conception sensibles (s'ils ne sont pas trop lourds)''' afin de ne minimiser le risque de perte de données et faciliter l'archivage des données importantes de l'association. A défaut (ou en complément), il propose les liens vers les repo Gitlab ou dossier Nextcloud des dites ressources.  
=== Une page Wiki doit être reliée à une catégorie ! ===
Médiawiki permet de générer facilement une arborescence des pages, sur laquelle repose largement la navigation de ce Wiki. Cette arborescence est construite autour de la notion de catégorie<ref>https://www.mediawiki.org/wiki/Help:Categories/fr</ref> (les catégories sont également elles mêmes dans d'autres catégories).  


=== Une page Wiki doit être reliée à UNE seule catégorie ! ===
La plupart des pages seront dans une seule catégorie, cependant, vous pouvez relier une page à plusieurs catégories. Pour ne pas compliquer la lecture de l'arborescence, n'attachez pas une page une catégorie "parent" d'une catégorie dans laquelle votre page est déjà. ''Par exemple, vous pouvez attacher un article sur l'asservissement de robots au catégories "Coupe de Robotique > Techniques pour la coupe de robotique" et la catégorie "Articles Techniques de robotique".''
Médiawiki permet de générer facilement une arborescence des pages, sur laquelle repose largement la navigation de ce Wiki. Cette arborescence est construite autour de la notion de catégorie<ref>https://www.mediawiki.org/wiki/Help:Categories/fr</ref> (les catégories sont également elles mêmes dans d'autres catégories). 


'''Il est demandé de n'attacher une page qu'à une seule catégorie''', afin de clarifier la navigation et réduire le risque d'exposer une éventuelle page confidentielle à l'extérieur (si une page est dans 2 catégories et que l'une des 2 catégories n'est pas en accès restreint, la page n'est pas protégée).  
Certaines catégories sont restreintes en lecture et en écriture (''e.g.  [[:Catégorie:Gestion courante (réservé bureau)|Gestion courante (réservé bureau)]]''). Vous pouvez y ajouter votre page si vous souhaitez qu'elle ne soit pas publique. '''Il est demandé de n'attacher les pages non publiques qu'à une seule catégorie''', afin de clarifier la navigation et réduire le risque d'exposer une éventuelle page confidentielle à l'extérieur (si une page est dans 2 catégories et que l'une des 2 catégories n'est pas en accès restreint, la page n'est pas protégée).


==== Ajouter une catégorie à la page ====
== Tutoriels :  Gestions des catégories et restrictions par groupes utilisateurs ==
Pour définir les catégories d'une page, dans l'éditeur de la page (à droite de la barre d'édition du haut, il faut aller dans les "Options de la page" (icone ☰)" puis "Catégories" puis choisir la catégorie adéquate dans la liste déroulante puis cliquer sur "Appliquer les modification". C'est tout ! Votre page devrait désormais apparaitre au bon endroit dans l'arborescence ! (vous pouvez changer la catégorie à tout moment)


'''Si la catégorie que vous souhaitez n'existe pas, créez là au préalable (tutoriel ci-dessous)'''
=== Ajouter une page à une catégorie ===
Pour définir les catégories d'une page, dans l'éditeur de la page, il faut aller dans les '''"Options de la page" (icône ☰) puis "Catégories"''', choisir les catégories adéquates dans la liste déroulante, puis il suffit de cliquer sur "Appliquer les modifications". C'est tout ! Votre page devrait désormais apparaître au bon endroit dans l'arborescence ! (vous pouvez changer les catégories à tout moment)


== Créer des catégories, gérer les restrictions par groupes utilisateurs ==
'''Si la catégorie que vous souhaitez n'existe pas, créez-là au préalable.'''


=== Création de catégorie ===
=== Création de catégorie ===
Une catégorie est '''une page spéciale dont le nom respecte le format <code>Catégorie:<Nom de la catégorie></code>''' où <code><Nom de la catégorie></code> est à remplacer par le nom désiré. Pour créer une nouvelle catégorie, vous pouvez donc utiliser le formulaire ci-dessus et créer une page respectant cette syntaxe.  
Une catégorie est '''une page spéciale dont le nom respecte le format <code>Catégorie:<Nom de la catégorie></code>''' où <code><Nom de la catégorie></code> est à remplacer par le nom désiré. Pour créer une nouvelle catégorie, vous pouvez donc utiliser le formulaire ci-dessus et créer une page respectant cette syntaxe. Dans l'idéal, le nom de la catégorie doit être explicite sans connaitre le nom de la catégorie parent. ''(e.g. ne pas faire "Coupe de France de robotique > Robots" mais "Coupe de France de robotique > Robots de la Coupe de France de Robotique")''


Vous pouvez laisser le contenu de la page de la catégorie vide et enregistrer. La page sera automatiquement mise à jour avec les pages qui seront ajouté à la catégorie.
Vous pouvez laisser le contenu de la page de la catégorie vide et enregistrer. La page sera automatiquement mise à jour avec les pages qui seront ajouté à la catégorie.


'''Votre catégorie doit être reliée à UNE SEULE catégorie parent.'''  
'''Vous DEVEZ associer votre catégorie à une catégorie parent.''' Pour cela, depuis l'édition de la page de la catégorie, suivez la même procédure que pour ajouter une catégorie à une page. '''Si vous jugez que votre catégorie n'appartient à aucune catégorie''' existante, '''vous devez associer à la catégorie "Toutes les catégories" (qui est la racine)'''. Sinon votre catégorie n’apparaîtra pas dans l'arborescence. 


'''Vous DEVEZ associer votre catégorie à une catégorie parent.''' Pour cela, depuis l'édition de la page de la catégorie, suivre la même procédure que pour ajouter une catégorie à une page (détaillée dans la section précédente). '''Si vous jugez que votre catégorie n'appartient à aucune catégorie''' existante, '''vous devez associer à la catégorie "Toutes les catégories"'''. Sinon votre catégorie n'apparaitra pas dans l'arborescence.  
=== Modifier la barre de navigation ===
Pour modifier la barre de navigation, éditez la page [[MediaWiki:Sidebar]]. Plus d'informations sur [[mediawikiwiki:Manual:Interface/Sidebar/fr|la documentation officielle.]] 


=== Restreindre l'accès aux pages d'une catégorie à certains groupes ===
=== Restreindre l'accès aux pages d'une catégorie à certains groupes ===
'''Vous pouvez restreindre l'accès des pages contenues dans certaines catégories à des groupes (de l'authentification centralisée Clubelek) définis.''' Pour celà, créez votre catégorie normalement (essayez de mettre le périmètre de la restriction dans le nom de la catégorie) puis contactez un sysadmin pour qu'il modifie le fichier <code>LocalSettings.php</code> de l'instance Mediawiki sur le serveur afin de mettre à jour les privilèges.
'''Vous pouvez restreindre l'accès des pages contenues dans certaines catégories à des groupes (de l'authentification centralisée Clubelek) définis.''' Pour cela, créez votre catégorie puis contactez un sysadmin pour qu'il modifie le fichier <code>LocalSettings.php</code> de l'instance Mediawiki sur le serveur afin de mettre à jour les privilèges (exemple ci-dessous).


<syntaxhighlight lang="php">
$wgCategoryLockdown['Gestion courante (réservé bureau)']['read'] = ['/bureau', '/sysadmin'];
$wgCategoryLockdown['Gestion courante (réservé bureau)']['read'] = ['/bureau', '/sysadmin'];
$wgCategoryLockdown['Gestion courante (réservé bureau)']['edit'] = ['/bureau', '/sysadmin'];
$wgCategoryLockdown['Gestion courante (réservé bureau)']['edit'] = ['/bureau', '/sysadmin'];
Ligne 52 : Ligne 63 :
$wgCategoryLockdown['Logisitique des événements (réservé membres/anciens)']['read'] = ['/membre-clubelek', '/Anciens'];
$wgCategoryLockdown['Logisitique des événements (réservé membres/anciens)']['read'] = ['/membre-clubelek', '/Anciens'];
$wgCategoryLockdown['Logisitique des événements (réservé membres/anciens)']['edit'] = ['/membre-clubelek', '/Anciens'];
$wgCategoryLockdown['Logisitique des événements (réservé membres/anciens)']['edit'] = ['/membre-clubelek', '/Anciens'];
</syntaxhighlight>
Cette protection repose sur l'extension CategoryLockdown<ref>https://www.mediawiki.org/wiki/Extension:CategoryLockdown</ref>. Comme le détaille la documentation, il faut protéger la catégorie qui contient DIRECTEMENT les pages. Une protection ne marchera pas sur une page qui est contenue dans une catégorie enfant d'une catégorie protégée (si cette catégorie enfant n'est pas explicitement protégée).


Cette protection repose sur l'extension CategoryLockdown<ref>https://www.mediawiki.org/wiki/Extension:CategoryLockdown</ref>. Comme le détaille la documentation, une protection ne marchera pas sur une page qui est contenue dans une catégorie enfant d'une catégorie protégée. Il faut donc protéger la catégorie qui contient DIRECTEMENT les pages. Si cela permet de protéger le contenu des pages, l'architecture de Médiawiki ne permet pas, en l'état, de protéger les images et autres fichiers. '''<u>Il ne faut donc pas mettre en ligne de ressources sensibles et il faut partir du principe que TOUS les fichiers uploadés sont visibles par TOUS.</u>'''
<big>CategoryLockdown permet de protéger le texte des pages, l'architecture de Médiawiki ne permet néanmoins pas, de protéger les images et autres fichiers. '''<u>Il ne faut donc pas mettre en ligne de ressources sensibles et il faut partir du principe que TOUS les fichiers uploadés sont visibles par TOUS.</u>'''</big>

Dernière version du 15 avril 2024 à 13:51

Créer une nouvelle page

Pour créer une nouvelle page, rien de plus simple, renseignez le nom de la page que vous souhaitez créer dans le champ ci-dessous puis rédigez une première version ! (Attention, il n'est pas très facile de changer le titre d'une page par la suite, choisissez bien votre titre)



Lisez les règles de bonnes pratiques de cette page pour associer votre page à la bonne catégorie et y inclure les bonnes informations.

Si vous souhaitez en restreindre l'accès (lecture/écriture) à certains membres du Clubelek, lisez également cette page.


Règles de conception propres au Wiki du Clubelek

Une page Wiki n'est pas un "Readme" !

Un Wiki doit orienter vers toutes les ressources nécessaires pour comprendre un projet. Il centralise l'ensemble. Il ne s'agit pas d'un "pense bête" pour les personnes travaillant sur le projet mais d'un document qui doit être compris 10 ans après, par des personnes qui n'étaient pas sur le projet. Dans l'idéal, toutes les informations incluses (ou recensées) dans le Wiki, doivent permettre de reproduire entièrement le projet.

Il est donc demandé de ne pas multiplier les pages courtes mais d'en faire une seule par projet, quitte à ce qu'elle soit très longue ! (e.g. une seule page par participation à la coupe de France de Robotique, avec mention de l'année dans le titre)

Dans l'idéal, une page Wiki héberge directement tous les fichiers de conception importants (s'ils ne sont pas trop lourds) afin de ne minimiser le risque de perte de données et faciliter l'archivage des données importantes de l'association. A défaut (ou en complément), elle propose les liens vers les repo Gitlab ou dossier Nextcloud des dites ressources.

Une page Wiki doit être reliée à une catégorie !

Médiawiki permet de générer facilement une arborescence des pages, sur laquelle repose largement la navigation de ce Wiki. Cette arborescence est construite autour de la notion de catégorie[1] (les catégories sont également elles mêmes dans d'autres catégories).

La plupart des pages seront dans une seule catégorie, cependant, vous pouvez relier une page à plusieurs catégories. Pour ne pas compliquer la lecture de l'arborescence, n'attachez pas une page une catégorie "parent" d'une catégorie dans laquelle votre page est déjà. Par exemple, vous pouvez attacher un article sur l'asservissement de robots au catégories "Coupe de Robotique > Techniques pour la coupe de robotique" et la catégorie "Articles Techniques de robotique".

Certaines catégories sont restreintes en lecture et en écriture (e.g. Gestion courante (réservé bureau)). Vous pouvez y ajouter votre page si vous souhaitez qu'elle ne soit pas publique. Il est demandé de n'attacher les pages non publiques qu'à une seule catégorie, afin de clarifier la navigation et réduire le risque d'exposer une éventuelle page confidentielle à l'extérieur (si une page est dans 2 catégories et que l'une des 2 catégories n'est pas en accès restreint, la page n'est pas protégée).

Tutoriels : Gestions des catégories et restrictions par groupes utilisateurs

Ajouter une page à une catégorie

Pour définir les catégories d'une page, dans l'éditeur de la page, il faut aller dans les "Options de la page" (icône ☰) puis "Catégories", choisir les catégories adéquates dans la liste déroulante, puis il suffit de cliquer sur "Appliquer les modifications". C'est tout ! Votre page devrait désormais apparaître au bon endroit dans l'arborescence ! (vous pouvez changer les catégories à tout moment)

Si la catégorie que vous souhaitez n'existe pas, créez-là au préalable.

Création de catégorie

Une catégorie est une page spéciale dont le nom respecte le format Catégorie:<Nom de la catégorie><Nom de la catégorie> est à remplacer par le nom désiré. Pour créer une nouvelle catégorie, vous pouvez donc utiliser le formulaire ci-dessus et créer une page respectant cette syntaxe. Dans l'idéal, le nom de la catégorie doit être explicite sans connaitre le nom de la catégorie parent. (e.g. ne pas faire "Coupe de France de robotique > Robots" mais "Coupe de France de robotique > Robots de la Coupe de France de Robotique")

Vous pouvez laisser le contenu de la page de la catégorie vide et enregistrer. La page sera automatiquement mise à jour avec les pages qui seront ajouté à la catégorie.

Vous DEVEZ associer votre catégorie à une catégorie parent. Pour cela, depuis l'édition de la page de la catégorie, suivez la même procédure que pour ajouter une catégorie à une page. Si vous jugez que votre catégorie n'appartient à aucune catégorie existante, vous devez associer à la catégorie "Toutes les catégories" (qui est la racine). Sinon votre catégorie n’apparaîtra pas dans l'arborescence.

Modifier la barre de navigation

Pour modifier la barre de navigation, éditez la page MediaWiki:Sidebar. Plus d'informations sur la documentation officielle.

Restreindre l'accès aux pages d'une catégorie à certains groupes

Vous pouvez restreindre l'accès des pages contenues dans certaines catégories à des groupes (de l'authentification centralisée Clubelek) définis. Pour cela, créez votre catégorie puis contactez un sysadmin pour qu'il modifie le fichier LocalSettings.php de l'instance Mediawiki sur le serveur afin de mettre à jour les privilèges (exemple ci-dessous).

$wgCategoryLockdown['Gestion courante (réservé bureau)']['read'] = ['/bureau', '/sysadmin'];
$wgCategoryLockdown['Gestion courante (réservé bureau)']['edit'] = ['/bureau', '/sysadmin'];
$wgCategoryLockdown['Gestion des infrastructures (réservé bureau/sysadmins)']['read'] = ['/bureau', '/sysadmin'];
$wgCategoryLockdown['Gestion des infrastructures (réservé bureau/sysadmins)']['edit'] = ['/bureau', '/sysadmin'];
$wgCategoryLockdown['Logisitique des événements (réservé membres/anciens)']['read'] = ['/membre-clubelek', '/Anciens'];
$wgCategoryLockdown['Logisitique des événements (réservé membres/anciens)']['edit'] = ['/membre-clubelek', '/Anciens'];

Cette protection repose sur l'extension CategoryLockdown[2]. Comme le détaille la documentation, il faut protéger la catégorie qui contient DIRECTEMENT les pages. Une protection ne marchera pas sur une page qui est contenue dans une catégorie enfant d'une catégorie protégée (si cette catégorie enfant n'est pas explicitement protégée).

CategoryLockdown permet de protéger le texte des pages, l'architecture de Médiawiki ne permet néanmoins pas, de protéger les images et autres fichiers. Il ne faut donc pas mettre en ligne de ressources sensibles et il faut partir du principe que TOUS les fichiers uploadés sont visibles par TOUS.