Wikipédia:LiveRC/Documentation/Configuration/en

1.0.5 m

Documentation

ToDo

Sources

Extensions

Traductions

Newsletter

Discussion

This page describe the way that users can customize LiveRC throught the configuration panel, and the purpose of the different tabs it provides.

• For the initial configuration after an installation on another wiki, see Wikipédia:LiveRC/Documentation/Installation/en.

Overview

Since version 0.4.5, many LiveRC settings can be customizables automatically. You just have to clic the button .

The config panel is divided in tabs, each one being a reflect of a customizable list of variables. Then, texts, starting options, icons, etc, can be fully customizable. For some variables, supplemental links are provided to add or remove items in the variable list.

The config panel can manage also the watched users list and the hidden users list, the installation of LiveRC extension and the customization of some CSS styles.

Some extensions may add more params to the config panel for the customization of their own variable lists.

Sysops also have another button, named Configuration MW. It permit to update from the MediaWiki API the informations of the local configuration needed by LiverC (system messages, available extensions, namespaces, etc...). By default, they are stored on the page called MediaWiki:Gadget-LiveRCSiteConfig.js, loaded with LiveRC, to avoid a systematic API request to get these informations.

Tabs descriptions

The pictures may be different of the actual rendering of LiveRC

Tabs

A particular tab, named Tabs, permit to choose wich tabs must be show when openning the configuration panel.

The default state of these options is the following one (checked = shown):

•  : LiveRC params (Params)
•  : Control panel options (Options)
•  : Blanking reasons for automatic blanking tool (Blanking)
•  : Rollback reasons for automatic rollback tool (Rollback)
•  : Message templates for automatic warning tool (Message)
•  : Tag templates for automatic tagging tool (Tags)
•  : Params for automatic reporting tool (Report)
•  : Icons used by LiveRC (Icons)
•  : Translatable texts (Texts 1)
•  : LiveRC params descriptions (Texts 2)
•  : Untranslatables texts (Texts 3)
•  : Extensions list (Extensions list)
•  : Params for comment tests (Comment test)
•  : Params for templates tests (Templates test)
•  : Params for page categories tests (Page categories test)
•  : Params for user categories tests (User categories test)
•  : Params for "Delete lines" buttons (Delete lines)
•  : Watched users list (Watched users)
•  : Hidden users list (Hidden users)
•  : Hidden pages list (Hidden pages)
•  : (Un)install LiveRC extensions ((Un)install extensions)
•  : CSS styles (CSS styles)

Notas:

• Some LiveRC extensions may add tabs to this list.
• Logically, the option « Show/hide config panel tabs », corresponding to the Tabs tab, is always checked and not editable.

LiveRC params

Params

• en : Interface language

  Lang code of the interface language, to be choosen à choisir among the languages supported by LiveRC. By default, this param matches the Mediawiki language. All languages are not available (see Wikipédia:LiveRC/Documentation/Traduction/en). If the translations in the choosen language are not available, the interface will be in english.

• Wikipédia:LiveRC : Page where LiveRC is launched

  Complete name of the page where LiveRC is active. You can use any other page, even if it doesn't exists.

• Wikipédia:Bac à sable : Local sandbox page

  Complète name of the local "Sandbox" page, where a "vandalism" don't need to be reverted.

• https://www.wikidata.org/wiki/$1 : Wikidata URL

  You can use another database

• //upload.wikimedia.org/wikipedia/commons/ : Images repository URL

  This param is user to show icons. You can choose another repository

• https://duckduckgo.com/?q=$1 : External search URL

  You can choose another search engine, for example for Google:

  https://www.google.com/#q=$1 (the $1 string is the position of the researched words)

• https://kiwiirc.com/client/irc.freenode.net/?nick=$2$1 : Tchat URL

  You can choose another chat. $1 is the channel position, $2 is the user name position

• #wikipedia-fr-liverc : Tchat channel

  You can choose another channel, for example #vandalism-en-wp

• 250px : Mini-diff height

  This param sets the maximum height of the mini-diff window.

• 250px : Preview window height

  This param sets the default height of the preview window. Then this height can be changed by drag and drop.

