Wikipedia:Twinkle/doc

Indien Twinkle is geïnstalleerd zal er een nieuw menu genaamd 'TW' verschijnen naast de zoekbalk, of, indien je gebruikmaakt van het Monobookthema, verschijnen er nieuwe knoppen in de menubalk bovenaan de pagina.

Installatie

Het installeren van Twinkle is eenvoudig. Volg de instructies op de Twinkle snelstartgids voor een snelle en gemakkelijke installatie. Voordat je Twinkle gebruikt willen we je adviseren deze handleiding aandachtig door te lezen, zo raak je bekend met de vele mogelijkheden van Twinkle en kun je hier optimaal gebruik van maken.

Noot: Vergeet niet dat je de volledige verantwoordelijkheid draagt voor alle bewerkingen die je met Twinkle doet. Zorg ervoor dat je bekend bent met de regels en richtlijnen en dat je je bij het gebruik van deze tool aan deze richtlijnen houdt, anders loop je het risico van deze tool uitgesloten te worden of zelfs volledig geblokkeerd te worden.

Oefenen met Twinkle

Het oefenen met Twinkle kan het beste in een van de zandbakken.

Voor het oefenen met het labelen en terugdraaien van pagina's gebruik: de reguliere zandbak.
Voor het oefenen met verwelkomen en het aanmaken van dossiers gebruik: de overlegpagina van Blokpop.

Een vriendelijk verzoek om niet te oefenen met nuweg, TBx, Rapporteer of Beveilig, aangezien deze daadwerkelijk een verzoek versturen naar de moderatoren. Denk er bij het oefenen ook om dat je Verwittig aanmaker van pagina e.d. uitschakelt om spam te voorkomen.

Installatieproblemen

Mocht de Twinkle installatie mislukken dan kan dat een van de volgende oorzaken hebben:

Je moet een account hebben op Wikipedia, en dit account dient autobevestigd te zijn (het moet minstens 4 dagen oud zijn), om Twinkle te kunnen gebruiken.
Twinkle ondersteunt Internet Explorer niet, om Twinkle te kunnen gebruiken dien je gebruik te maken van een moderne webbrowser zoals Safari, Mozilla Firefox, Microsoft Edge, Google Chrome of Opera. Zorg er tevens voor dat je webbrowser voorzien is van de laatste updates.
Check of er geen browser-addons zijn ingeschakeld die de werking van Twinkle verstoren. Vooral adblockers staan hierom bekend (voeg desnoods een uitzondering toe aan je adblocker voor nl.wikipedia.org).
Na de installatie van Twinkle, moet je mogelijk je browsercache legen. Lees hier hoe dat moet.

Zijn de problemen na de bovenstaande instructies nog niet verholpen, meld je probleem dan het liefst op de issue-tracker op GitHub (hiervoor is een gratis GitHub-account vereist). Mocht je bezwaar hebben tegen het gebruik van GitHub, dan kun je het probleem melden op de overlegpagina, meld dan duidelijk o.a. welke problemen je ondervond, welke webbrowser je gebruikt, wat je al geprobeerd hebt om het zelf op te lossen en hoe een Twinkle-ontwikkelaar het probleem kan nabootsen.

Cache legen

Na het veranderen van Twinkle-instellingen moet mogelijk de browsercache geleegd worden om de wijzigingen zichbaar te maken. Afhankelijk van de webbrowser werkt dat als volgt:

Mozilla Firefox: Het herlaad de pagina door Ctrl ⇧ Shift R tegelijkertijd in te drukken (⌘ Cmd ⇧ Shift R op MacOS).
Google Chrome: Het herlaad de pagina door Ctrl ⇧ Shift R tegelijkertijd in te drukken (⌘ Cmd ⇧ Shift R op MacOS).
Safari: Leeg de cache door ⌥ Opt ⌘ Cmd E tegelijkertijd in te drukken, herlaad vervolgens de pagina.
Opera: Herlaad de pagina door ⇧ Shift F5 tegelijkertijd in te drukken.

