Toolhub
Toolhub je komunitou spravovaný katalóg softvéru nástrojov používaného v hnutí Wikimedie. Technickí dobrovoľníci môžu použiť Toolhub na dokumentáciu nástrojov, ktoré vytvárajú alebo spravujú. Všetci Wikimedianci môžu použiť Toolhub na vyhľadávanie nástrojov, ktoré im pomôžu s pracovnými postupmi, a na vytváranie zoznamov užitočných nástrojov, ktoré môžu zdieľať s ostatnými.
Čo je to "nástroj"?
V Toolhub je „nástroj“ inkluzívny výraz pre softvérové aplikácie, ktoré interagujú s projektmi Wikimedia bez toho, aby boli plne implementované v MediaWiki. Patria sem veci ako používateľské skripty, gadgets, boty, šablóny, lua moduly, webové aplikácie a mobilné aplikácie. Katalóg má byť skôr inkluzívny než exkluzívny, pokiaľ sú veci, ktoré dokumentuje, užitočné na zlepšenie pracovných postupov a používateľských skúsenosti pri interakcii s projektmi Hnutia Wikimédie.
Licencia obsahu
Údaje Toolinfo.json a ďalšie štruktúrované údaje zhromaždené v Toolhube sú licencované v rámci Creative Commons CC0 Dedication (CC0). Opätovným používateľom sa odporúča poskytnúť uvedenie zdroja prepojením späť na Toolhub, ale nie je to potrebné pre súlad s licenciou. Je zodpovednosťou správcov externe hostovaných dátových súborov toolinfo.json, aby zabezpečili, že ich prispievatelia poznajú požiadavku licencovania CC0. Údaje o nástrojoch skopírované z wiki stránok s obsahom Wikimedia alebo inej dokumentácie na základe licencie inej ako CC0 by mali obmedziť skopírovaný obsah „popisu“ na 50 slov/250 znakov, aby sa obmedzili nároky na potenciálne záväzky vyplývajúce z autorských práv, ako je uvádzanie autora. Limit slov/znakov platí len pre skopírovaný obsah a pôvodné popisy CC0 môžu mať ľubovoľnú dĺžku.
Používateľské účty
Toolhub používa autentifikáciu OAuth, aby umožnil používateľom prihlásiť sa do Toolhub pomocou ich používateľského wiki účtu vo Wikimédie. Nie sú potrebné žiadne nové účty ani heslá.
Pridávanie nástrojov do katalógu
Nástroje je možné pridať do katalógu Toolhub buď načítaním z adresy URL zaregistrovaného súboru toolinfo.json alebo priamym odoslaním údajov do API Toolhub.
Hosting your toolinfo.json files as part of a Git repository makes it possible for volunteers to submit pull requests to help keep the core tool information updated.
Zverejnite súbor s informáciami o nástroji a zaregistrujte ho vo webovom vyhľadávači Toolhub
Súbor toolinfo je dokument JSON, ktorý vyhovuje toolinfo schéme. Tento štandard je rozšírením špecifikácie toolinfo pôvodne vyvinutej používateľom Husky ako súčasť jeho nástroja Hay's Directory.
- Vytvorte súbor JSON v súlade so schémou
- Zverejnite tento súbor na webovej stránke
- Zaregistrujte adresu URL súboru pomocou webového vyhľadávači Toolhub
Toolhub skontroluje každú zaregistrovanú URL adresu toolinfo približne každých 60 minút a aktualizuje katalóg o zmeny.
Example toolinfo.json files from real tools:
Nástroje hosťované na Toolforge môžu použiť toolsadmin na vytvorenie záznamu s informáciami o nástroji, ktorý bude automaticky importovaný nástrojmi Toolhub a Hay's Directory. |
Na vytvorenie a úpravu záznamu toolinfo Použite používateľské rozhranie Toolhub
Na obrazovke Toolhube môžete cez Pridať alebo odstrániť nástroje > Vytvoriť nový nástroj priamo vytvoriť v katalógu Toolhubu nový toolinfo záznam. Ďalšie informácie, ktoré nie sú zhromaždené vo formulári na vytvorenie informácií o nástroji, je možné pridať prostredníctvom následných úprav cez obrazovku nástroja na úpravu nástroja.
Použite Toolhub API na vytvorenie a úpravu toolinfo záznamu
Koncový bod POST /api/tools/ API Toolhub možno použiť na vytvorenie nového toolinfo záznamu priamo v katalógu Toolhub. Toto API používa v zákulisí používateľské rozhranie Toolhub. Podrobné informácie o očakávaných vstupoch a výstupoch tohto koncového bodu API nájdete v dokumentácii API Toolhub.
Informácie o úprave nástroja
Some of the information contained in the toolinfo record is editable by anyone, but some of it can only be edited by owners or admins. Toolhub's data model splits tool information into two parts: the core tool info and its annotations:
| Type of metadata | How it is created | Who can change it | Where to make changes |
| Core tool info
Basic and essential information about the tool. |
Created by using API or Toolhub (the UI uses the API on the backend) OR By submitting a toolinfo.json URL to be crawled |
The owner, Administrators and Oversighters OR Users who can change (or submit pull requests for) the externally-stored toolinfo.json file |
In the same place the record was created. If the tool record was originally submitted through Toolhub, it can only be edited through Toolhub. If tool record data is stored externally in toolinfo.json files, it can only be edited there. |
| Community annotations
Additional information about the tool. |
Toolhub UI, API, or through tools like Toolhunt that use the API | Any authenticated user with a Wikimedia account | Toolhub UI, API, or through tools like Toolhunt that use the API |
Core tool info
All tools in Toolhub have a core tool record containing basic information, such as the tool name and author. Only the owner, Administrators and Oversighters can edit the core tool info in Toolhub. The owner of a tool's core information is the user who created it within Toolhub (regardless of which method they used to create it).
For externally-stored toolinfo records, anyone with permissions to edit the crawled toolinfo file can edit the core tool info.
URL nástroja na úpravu
Adresa URL nástroja je súčasťou „základných“ údajov o nástroji. To znamená, že ho môže odoslať ako súčasť súboru toolinfo.json alebo ho môže upraviť prostredníctvom používateľského rozhrania a rozhrania API „vlastník“ záznamu toolinfo. Komunita ako celok ho (zatiaľ) nemôže upravovať. Ak formulár, ktorý vidíte po kliknutí na tlačidlo „upraviť nástroj“, začína poľom „Adresa URL rozhrania API“, potom sa vám zobrazuje formulár na úpravu vrstvy „anotácií“ záznamu s informáciami o nástroji – nebudete môcť upraviť URL.
Ak ste správcom nástroja a váš záznam bol importovaný z https://toolsadmin.wikimedia.org, vo formulári na úpravu na správcovi nástrojov sa v dolnej časti formulára zobrazí začiarkavacie políčko s označením „Toto je webová služba“. Začiarknutím tohto políčka sa adresa URL záznamu s informáciami o nástroji automaticky nastaví. Všimnite si, že vyhľadaváč Toolhub beží raz za hodinu, takže zmeny v záznamoch toolinfo uskutočnené cez Toolsadmin trvajú viac ako hodinu, kým sa prejavia.
Community annotations
After Toolhub receives a core tool record, volunteers can submit annotations to it. Annotations help make it easier to find tools by supplying additional information. Annotations cannot be stored in toolinfo.json files; they are meant to always be editable by community members.
The annotations fields are:
- Ikona
- Typ nástroja
- Dostupné jazyky používateľského rozhrania
- Pre wiki
- QID Wikiúdajov
- Odkazy: API, preklady, nástroj na sledovanie chýb, dokumenty atď.
- Či je nástroj zastaraný/experimentálny/nahradený iným nástrojom
Podrobnosti o poliach, ktoré sú súčasťou vrstvy anotácií, sú v dokumentácii API na https://toolhub.wikimedia.org/api-docs#put-/api/tools/-name-/annotations/.
Some annotations mirror fields from the core toolinfo.json specification. Toolhub only displays an annotations field for community editing if the corresponding field in the core record is empty or missing. When both the core and annotation data for a given field are populated, Toolhub displays the core data rather than the annotation data. This was chosen as a compromise between the conflicting desires for tool maintainers to have ultimate control of their data records, and for the community to be able to improve the documentation for tools.
Vyhľadávanie nástrojov
Vyhľadávania obrazovka používa Elasticsearch syntax jednoduchého reťazcového dotazu:
+znamená operáciu AND|znamená operáciu ALEBO-neguje jeden token"obalí množstvo tokenov na označenie frázy pre vyhľadávanie*t na konci výrazu označuje dotaz na predponu(a)znamenajú prednosť~N po slove znamená vzdialenosť úprav (neostrosť)~N po fráze znamená množstvo slopu- Špeciálne znaky (
+,|,-,",*,(,), and~) musia byť escapované pomocou\alebo v úvodzovkách, ktoré sa majú hľadať - Pri vyhľadávaní sa nerozlišujú veľké a malé písmená
Funkcia automatického dopĺňania je navrhnutá tak, aby vám pomohla s relevantnými návrhmi pri zadávaní vyhľadávania.
Vytvárajte a zdieľajte zoznamy nástrojov
Obrazovku Vaše zoznamy nájdete cez odkaz v používateľskej ponuke dostupnej pre prihlásených používateľov. Kliknutím na ikonu používateľa v hornom navigačnom paneli vedľa nastavovača jazyka otvoríte používateľskú ponuku. Tu môžete vytvárať a upravovať zoznamy nástrojov a keď budete pripravení, označiť ich ako verejné, aby ste ich mohli zdieľať s ostatnými.
Nástroje je tiež možné pridať do existujúceho alebo novovytvoreného zoznamu (alebo z neho odstrániť) priamo pomocou tlačidla ponuky na karte nástroja, ako aj pomocou tlačidla ponuky na informačnej stránke nástroja.
Verejné a odporúčané zoznamy
Verejné zoznamy je možné prezerať a vyhľadávať tak, že prejdete do sekcie Publikované zoznamy z navigačného panela vľavo. Administrátori môžu označiť verejné zoznamy ako odporúčané, čo im umožní zobraziť ich na vstupnej stránke Toolhub.
Zoznamy je možné zdieľať skopírovaním adresy URL zoznamu z panela s adresou URL vášho prehliadača alebo kliknutím na odkaz Kopírovať odkaz a zdieľať s ostatnými na obrazovke podrobností zoznamu.
Uložte si svoje obľúbené nástroje do špeciálneho zoznamu
Prihlásení používatelia môžu nástroje označiť ako „obľúbené“, čo znamená, že sa uložia do špeciálneho zoznamu viditeľného iba pre aktuálneho používateľa. Tento zoznam obľúbených je dostupný z používateľskej ponuky v pravom hornom rohu. Ak chcete nástroj označiť ako obľúbený, kliknite na kartu nástroja, aby ste sa dostali na stránku s informáciami o nástroji, a potom kliknite na tlačidlo obľúbené.
Úrovne povolení používateľa
Anonymní používatelia
Všetky akcie typu iba-čítanie je možné použiť bez overenia totožnosti na Toolhub.
Používatelia
Overení používatelia môžu vykonávať všetky akcie iba na čítanie rovnakým spôsobom ako anonymní používatelia. Okrem toho môžu vytvárať nové záznamy s informáciami o nástrojoch, upravovať záznamy s informáciami o nástrojoch, ktoré predtým vytvorili, vytvárať nové zoznamy a upravovať zoznamy, ktoré predtým vytvorili.
Byrokrati
Byrokrati môžu zmeniť povolenia pre iných používateľov vrátane seba. To zahŕňa udeľovanie aj odstraňovanie povolení.
Patrolovia (strážcovia)
Patrolovia môžu kontrolovať úpravy akýchkoľvek záznamov s informáciami o nástrojoch a buď ich označiť ako strážené, alebo ich nechať nestrážené. V súčasnosti neexistuje spôsob, ako by hliadka mohla odmietnuť úpravu.
Dozorcovia
Dozorcovia sú schopní skryť (prehliadnuť/potlačiť) akúkoľvek úpravu. Úpravy, ktoré boli predtým skryté, môžu byť odhalené. Kontrolóri môžu tiež upravovať záznamy a zoznamy s informáciami o nástrojoch vytvorené inými používateľmi, aby mohli vrátiť zmeny alebo vykonať novú úpravu s cieľom odstrániť problémový obsah.
Administrátori
Administrátori majú všetky práva byrokratov, patrolov a dozorcov.
Zmeny patrolov
Patroli a správcovia môžu hliadkovať pri zmenách. Patrolové práva udeľujú byrokrati alebo správcovia.
Keď sa vykoná zmena v informáciách o nástroji alebo v zázname zoznamu nástrojov, možno ich kontrolovať z jedného z troch miest:
- Z histórie stránky: kliknite na možnosť „Označiť ako kontrolované“ pri prihlásenom zázname
- Od odkazu k samotnej zmene: kliknite na odkaz „Označiť ako kontrolované“ v súhrnných informáciách zmien v hornej časti stránky.
- Z Posledné zmeny prístupné z navigačného panela vľavo. Tu môžete vyhľadávať a filtrovať posledné zmeny podľa viacerých kritérií, ako je typ záznamu (nástroj alebo zoznam), používateľské meno a stav kontroly.
Zmeny môžu byť prijaté (kontrolované) alebo ponechané samostatne. Nemožno ich prijať ani odmietnuť.
Zmena používateľských oprávnení
Administrátori a byrokrati môžu zmeniť povolenia pre seba a ostatných používateľov. Povolenia je možné pridať alebo odstrániť. Každé jednotlivé pridanie alebo odstránenie povolenia sa zobrazí v protokoloch auditu. To znamená, že ak sa zmenia dve povolenia, vytvoria sa dva záznamy denníka auditu, jeden pre každé povolenie.
Ak chcete pridať povolenie
- Prejdite na obrazovku "Členovia".
- Vyberte používateľa, ktorého chcete upraviť. Na vyhľadanie používateľa použite vyhľadávacie filtre.
- Kliknite na ikonu ceruzky (za menom používateľa). Zobrazí sa dialógové okno s aktuálnymi povoleniami používateľa.
- Z rozbaľovacieho zoznamu vyberte skupinu, ktorú chcete pridať.
- Kliknite na tlačidlo „Pridať“.
- Na obrazovke sa zobrazí upozornenie, že zmena bola úspešná.
Odstránenie povolenia
- Prejdite na obrazovku "Členovia".
- Vyberte používateľa, ktorého chcete upraviť. Na vyhľadanie používateľa použite vyhľadávacie filtre.
- Kliknite na ikonu ceruzky za menom používateľa. Zobrazí sa dialógové okno s aktuálnymi povoleniami používateľa.
- Identifikujte povolenie na odstránenie. Kliknutím na červené tlačidlo odpadkového koša toto povolenie odstránite.
- Na obrazovke sa zobrazí upozornenie, že zmena bola úspešná.
Skrývanie
Skrývanie umožňuje skryť individuálnu úpravu záznamu s informáciami o nástroji. Môže sa to použiť napríklad vtedy, keď používateľ omylom zverejnil svoje súkromné informácie. Správcovia a dozorcovia majú povolenia potrebné na skrytie alebo odhalenie úprav.
Revízie, ktoré boli prehliadnuté, budú mať dátum/čas revízie, meno používateľa a zhrnutie úprav skryté v zobrazení histórie záznamu o nástroji. Všetky činnosti dohľadu sú zaznamenané v denníku auditu vrátane mena dozorného orgánu.
Ak chcete skryť revíziu
- Identifikujte obsah, ktorý má byť skrytý.
- Skontrolujte históriu a zistite, kedy bol tento obsah prvýkrát pridaný.
- Uistite sa, že obsah, ktorý sa má skryť, už nie je viditeľný v zázname toolinfo
- Ak je stále viditeľný, vlastník záznamu s informáciami o nástroji, správca alebo dozorca môže záznam s informáciami o nástroji upraviť a odstrániť problémový obsah.
- Z histórie záznamov toolinfo identifikujte všetky zmeny, ktoré je potrebné prehliadnuť.
- Kliknutím na odkaz „skryť“ skryjete revíziu.
- Opakujte podľa potreby, aby ste prešli všetky relevantné úpravy.
Ak chcete zobraziť skrytú revíziu
- Z histórie záznamov toolinfo identifikujte všetky zmeny, ktoré je potrebné odhaliť.
- Kliknutím na odkaz „zobraziť“ zobrazíte revíziu.
- Opakujte podľa potreby, aby ste odhalili všetky relevantné úpravy.
Preklad
Jazykové preklady na Toolhub rovnako ako ostatné projekty a nástroje vo Wikimedia Foundation zabezpečuje translatewiki.net komunita.
Toolhub poskytuje výber jazyka na základe zoznamu známych jazykov a nedokončených prekladov a je nakonfigurovaný tak, aby poskytoval preklady na základe zoznamu záložných jazykov v rôznom poradí podľa relevantnosti, pričom predvolene je angličtina, keď sa pre daný reťazec vo vybranom jazyku alebo v iných nakonfigurovaných záložných jazykoch. Z tohto dôvodu sa často stretnete so situáciami, keď časť prekladov na stránke je vo vybranom jazyku, zatiaľ čo ostatné časti sú v iných jazykoch alebo angličtine. Môžete nám to pomôcť vyriešiť tak, že sa dobrovoľne prihlásite do prekladu toolhub na translatewiki.net.