Toolhub

This page is a translated version of the page Toolhub and the translation is 100% complete.
Other languages:

Toolhub community logo.svg

Toolhub to utrzymywany przez społeczność katalog narzędzi, wykorzystywanych w ruchu Wikimedia. Wolontariusze-technicy mogą skorzystać z niego do dokumentowania oprogramowania, które tworzą lub utrzymują. Wszyscy wikimedianie mogą przeglądać Toolhuba w poszukiwaniu narzędzi, jakich potrzebują, oraz tworzyć listy, które można potem udostępnić innym.

Czym jest „narzędzie”

W Toolhubie, „narzędzie” jest określeniem używanym na oprogramowanie, które współpracuje z projektami Wikimedia, niebędąc częścią MediaWiki. Do tej grupy należą m.in. skrypty użytkowników, gadżety, boty, szablony, moduły Lua, aplikacje internetowe oraz mobilne. Katalog w zamyśle ma być inkluzywny i zawierać oprogramowanie, które pomaga organizować pracę i poprawiać doświadczenia użytkowników projektów Wikimedia.

Licencja na zawartość

Zawartość toolinfo.json oraz inne dane strukturyzowane zbierane w Toolhubie są dostępne na licencji Creative Commons CC0 Przekazanie do domeny publicznej (CC0). Zachęcamy osoby korzystające z nich do podania atrybucji, linkując do Toolhuba, jednak nie jest to wymagane dla zgodności z licencją. Utrzymujący pliki toolinfo.json na zewnątrznych serwerach muszą się upewnić, że ich (współ)autorzy są świadomi wymogu publikacji na licencji CC0. Opisy narzędzi, skopiowane z projektów Wikimedia lub dokumentacji, które są udostępniane na innej licencji, powinny zostać skrócone do 50 słów/250 znaków, aby ograniczyć zakres wymogów licencyjnych. Ten limit odnosi się tylko do treści skopiowanych. Teksty na CC0 mogą być dowolnej długości.

Konta użytkowników

Toolhub wykorzystuje autoryzację protokołem OAuth, z użyciem istniejących kont Wikimedia. Nie ma potrzeby tworzenia nowych kont, ani ustalania nowych haseł.

Dodawanie narzędzi do katalogu

Narzędzia w Toolhubie pochodzą z zarejestrowanych plików toolinfo.json, dostępnych w internecie. Drugą metodą dodania wpisów do katalogu jest przesłanie danych bezpośrednio do API Toolhuba.

Publikacja pliku toolinfo i rejestracja w Toolhubie

Plik toolinfo jest dokumentem JSON, zgodnym ze standardem toolinfo. Jest on rozszerzeniem specyfikacji stworzonej przez Husky'ego, jako część jego Hay's Directory.

  1. Stwórz plik JSON zgodny ze standardem
  2. Umieść go na stronie internetowej
  3. Zarejestruj adres URL pliku w Toolhubie

Toolhub sprawdza każdy zarejestrowany plik toolinfo co około 60 minut i aktualizuje katalog w razie potrzeby.

Utworzenie rekordu toolinfo poprzez interfejs użytkownika Toolhuba

Aby utworzyć nowy wpis toolinfo wprost w katalogu, możesz użyć opcji Add or remove tools > Create a new tool w Toolhubie. Jeśli chcesz podać więcej informacji, niż pozwala formularz tworzenia narzędzia, możesz je dodać później, wykorzystująć okno edycji narzędzia (Edit tool).

Tworzenie i edycja toolinfo poprzez API

Punkt końcowy POST /api/tools/ API Toolhuba może zostać wykorzystany do stworzenia nowego wpisu toolinfo bezpośrednio w katalogu narzędzi. Ta sama metoda jest wykorzystywana przez interfejs użytkownika. Po więcej informacji o specyfikacji tego punktu dostępu możesz się udać do dokumentacji API Toolhuba.

Przeszukiwanie katalogu