Modules

Twinkle is opgebouwd uit veel verschillende "modules". Iedere module heeft zijn eigen taak en functie. Veel modules zijn aan te roepen via het "TW"-menu naast de zoekbalk, of (voor gebruikers van Monobook) via tabbladen bovenaan de pagina.

Nuweg (direct verwijderen)

Nuweg is de module waarmee een pagina kan worden gelabeld voor directe verwijdering. Indien je denkt dat het artikel in aanmerking komt voor één van de RVM-criteria voor directe verwijdering dan kun je middels deze module het artikel snel nomineren.

Deze module gebruiken

Klik op het tabblad "Nuweg". Er komt een lijst met RVM-nuwegcriteria in beeld, afhankelijk van de naamruimte waar je je in bevindt zijn sommige criteria wel of niet beschikbaar. Indien je een passende verwijderingsreden hebt gekozen klik je op de "Nomineer pagina"-knop onder aan het menu.

Indien Breng aanmaker op de hoogte is aangevinkt, en je Twinkle-instellingen zijn correct ingevuld, zal Twinkle tevens de aanmaker van het artikel op de hoogte brengen van het feit dat jij de pagina hebt genomineerd, wel zo netjes!
Indien je "Nomineer wegens meerdere redenen" aanvinkt, kun je het artikel nomineren wegens meerdere problemen. Waar Twinkle normaal slechtst 1 reden accepteert kun je er nu meerdere aanvinken.
Op het Twinkle-configuratiescherm kun je een nuweg-logboek inschakelen in je eigen naamruimte, hiermee kun je als niet-moderator al je nuweg-aanvragen bijhouden. Zo kun je leren van afgewezen aanvragen en jezelf verder verbeteren.
Standaard worden alle pagina's die je nomineert op je volglijst geplaatst. Dit kun je uitschakelen op het Twinkle-configuratiescherm.
Je kunt er op het Twinkle-configuratiescherm voor kiezen om pagina's die je nomineert voor directe verwijdering automatisch te markeren als gecontroleerd.

Goed om te weten

Indien je een pagina nomineert wegens cyberpesten, wordt de pagina automatisch leeggehaald om het slachtoffer te beschermen.
Met Twinkle kun je ontzettend snel een nuweg-nominatie op een pagina plaatsen. Onthoud hierbij dat jíj verantwoordelijk blijft om dit op een correcte manier te doen. Maak bij twijfel gebruik van een beoordelingspagina en bijt geen nieuwelingen.

Extra functies voor moderatoren

Admins kunnen pagina's verwijderen middels de Nuweg-module, hierbij kunnen tevens overlegpagina's en inkomende doorverwijzingen met één druk op de knop worden verwijderd.

TBx (Te Beoordelen ...)

TBx, kort voor Te Beoordelen ..., is een module waarmee pagina's met één druk op de knop kunnen worden genomineerd op een beoordelingspagina. Dit kan worden gebruikt indien een directe verwijdering (nuweg) ongeschikt is, maar je wel twijfelt of een artikel thuis hoort op Wikipedia. Indien je hiervan gebruik maakt gebeuren er een aantal dingen tegelijk: er wordt een sjabloon geplaatst op de pagina, de pagina wordt toegevoegd aan de beoordelingsdagpagina en tevens wordt, indien gewenst, de aanmaker van het artikel op de hoogte gebracht van je nominatie.

Deze module gebruiken

Klik op het tabblad "TBx", standaard staat de juiste beoordelingslocatie geselecteerd, kies een passend nominatiesjabloon en geef een reden voor nominatie.

Indien Breng aanmaker op de hoogte is aangevinkt, en je Twinkle-instellingen zijn correct ingevuld, zal Twinkle tevens de aanmaker van het artikel op de hoogte brengen van het feit dat jij de pagina hebt genomineerd met een link naar het beoordelingsoverleg, wel zo netjes!
Het invullen van een reden is verplicht, je mag hierbij wikiopmaak gebruiken.
Standaard worden alle pagina's die je nomineert op je volglijst geplaatst. Dit kun je uitschakelen op het Twinkle configuratiescherm.

