Vikipeedia:Tööriistad/Viidete korrastaja

Viidete korrastaja on tööriist, mis võimaldab artiklis olevate viidete korrastamist kasutaja eelistuste järgi. Tööriist otsib üles kõik artiklis olevad viited, koondab topeltviited (kui neid on) ühe viite alla ja kuvab tulemusena saadud viidete loendi graafilises kasutajaliideses. Kasutaja saab seejärel viiteid erinevate tunnuste järgi sortida, ümber nimetada ja valida, kas viited (kõik või osa neist) asuvad viiteloendi mallis või artikli tekstis. Järgmises sammus kuvatakse tööriista tehtud muudatused artikli teksti muudatuste vaates ja kasutaja saab otsustada, kas ta soovib muudatused salvestada.

Tööriista autor on Vikipeedia kasutaja Cumbril.

Kasutamine

Punase noolega on näidatud tööriista käivituslink

Tööriista saavad kasutada sisseloginud kasutajad. Tööriista sisse lülitamiseks tee menüü Eelistused vahekaardil Tööriistad linnuke "Viidete korrastaja" ette. Välja lülitamiseks eemalda linnuke.

Kui tööriist on sisse lülitatud, tekib artiklite ja kasutaja nimeruumis menüüsse "Veel" valik "V-korrasta". Valikul klõpsates (mida saab teha nii redigeerimisrežiimis kui ka artikli leheküljel redigeerimisrežiimi minemata) asendab tööriist artikli sisuosas olevad viited märksõnadega ja liigutab viidete kirjeldused malli {{viited}} sisse.

Tööriista tööks vajalikud eeltingimused

• Tööriist eeldab, et artiklis olevate viidete loend on esitatud malliga {{viited}}. Kui viidete loendi malli asemel on kasutatud silti <references />, siis tööriist viiteid koondada ei oska. Tööriist ei oska lugeda viidete silte kujul {{#tag:ref. Kasutaja peab tagama, et kõik viited oleks esitatud siltide <ref>...</ref> vahel, ja viidete loend(id) malliga {{viited}}. Tööriista rakendamine artikli peal, kus neid silte on vaheldumisi kasutatud, kutsub suure tõenäosusega esile vea.

• Kui mall {{viited}} artiklis üldse puudub, ei saa tööriist viiteid koondada. Lisa esmalt mall ja käivita seejärel tööriist.

Omadused

• Tööriist toetab rohkem kui ühe malli {{viited}} olemasolu artiklis, näiteks kui osade viidete loend on esitatud infokasti või tabeli järel ja teise osa viidete loend artikli lõpus.

• Tööriist toetab viitegruppe (parameeter |grupp= malli {{viited}} sees, parameeter group= sildi <ref>...</ref> sees).

• Tööriist toetab tühikuid sisaldavaid viitenimesid.

• Tööriist otsib artiklist duplikaatviiteid ja koondab need ühe viite alla.
  • Kui tekstis on mitu täpselt sama nime ja sisuga viidet, siis kustutab tööriist topeltviited.
  • Kui tekstis on mitu sama nime, kuid erineva sisuga viidet, siis jätab tööriist ühe viite originaalnime alla ja nimetab teised viited ümber. Uueks nimeks saab vana nimi + alakriips + juhuslikult genereeritud nimeosa.
  • Kui tekstis on mitu sama sisu, kuid erineva nimega viidet, siis hoiab tööriist neist ühe viite alles ja kustutab ülejäänud. Kustutatud viidetele viitavad korduskasutused nimetatakse ringi.
  • Korduva sisuga nimeta viited koondatakse ühe nime alla. Kui nimeta viite sisu on juba mõne nimega viite all olemas, siis kasutatakse selle viite nime korduskasutuse märksõna tekitamiseks.

• Tööriist säilitab kõik viidete olemasolevad, kasutaja antud nimed.

• Tööriist säilitab kõik unikaalsed olemasolevad viited, isegi kui neid artikli tekstis ei kasutata (mis kutsub esile viitamistõrke).

• Kui viitel pole nime (sildis puudub parameeter |name=), genereerib tööriist viitele juhusliku viiest tähemärgist koosneva nime.

• Tööriist säilitab kõik malli {{viited}} olemasolevad parameetrid.

• Tööriist tunneb ära malli {{viited}} aliased (nagu {{reflist}}) ja parameetrite aliased (nagu |group= ja |refs=) ning asendab need artiklis tööriista konfiguratsioonis defineeritud väärtustega.

• Tööriist puhastab viidete koodi mitmekordsetest tühemikumärkidest ja eemaldab reavahemärgid.

• Tööriista kood toetab teistesse vikidesse portimist. Viidete malli nimi, parameetrite nimed jms on eraldi konfiguratsioonifailis.

Tulemuse kontrollimine

Viidete korrastaja tulemus muudatuste vaates

Tööriist oskab viiteid õigesti koondada vaid juhul, kui need on artiklis ilma vigadeta kirjeldatud. Kui artiklis on lohakusvigu, siis võidakse viited valesti sisse lugeda ja tulemuseks võib olla segamini tekst, osade viidete kadumine, mitmest viitest ühe viite tegemine, viitetõrked jms. Vigasid võib tekitada näiteks:

• sulgemata jäänud silt <ref>...</ref>
• puuduv või üleliigne jutumärk sildi <ref>...</ref> parameetrites (<ref name="nimi>)
• üleliigsed kahekordsed sulgevad looksulud (}}) viidete loendi malli sees
• ...

Viitetõrge tekib juhul, kui artikli tekstiosas on HTML-kommentaari (<!-- -->) sisse suletud viiteid – tööriist paneb need ilma ümbritseva kommentaarita viidete loendi malli sisse, mis tekitab nende artiklis mittekasutamise viitetõrke.

Seepärast on oluline, et tööriista kasutaja kontrolliks enne artikli salvestamist, kas viidetega on kõik korras.

Vahel hakkab vea olemasolu kergesti silma: artikli tekst on segamini, esinevad punased viitetõrked. Vahel aga paistab väliselt kõik korras ja viga märkab vaid lähemal vaatlemisel. Üheks märgiks selle kohta, et artiklis polnud enne tööriista käivitamist viidetega kõik korras ja tulemust tuleks lähemalt uurida, on alakriipsu sisaldavad viitenimed.

Võib ka olla, et viited on artiklis vigadeta kirjeldatud, kuid viga tekib mõnest olukorrast, mida tööriista koodis ei ole osatud ette näha. Sellisel juhul anna palun veast siinse lehekülje arutelulehel teada.

Tööriista arendamine

Tööriist on kirjutatud JavaScriptis ja selle koodihoidla asub GitHubis leheküljel https://github.com/Cumbril/refcon. Oled teretulnud tööriista arendamises osalema.