Wyszukiwarka korzysta ze składni Elasticsearch simple query string syntax:

  • + oznacza koniunkcję (spójnik „i”)
  • | oznacza alternatywę (spójnik „lub”)
  • - powoduje negację pojedynczego członu
  • " oznacza frazę, składającą się z kilku członów
  • * na końcu wyrażenia oznacza prefiks wyszukiwania
  • ( i ) służą do grupowania wyrażeń
  • ~N (gdzie N to liczba) po słowie oznacza odległość edycyjną
  • ~N (gdzie N to liczba) po frazie oznacza maksymalną liczbę pozycji pomiędzy pasującymi członami
  • Znaki specjalne (+, |, -, ", *, (, ), and ~) muszą zostać poprzedzone \ albo umieszczone wewnątrz cudzysłowów, aby utracić swoje specjalne znaczenie.
  • Wyszukiwania nie rozróżniają wielkości znaków

Tworzenie i udostępnianie list narzędzi

Do ekranu Your lists (Twoje listy) można przejść za pomocą linku w menu użytkownika. Jest on dostępny wyłącznie po zalogowaniu. Naciśnij ikonkę użytkownika obok przycisku wyboru języka w pasku nawigacyjnym u góry, by otworzyć menu. Za jego pomocą możesz tworzyć i edytować listy, a także – kiedy będą gotowe – oznaczyć je jako publiczne, by inni mogli z nich korzystać. Publiczne listy mogą zostać wyróżnione przez administratorów, dzięki czemu będą mogły się wyświetlić na stronie głównej Toolhuba.

Listy można udostępnić, kopiując URL z paska adresu przeglądarki lub klikając na przycisk Copy link and dhare with others (skopiuj link i udostępnij innym) na ekranie ze szczegółami listy.

Obsługa list w Toolhubie 1.0 działa, ale nie ma wszystkich funkcji, które zamierzyliśmy. Spodziewaj się nowych, takich jak przeszukiwanie wszystkich publicznych list czy wyświetlanie historii zmian.

Uprawnienia użytkowników

Użytkownicy anonimowi

Wszystkie czynności polegające na odczycie danych można wykonywać bez logowania do Toolhuba.

Użytkownicy

Zalogowani użytkownicy mogą wykonywać wszystko to, co anonimowi. Ponadto, są uprawnieni do tworzenia nowych rekordów toolinfo, edycji stworzonych przez siebie wpisów do katalogu, a także tworzenia i edycji swoich list.

Biurokraci

Biurokraci mogą zmieniać uprawnienia sobie i innym. Dotyczy to zarówno przyznawania jak i odbierania uprawnień.

Patrolujący

Patrolujący mają uprawnienia do oceniania zmian w dowolnych rekordach toolinfo i oznaczenia ich jako „sprawdzone” lub pozostawiania nieoznaczonymi. W tej chwili nie ma możliwości wycofania edycji.

Rewizorzy

Rewizorzy mogą ukrywać dowolną zmianę oraz przywracać te ukryte. Mają również uprawnienia do edycji rekordów toolinfo i list innych użytkowników, dzięki czemu mogą cofać problematyczne zmiany albo usuwać zawartość, która nie powinna się w katalogu znaleźć.

Administratorzy

Administratorzy mają wszystkie uprawnienia biurokratów, patrolujących i rewizorów.

Patrolowanie zmian

Zmiany mogą sprawdzać patrolujący oraz administratorzy. Odpowiednie uprawnienie przyznają biurokraci lub administratorzy.

Kiedy w rekordzie toolinfo zostanie wykonana zmiana, może zostać sprawdzona z dwóch miejsc:

  • Z poziomu historii strony: kliknij opcję „Oznacz jako «sprawdzoną»” (Mark as patrolled) na odpowiednim wpisie rejestru;
  • Z poziomu linku do samej zmiany: kliknij „Oznacz jako «sprawdzoną»” (Mark as patrolled) w podsumowaniu zmian na górze strony.

Zmiany mogą jedynie zostać oznaczone, albo pozostawione bez zmian. Nie ma możliwości odrzucenia ich lub wycofania.

Zmiana uprawnień użytkowników

Administratorzy i biurokraci mogą zmieniać uprawnienia sobie i innym. Dotyczy to zarówno ich przyznawania jak i odbierania. Każda pojedyncza zmiana w uprawnieniach użytkownika będzie widoczna w logach. To oznacza, że jednoczesne przyznanie lub odebranie kilku uprawnień wygeneruje więcej niż jeden wpis w rejestrze.

Przyznawanie uprawnień

  • Przejdź do widoku „Członkowie” (Members).
  • Wybierz użytkownika, któremu chcesz nadać uprawnienia. Pomocne może być ustawienie filtrów wyszukiwania.
  • Kliknij ikonkę ołówka obok nazwy użytkownika. Wyświetli się okno z jego bieżącymi uprawnieniami.
  • Z listy rozwijanej wybierz grupę, do której chcesz dodać użytkownika.
  • Naciśnij „Dodaj” (Add).
  • Pojawi się komunikat, że operacja się powiodła.

Odbieranie uprawnień

  • Przejdź do widoku „Członkowie” (Members).
  • Wybierz użytkownika, któremu chcesz odebrać uprawnienia. Pomocne może być ustawienie filtrów wyszukiwania.
  • Kliknij ikonkę ołówka obok nazwy użytkownika. Wyświetli się okno z jego bieżącymi uprawnieniami.
  • Znajdź uprawnienie do odebrania. Kliknij czerwoną ikonę kosza na śmieci obok odpowiedniej pozycji.
  • Pojawi się komunikat, że operacja się powiodła.

Ukrywanie wersji

Uprawnieniami do ukrywania i odkrywania wersji dysponują rewizorzy i administratorzy. Pozwala to reagować na sytuacje, kiedy użytkownik omyłkowo udostępni prywatne informacje.

Metadane (takie jak data edycji, nazwa użytkownika i opis zmian) powiązane z wersją nie będą widoczne na stronie historii rekordu toolinfo. Wszystkie akcje rewizorskie, razem z nazwą użytkownika, który je wykonał, są zapisywane w odpowiednim rejestrze.

Ukrywanie wersji

  • Określ zawartość do ukrycia
  • Przejrzyj historię zmian, aby określić kiedy dodano tę treść
  • Upewnij się że zawartość do ukrycia nie jest częścią najnowszej wersji strony
    • Jeśli najnowsza wersja zawiera treść do ukrycia, administrator, rewizor lub właściciel narzędzia powinni edytować opis, by ją usunąć
  • Określ, które wersje należy ukryć
  • Kliknij na link „ukryj” (hide), aby ukryć zmianę
  • Powtórz tyle razy, ile to konieczne, by ukryć wszystkie problematyczne wersje

Ujawnianie ukrytej wersji

  • Z poziomu historii wersji, określ które wersje należy ujawnić
  • Kliknij link „ujawnij” (reveal) przy pojedynczej pozycji
  • Powtórz tyle razy, ile konieczne, by ujawnić wszystkie pożądane wersje