Goed om te weten

Twinkle kan plots stoppen tijdens het aanmaken van een TBx-verzoek. De exacte oorzaak hiervan is onbekend, maar heeft zeer waarschijnlijk te maken met de capaciteit op de servers van Wikipedia. Wacht geduldig, Twinkle gaat vanzelf weer verder, maar dit kan (in extreme gevallen) meer dan 30 seconden duren.
Op dit moment kan Twinkle alleen pagina's nomineren, het nomineren van sjablonen en categorieën werkt als gevolg van technische beperkingen (nog) niet.

Extra tools voor moderatoren

Twinkle heeft (nog) geen extra hulpmiddelen voor moderatoren.

Laatste

Laatste is een hulpmiddel om het verschil tussen verschillende versies te bekijken.

Rapporteer

Rapporteer is een tool waarmee een gebruiker (of IP-adres) kan worden gerapporteerd op de daarvoor bestemde pagina. De knop is alleen zichtbaar op de gebruikersnaamruimte en op Speciaal:Bijdragen/gebruiker. Er zijn drie locaties waar gerapporteerd kan worden:

WP:REGBLOK - Rapporteer geregistreerde gebruikers.
WP:IPBLOK - Rapporteer anonieme gebruikers.
WP:SOKPOP - Rapporteer mogelijk sokpoppenmisbruik.

Voor alle drie de meldpagina's komt een formulier in beeld, waarmee de melding correct kan worden uitgevoerd.

Dossiers

Op pagina's in de gebruikersnaamruimte is de knop Dossier zichtbaar. Middels deze knop is het mogelijk om gemakkelijk en snel een vriendelijke uitleg of duidelijke waarschuwing te geven aan de gebruiker. Met het Twinkle formulier kan het meest geschikte bericht worden geselecteerd aan de hand van de volgende stappen:

Kies een waarschuwingsniveau, afhankelijk van de ernst van de situatie en afhankelijk van het feit of dit de eerste mededeling is of een herhaling (zie hier voor meer informatie).
Kies een geschikte dossiertekst uit de lijst.
Voer de naam in van het artikel waar de bewerking is gedaan.
Voeg optioneel een extra verklaring of reden in om toe te voegen aan de dossiertekst.

Goed om te weten

Indien er gebruik is gemaakt van Twinkle-terugdraaien, en browser pop-ups zijn ingeschakeld, zal Twinkle-terugdraaien automatisch het dossiermenu openen. Dit kan eventueel uitgeschakeld worden op het Twinkle configuratiescherm.
Indien je de reguliere terugdraaiknop hebt gebruikt, kun je op de terugdraaipagina op de knop (overleg) achter de gebruikersnaam klikken, in dat geval wordt het dossiermenu eveneens geopend.
Het is mogelijk om zelfgemaakte dossiersjablonen toe te voegen aan Twinkle, dit kan op het Twinkle configuratiescherm.

Welkom

Via het tabblad Welkom kan je een gebruiker snel welkom heten.

Bij sommige welkomssjablonen kan een koppeling gemaakt worden naar een pagina waarop de gebruiker recent heeft bewerkt, deze koppeling wordt vervolgens toegevoegd aan de sjabloontekst. Dit veld wordt automatisch ingevuld indien een vanarticle URL parameter is gegeven, welke automatisch wordt toegevoegd bij een (Twinkle)terugdraaiing.

Tevens is het mogelijk om zelfgemaakt sjablonen toe te voegen aan de Welkom-module, dit kan via het Twinkle-configuratiescherm.

Ongedaan maken en Terugdraaien

Op het moment dat je de geschiedenis van een artikel bekijkt, plaats Twinkle 1 à 2 knoppen achter of boven iedere revisie:

