Wikiprojekt:Sprzątanie kodu

Skrót: WP:SK Wikiprojekt ma na celu czyszczenie kodu stron Wikipedii. Aby dołączyć do wikiprojektu, należy włączyć odpowiedni gadżet w Preferencjach Wikipedii albo skorzystać z odpowiedniego kodu dla bota.

Gadżet w oknie edycji

Narzędzie sprzątania kodu należy wykorzystywać przy okazji normalnej pracy edytorskiej. Aby dodać sobie przycisk do sprzątania () należy w preferencjach Wikipedii na karcie Gadżety włączyć Sprzątanie kodu lub "ręcznie" zainstalować skrypt wg ogólnej instrukcji instalacji narzędzi.

Wykonywane zmiany:

• sprzątanie wikilinków (m.in. poprawa anglojęzycznych przestrzeni, różnego rodzaju skracanie kodu linków, poprawki popularnych linków)
• sprzątanie szablonów (m.in. sprzątanie kodów infoboksów, skracanie kodu szablonów, wstawianie multilang, ujednolicanie nazw szablonów)
• sprzątanie innych elementów wikiskładni (m.in. ujednolicanie standardowych nagłówków, sprzątanie kod list)
• sprzątanie tekstu (m.in. korekty dat, poprawki popularnych skrótów, zamiana popularnych encji na odpowiedni znak)
• porządkowanie kategorii, interwiki itp.

Zobacz też sekcję funkcje niestandardowe i dodatkowe ustawienia.

Skrypt działa na zaznaczonym obszarze lub na całości okna edycyjnego (jeśli nic nie zostało zaznaczone). Powinien działać pod wszystkimi współczesnymi przeglądarkami. Po uruchomieniu należy zawsze sprawdzić czy skrypt wykonał prawidłowe zmiany - w tym celu używa się przycisku "Podgląd zmian".

Zmiany nie są wykonywane w obrębie specjalnych tagów, czyli obszarów w tagach: nowiki, pre, source i math.

Nie powinno wykonywać się edycji które polegają tylko i wyłącznie na użyciu tego gadżetu.

Notka autorska

• Licencja: GNU General Public License v2
• Autor: Maciej 'Nux' Jaros (dyskusja).
• Skrypt: Wikipedysta:Nux/wp sk.js.
• Do wklejenia przy ręcznej instalacji:

var wp_sk_show_as_button = true; // pokazuj przycisk
importScript('Wikipedysta:Nux/wp_sk.js')

Szczególne podziękowania dla:

• ABach - za zebranie i opracowanie długiej listy elementów do sprzątania
• Malarz pl - za garść kolejnych elementów do sprzątania
• BartekChom - za pomysły i gotowe wyrażenia regularne
• Gregul - za garść wyrażeń regularnych
• PMG - za wytrwałe i szczegółowe testowanie
• ToSter - za testy i pomysły na nowe rozwiązania

Funkcje niestandardowe

Linki do map Polski

Szablon:Linki do map Polski to dosyć często występujący, jednak stosunkowo trudny do wypełnienia szablon. WP:SK umożliwia wypełnienie go na podstawie linka pochodzącego z Google Maps. Wystarczy wkleić taki link w pierwszy parametr wywołania szablonu i wcisnąć przycisk sprzątania kodu.

Dodatkowe ustawienia

Ustawienia należy wprowadzić na swoją podstronę ze skryptami ponad kodem wklejonym przy ręcznej instalacji. Lepiej nie korzystać wówczas z instalacji przez stronę preferencji (zakładka gadżetów), ponieważ mogą tam być ustawione inne domyślnie opcje i zamazywać ustawienia użytkownika.

Przykładowy kod do wklejenia (włączone pokazywanie przycisku i sprzątaniem przekierowań):

var wp_sk_show_as_button = true; // pokazuj przycisk
var wp_sk_redir_enabled = true; // ajaksowe redirecty
importScript('Wikipedysta:Nux/wp_sk.js')

Należy pamiętać, że w wypadku "ręcznej" instalacji należy wyłączyć gadżet na stronie preferencji. W przeciwnym wypadku pojawi się konflikt.

Pokaż przycisk

var wp_sk_show_as_button = true; // pokazuj przycisk

Skrypt można teoretycznie uruchamiać w inny sposób niż przez przycisk i może być częścią większego skryptu. Stąd przy ręcznej instalacji bez podania żadnych opcji przycisk się nie pokaże.

Sprzątanie przekierowań (od wersji 2.2.0)

var wp_sk_redir_enabled = true; // ajaksowe redirecty

Dołączenie tej opcji powoduje, że przy zwykłym podglądzie artykułu sprawdzone zostaną wszystkie przekierowania.

Jeśli w podglądzie znalezione zostaną przekierowania, to najpierw pojawi się dodatkowa ikonka przetwarzania: . Gdy sprawdzanie zostanie zakończone, w ikonce przycisku sprzątania pojawi się małe "#R" (). Wciśniecie przycisku sprzątania z małym "#R" spowoduje, że wikilinki przekierowań zostaną poprawione.

