Toolhub/nl
Toolhub is een door de gemeenschap beheerde catalogus van software hulpmiddelen die gebruikt worden in de Wikimedia-beweging. Technische vrijwilligers kunnen Toolhub gebruiken om de hulpmiddelen die zij maken of onderhouden te documenteren. Alle Wikimedianen kunnen Toolhub gebruiken om hulpmiddelen te zoeken die hun workflows helpen en om lijsten te maken van nuttige hulpmiddelen om met anderen te delen.
Wat is een "hulpmiddel"?
In Toolhub is "tool" (hulpmiddel) een inclusieve term voor softwaretoepassingen die interactie hebben met de Wikimedia-projecten zonder volledig geïmplementeerd te zijn door MediaWiki. Dit omvat dingen als gebruikersscripts, gadgets, bots, sjablonen, lua modules, webapplicaties en mobiele apps. De catalogus is bedoeld om inclusief te zijn in plaats van exclusief, zolang de documenten die hij documenteert nuttig zijn voor het verbeteren van workflows en gebruikerservaringen bij het samenwerken met de projecten van de Wikimedia-beweging.
Content licentie
Toolinfo.json data en andere gestructureerde data die in Toolhub worden verzameld, zijn gelicentieerd onder de Creative Commons CC0 Dedication (CC0). Hergebruikers worden aangemoedigd om bronvermelding te geven door terug te linken naar Toolhub, maar dit is niet vereist voor het naleven van de licentie. Het is de verantwoordelijkheid van beheerders van extern gehoste toolinfo.json databestanden om ervoor te zorgen dat hun bijdragers op de hoogte zijn van de CC0-licentievereiste. Toolinfo-gegevens die zijn gekopieerd van Wikimedia-inhoudswiki's of andere documentatie onder een niet-CC0-licentie moeten de gekopieerde 'beschrijving'-inhoud beperken tot 50 woorden/250 tekens om claims van mogelijke auteursrechtverplichtingen, zoals naamsvermelding, te beperken. De woord-/tekenlimiet geldt alleen voor gekopieerde inhoud, originele CC0-beschrijvingen kunnen elke lengte hebben.
Gebruikersaccounts
Toolhub gebruikt OAuth-authenticatie om gebruikers in staat te stellen in te loggen op Toolhub met hun Wikimedia wiki-gebruikersaccount. Er zijn geen nieuwe accounts of wachtwoorden nodig.
Hulpmiddelen toevoegen aan de catalogus
Hulpmiddelen kunnen aan de Toolhub-catalogus worden toegevoegd door ze te lezen vanaf een geregistreerde toolinfo.json bestand-URL of door gegevens direct naar de Toolhub API te sturen.
Door uw toolinfo.json-bestanden als onderdeel van een Git-repository te hosten, kunnen vrijwilligers pull-verzoeken doen om de kerninformatie van het hulpmiddel bij te houden.
Toolinfo-bestand publiceren en dit registreren bij de webcrawler van Toolhub
Een toolinfo-bestand is een JSON-document dat voldoet aan het toolinfo schema. Deze standaard is een uitbreiding van de toolinfo-specificatie, oorspronkelijk ontwikkeld door Husky als onderdeel van zijn hulpmiddel Hay's Directory.
- Maak een JSON-bestand conform het schema
- Publiceer dat bestand op een website
- Gebruik de toolhub-interface om de URL te registreren van het bestand met toolhub's webcrawler
Toolhub controleert elke geregistreerde toolinfo-URL ongeveer om de 60 minuten en werkt de catalogus bij met wijzigingen.
Voorbeeld toolinfo.json bestanden van echte hulpmiddelen:
 | Een hulpmiddel dat gehost is op Toolforge kan toolsadmin gebruiken om een toolinfo-record aan te maken dat automatisch wordt geïmporteerd door Toolhub en Hay's Directory. |