• 250px : History window height

  This param sets the default height of the preview history window. Then this height can be changed by drag and drop.

• 250px : Search window height

  This param sets the default height of the search window. Then this height can be changed by drag and drop.

• 350px : Tchat window height

  This param sets the default height of the search window. Then this height (together with the width) can be changed by drag and drop.

• 100px : Special logs heights

  This param sets the default height of the special logs heights. Then these heights can be changed by drag and drop.

•     : Time zone

  This param permit to add a time offset to the edits timestamps (+02:00, 02:00, -02:00, -05:00, ...).

•                                              : Languages for shown langlinks (example: « de|en|es|fr|it »)

  This param permit to set which langlinks will be always shown in the RC lines

• 30 : Max RC lines

  This param sets the maximum RC lines shown in the RC table. If there is more, the oldest are deleted. Notifications lines are not counted. Beware, a big number will make LiveRC starting heavier.

• 10 : RC refrech delay

  Ce paramètre détermine le délai entre deux rafraichissement des RC, c'est à dire la fréquence à laquelle des requêtes sont régulièrement envoyées au serveur pour prendre connaissance des dernières RC.

• 0 : Max length for page names

  This param can set a limit for page names in RC lines. If the limit is reached, the page name is truncated. Set to 0 to disable this feature.

• 0 : Max length for user names

  This param can set a limit for user names in RC lines. If the limit is reached, the user name is truncated. Set to 0 to disable this feature.

• 5 : Watchers limit between levels 1 and 2

  This param sets the frontier between pages with "few" watchers (orange icon) and "average" watchers (yellow icon). Only used for sysops, because for non-sysop there is a mediawiki limitation about this feature and the limit between ""few" and "enought" is automatically set to 30.

• 10 : Watchers limit between levels 2 and 3

  This param sets the frontier between pages with "average" watchers (yellow icon) and "enought" watchers (green icon). Only used for sysops, because for non-sysop there is a mediawiki limitation about this feature and the limit between ""few" and "enought" is automatically set to 30.

•  : Bold edit comments

  If this param is checked, edit comments will be bolded

•  : Load bot & sysop list (expensive at loading)

  If this param is unchecked, LiveRC won't request the list of bots and sysops.

•  : Load watched pages and users (expensive at loading)

  If this param is unchecked, LiveRC won't request the watchlist, so that watched and hidden users list will be empty, and watched pages won't be detected if the param « Load page infos (expensive) » is not checked.

•  : Load user categories (expensive at loading)

  If this param is unchecked, LiveRC won't request the user categories members, so that these users won't be detected.

•  : Load block log (expensive at loading)

  If this param is unchecked, LiveRC won't request the last blocks, so that recently blocked users won't be detected.

•  : Load page infos (expensive)

  If this param is unchecked, this avoid LiveRC to request infos about every edited page, but many informations will be missing : templates used, categories, lang links, protection status, watchers number, etc...

•  : Use mini-diff (very expensive)

  If this param is checked, a window appears under each RC lines of these types : Diff, New, Filter, Feedback and Upload. This window permit a first quick check of the RC.

•  : Show notifications

  If this param is checked, notifications about the user are show in the RC table

•  : Show pages langlinks

  If this param is checked, lang links are shown near the page title.

•  : Keep all lines in RC list

  If set, this param permit to by-pass the RC limit. All edits shown are kept forever (unless you delete them manually).

•  : Invert RC apparitions

  If this param is checked, new RC appears at the bottom of the RC table instead of at the top.

•  : Delete a line after diff preview

  If set, this param permit to automatically delete a RC line after a click on a Diff link (or any links with different text at the same position).

•  : Preload diffs

  If this param is set, the "next" diff is preloaded while you see the previous one.

•  : Subst message templates

  If set, the templates used for messages or warning on user talk pages are substed

•  : Do not automatically add pages I edit to my watchlist

  If set, the page you edit won't be automatically added to your watchlist, whatever you set in your Mediawiki preferences

Options

This tab permit to change initial states for LiveRC components : show or not the different windows, (un)check checkboxes, etc...

Components show status