Deze versie terugzetten - Zet de geselecteerde versie van het artikel terug (er wordt een bewerkingssamenvatting gevraagd).
Terugdraaien - Zet de pagina terug tot de laatste versie van de vorige bewerker, en vraag vervolgens om een bewerkingssamenvatting.
Vandalisme - Doet het zelfde als Terugdraaien maar vult "Vandalisme" in als bewerkingssamenvatting.

Modules voor moderatoren

Niet alleen hebben moderatoren meer mogelijkheden op de wiki, ze hebben ook meer Twinkle-modules tot hun beschikking:

Batch Del (Batch verwijderen)

De Batch Del-module maakt het mogelijk om alle (of een deel van de) pagina's te verwijderen die in een bepaalde categorie of op een bepaalde lijst voorkomen, of op basis van zoekresultaten op Speciaal:Voorvoegselindex. De module maakt het tevens mogelijk om alle overlegpagina's, doorverwijzingen en subpagina's te verwijderen. Daarnaast is het mogelijk om de verwijderde pagina's te ontlinken uit de hoofd- en portaalnaamruimte. Indien deze module wordt gebruikt voor het verwijderen van lokale afbeeldingen is het tevens mogelijk om deze te ontlinken in alle overige naamruimtes. Deze module kan bijvoorbeeld bruikbaar zijn bij het massaal afhandelen van TBP- of Nuweg-nominaties. Zodra je je verwijdervoorkeuren hebt aangegeven, een reden hebt ingevuld en op versturen drukt zal Twinkle alle pagina's automatisch verwijderen, afhankelijk van het aantal te verwijderen pagina's kan dit even duren. Let op! indien je op verstuur drukt is er in principe geen weg meer terug, wees met deze module dus minstens net zo voorzichtig als met Speciaal:MassaalVerwijderen.

Batch Undel (Batch terugzetten)

Batch Undel is vergelijkbaar met batch verwijderen, maar zet de pagina's terug in plaats van ze te verwijderen. De module werkt alleen op basis van lijsten in de gebruikersnaamruimte. Dus om deze module te gebruiken zul je een lijst in je gebruikernaamruimte moeten maken (of naar de gebruikernaamruimte toe substitueren met subst:) met alle pagina's die je wil terugzetten.

Batch Bev (Batch beveiligen)

Batch Bev is vergelijkbaar met batch verwijderen, maar beveiligt de pagina's. Het kan als noodmaatregel worden gebruikt tegen ernstig vandalisme op meerdere pagina's tegelijk. Het is bijvoorbeeld mogelijk om een gehele categorie in een keer te beveiligen (of de beveiliging juist op te heffen).

Configuratie

Verreweg de makkelijkste manier om Twinkle instellingen aan te passen is via het Twinkle-configuratiescherm, te vinden op Wikipedia:Twinkle/Preferences. Vanuit hier kunnen vrijwel alle Twinkle instellingen volledig naar wens worden aangepast.

Technische details

Het Twinkle-configuratiescherm werkt door een JSON-object op te slaan in de gebruikersnaamruimte (op Special:MyPage/twinkleoptions.js), welke vervolgens iedere keer dat je een wikipagina laadt, wordt ingelezen door Twinkle (dat klinkt misschien als een behoorlijke aanslag op je computerprestaties, alleen zal je browser in veel gevallen het bestand cachen waardoor het niet iedere keer opnieuw gedownload hoeft te worden).

In het geval dat er iets misloopt in het configuratiescherm, of indien je wat geavanceerde instellingen wil instellen, kun je er voor kiezen het configuratiebestand handmatig aan te passen via Special:MyPage/twinkleoptions.js. Het bestand heeft het volgende format (mensen zonder kennis over JavaScript wees gewaarschuwd):

window.Twinkle.prefs = {
  "optionsVersion": 2.1,
  "revertMaxRevisions": 13,
  "showRollbackLinks": [ 'diff', 'recent', 'history' ],
  "watchWelcomes": "1 week",
};

Geavanceerde parameters

