Centrum Społeczności
Advertisement
Rozszerzenie jest domyślnie wyłączone, ale może być dostępne na żądanie.

Gadżety udostępniają niestandardowe CSS i JavaScript użytkownikom, którzy zdecydują się je włączyć. W odróżnieniu od CSS-u i JS-u społeczności, ładowanych dla wszystkich użytkowników, CSS i JS gadżetów jest ładowany tylko użytkownikom posiadającym włączony dany gadżet. Gadżety są konfigurowane niezależnie dla każdej społeczności – użytkownicy mogą je włączać i wyłączać w swoich preferencjach w zakładce „Gadżety”.

Przykładowa sekcja gadżetów na Specjalna:Preferencje

Gadżety stanowią drogę na udostępnienie użytkownikom opcjonalnych funkcji w obrębie całej wiki – pamiętaj jednak,  że anonimowi użytkownicy nie mogą włączać gadżetów ani reaktywować tych ustawionych jako domyślnie włączone.

Uruchomienie rozszerzenia

Domyślnie większość wiki na Fandomie nie używa gadżetów. Są one dostarczane poprzez rozszerzenie, o włączenie którego zainteresowana społeczność musi poprosić wsparcie Fandomu na Centrum Społeczności lub w formularzu kontaktowym.

Lista gadżetów

Przykładowy wygląd strony Specjalna:Gadżety

Aby zobaczyć listę gadżetów dostępnych w społeczności, przejdź na stronę Specjalna:Gadżety. Ta strona specjalna udostępnia również linki umożliwiające edytowanie opisy gadżetów, listę plików wykorzystywanych przez każdy gadżet oraz uprawnienia wymagane do ich używania. Pamiętaj jednak, że nie możesz na tej stronie włączać oraz wyłączać gadżetów – w celu zarządzania używanymi gadżetami na danej wiki musisz wejść na Specjalna:Preferencje.

Wiki bez włączonego rozszerzenia Gadżetów wyświetlą na stronie Specjalna:Gadżetu komunikat o błędzie, ponieważ strona ta na nich nie istnieje.

Dodawanie gadżetów

Definicja gadżetu

Przykład zawartości MediaWiki:Gadgets-definition

Pierwszym krokiem do utworzenia gadżetu jest jego zdefiniowanie. Aby to zrobić, przejdź na stronę MediaWiki:Gadgets-definition na swojej wiki i kliknij przycisk edycji. Każdy z gadżetów jest definiowany przez wpis w liście wypunktowanej, a więc każda nowa linia rozpoczyna się od symbolu *.

Formatowanie definicji gadżetów wygląda następująco:

* nazwa_gadżetu [ustawienia] | plik1 | plik2 | itd.
  • nazwa_gadżetu musi być unikalna oraz wielkość znaków w niej ma znaczenie. Musi zaczynać się od podstawowego znaku z alfabetu łacińskiego ([A-Za-z]) i może zawierać dowolną liczbę liter, cyfr ([0-9]), myślników (-), podkreśleń (_), dwukropków (:) oraz kropek (.).
  • Zobacz #Ustawienia gadżetu, aby dowiedzieć się więcej na temat ustawienia.
  • Zobacz #Pliki gadżetu, aby dowiedzieć się więcej na temat plik1, plik2, itd.

Jeśli twoja wiki posiada wiele gadżetów, pomocne może okazać się podzielenie ich listy na sekcje przy użyciu składni nagłówków (== nagłówek ==). Na przykład poniższa lista czterech gadżetów jest podzielona na dwie sekcje: utilities oraz visual. Podobnie jak nazwy gadżetów, nagłówki sekcji są podatne na zmiany wielkości liter oraz muszą być unikalne, ponadto poleca się, aby nagłówki sekcji były zapisane w języku angielskim.

== utilities ==
* narzędzie1 [ResourceLoader] | NiezłeNarzędzie.js
* narzędzie2 [ResourceLoader|rights=rollback] | NarzędzieRollbacków.js | NarzędzieRollbacków.css

== visual ==
* motyw1 [type=styles] | NiezłyMotyw.css
* motyw2 [type=styles] | OgnistyMotyw.css

Opis gadżetu

Domyślnie dla użytkowników twój gadżet zostanie wyświetlony na Specjalna:Preferencje jako ⧼gadget-nazwa_gadżetu⧽. Nie jest to bardzo pomocny opis, dlatego możesz edytować opisy wyświetlane użytkownikom, przechodząc do strony MediaWiki:Gadget-nazwa_gadżetu na swojej wiki i nadając jej odpowiednią treść. Alternatywnie możesz również przejść do listy gadżetów na Specjalna:Gadżety i kliknąć opcję „Edytuj” obok definicji danego gadżetu.

Pomocny opis gadżetu zawiera informacje na temat zmian, jakie przyniesie włączenie gadżetu lub nowych funkcji, do których użytkownik zyska dostęp po jego aktywacji. Pamiętaj, że celem gadżetów jest dawanie użytkownikom wyboru w kwestii modyfikowania swojego doświadczenia na wiki. Aby dokonać wyboru, potrzebują oni niezbędnych informacji.