•  : Show LiveRC interface
•  : Show RC table
•  : Show tchat window
•  : Show preview window
•  : Show special logs
  •  : Show Abusefilter log (if extension Abuse Filter available)
  •  : Show Spamblacklist log (if extension SpamBlacklist available)
  •  : Show reverts log
  •  : Show new users log
  •  : Show watched users log
  •  : Show hidden users log
  •  : Show watchlist log
  •  : Show new pages log
  •  : Show pending changes log (if extension Flagged Revisions available)
  •  : Show feedback log (if extension ArticleFeedbackv5 available)
•  : Show debug panel

RC control bar

•  : "Stop" checkbox initial state
•  : "Mini-diff" checkbox initial state
•  : "RC" checkbox initial state
  •  : "Normal edits" checkbox initial state
  •  : "Minor edits" checkbox initial state
  •  : "New pages" checkbox initial state
  •  : "Wikidata edits" checkbox initial state
•  : "Logs" checkbox initial state
  •  : "XXX log" checkbox initial state (the number of checkboxes and their title depends on the locally available log types)
•  : "Watched pages" checkbox initial state (RC & Logs)
•  : "Not watched pages" checkbox initial state (RC & Logs)
•  : "Namespaces" checkbox initial state
  •  : "Namespace" checkbox initial state : XXX (the number and the names of the checkboxes depends on the locally available namespaces)
•  : "Users" checkbox initial state
  •  : "IP" checkbox initial state
  •  : "Registred users" checkbox initial state (non autopattrolled only)
  •  : "Newbies" checkbox initial state (autopattrolled only)
  •  : "Autopatrolled users" checkbox initial state (autopattrolled only)
  •  : "Authorized bots" checkbox initial state

• •  : "Always show my own edits" checkbox initial state

• •  : "Always show watched users" checkbox initial state

• •  : "Always show my watchlist" checkbox initial state

• •  : "Always show reverts" checkbox initial state

• •  : "Always show blankings" checkbox initial state

• •  : "Always show text replacements" checkbox initial state

• •  : "Always hide edits of a user on his own sub-pages" checkbox initial state

Icons

In this tab are listed all images used by LiveRC.

Each item is made of four things :

1. type : is the type of icon :
   • img for a simple image (default value)
   • sup for an image surrounded by a <sup> tag
   • sub for an image surrounded by a <sub> tag
   • no, for no icon at all
2. src : is the path of the image

   Note : the beginning of the image URL is set in lrcParams["CommonsURL"]

3. width : the image width, in pixels (optionnal, default is 14)
4. height : the image height, in pixels (optionnal, if not set the value of width is applied to height)

It is possible to add new icons using the (+) at the end of the list. It opens a form where you can set :

• The image ID
• The tooltip text

The two fields must be set, and the ID must not be already used by LiveRC.

After this form validation, a new line is added where the image components can be set. The config panel validation then add the image to your customized params.

Usage of the mediawiki API to define the image URL

1.) Copy the following URL :

https://en.wikipedia.org/w/api.php?action=query&prop=imageinfo&iiprop=url|size
&titles=File:FILENAME.XXX
&iiurlwidth=WIDTH
&iiurlheight=HEIGHT

2.) Replace :

• FILENAME.XXX by the file name, with its MIME type extension
• WIDTH by the wanted width (pixels)
• HEIGHT by the wanted height (pixels)

Nota : if you don't know the image ration, use only one of the two last params.

3.) Paste the result in the browser address bar

4.) In the API result:

• get the (clickable) content of the thumburl attribute except for animated gif wich need the content of the url attribute
  • LiveRC only need the end of the URL, after the .../commons/ part
• if needed, get the width (thumbwidth) and/or the height (thumbheight) if they were unknown before

 

Texts

The Texts 1 and Texts 3 tabs permit to modify texts used by LiveRC. Each input field match a text used somewhere by LiveRC, one or several times. Usually, HTML is accepted.

The {{Touche|Texts 2} } tab permit to modify the description of the different variables that can be customized in the config panel it-self.

Each input field match one variable item. Usually, HTML is accepted.

For Texts 1 tab, a (+) link at the end of the list permit to add a new text.

This link add a form asking for:

• The ID of the text
• The text it-self
• The description of the text

