Wikipédia:LiveRC/Documentation/Installation/fr

(fr)(en)(it)[edit]

Cette page décrit la façon d'installer et de configurer LiveRC sur un autre wiki.

Les indications ci-dessous sont destinées à une installation et une configuration manuelles. Pour une installation et une configuration assistée, il est possible d'utiliser l'extension InstallAndConfigLiveRCExtension.

InstallationModifier

Pour installer LiveRC sur un autre wiki, créer localement une page nommée MediaWiki:Gadget-LiveRC.js (vous devez être administrateur).

Dans cette page, ajouter le code suivant :

window.LiveRC_getSiteCustom = function (){

	// Ici se met la configuration

};
mw.loader.load( '//fr.wikipedia.org/w/index.php?title=MediaWiki:Gadget-LiveRC.js&action=raw&ctype=text/javascript' );

Ajouter ce gadget à à la liste des gadgets locaux (Mediawiki:Gadgets-definition) et sélectionnez-le dans vos préférences, ou mettez-le directement dans votre sous-page personnelle .../common.js.

Purgez le cache de votre navigateur et lancer LiveRC (allez à la page Wikipédia:LiveRC, peu importe si elle n'existe pas).

Une fois que l'interface est visible, ouvrez le panneau de configuration (bouton  ), puis cliquez sur le bouton Configuration MW.
Cela va créer une page nommée Mediawiki:Gadget-LiveRCSiteConfig.js où la configuration de votre wiki sera sauvegardée (cela évite à LiveRC de récupérer ces informations à chaque démarrage au moyen de coûteuses requêtes Ajax sur l'API de mediawiki).

A présent, LiveRC est installé et vous êtes prêt à le configurer pour les spécificités de votre wiki.

ConfigurationModifier

Comme vous avez pu le voir à l'étape "Installation", une fonction LiveRC_getSiteCustom() a été crée dans la page MediaWiki:Gadget-LiveRC.js. Cette fonction, exécutée au démarrage de LiveRC, va permettre de modifier la configuration par défaut qui ne correspond probablement pas à votre wiki. A moins qu'il soit spécifié le contraire, les personnalisations doivent se faire à l'intérieur de la fonction LiveRC_getSiteCustom().

Chaque variable décrite ci-dessous est différente. Pour certaines d'entre elles, vous n'aurez qu'à modifier certains items. Pour d'autres, il faudra modifier la totalité du contenu de la variable. Cela est expliqué dans les chapitres suivants.

Pour chaque variable modifiée, vous devez utilisez la syntaxe suivante, qui prévient d'éventuelles erreurs pouvant faire bugguer la totalité de la configuration :

try{

// Mettre ici la variable modifiée

}catch(e){  }

Descriptions des variablesModifier

lrcParamsModifier

Cette variable regroupe les paramètres de LiveRC.

Vous pourriez avoir besoin d'en modifier certains, par exemple la langue par défaut, ou le titre de la page où LiveRC s'active :

lrcParams["Language"] = 'en';
lrcParams["PageTitle"] = 'MyWiki:LiveRC';

NE PAS MODIFIER LA TOTALITÉ DE LA VARIABLE. Si vous copiez-collez le code de LiveRC, en changeant ce dont vous avez besoin, la totalité de la variable par défaut est écrasée et vous n'aurez pas d'éventuels items ajoutés par la suite. Leur absence pourrait générer des erreurs.

Exemple :

lrcParams = {
    "Language"            : "en", 
    "PageTitle"           : 'MyWiki:LiveRC', 
    "SandboxPage"         : "MyWiki:Sandbox", 
    "WikidataURL"         : "https://www.wikidata.org/wiki/$1",   
    "CommonsURL"          : "//upload.wikimedia.org/wikipedia/commons/",
    "SearchURL"           : "https://duckduckgo.com/?q=$1",
    "TchatURL"            : "https://kiwiirc.com/client/irc.freenode.net/?nick=$2$1",
    "TchatChannel"        : "#wikipedia-en-liverc"
};

Ceci est MAUVAIS, parce que tous les autres items de la variable sont perdus et de nombreuses erreurs sont à prévoir lorsque ces items seront demandés par le programme. Vous devez redéfinir chaque item séparément comme dans le premier exemple.

lrcOptionMenuValuesModifier

Cette variable regroupe les differentes options de LiveRC. Elle commande l'état initial de certains boutons, cases à cocher, sélecteurs, etc...

Pous pouvez avoir besoin d'en modifier certains, par exemple l'état initial de la case "Stop"  :

lrcOptionMenuValues["Stop"] = true;

NE PAS MODIFIER LA TOTALITÉ DE LA VARIABLE. Si vous copiez-collez le code de LiveRC, en changeant ce dont vous avez besoin, la totalité de la variable par défaut est écrasée et vous n'aurez pas d'éventuels items ajoutés par la suite. Leur absence pourrait générer des erreurs.

lrcTextsModifier

Cette variable ne contient que des textes. Leur traduction est faite par un autre moyen.

Si besoin, des textes additionnels peuvent être ajoutés au moyen de la syntaxe suivante :

lrcTexts["MyTextId"] = "MyText";

lrcParamDescModifier

Cette variable ne contient que des textes. Leur traduction est faite par un autre moyen.

Si besoin, des textes additionnels peuvent être ajoutés au moyen de la syntaxe suivante :

lrcParamDesc["MyTextId"] = "MyText";

UnTranslatedTextsModifier

Cette variable ne contient que des textes. Contrairement aux deux autres variables de textes, ceux-ci dépendent du wiki et non de la langue.

Vous pouvez vouloir en modifier certains, par exemple le début du commentaire de modification  :

UnTranslatedTexts["RESUMESTART"] = "[[MyWiki:LiveRC|LiveRC]] : ";

NE PAS MODIFIER LA TOTALITÉ DE LA VARIABLE. Si vous copiez-collez le code de LiveRC, en changeant ce dont vous avez besoin, la totalité de la variable par défaut est écrasée et vous n'aurez pas d'éventuels items ajoutés par la suite. Leur absence pourrait générer des erreurs.

lstAvertoModifier

Cette variable contient la liste des modèles d'avertissement ou de message prédéfinis qui peuvent être envoyés aux utilisateurs via LiveRC.

Chaque item est composé de quatre éléments :

  1. template : le nom du modèle (sans l'espaces de noms)
  2. string : le texte apparaissant dans le sélecteur
  3. hasPage : une option pour ajouter ou non le titre de la page dans le modèle
  4. addName : une option pour ajouter ou non le nom de l'utilisateur (votre nom) dans le modèle
  5. addSectionTitle : une option pour ajouter un titre de section avant le modèle

VOUS DEVEZ REDÉFINIR LA TOTALITÉ DE LA VARIABLE VARIABLE, comme ceci :

lstAverto = [
    { template: "Test 0" , string: "Test 0" , hasPage: true,  addName: true,  addSectionTitle: false  },
    { template: "Test 1" , string: "Test 1" , hasPage: true,  addName: true,  addSectionTitle: false  },
    { template: "Test 2" , string: "Test 2" , hasPage: false, addName: false, addSectionTitle: false  },
    { template: "Test 3" , string: "Test 3" , hasPage: false, addName: false, addSectionTitle: false  }
];

La syntaxe du modèle doit être la suivante :

  • {{Modèle|1=Page|user=User}}

lstBandoModifier

Cette variable regroupe les modèles de bandeaux à ajouter au sommet d'une page.

Chaque item est composé de trois éléments :

  1. template : le nom du modèle (sans l'espace de noms)
  2. string : le texte apparaissant dans le sélecteur
  3. withDate : une option pour ajouter ou non la date dans le modèle. Si vide, le paramètre n'est pas ajouté. Des "mots magiques" permettent de définir le format de la date :
    • $day pour le jour (ici : 25)
    • $month pour le nom du mois (première lettre en minuscule) (ici : septembre)
    • $Month pour le nom du mois (première lettre en majuscule) (ici : Septembre)
    • $year pour l'année (ici : 2022)

VOUS DEVEZ REDÉFINIR LA TOTALITÉ DE LA VARIABLE VARIABLE, comme ceci :

lstBando = [
    { template: "Check admissibility"  , string: "admissibility"  , withDate: "$month $year" },
    { template: "Copyright violation"  , string: "copyvio"        , withDate: ""             },
    { template: "No source"            , string: "No source"      , withDate: "$month $year" }
  ];

La syntaxe du modèle doit être la suivante :

  • {{Modèle|date=ParamDate}}

lstBlankModifier

Cette variable regroupe la liste des commentaires prédéfinis possibles pour le blanchiment d'une page.

Chaque iten est composé de deux éléments :

  1. tooltip : le texte apparaissant dans le sélecteur
  2. resume : le commentaire (en wikitexte)

VOUS DEVEZ REDÉFINIR LA TOTALITÉ DE LA VARIABLE VARIABLE, comme ceci :

lstBlank = [
    {tooltip: "copyvio"      , resume: "copyvio"          },
    {tooltip: "not encyclo"  , resume: "not encyclopedic" },
    {tooltip: "sandbox"      , resume: "sandbox"          },
    {tooltip: "vandalism"    , resume: "vandalism"        }
];

lrcRevertMessagesModifier

Cette variable regroupe la liste des commentaires prédéfinis possibles pour la révocation d'une modification.

Chaque iten est composé de deux éléments :

  1. resume : le commentaire (en wikitexte)
  2. text : le texte apparaissant dans le sélecteur

VOUS DEVEZ REDÉFINIR LA TOTALITÉ DE LA VARIABLE VARIABLE, comme ceci :

lrcRevertMessages = [
    { resume: "Sandbox"               , text: "Sandbox" },
    { resume: "Vandalism"             , text: "Vandalism"  },
    { resume: "no source"             , text: "No source"  },
    { resume: "Automatic translation" , text: "Auto trans"   }
];

lstReportModifier

Cette variable regroupe la liste des paramètres nécessaires à l'outil de signalement, permettant à un utilisateur n'ayant pas certains droits d'effectuer des requêtes sur la page adéquate.

Chaque item est composé de huit éléments :

  1. userright : le droit nécessaire. Si l'utilisateur a ce droit, cet item n'apparaitra pas dans le sélecteur. Pour une requête particulière, vous pouvez définir un droit inexistant, de sorte que l'item apparaitra à tous.
    • Attention : le même droit ne peut être utilisé plusieurs fois.
  2. text : l'identifiant du texte qui apparaît dans le sélecteur (défini dans lrcTexts)
  3. page : la page où se fait la requête. Des "Mots magiques" peuvent être utilisés pour définir une sous-page dépendant de la date :
    • $day pour le jour (ici : 25)
    • $month pour le nom du mois (première lettre en minuscule) (ici : septembre)
    • $Month pour le nom du mois (première lettre en majuscule) (ici : Septembre)
    • $year pour l'année (ici : 2022)
  4. template : le modèle utilisé pour faire la requête
  5. parampage : une option définissant s'il faut ou non ajouter le nom de la page dans le modèle (pour une demande de suppression ou de protection, par exemple)
  6. paramuser : une option définissant si'il faut ajouter ou non le nom de l'utilisateur dans le modèle (pour une demande de blocage, par exemple)
  7. resume : Le commentaire de modification, qui sert également de titre de section ($1 est le nom de la page, $2 est le nom de l'utilisateur)
  8. reasonsdropdownname : un message système contenant des raisons prédéfinies pour ce type de demande (optionnel, si vide, l'utilisateur sera libre d'écrire la raison qu'il souhaite)

VOUS DEVEZ REDÉFINIR LA TOTALITÉ DE LA VARIABLE VARIABLE, comme ceci :

lstReport = [
        {  userright:"delete",
           text:"REPORTING_DELETION",
           page:"MyWiki:Request for deletion/$year/$Month",
           template:"Template:Request for deletion/LiveRC",
           parampage:true,
           paramuser:false,
           resume:"Request for deletion : $1",
           reasonsdropdownname:"deletereason-dropdown"
        },
        {  userright:"anyRight",
           text:"REPORTING_HELP",
           page:"MyWiki:New users forum",
           template:"Template:New user needing help",
           parampage:false,
           paramuser:true,
           resume:"New user need help : $2",
           reasonsdropdownname:""
        }
];

La syntaxe du modèle doit être la suivante :

  • {{Modèle|page=Page|user=User|raison=Raison}}

lrcIconsModifier

Cette variable regroupe les image utilisées par LiveRC.

Chaque item est composé de quatre éléments :

  1. type : est le type d'icône :
    • 0 pour une image simple (valeur par défaut)
    • 1 pour une image en exposant (entourée d'une balise <sup>)
    • 2 pour une image en indice (entourée d'une balise <sub>)
    • -1 pour ne pas afficher du tout l'image
  2. src : le chemin de l'image
    Note : le début de l'URL est défini via le paramètre lrcParams["CommonsURL"]
  3. width : la largeur de l'image, en pixels (optionnel, 14 par défaut)
  4. height : la hauteur de l'image, en pixels (optionnel, si non défini, la valeur de width est appliquée à height)

Vous pouvez vouloir en modifier certains, par exemple l'icône d'un log de type upload (téléversement d'un fichier) :

lrcIcons["UploadIcon"] = {"type":0,
                          "src":"thumb/8/8f/File_upload.svg/16px-File_upload.svg.png",
                          "width":16
}

NE PAS MODIFIER LA TOTALITÉ DE LA VARIABLE. Si vous copiez-collez le code de LiveRC, en changeant ce dont vous avez besoin, la totalité de la variable par défaut est écrasée et vous n'aurez pas d'éventuels items ajoutés par la suite. Leur absence pourrait générer des erreurs.

commenttestsModifier

Cette variable regroupe les paramètres permettant de définir des test, à base d'expression rationnelle, pour détecter certains types de commentaires et marquer la modification, soit via une icône (dans la dernière colonne des RC), soit via une classe CSS qui va influer sur la couleur ou la bordure des cases de la ligne RC. Ces tests sont utilisables pour filtre les RC via la checklist qui apparaît au survol de la case RC de la barre de contrôle des RC.

Chaque item est composé de cinq éléments :

  1. state : Variable d'état, interne à LiveRC. Généralement tout en majuscule. Sauf si cela est expressément voulu, cette variable devrait être différentes de toutes les autres variables de ce type utilisées par LiveRC
  2. icon : Identifiant de l'icône à ajouter dans la dernière colonne des RC (facultatif)
  3. class : Classe à ajouter à la ligne des RC (facultatif)
  4. regex : Expression rationnelle pour le test du commentaire de modification (wikitexte)
  5. hide : État initial de la case correspondante dans la checklist RC

Vous pouvez avoir besoin de modifier les Expressions rationnelles pour coller aux résumés de modifs de votre wiki.

VOUS DEVEZ REDÉFINIR LA TOTALITÉ DE LA VARIABLE VARIABLE, comme ceci :

commenttests = [
    { state: "REVERT"     , icon:"RevertIcon",           class:"RcRevert",           hide:false, regex: "(LiveRC : )?Révocation |([Bb]ot : )?[Aa]nnulation des modifications|([Bb]ot : )?[Rr]évocation de |^(Undid|Revert to( the)?) revision|^(Undoing|Reverted( \d+)?) edit|^r(e)?v(ert(ing|ed)?)?\b|LiveRC : Blanchiment"},
    { state: "BLANKING"   , icon:"BlankingIcon",         class:"RcBlanking",         hide:false, regex: "^Résumé automatique : blanchiment|^[Bb]lanchi"},
    { state: "REPLACED"   , icon:"ReplacedIcon",         class:"RcReplaced",         hide:false, regex: "^Résumé automatique : contenu remplacé par"},
    { state: "REDIRECTED" , icon:"RedirectedIcon",       class:"RcRedirected",       hide:false, regex: "^Page redirigée vers|^#REDIRECT" },
    { state: "WPCLEANER"  , icon:"WPCIcon",              class:"RcWPC",              hide:false, regex: "(WPCleaner|Correction syntaxique)"},
    { state: "AWB"        , icon:"AWBIcon",              class:"RcAWB",              hide:false, regex: "(AWB|AutoWikiBrowser)"},
    { state: "B_PORTAIL"  , icon:"BandeauxPortailsIcon", class:"RcBandeauxPortails", hide:false, regex: "BandeauxPortails"},
    { state: "B_EBAUCHE"  , icon:"BandeauxEbauchesIcon", class:"RcBandeauxEbauches", hide:false, regex: "BandeauxEbauches"},
    { state: "HOTCAT"     , icon:"HotCatIcon",           class:"RcHotCat",           hide:false, regex: "(HotCatsMulti|HotCat)"},
    { state: "LRC"        , icon:"LRCIcon",              class:"RcLRC",              hide:false, regex: "(Live|Patrouille) *(RC)?"},
    { state: "POPUPS"     , icon:"PopupsIcon",           class:"RcPopups",           hide:false, regex: "popups" },
    { state: "CATRENAME"  , icon:"CatRenameIcon",        class:"RcCatRename",        hide:false, regex: "Renommage de catégorie"}
];

templatestestsModifier

Cette variable regroupe les paramètres permettant de marquer certaines modifications selon l'inclusion ou nom d'un modèle dans la page. Le marquage se fait soit via une icône (située juste devant le titre de la page), soit via une classe CSS qui va influer sur la couleur ou la bordure des cases de la ligne RC.

Chaque item se compose de quatre éléments :

  1. state : Variable d'état, interne à LiveRC. Généralement tout en majuscule. Sauf si cela est expressément voulu, cette variable devrait être différentes de toutes les autres variables de ce type utilisées par LiveRC
  2. icon : Identifiant de l'icône à ajouter devant le titre de la page (facultatif)
  3. class : Classe à ajouter à la ligne des RC (facultatif)
  4. template : Le nom du modèle à tester (sans l'espace de noms)

VOUS DEVEZ REDÉFINIR LA TOTALITÉ DE LA VARIABLE VARIABLE, comme ceci :

templatestests = [
    { state: "PORTAIL"    , icon:""             , class:"RcPortail",   template: "Méta lien vers portail"          },
    { state: "RECENT"     , icon:"RecentIcon"   , class:"RcRecent",    template: "Méta bandeau d'événement récent" },
    { state: "R3R"        , icon:"R3RIcon"      , class:"RcR3R",       template: "Règle des 3 révocations"         },
    { state: "PAS"        , icon:"PaSIcon"      , class:"RcPaS",       template: "Suppression"                     },
    { state: "COPYRIGHT"  , icon:"CopyrightIcon", class:"RcCopyright", template: "Copie de site"                   },
    { state: "COPYRIGHT"  , icon:"CopyrightIcon", class:"RcCopyright", template: "Copie à vérifier"                },
    { state: "COPYRIGHT"  , icon:"CopyrightIcon", class:"RcCopyright", template: "Copyrighté"                      },
    { state: "COPYRIGHT"  , icon:"CopyrightIcon", class:"RcCopyright", template: "Texte copyvio"                   },
    { state: "COPYRIGHT"  , icon:"CopyrightIcon", class:"RcCopyright", template: "Image copyvio"                   },
    { state: "COPYRIGHT"  , icon:"CopyrightIcon", class:"RcCopyright", template: "Synopsis"                        }
];

categoriestestsModifier

Cette variable regroupe les paramètres permettant de marquer certaines modifications selon l'appartenance de la page à une catégorie particulière. Le test se fait via une expression régulière. Le marquage se fait soit via une icône (située juste devant le titre de la page), soit via une classe CSS qui va influer sur la couleur ou la bordure des cases de la ligne RC

Chaque item se compose de quatre éléments :

  1. state : Variable d'état, interne à LiveRC. Généralement tout en majuscule. Sauf si cela est expressément voulu, cette variable devrait être différentes de toutes les autres variables de ce type utilisées par LiveRC
  2. icon : Identifiant de l'icône à ajouter devant le titre de la page (facultatif)
  3. class : Classe à ajouter à la ligne des RC (facultatif)
  4. regex : Expression rationnelle pour le test sur le nom des catégories de la page

VOUS DEVEZ REDÉFINIR LA TOTALITÉ DE LA VARIABLE VARIABLE, comme ceci :

categoriestests = [
    { state: "ADQ"       , icon:"AdQIcon"      , class:"RcADQ",       regex: 'Article de qualité( contesté|)$'                },
    { state: "BA"        , icon:"BAIcon"       , class:"RcBA",        regex: 'Bon article$'                                   },
    { state: "APDQ"      , icon:"APDQIcon"     , class:"RcAPDQ",      regex: 'Article potentiellement (bon|de qualité)'       },
    { state: "STUB"      , icon:"StubIcon"     , class:"RcStub",      regex: 'Wikipédia:ébauche'                              },
    { state: "COPYRIGHT" , icon:"CopyrightIcon", class:"RcCopyright", regex: 'Article soupçonné de travail sous copyright'    },
    { state: "PAS"       , icon:"PaSIcon"      , class:"RcPaS",       regex: 'Page proposée à la suppression'                 }
];

watchCategoriesModifier

Cette variable regroupe les paramètres permettant de marquer certaines modifications selon l'appartenance de l'utilisateur à une catégorie particulière. Le marquage se fait soit via une icône (située juste devant le nom de l'utilisateur), soit via une classe CSS qui va influer sur la couleur ou la bordure des cases de la ligne RC

Chaque item se compose de quatre éléments :

  1. state : Variable d'état, interne à LiveRC. Généralement tout en majuscule. Sauf si cela est expressément voulu, cette variable devrait être différentes de toutes les autres variables de ce type utilisées par LiveRC
  2. icon : Identifiant de l'icône à ajouter devant le titre de la page (facultatif)
  3. class : Classe à ajouter à la ligne des RC (facultatif)
  4. category : La catégorie à tester, sans l'espace de noms

VOUS DEVEZ REDÉFINIR LA TOTALITÉ DE LA VARIABLE VARIABLE, comme ceci :

watchCategories = [
    { state: "SCOLARIP"      , icon:"ScolarIPIcon"      , class:"RcScolarIP",      category: "Adresse IP scolaire"                  },
    { state: "SHAREDIP"      , icon:"SharedIPIcon"      , class:"RcSharedIP",      category: "Adresse IP partagée"                  },
    { state: "COPYRIGHTUSER" , icon:"CopyrightUserIcon" , class:"RcCopyrightUser", category: "Utilisateur enfreignant un copyright" },
    { state: "PEDIAPROJECT"  , icon:"PediaProjectIcon"  , class:"RcPediaProject",  category: "Utilisateur projet pédagogique"       }
];

lrcExtensionsModifier

Cette variable est la liste des extensions de LiveRC disponibles dans le menu de configuration.

Chaque item correspond à une extension et est composé de quatre éléments :

  1. name : Le nom de l'extension (doit être unique)
  2. url : L'URL d'où l'extension peut être chargée
  3. desc : La description par défaut de l'extension (la traduction de ce texte peut se faire via la méthode décrite dans Wikipédia:LiveRC/Documentation/Traduction/fr)
  4. neededright : un droit mediawiki nécessaire pour l'extension. Si précédé d'un point d'exclamation, l'extension ne fonctionne que si l'utilisateur n'a pas ce droit

NE PAS MODIFIER LA TOTALITÉ DE LA VARIABLE

  • Si vous souhaitez ajouter une extension, utilisez cette syntaxe :
var MyExtension = {
  "name"        : "ProposeTranslationExtension",
  "url"         : "//fr.wikipedia.org/w/index.php?title=MediaWiki:Gadget-LiveRC.js/Extensions/ProposeTranslationExtension.js",
  "desc"        : "Ajoute un formulaire pour proposer une traduction de l’interface.",
  "neededright" : ""
}
LiveRC_AddNewExtension(MyExtension);
  • Si vous souhaitez supprimer une extension, utilisez cette syntaxe :
LiveRC_DeleteExtension("ProposeTranslationExtension");

lrcCSSstylesModifier

Cette variable regroupe les styles CSS pouvant être personnalisés.

Comme ils sont liés aux styles CSS de LiveRC, cette variable ne devrait pas être modifiés, sauf à savoir très exactement ce que vous faîtes.

La traduction des descriptions des différents styles est gérée par la méthode décrite dans Wikipédia:LiveRC/Documentation/Traduction/fr

lrcSupprLineParamsModifier

Cette variable regroupe les paramètres utilisés pour créer les boutons de suppression de lignes RC dans la barre de contrôle des RC.

Chaque item se compose de quatre éléments :

  1. textid : Identifiant du texte de l'infobulle du bouton
  2. color : Couleur de la croix dans le bouton
  3. class : Classe des lignes à supprimer lors du clic sur le bouton (voir par exemple MediaWiki:Gadget-LiveRC.css/Test)
  4. separator : Séparateur ajouté à la suite du bouton (facultatif)

VOUS DEVEZ REDÉFINIR LA TOTALITÉ DE LA VARIABLE VARIABLE, comme ceci :

lrcSupprLineParams = [
  {textid:"HIDE_ALL"      , color:"red"              , class:"*"          , separator:"|" },
  {textid:"HIDE_REVIEWED" , color:"rgb(255,235,71)"  , class:"RcChecked"  , separator:""  },
  {textid:"HIDE_REVERTS"  , color:"rgb(255,99,83)"   , class:"RcRevert"   , separator:""  },
  {textid:"HIDE_NEW"      , color:"rgb(178,243,113)" , class:"RcNew"      , separator:""  },
  {textid:"HIDE_BLANKING" , color:"white"            , class:"RcBlanking" , separator:""  },
  {textid:"HIDE_LOG"      , color:"blue"             , class:"RcLog"      , separator:""  }
];

Note : la première ligne, qui permet de tout supprimer, devrait être conservée

Autres configurationsModifier

Configurations préalablesModifier

Contrairement aux autres configurations, ces personnalisations doivent être effectuées AVANT l'appel du code de LiveRC et EN DEHORS de la fonction LiveRC_getSiteCustom(). Il est de plus nécessaire de déclarer la variable globale LiveRC_Config, qui à ce stade n'existe pas encore.

Une installation de ce type se fait avec la syntaxe suivante :

/* ===== Configurations préalables ===== */

window.LiveRC_Config = {};
LiveRC_Config.SiteConfigPage = 'User:MyName/LiveRCSiteConfig.js'; // Page de stockage de la config locale
LiveRC_Config.CSSPage = 'User:MyName/LiveRCSiteConfig.css';       // Page de stockage du css local
LiveRC_Config.UserParamPage = '/LiveRCPersonalConfig';            // Sous-page utilisateur de stockage des personnalisations

/* ===== Configurations postérieures ===== */

window.LiveRC_getSiteCustom = function (){

	// Ici se met le reste de la configuration

}

/* ===== Récupération de LiveRC ===== */

mw.loader.load('//fr.wikipedia.org/w/index.php?title=MediaWiki:Gadget-LiveRC.js&action=raw&ctype=text/javascript');
Page de la configuration localeModifier

La page où se trouve la configuration locale (par défaut, Mediawiki:Gadget-LiveRCSiteConfig.js) peut être modifiée. Cela est utile par exemple sur un wiki où vous n'avez pas les droits nécessaires pour éditer l'espace de noms MediaWiki: Il est alors possible de choisir une page de l'espace Utilisateur: et si LiveRC détecte que c'est une de vos sous-page, le bouton Configuration MW apparaîtra (il apparaîtra aussi aux administrateur utilisant le code, puisque ils ont théoriquement le droit de modifier les .js des autres utilisateurs).

La page doit impérativement se terminer par .js, sans quoi n'importe qui pourra la modifier.

Page de stockage du css localModifier

La page où se trouve le css local (par défaut, MediaWiki:Gadget-LiveRC-local.css) peut être modifiée. Cela est utile par exemple sur un wiki où vous n'avez pas les droits nécessaires pour éditer l'espace de noms MediaWiki: Il est alors possible de choisir une page de l'espace Utilisateur:.

La page doit impérativement se terminer par .css, sans quoi n'importe qui pourra la modifier.

Sous-page utilisateur de stockage des personnalisationsModifier

La sous-page utilisée pour sauvegarder les configurations personnelles (par défaut, /LiveRCparam) peut être modifiée.

L'extension de la sous-page est automatiquement ajoutée lorsque nécessaire, suivant qu'il s'agit de javascript (.js) ou de CSS (.css), il est donc inutile de l'ajouter.

Configurations postérieuresModifier

Ces personnalisation doivent être effectuées À L’INTÉRIEUR de la fonction LiveRC_getSiteCustom().

ID du contenuModifier

Suivant le skin utilisé, l'identifiant de l'élément qui contient le contenu d'une page change. La variable LiveRC_Config["PageContentIds"] définit les identifiants qui doivent être recherchés.

Si le site d'installation propose des skins supplémentaires il peut être nécessaire d'ajouter un ou plusieurs identifiants à la liste.

  • Un identifiant peut s'ajouter à la liste avec la syntaxe suivante :
  /* Identifiants contenu de page  */
  LiveRC_Config["PageContentIds"].push("mynewid");
Catégories de suiviModifier

LiveRC peut marquer les modifications faites sur les pages appartenant à ces catégories via un icône particulier. La liste des catégories est disponible via la page spéciale Special:TrackingCategories. La liste se compose en réalité des messages système (2e colonne du tableau) dont le contenu définit la catégorie correspondante. Ne lister que les messages des catégories qui sont activées (l'existence ou non de la page de catégorie n'a pas d'importance).

  • Exemple de syntaxe :
    // Catégories de suivi ([[Special:TrackingCategories]])
  LiveRC_Config["TrackingCategories"] = [
    "expensive-parserfunction-category",
    "post-expand-template-argument-category",
    "post-expand-template-inclusion-category",
    "hidden-category-category",
    "broken-file-category",
    "node-count-exceeded-category",
    "expansion-depth-exceeded-category",
    "score-error-category",
    "massmessage-list-category",
    "commonsmetadata-trackingcategory-no-license",
    "commonsmetadata-trackingcategory-no-description",
    "commonsmetadata-trackingcategory-no-author",
    "commonsmetadata-trackingcategory-no-source",
    "geodata-broken-tags-category",
    "geodata-unknown-globe-category",
    "geodata-unknown-region-category",
    "geodata-unknown-type-category",
    "scribunto-common-error-category",
    "scribunto-module-with-errors-category"
  ];
Filtrage par groupe d'utilisateursModifier

Il est possible de définir différents groupes d'utilisateurs :

  • La liste des membres est récupérée au démarrage de LiveRC (ne pas choisir un groupe dont les membres sont trop nombreux pour ne pas trop ralentir le démarrage de LiveRC).
  • Les lignes RC peuvent être stylées selon une classe particulière
  • Les modifications faites par les utilisateurs membres des groupes peuvent être affublées d'une icône particulière
  • Le filtrage des RC par utilisateur peut se faire par groupe

LiveRC propose en natif deux groupes : sysop et bot.


L'exemple ci-dessous définit un nouveau groupe nommé patroller (patrouilleur).

Notes :

  • La variables LiveRC_Config["UserGroupList"] est entièrement redéfinie afin de conserver le groupe bot en fin de liste.
  • Si aucun icône n'est souhaité, définir l'item type à -1
  • La définition de styles pour la classe associée au groupe d'utilisateurs est facultative
  • Noter la casse de la première lettre du groupe : minuscule pour LiveRC_Config["UserGroupList"] (sauf si défini différemment dans l'installation Mediawiki), majuscule dans les autres cas.


Dans la configuration javascript, au sein de la fonction LiveRC_getSiteCustom() :
   // Listes d'utilisateurs locaux par groupe
  LiveRC_Config["UserGroupList"] = {
    "patroller" : { list : [], show : true  },
    "sysop"     : { list : [], show : false },
    "bot"       : { list : [], show : false },
  };

   // Icône
  lrcIcons["PatrollerIcon"] = {
      type:0,
      src:"thumb/5/5d/Gnome-stock_person_target.svg/16px-Gnome-stock_person_target.svg.png",
      width:16,
      height:16
  };

   // Textes (textes par défaut : demander éventuellement une traduction sur [[Discussion MediaWiki:Gadget-LiveRC.js]])
  lrcTexts['PatrollerIcon_Title'] = 'Patrouilleur';
  lrcParamDesc['DescPatrollerIcon'] = 'Patrouilleur';
  lrcParamDesc['DescPatrollerIcon_Title'] = 'Infobulle de l’icône RC d’un patrouilleur';

   // Classe personnalisable (facultatif)
  lrcCSSstyles.push({
     target:".RcPatroller .td2RC",
     style:"background-color:#a2a2a2;",
     desc:"Ligne RC : Utilisateur patrouilleur" // (texte par défaut : demander éventuellement une traduction sur [[Discussion MediaWiki:Gadget-LiveRC.js]])
  });
Dans le CSS local ou un fichier .css à appeler en même temps que le gadget avec la méthode mw.loader.load() :
   /* Classe personnalisable (facultatif) */

/* Ligne RC : Utilisateur patrouilleur */
.RcPatroller .td2RC {
  background-color:#a2a2a2;
}
Extension Flagged revisionsModifier

Si l'extension mediawiki Extension:FlaggedRevs est installée sur votre wiki, il est nécessaire d'en définir la configuration pour que LiveRC s'y adapte. Deux variables sont nécessaires :

  • LiveRC_Config["FlagRevNamespaces"] : indique dans quels espaces de noms l'extension est active. Ce paramètre correspond à la variable PHP $wgFlaggedRevsNamespaces.
  • LiveRC_Config["FlagRevProtection"] : indique si l'outil de modification de statut de validation est intégré à l'outil de protection ou si il passe par une page spéciale dédiée, Special:Stabilization. Ce paramètre correspond à la variable PHP $wgFlaggedRevsProtection

Pour un wiki de la Wikimedia Fundation, voir ce fichier de configuration pour connaître les valeurs nécessaires.

La syntaxe à utiliser est la suivante, ici avec les valeurs par défaut de l'extension :

  /* Flagged Revisions  */
  LiveRC_Config["FlagRevNamespaces"] = new Array(0, 6, 10, 828);   // Liste des namespaces où la validation est active
  LiveRC_Config["FlagRevProtection"] = false;                      // Stabilisation intégrée à l'outil de protection
Extension FlowModifier

Si l'extension mediawiki Extension:Flow est installée sur votre wiki, il est nécessaire d'en définir la configuration pour que LiveRC s'y adapte. Trois variables sont nécessaires :

  • LiveRC_Config["FlowOccupyPages"] : indique sur quelles pages l'extension est active. Ce paramètre correspond à la variable PHP $wgFlowOccupyPages.
  • LiveRC_Config["FlowOccupyNamespaces"] : indique dans quels espaces de noms l'extension est active. Ce paramètre correspond à la variable PHP $wgFlowOccupyNamespaces.
  • LiveRC_Config["FlowCoreActionWhitelist"] : indique quelles actions sont permises dans les pages où l'extension est active. Ce paramètre correspond à la variable PHP $wgFlowCoreActionWhitelist

Pour un wiki de la Wikimedia Fundation, voir ce fichier de configuration pour connaître les valeurs nécessaires.

La syntaxe à utiliser est la suivante, ici avec les valeurs par défaut de l'extension :

  /* Flow  */
  LiveRC_Config["FlowOccupyPages"] = []; // Liste des pages où flow est actif    
  LiveRC_Config["FlowOccupyNamespaces"] = [2600]; // Liste des namespaces où flow est actif    
  LiveRC_Config["FlowCoreActionWhitelist"] = ['info', 'history', 'protect', 'unprotect', 'unwatch', 'watch']; // Actions permises sur les pages où flow est actif
AutresModifier

La variable de configuration globale LiveRC_Config["CustomCatTemplate"] est utilisée par LiveRC pour catégoriser les différentes pages .css ou .js créées automatiquement, que ce soit les sous-pages de personnalisation ou les pages de traduction créées par l'extension ProposeTranslation

Par défaut, sa valeur est "Catégorisation JS", ce qui correspond au modèle {{Catégorisation JS}}.