Obecnie przekierowania są sprawdzane wyłącznie, gdy widoczny jest podgląd. Przy czym można włączyć podgląd od razu przy wejściu do edycji - wystarczy ustawić odpowiednią opcję na stronie preferencji (zakładka "Edytowanie" → "Pokaż podgląd strony podczas pierwszej edycji").

Debug

var wp_sk_debug_enabled = true; // debug

Opcja specjalna, dla użytkowników zaawansowanych. Aby w pełni skorzystać z tej opcji należy posiadać dodatkową funkcję debugującą - szczegóły u autora.

Forki (inne wersje)

W grudniu 2007 roku powstała nowa wersja oparta na ówczesnej wersji 1.4.1, która rozwijana była przez BartkaChoma (zobacz osobną stronę). Potem została dodatkowo przebudowana i jest rozwijana niezależnie od oryginału (nie wszystkie opisane tu funkcje są tam dostępne i nie wszystkie stamtąd są dostępne tutaj).

Własne rozszerzenia

Jak rozbudować WP:SK?

Zaawansowani użytkownicy mogą w prosty sposób dodać swoje własne funkcje do sprzątania. Zalecaną metodą (pozwalającą być na bieżąco) jest wstawienie poniższego kodu poniżej kodu ręcznej instalacji:

addOnloadHook(function()
{
 wp_sk.cleanerWikiVaria_old = wp_sk.cleanerWikiVaria;
 wp_sk.cleanerWikiVaria = function (str)
 {
  str = wp_sk.cleanerWikiVaria_old(str);
 
  /*
   tu wstaw swoje operacje
   np.
   str = str.replace('[[ciągle zmieniam ten link]]', '[[na ten link]]');
  */
 
  return str;
 }
});

Oczywiście, aby coś dodać, powinno się znać przynajmniej podstawy kodowania w języku JavaScript, w szczególności sposób funkcjonowania metody replace.

Dzięki podmianie funkcji cleanerWikiVaria, a nie cleaner, Twoje operacje nie będą psuły tego, czemu zapobiega podstawowa wersja: zostaną ominięte znaczniki <nowiki>, <math>, <pre> i podobne.

Lista rozszerzeń użytkowników

Jeśli sam korzystasz z WP:SK z dodatkowymi opcjami, podaj poniżej link do swojego kodu skryptu. W ten sposób inni użytkownicy będą mogli się wzorować na Twoim kodzie, dodawać z niego wybrane opcje do swojego, a może i autor wprowadzi Twoje poprawki do wersji głównej. Oczywiście należy zachować wzmożoną ostrożność przy korzystaniu z poniższych skryptów, część opcji może być niedokładnie przetestowana lub działać w ograniczonym zakresie (np. skrypt ułatwia zmiany, ale trzeba jeszcze trochę poprawić ręcznie). Zebranie rozszerzeń pozwoli też na wzajemną kontrolę. Najlepiej w swoich rozszerzeniach komentować zmiany, które nie są oczywiste.

Aby użyć poniższych rozszerzeń, w swojej stronie JS dodaj kod importScript('adres skryptu.js'); – koniecznie po importScript('Wikipedysta:Nux/wp_sk.js'); (rozszerzenia zakładają, że podstawowy skrypt został już włączony).

Skrypt	Autor	Dodane rozszerzenia
Wikipedysta:ToSter/wpsk user.js	ToSter	wikizacja HTML zamiana łączników na poprawne półpauzy (omijane są linki i nazwy plików) formatowanie liczb w niektórych przypadkach poprawa niektórych błędów ortograficznych i interpunkcyjnych usuwanie pustych parametrów szablonów cytowania ujednolicanie kodów wstawionych plików inne drobne zmiany
Wikipedysta:Malarz pl/wp sk.js	malarz pl	poprawienie błędnego formatowania ISBN -10/13 poprawienie nazw szablonów usunięcie spacji z końca linii unifikacja nagłówków (Bibliografia, Referencje, Pismiennictwo) poprawa liczebników w datach (usuwanie kropek) usunięcie enterów po infoboksie usunięcie enterów na początku artykułu usunięcie <br>'ów na końcach linii w listach (punktowanej i numerowanej) zamienia sekwencje specjalne na znaki UTF-8 (większość)
Wikipedysta:Beno/wp_sk.js	Beno	najbardziej rozwinięty plik konfiguracyjny do skryptu Nuxa, ciągle rozwijany, wprowadzający bardzo dużo poprawek, ale za cenę możliwych błędów; absolutnie nie nadaje się do stosowania automatycznego, konieczne dokładne sprawdzanie zmian(!)

Botowate

Lista zadań bota jest dostępna tutaj.

Aby skorzystać z wersji dla botów, należy:

• posiadać własnego bota używającego oprogramowania Tawbot.pm
• podmienić kod funkcji post w pliku Tawbot.pm
• używać bota do zwykłej pracy