Toolhub-gebruikersinterface gebruiken om een toolinfo-record aan te maken en te bewerken
Het scherm Add or remove tools > Create a new tool in Toolhub kan direct gebruikt worden om in de catalogus van Toolhub een nieuw toolinfo-record aanmaken. Aanvullende informatie die niet in het formulier wordt verzameld, kan worden toegevoegd via latere bewerkingen met het scherm edit tool voor het hulpmiddel.
Toolhub-API gebruiken om een toolinfo-record aan te maken en te bewerken
Het endpoint van Toolhub's API van POST /api/tools/ kan worden gebruikt om een nieuw toolinfo-record direct in Toolhub's catalogus te maken. Deze API wordt achter de schermen gebruikt door de Toolhub-gebruikersinterface. Zie Toolhub's API-documentatie voor gedetailleerde informatie over de verwachte invoer en uitvoer.
Informatie hulpmiddel bewerken
Sommige informatie in het toolinfo-record is voor iedereen bewerkbaar, maar wat informatie kan alleen door eigenaren of beheerders worden bewerkt. Toolhub's datamodel splitst informatie op in twee delen: de kerninformatie van het hulpmiddel en de annotaties:
| Type metadata | Hoe het wordt aangemaakt | Wie het kan wijzigen | Waar het kan worden gewijzigd |
| Kerninformatie hulpmiddel
Basis- en essentiële informatie over het hulpmiddel. |
Aangemaakt met behulp van API of Toolhub (de UI gebruikt de API op de backend)
OF Door een toolinfo.json URL te sturen die dan wordt gecrawled |
De eigenaar, beheerders en toezichthouders
OF Gebruikers die het extern opgeslagen toolinfo.json-bestand kunnen wijzigen (of pull-verzoeken kunnen indienen) |
Op dezelfde plaats als het record is gemaakt. Als het record oorspronkelijk via Toolhub is ingediend, kan het alleen worden bewerkt via Toolhub.
Als de gegevens van het record extern worden opgeslagen in toolinfo.json-bestanden, kunnen deze alleen daar worden bewerkt. |
| Gemeenschap annotaties
Aanvullende informatie over het hulpmiddel. |
Toolhub UI, API, of via hulpmiddelen zoals Toolhunt die de API gebruiken | Alle geauthenticeerde gebruikers met een Wikimedia-account | Toolhub UI, API, of via hulpmiddelen zoals Toolhunt die de API gebruiken |
Core tool informatie
Alle hulpmiddelen in Toolhub hebben een kernrecord met basisinformatie, zoals de naam en auteur. Alleen de eigenaar, beheerders en Oversighters/toezichthouders kunnen de kerninformatie van het hulpmiddel in Toolhub bewerken. De eigenaar van de kerninformatie van een hulpmiddel is de gebruiker die het binnen Toolhub heeft gemaakt (ongeacht welke methode hij gebruikte om het te maken).
Voor extern opgeslagen toolinfo-records kan iedereen met rechten om het gecrawlde toolinfo-bestand te bewerken de kerninformatie van het hulpmiddel aanpassen.
Hulpmiddel URL's bewerken
De URL van een hulpmiddel maakt deel uit van de kerngegevens van toolinfo. Dit betekent dat het kan worden ingediend als onderdeel van een toolinfo.json-bestand of via de UI & API kan worden bewerkt door de eigenaar van het toolinfo-record. Het kan nu niet door de bredere gemeenschap worden bewerkt. U kunt deze URL alleen bewerken als u de keuze krijgt om "Kerninformatie bewerken" te selecteren nadat u op de knop "bewerken" heeft geklikt. Anders ziet u het formulier voor het bewerken van de "annotaties"-laag van een toolinfo-record – u kunt de URL van het hulpmiddel niet bewerken.
Als u van een hulpmiddel de maintainer bent en uw record is geïmporteerd van https://toolsadmin.wikimedia.org, wordt in het bewerkingsformulier op toolsadmin een checkbox aangebracht in de onderkant van het formulier met het opschrift "Dit is een webservice". Vink dit vak aan om automatisch de URL van het toolinfo-record te instellen. Merk op dat de Toolhub-crawler één keer per uur loopt, dus wijzigingen in toolinfo-records die via Toolsadmin worden gemaakt, worden niet direct actief.
Dubbele tool-records vermijden
Als uw hulpmiddel wordt gehost in Toolforge en u wilt dat de toolinfo-records buiten toolsadmin.wikimedia.org de primaire informatiebron in Toolhub zijn, stel dan de naam in het toolinfo-record in op toolforge-$TOOL_NAME waarbij $TOOL_NAME de naam is die u intypt om de shell van het hulpmiddel op een Toolforge-bastion aan te roepen. De naamsleutel is het enige veld in een toolinfo.json record dat wordt meegenomen bij het dedupliceren van de dataset. Voor voorbeelden, zie phab:T293518.
Gemeenschap annotaties
Nadat Toolhub een tool-record heeft ontvangen, kunnen vrijwilligers er annotaties in malen. De annotaties helpen het vinden van hulpmiddelen te vergemakkelijken door aanvullende informatie te verstrekken. De annotaties kunnen niet worden opgeslagen in toolinfo.json-bestanden; zij moeten altijd door de leden van de gemeenschap kunnen worden bewerkt.
De annotatie-velden zijn:
- Pictogram (Icon)
- Of het hulpmiddel ontraden/experimenteel/vervangen is door een ander hulpmiddel
- Tool type
- Voor wiki's
- Doelgroep (Audiences)
- Inhoudstypen (Content types)
- Taken (Tasks)
- Onderwerp domeinen (Subject domains)
- Beschikbare UI-talen
- Links: API, eindgebruiker documenten, feedback, privacybeleid, bugtracker, vertalingen, ontwikkelaarsdocumentatie
- Wikidata-QID
Details over velden die deel uitmaken van de annotatielaag staan in de API-documentatie bij https://toolhub.wikimedia.org/api-docs#put-/api/tools/-name-/annotations/.
Sommige annotaties spiegelen velden uit de kern toolinfo.json specificatie. Toolhub toont alleen een annotatieveld voor gemeenschaps-bewerking als het overeenkomstige veld in het kernrecord leeg is of ontbreekt. Wanneer zowel de kern- als de annotatiegegevens voor een bepaald veld worden ingevuld, toont Toolhub de kerngegevens in plaats van de annotatiegegevens. Dit werd gekozen als een compromis tussen de tegenstrijdige wens van hulpmiddel-beheerders om de ultieme controle over hun datarecords te hebben, en om de gemeenschap de documentatie van de hulpmiddelen te kunnen verbeteren.
Naar hulpmiddelen zoeken
Het zoekscherm gebruikt de Elasticsearch eenvoudige query-string syntaxis:
+betekent AND operatie|betekent OR operatie-een enkel teken negeren"wikkelt een aantal tokens om een zoekterm aan te geven*at the end of a term signifies a prefix query(en)betekent verwerkingsvolgorde~N na een woord betekent bewerkingsafstand (vaagheid).~N na een zin staat de hoeveelheid "slop",- Speciale tekens (
+,|,-,",*,(,)en~) moeten escaped worden met\of in een geciteerde uitdrukking staan om op te zoeken - Zoekopdrachten zijn niet hoofdlettergevoelig
De autocomplete functie is ontworpen om u te helpen bij relevante suggesties wanneer u een vraag invoert.
Een lijst hulpmiddelen maken en delen
Het scherm Uw lijsten is te vinden via de link in het gebruikersmenu dat beschikbaar is voor ingelogde gebruikers. Klik op het pictogram gebruiker in de bovenste navigatiebalk naast de taalselectie om het gebruikersmenu te openen. Hier kunt u lijsten van hulpmiddelen maken en bewerken en, wanneer u klaar bent met de lijst, markeer die dan als openbaar om de lijst met anderen te delen.
Hulpmiddelen kunnen ook worden toegevoegd aan (of verwijderd van) een bestaande of nieuw gecreëerde lijst direct vanaf de menu-knop op de "toolcard", evenals vanaf de menu knop op de info-pagina.
Openbare en uitgelichte lijsten
Openbare lijsten kunnen worden bekeken en doorzocht door te navigeren naar het gedeelte Gepubliceerde lijsten vanuit de navigatie aan de linkerkant. Beheerders kunnen publieke lijsten als uitgelicht markeren, waardoor ze op de Toolhub-landingspagina kunnen worden weergegeven.
Lijsten kunnen gedeeld worden door de URL van de lijst te kopiëren uit de URL-balk van uw browser of door op de link Link kopiëren en delen met anderen te klikken op het detailscherm van de lijst.
Uw favoriete hulpmiddelen opslaan in een speciale lijst
Hulpmiddelen kunnen als "favorieten" worden gemarkeerd door ingelogde gebruikers, wat betekent dat ze worden opgeslagen in een speciale lijst die alleen zichtbaar is voor de huidige gebruiker. Deze lijst met favorieten is toegankelijk via het gebruikersmenu rechtsboven. Om een hulpmiddel als favoriet te markeren, klikt u op een "toolcard" om de informatiepagina te bereiken en klikt u vervolgens op de knop favoriet.
Gebruikersrechten niveaus
Anonieme gebruikers
Alle read-only acties kunnen worden gebruikt zonder authenticatie in Toolhub.
Gebruikers
Geauthenticeerde gebruikers kunnen alle alleen-lezen acties uitvoeren op dezelfde manier als anonieme gebruikers. Daarnaast kunnen ze nieuwe toolinfo-records aanmaken, toolinfo-records bewerken die ze eerder hebben aangemaakt, annotaties toevoegen aan tool-records die door anderen zijn gemaakt, nieuwe lijsten aanmaken en lijsten bewerken die ze eerder hebben aangemaakt.
Bureaucraten
Bureaucraten kunnen de rechten wijzigen van gebruikers, inclusief zichzelf. Dit omvat zowel het verlenen als het verwijderen van rechten.
Patrollers
Patrouilleurs kunnen bewerkingen van alle toolinfo-records beoordelen en ze ofwel als gecontroleerd markeren of ongecontroleerd laten. Er is nu geen manier voor een patrouilleur om een bewerking af te wijzen.
Toezichthouders
Toezichthouders kunnen elke bewerking verbergen (toezicht/onderdrukken). Bewerkingen die eerder verborgen waren, kunnen worden onthuld. Zij kunnen ook toolinfo-records en lijsten bewerken die door andere gebruikers zijn aangemaakt, zodat ze een wijziging kunnen terugdraaien of een nieuwe wijziging kunnen uitvoeren om problematische inhoud te verwijderen.
Beheerders
Beheerders hebben alle mogelijkheden van bureaucraten, patrollers en toezichthouders.
Wijzigingen controleren
Patrollers en beheerders kunnen patrouilleren/controleren. Deze rechten worden verleend door bureaucraten of beheerders.
Wanneer een wijziging van een toolinfo of een hulpmiddel lijst wordt aangebracht, kan deze op één van de drie plaatsen worden gecontroleerd:
- Vanuit de paginageschiedenis: klik op de optie "Markeer als gepatrouilleerd" in de geregistreerde vermelding
- Van een link naar de wijziging zelf: klik op de link "Markeer als gepatrouilleerd" in de wijzigingssamenvatting bovenaan de pagina.
- Van Recente wijzigingen, toegankelijk via de navigatie aan de linkerkant. Hier kunt u recente wijzigingen zoeken en filteren op meerdere criteria, zoals recordtype (hulpmiddel of lijst), gebruikersnaam en patrouillestatus.
Wijzigingen kunnen alleen worden aanvaard (gepatrouilleerd) of over worden geslagen. Zij kunnen niet worden geweigerd of afgewezen.
Gebruikersrechten wijzigen
Beheerders en bureaucraten kunnen de rechten voor zichzelf en andere gebruikers wijzigen. Rechten kunnen worden toegevoegd of verwijderd. Elke individuele toevoeging of verwijdering van toestemming zal in de auditlogboeken verschijnen. Dit betekent dat als twee rechten worden gewijzigd, er twee auditlogboekvermeldingen zijn, één voor elke recht.
Een recht toevoegen
Ga naar het scherm "Members".
- Selecteer de gebruiker om te wijzigen. Gebruik de filters om de gebruiker te vinden.
- Klik op de naam van de gebruiker. Er wordt een dialoog weergegeven met de huidige rechten van de gebruiker.
- Kies de groep die u wilt toevoegen uit de dropdownlijst.
- Klik op de knop "Voeg toe".
- Op het scherm verschijnt een melding dat de wijziging succesvol is.
Een recht verwijderen
Ga naar het scherm "Members".
- Selecteer de gebruiker om te wijzigen. Gebruik de zoekfilters om de gebruiker te vinden.
- Klik op het pictogram potlood na de naam van de gebruiker. Er wordt een dialoog weergegeven met de huidige rechten van de gebruiker.
- Identificeer het recht dat moet worden verwijderd. Klik op de knop rode vuilnisbak om het recht te verwijderen.
- Op het scherm verschijnt een melding dat de wijziging succesvol is.
Toezicht houden
Bij het toezicht houden is het mogelijk om een individuele bewerking van een toolinfo-record te verbergen. Dit kan bijvoorbeeld worden gebruikt wanneer een gebruiker zijn persoonlijke informatie per ongeluk heeft gepubliceerd. Beheerders en Toezichthouders hebben het nodige recht om een bewerking te verbergen of te tonen.
Bij revisies die gecontroleerd zijn door een Toezichthouder, worden de datum/tijd van de revisies, de naam van de gebruiker en de samenvatting van de bewerking verborgen in de geschiedenisweergave van het toolinfo-record. Alle toezichtmaatregelen worden opgenomen in het auditlogboek, met inbegrip van de naam van de toezichthouder.
Een revisie verbergen
- Bepaal de inhoud die moet worden verborgen.
- Lees de geschiedenis door om te zien wanneer deze inhoud voor het eerst is toegevoegd.
- Zorg ervoor dat de inhoud die moet worden verborgen niet meer zichtbaar is in het toolinfo-record
- Als deze nog zichtbaar blijft, kan de eigenaar van het toolinfo-record, een beheerder of een toezichthouder het toolinfo-record bewerken om de probleeminhoud te verwijderen.
- Uit de geschiedenis toolinfo-record, bepaal alle wijzigingen die moeten worden gecontroleerd.
- Klik op de link "verbergen" om een revisie te verbergen.
- Herhaal dit indien nodig om alle relevante bewerkingen te controleren.
Een verborgen revisie weergeven
- Uit de geschiedenis van het toolinfo-record, alle wijzigingen die moeten worden getoond, bepalen.
- Klik op de link "reveal" om een revisie te laten zien.
- Herhaal dit indien nodig om alle relevante bewerkingen te laten zien.
Vertalen
Het vertalen van Toolhub wordt net als bij andere projecten en hulpmiddelen bij Wikimedia Foundation gedaan door de translatewiki.net gemeenschap.
Toolhub biedt taalkeuze op basis van lijst van bekende talen en niet op vertaling voltooiing, en is geconfigureerd om vertalingen te bieden op basis van een lijst van terugvaltalen in verschillende volgorde van relevantie, standaard naar het Engels wanneer er geen vertaling is gevonden voor de string in de geselecteerde taal of andere geconfigureerde terugvaltalen. Om deze reden komt het vaak voor dat een deel van de vertalingen op een pagina in de geselecteerde taal zijn, terwijl andere delen in andere talen of in het Engels zijn. U kunt ons helpen dit op te lossen door vrijwilligerswerk te doen om Toolhub te vertalen op translatewiki.net.