The three input fields must be set, and the ID must not match a ID already used by LiveRC.

After the form validation, the new text is added to the Texts 1 tab list while the description is added to the Texts 2 tab list.

Nota : the text and the description are only created for the language the user has set at this time. If the language is modified, these texts will no more be visible.

Extensions

The (Un)install extensions tab permit to add an extension to LiveRC code.

It is third-party codes loaded with LiveRC and executed at some moments of the process, opening acces to new functionnalities. They are stored on your /LiveRCparam.js page with your aother customizations.

The following extensions are available through this tab (complete list automatically updated) :

Script	Description
ProposeTranslationExtension.js	Add a form to propose a translation of the interface text. Documentation
InstallAndConfigLiveRCExtension.js	Provide an interface for the global LiveRC configuration. Documentation
UserWarningsExtension.js	Add an icon to user that have received a warning. Optionnal: show if the user talk page exists. Documentation
LinkOnIconExtension.js	Link AfD, FA, GA and copyvio icons to the corresponding talk page. Documentation
LinkOnLanglinkCountExtension.js	Link langlinks count to the wikidata item (when existing). Documentation
EditCharactersExtension.js	Add Common.js edit mode functions to the preview window (toolbar and special characters).
ToolbarExtension.js	Add a toolbar when editing a page. Documentation
RunCommonJS.js	Add Common.js functions to the prewiew window (navbox, etc...).
HotCatsMulti.js	Permit to add/modify/remove one or several categories while previewing a page. HotCatsMulti gadget documentation (fr)
BandeauPortail.js	Permit to add/modify/remove one or several Portal template while previewing a page BandeauxPortails gadget documentation (fr)
MostModifiedPagesExtension.js	Add an icon to pages recently modified by several users or with several reverts. Documentation
PreviewThisPageExtension.js	Permit to preview any page you want. Documentation
CategoryRCExtension.js	Permit to watch only pages that belong to one or more categories. Documentation
PreviewAllLinksExtension.js	Permit to preview all links in the preview window
DiffExtension.js	Provide LiveRC automatic functions in "normal" diff pages. Documentation
AddComplexTemplateExtension (it:InserisciTemplate)	Permit to add complex templates with parameters Documentation
AskForRevisionDeleteFromHistExtension	Add checkboxes and button in history for revision deletion request. Documentation

LiveRC config panel, Extensions list tab

If set in the Tabs tab, a second tab named Extensions list is available. It permit to modify the extension list used to create the previous one.

Each line is made of four things :

1. name: The name of the extension
2. url: The url where the extension code can be found
3. desc: The default description of the extension, HTML authorized (the translation can be managed through Wikipédia:LiveRC/Documentation/Traduction/en process)
4. neededright : A mediawiki right needed to the extension. If prefixed with a !, the extension will only work if the user do not have this right

The (–) link next to each line permit to delete the extension line.

The (+) link at the end of the list permit to add a new extension to the list.

CSS styles

The CSS styles tab permit to customize some CSS styles.

A (+) links at the end of the list permit to add a new line, and to set a new personal style.

Two cases arise, depending on whether the style is a predetermined style LiveRC or not.

If the style is a default style

• Only the styles are customizable, not the target
• It is not possible to delete the style line
• Is the style is customized, it is written in red

If the style is a personal one

• Both the target and the styles are customizable
• A(-) link permit to delete the line
• The whole style line is written in red

RC lines deleting

The Delete lines tab permet permit to customize the delete lines buttons at the beginning of the RC control bar.

Each button is set by four things :

1. textid: The text ID of the button tooltip
2. color: The color applied to the button text
3. class: The className of the RC lines to be deleted
4. separator: A separator to be added after the button (optional)

• Nota: The tooltip text can be set through the Texts 1 tab.

For each line, a (-) link permit to delete the line.

A (+) link at the end of the list permit to add a new line.

Automatic functions params

Warnings

"autopatrolled" users can use a special tool to add a template on user talk page. The Message tab permit to define these templates.

Each template is defined with five items :

1. template: the template name
2. string: a text that appear in the selector
3. hasPage: an option to add or not the page name to the template
4. addName: an option to add or not the user name (your name) to the template
5. addSectionTitle : an option to add a section title before the template