Nagłówki sekcji również mogą zostać zmodyfikowane, aby wyświetlały się w sposób przyjazny dla użytkowników. Korzystając z powyższego przykładu, aby zmienić nagłówek sekcji utilities, przejdź na stronę MediaWiki:Gadget-section-utilities lub kliknij link „[Edytuj]” obok nagłówka sekcji na Specjalna:Gadżety.

Ustawienia gadżetu

Definicja gadżetu może zawierać opcje, które precyzują, w jaki sposób ładowany będzie gadżet lub kto otrzyma do niego dostęp. Każda opcja musi zostać oddzielone od innych przy użyciu symbolu |. Opcje, które nie wymagają żadnych parametrów, jak np. ResourceLoader, mogą zostać dodane samodzielnie, jednak opcje które wymagają podania parametrów, muszą zostać zdefiniowane wraz ze znakiem równości oraz listą parametrów oddzielonych przecinkami, jak np. rights=rollback,delete.

Poniższa tabela wymienia ustawienia gadżetów dostępne na Fandomie.

Nazwa Parametry Opis
ResourceLoader Brak Oznacza skrypty gadżetu jako kompatybilne z ResourceLoaderem.
Ta opcja jest wymagana dla każdego gadżetu ładującego co najmniej jeden plik JavaScript. W innym wypadku strona Specjalna:Gadżety wyświetli błąd, a JS nie zostanie wczytany.
dependencies Nazwy modułów ResourceLoadera oddzielone przecinkami Ta opcja nie wywołuje żadnego efektu, jeżeli gadżet nie posiada żadnych zasobów kompatybilnych z ResourceLoaderem (brak skryptów i stylów oznaczonych jako kompatybilne).
rights Nazwy uprawnień oddzielone przecinkami Wyłącza i ukrywa gadżet w preferencjach użytkowników, którzy nie posiadają podanych uprawnień. Zwróć uwagę, że uprawnienia użytkowników to nie grupy uprawnień – pełna lista uprawnień znajduje się na stronie Specjalna:Grupy użytkowników.
default Brak Każdy gadżet włączony domyślnie MUSI spełniać wymagania stawiane przez politykę modyfikacji.
Włącza gadżet domyślnie dla wszystkich użytkowników, włączając w to niezalogowanych. Tylko zarejestrowani użytkownicy mogą wyłączać takie gadżety.
type styles lub general Użyj type=styles dla gadżetów, które ładują tylko pliki CSS. Sprawi to, że CSS zostanie wczytany poprzez HTML strony, co jest szybsze niż domyślne ładowanie przez JavaScript. Zwróć jednak uwagę, że użycie type=styles oznacza, iż gadżet nie wczyta żadnych plików JS.

Pliki gadżetu

Chlebem i solą każdego gadżetu są pliki, które zostają wczytane po jego włączeniu. Każdy plik CSS i JS ładowany przez gadżet musi zaczynać się od MediaWiki:Gadget-. Korzystając z powyższego przykładu, narzędzie2 definiuje dwa pliki: „NarzędzieRollbacków.js” oraz „NarzędzieRollbacków.css”, których lokalizacjami byłyby kolejno MediaWiki:Gadget-NarzędzieRollbacków.js oraz MediaWiki:Gadget-NarzędzieRollbacków.css. Dobrą praktyką jest używać tych samych nazw dla gadżetów i ich plików, jednak jak przedstawiono na przykładzie, nie jest to twardy wymóg.

Pomijając prefiks „Gadget-”, pliki CSS i JS gadżetów działają jak każdy inny plik CSS i JS na wiki. W związku z tym zwróć uwagę, że pliki JS gadżetów muszą zostać zatwierdzone w procesie przeglądu JavaScriptu, zanim zaczną działać dla wszystkich. Zaś w kwestii kolejności ładowania, gadżety są wczytywane po innych lokalnych kodach społeczności, lecz przed osobistymi kodami.

Pojedynczy gadżet może wczytywać tak wiele stron kody jak tylko zapragniesz, jednak rzadko spotyka się przypadki wymagające ładowania więcej niż jednej strony JS i jednej strony CSS. Każdy plik musi być odseparowany w definicji gadżetu symbolem |. Ponadto każda strona CSS i JS gadżetu może być ładowana przez wiele gadżetów. Tak jak inne strony kodów na wiki, gadżety mogą być napisane jedynie przy użyciu CSS-u i JS-u.

Zobacz także

  • Rozszerzenie:Gadżety: opis rozszerzenia na MediaWiki.org, na którym oryginalnie bazowano tę stronę.
  • Pomoc:Rozszerzenia: przewodnik po wszystkich rozszerzeniach, które ma do zaoferowania Fandom.

Dalsze wsparcie

Szukasz dalszego wsparcia lub masz pytanie? Sprawdź poniższe linki, aby dowiedzieć się więcej.

Advertisement