Vikipeedia:Tööriistad/Viidete korrastaja: erinevus redaktsioonide vahel

Allikas: Vikipeedia
Eemaldatud sisu Lisatud sisu
Resümee puudub
70. rida: 70. rida:


==Teadaolevad vead==
==Teadaolevad vead==
Kui viidete loendi mallis on juba olemas viited ja viidete tekst (näiteks pealkiri) sisaldab püstkriipsu (|), siis võidakse viited valesti sisse lugeda ja väljastada. Skripti arendaja töötab lahenduse kallal.
Kui viidete loendi mallis on juba olemas viited ja viidete tekst (näiteks pealkiri) sisaldab püstkriipsu (|), siis võidakse viited valesti sisse lugeda ja väljastada. Tööriista arendaja töötab lahenduse kallal.


==Tööriista arendamine==
==Tööriista arendamine==

Redaktsioon: 12. veebruar 2017, kell 09:57

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.

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 koondaja tulemus muudatuste vaates

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 siinse lehekülje arutelulehel teada.

Kasutajasuvandid

Viidete sorteerimine

Vaikimisi on viited malli {{viited}} sees sorteeritud järgmiselt:

  • kõige ees tulevad viidete malli sees varem asunud viited (sellises järjekorras nagu nad mallis algselt olid);
  • seejärel tulevad artikli teksti sees olevad nimega viited, teksti sees asumise järjekorras;
  • lõpuks tulevad viited, millele tööriist juhusliku nime määras, teksti sees asumise järjekorras.

Kui soovid, et tööriist sorteeriks viited malli {{viited}} sees tähestikulises järjekorras viite nime järgi, lisa oma common.js faili sisse järgmine kood:

if ( typeof( refConsolidateConfig ) === 'undefined' ) refConsolidateConfig = {};
refConsolidateConfig.sort = true;

Tähestikuline sorteerimine pole tõstutundlik.

Teadaolevad vead

Kui viidete loendi mallis on juba olemas viited ja viidete tekst (näiteks pealkiri) sisaldab püstkriipsu (|), siis võidakse viited valesti sisse lugeda ja väljastada. Tööriista arendaja töötab lahenduse kallal.

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.