For each template definition, a (-) link permit to delete the template.

A (+) link at the end of the list permit to add a new line.

Tags

"autopatrolled" users can use a special tool to add a tag template at the top of a page. The Tags tab permit to define these templates.

Each template is defined with three things :

1. template: the template name
2. string: a text that appear in the selector
3. withDate: an option to add or not the date in the template. If empty, the date is not added. "Magic words" can be used to define the date format:
   • $day for the day (here : 25)
   • $month for the month name (firstletter = lower case ; translation in the wiki's language) (here : avril)
   • $Month for the month name (firstletter = upper case ; translation in the wiki's language) (here : Avril)
   • $year for the year (here : 2024)

For each template definition, a (-) link permit to delete the template.

A (+) link at the end of the list permit to add a new line.

Blanking

"autopatrolled" users can use a special tool to automatically blank a page. The Blanking tab permit to define blanking edits comments.

Each comment is defined by two things :

1. tooltip: a text that appear in the selector
2. resume: the comment (in wikitext)

For each blanking comment, a (-) link permit to delete the line.

A (+) link at the end of the list permit to add a new line.

Rollback

"autopatrolled" users can use a special tool to automatically revert or rollback user edit(s). The Rollback tab permit to define blanking edits comments.

Each comment is defined by two things :

1. resume: the comment (in wikitext)
2. text: a text that appear in the selector

For each rollback comment, a (-) link permit to delete the line.

A (+) link at the end of the list permit to add a new line.

Reporting

"autopatrolled" users can use a special tool to automatically make a request about a page or a user. The Report tam permit to configure the different requests.

Each request type is defined by eight things :

1. userright: the userright needed. If the user has the right, this item won't appear in the selector. For a special purpose/request, you can make the item always appear by setting a right that doesn't exist.
   • .
2. text: The text ID of the selector option
3. page: the page where the user can ask. "Magic words" can be used to define a sub-page on a per-date basis:
   • $day for the day (here : 25)
   • $month for the month name (firstletter = lower case ; translation in the wiki's language) (here : avril)
   • $Month for the month name (firstletter = upper case ; translation in the wiki's language) (here : Avril)
   • $year for the year (here : 2024)
4. template: the template used to ask
5. parampage: an option to add or not the page that need special care
6. paramuser: an option to add or not the user that need special care
7. resume: The comment of the edit, and also the new section title ($1 is the page name, $2 is the user name)
8. reasonsdropdownname: a system message where can be found some reasons for the demand (optionnal, can be set to false). The message syntax must match the Mediawiki:deletereason-dropdown one.

• Nota: The text item text can be set through the Texts 1 tab.

For each line, a (-) link permit to delete the line.

A (+) link at the end of the list permit to add a new line.

Tests params

Edit comments

The Comment tests tab permit to customize test made on edit comments with RegExp to tag the modification, with an icon (in the last RC column) and/or with a specific CSS class applied to the whole RC line. These test are also used in the RC checlist, when mouse is over RC checkbox in the RC control bar, to hide or not these RC lines.

Each test is defined by five things :

1. state: The state added to the edit when RegExp is found (an internal variable)
2. icon: The icon name added in RC line (optionnal)
3. class: The className added to the line (optionnal)
4. hide: The default checkbox state in RC checklist
5. regex: The RegExp to test comment

• Notas :
  • The icon can be created throught the Icons tab.
  • The text of the RC checklist checkbox label can be set through the Texts 1 tab. The text ID is SHOWRC_state_TIP, where state = the state element of the test item.

For each line, a (-) link permit to delete the line.

A (+) link at the end of the list permit to add a new line.

Templates

The Templates tests tab permit to customize test about templates included in a page to tag the modification, with an icon (just before the page name) and/or with a specific CSS class applied to the whole RC line.

Each test is defined by four things :

1. state: The state added to the edit when the template is found (an internal variable)
2. icon: The icon name added in RC line (optionnal)
3. class: The className added to the line (optionnal)
4. template: The template to test, without the namespace

• Notas :
  • The icon can be created throught the Icons tab.
  • The param « Load page infos (expensive) » must be checked in the Params tab. If not, the page templates won't be loaded, so the tests will not be performed.

For each line, a (-) link permit to delete the line.

A (+) link at the end of the list permit to add a new line.

Page categories

The Page categories test tab permit to customize test made on page categories with RegExp to tag the modification, with an icon (just before the page name) and/or with a specific CSS class applied to the whole RC line.

Each test is defined by four things :

1. state: The state added to the edit when the template is found (an internal variable)
2. icon: The icon name added in RC line (optionnal, must be defined in lrcIcons)
3. class: The className added to the line (optionnal)
4. regex: The category to test (regexp format)

• Notas :
  • The icon can be created throught the Icons tab.
  • The param « Load page infos (expensive) » must be checked in the Params tab. If not, the page categories won't be loaded, so the tests will not be performed.

For each line, a (-) link permit to delete the line.

A (+) link at the end of the list permit to add a new line.

User categories

The User categories tests tab permit to customize test made on user categories to tag the modification, with an icon (just before the user name) and/or with a specific CSS class applied to the whole RC line.

Each test is defined by four things :

1. state: The state added to the edit when the user belongs to the category (an internal variable)
2. icon: The icon name added in RC line (optionnal)
3. class: The className added to the line (optionnal)
4. category: The category to test, without the namespace

• Notas :
  • The icon can be created throught the Icons tab.
  • The param « Load user categories (expensive at loading) » must be checked in the Params tab. If not, the user categories won't be loaded, so the tests will not be performed.

For each line, a (-) link permit to delete the line.

A (+) link at the end of the list permit to add a new line.

Watched users tab

LiveRC permit to list users that will be considered as "watched", followed with a particular attention. This list is stored throught the watchlist. Theses watched users can be added or deleted throught links in RC lines and special logs, and are globally settables throught the Watched users tab in the config panel.

The tab is made of a list of users, and for each one a (-) permit to delete the user from the list.

To add a user to the list, use the Add a wathed user button that create a form to selet a user name or an IP address. Once validated, this user is added to the list.

To save the changes made on the watched users list, it is need to click on the Validate button (only watched users will be saved, not the customizations made in other tabs).

Hidden users tab

LiveRC permit to list users that will be considered as "hidden", and which edits won't be shown in the RC lines. This list is stored throught the watchlist. Theses hiden users can be added throught a link in RC lines, and are globally settables throught the Hidden users tab in the config panel.

The tab is made of a list of users, and for each one a (-) permit to delete the user from the list.

To add a user to the list, use the Add a hidden user button that create a form to selet a user name or an IP address. Once validated, this user is added to the list.

To save the changes made on the hidden users list, it is need to click on the Validate button (only hidden users will be saved, not the customizations made in other tabs).

Hidden pages tab

LiveRC permit to list pages that will be considered as "hidden", and which edits won't be shown in the RC lines. This list is stored throught the watchlist. Theses hidden pages can be added throught a link in RC lines, and are globally settables throught the Hidden pages tab in the config panel.

The tab is made of a list of pages, and for each one a (-) permit to delete the page from the list.

To add a page to the list, use the Add a hidden page button that create a form to selet a page name. Once validated, this page is added to the list.

To save the changes made on the hidden pages list, it is need to click on the Validate button (only hidden pages will be saved, not the customizations made in other tabs).

Saving

Unlike it could be supposed, all changes made in the config panels are not saved at the same time. This depends on where theses changed are stored.

So, what is saved when clicking a Validate (or Default values for a reset) depends of the tab opened at this moment.

In the /LiveRCparam.js personal sub-page, these customizations are stored

• params
• options
• icons
• texts
• automatic functions params
• tests params
• delete RC lines buttons params
• extension list and installed extensions
• maybe some params provided by extensions

In the LiveRCparam.css personal sub-page are saved

• customized CSS styles

In the watchlist is saved (separately)

• watched users list,
• hidden users list,
• hidden pages list

Furthermore, sysops also have another button, named Configuration MW to update from the MediaWiki API the informations of the local configuration needed by LiveRC (system messages, available extensions, namespaces, etc...). By default, they are stored on the page called MediaWiki:Gadget-LiveRCSiteConfig.js.