Het aanpassen van deze parameters is handig indien je browser of netwerk verbinding moeite heeft om de bewerkingen uit te voeren zonder last te krijgen van database vergrendelingen of verbinding timeouts. Deze instellingen staan niet in het configuratiescherm, en moeten daarom handmatig aangepast worden via Special:MyPage/twinkleoptions.js.

Voor frequente gebruikers kan het mogelijk voordelig zijn de volgende instelling te fine-tunen:

revertMaxRevisions: Bepaalt het maximum aantal revisies dat Twinkle terugkijkt in de geschiedenis tijdens een rollback. Het limiet van de server is 50. Standaard is 50.
autolevelStaleDays: Bepaalt na hoeveel dagen na de laatste waarschuwing het waarschuwingsniveau weer wordt gereset naar 1. Standaard is 14.

Voor moderatoren kan het mogelijk voordelig zijn de volgende instelling te fine-tunen:

batchMax: Bepaalt het maximum aantal acties in één batch. Het aanpassen van deze variabele wordt afgeraden. Standaard is 5000.
batchChunks: Bepaalt hoeveel acties er per batch tegelijkertijd aangemeld kunnen worden bij de server. De serverlimiet is 50. Het aanpassen van deze variabele wordt afgeraden. Standaard is 50.

Locatie van Twinkle menu onderdelen

De standaard locatie van het Twinkle-menu in het Vector-thema is naast de zoekbalk als drop-down menu; in alle andere thema's wordt het weergeven als losse tabbladen. Indien gewenst, kun je de locatie en vormgeving van deze functies veranderen door wat instellingen in je twinkleoptions.js te veranderen:

"portletArea" "portletId" "portletName" "portletType" "portletNext"

Bijvoorbeeld als je een paar onderdelen wil verplaatsen naar het toolbox menu aan de linkerzijde van je scherm, voeg dan "portletId": "p-tb", toe aan je Twinkle configuratie, ongeveer zoals dit:

window.Twinkle.prefs = {
  "twinkle": {
    // ...
    "portletId": "p-tb",
    // ...
  },
  // ...
};

Indien je de modules als losse tabbladen wil weergeven, net als in het monobook thema, voeg dan "portletId": "p-views", toe aan je Twinkle configuratie, ongeveer zoals dit:

window.Twinkle.prefs = {
  "twinkle": {
    // ...
    "portletId": "p-views",
    // ...
  },
  // ...
};

portletId is het ID van de portlet waar je de module wil tonen. 'p-tb' is de toolbar, en 'p-views' is de menu balk is. Voor een volledige lijst met alle ID's zie: Catalogue of CSS classes op de Engelstalige Wikipedia.

Tevens kun je ook een nieuw menu maken met slechts Twinkle modules. In dat geval, voeg dit toe:

window.Twinkle.prefs = {
  "twinkle": {
    // ...
    "portletArea": "column-one",
    "portletId"  : "p-twinkle",
    "portletName": "Twinkle",
    "portletNext": "p-search",
    // ...
  },
  // ...
};

In dit geval refereert de portletId parameter nu aan een specifieke Twinkle tool set, 'p-twinkle'. portletArea geeft aan waar dit weergeven dient te worden (het gegeven 'column-one' is de sidebar voor Monobook; voor Vector is het het 'panel' en voor Modern is het 'mw_portlets'; Andere mogelijkheden zijn 'left-navigation' en 'right-navigation' in Vector, en 'mw_contentwrapper' in Modern (wat weergeven zal worden als een nieuw level boven alle andere tabbladen). Verander portletNext om aan te geven welk ID er na het Twinkle-menu geplaatst dient te worden (in dit geval betekent 'p-search' na de zoekbalk). Verander de portletName parameter om de te weergeven naam van het menu aan te passen (indien van toepassing), in dit geval "Twinkle".

Mocht dit allemaal overkomen als abracadabra, begin dan niet zomaar met het aanpassen van het de configuratie, aangezien configuratiefouten tot schade kan leiden. Vraag eventueel om hulp op de overlegpagina.