Vikipeedia:Tööriistad/Viidete korrastaja

Viidete koondaja on tööriist, millega saab artikli tekstis olevad viited koondada kokku viidete loendi malli(de) sisse. Sellisel viisil liigutatakse viidete kood, mis võib lähtetekstirežiimis toimetamist segada, artikli sisuosast välja eraldi plokki.

Viited koondatakse malli {{viited}} parameetrisse |allikad= ja artikli sisuosasse jäävad märksõnad mallis kirjeldatud viidetele kujul <ref name="viite nimi" />. Selle kohta, kuidas viiteid viidete loendi mallis kirjeldada, saab lähemalt lugeda lehekülje Vikipeedia:Viitamine alajaotuses "Korduvviited" ja malli Viited leheküljel alajaotuses "Viidete kirjeldamine".

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 koondaja" ette. Välja lülitamiseks eemalda linnuke.

Kui tööriist on sisse lülitatud, tekib artiklite ja kasutaja nimeruumis menüüsse "Veel" valik "V-koonda". 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.

Omadused

• 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.

• 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.

• Kui artiklis on mitu samasuguse sisuga viidet, siis püüab tööriist need ühe nime alla koondada. See eeldab, et viidete sisu string oleks täpselt samasugune.

• Kui artiklis on mitu sama nimega, kuid sisu poolest erinevat viidet (mis tekitab artiklis viitamistõrke), annab tööriist topeltviidetele uued nimed. Uus nimi koosneb vanast nimest, alakriipsust ja juhuslikult genereeritud viiest tähemärgist.

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

• Tööriist säilitab kõik 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

Tööriist oskab viiteid õigesti koondada vaid juhul, kui need on artiklis ilma vigadeta kirjeldatud. Kui artiklis on lohakusvigu, nagu sulgemata silt <ref>...</ref>, puuduv või üleliigne jutumärk sildi <ref>...</ref> sees vms, siis võidakse viited valesti sisse lugeda ja tulemuseks võib olla segamini tekst, osade viidete kadumine, mitmest viitest ühe viite tegemine jms. Seepärast on oluline, et tööriista kasutaja kontrolliks enne artikli salvestamist, kas viidetega on kõik korras.

Vahel on viga ilmne: artikli segamini tekst, 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 selle lehekülje arutelulehel teada.

Tööriista arendamine

Tööriista Javascriptis kirjutatud kood asub GitHubis leheküljel https://github.com/Cumbril/refcon. Oled teretulnud tööriista arendamises osalema.