VisualEditor/Orodje za navajanje

VisualEditorjevo orodje za navajanje dovoljuje uporabnikom uporabljati vaše wiki predloge za navajanje znotraj VisualEditorja. Za omogočanje orodja, morate narediti sledeče: delujoča instalacija VisualEditorja in Parsoid a, predloge za navajanje na vašem wikiju, ki za svoje delovanje uporabljajo TemplateData in posebno .json sporočilo, ki poveže skupaj VisualEditor in predlogo.

Uvažanje predlog za navajanje

V vaši bazi podatkov potrebujete vaše predloge, tako da lahko uporabljate katerokoli funkcijo navajanja. Če trenutno nimate predlog za navajanje na vašem wikiju (na primer, v primeru nove instalacije), jih boste morali narediti. To najlažje naredite tako, da jih skopirate iz Wikipedije. Če na vašem wikiju že imate predloge za navajane, te korake lahko preskočite.

1. Inštlirajte Extension:Scribunto, Extension:ParserFunctions, Extension:Cite in Extension:TemplateData. Večina predlog za navajanje v Wikipediji uporablja programski jezik Lua, ki ga omogoča Scribunto, in prav tako uporabljajo razširitve parserskih funkcij. Razširitev Cite vam dovoljuje uporabo označevalcev <ref>.

Most citation templates on Wikipedia use the programming language Lua which Scribunto makes available, and they also use the extension's parser functions. The Cite extension allows you to use the ‎<ref> tags. Vse Wikipedije in ostali WMF wikiji so vse to že instalirali.

1. Export citation templates from Wikipedia: Manual:Using content from Wikipedia . Exporting w:Template:Cite web, w:Template:Cite news, w:Template:Cite journal, w:Template:Cite book is a good place to start.

Recent versions of these templates at the English Wikipedia and some others also require the supporting Lua modules.

1. Naložite vaše predloge z uporabo Posebno:Uvoz na vašem wikiju (na primer, http://localhost/index.php/Special:Import)

Template data

Da bo orodje za navajanje lahko naložilo podatke predloge v polja VisualEditorja boste potrebovali Extension:TemplateData , in vsaka predloga mora imeti definirane podatke predloge. Za več informacij kako definirati podatke predloge za navajanje in za zaslonske posnetke oken za navajanje (z in brez definiranih podatkov predloge), glejte: Wikipedija:VisualEditor/TemplateData

Definicija orodja za navajanje

Da na vašem wikiju omogočite VisualEditor orodje za navajanje, morate na vašem wikiju ustvariti posebno sporočilo: MediaWiki:Cite-tool-definition.json. To morate storiti zato, ker je vsak wiki drugačen in morate določiti katere funkcije želite uporabljati; na primer, imena predlog se lahko na vašem wikiju razlikujejo od drugih wikijev.

Namen konfiguracijskega sporočila

Sporočilo:

• Pove katere predloge vaša wiki uporablja za standardizirano navajanje (navedete lahko do 5 predlog).
  • Bodite pozorni, da mora vsaka predloga vsebovati TemplateData, drugače bo sistem za uporabnike težko razumljiv. Če vaša wiki trenutno ne vsebuje predlog za navajanje, je najbolje da jih skopirate iz angleške Wikipedije (kot osnovni nabor).
• Pove katere oznake želite uporabiti za vsak tip navedka.
  • Obstajajo standardne štiri, "web", "book", "news" in "journal", ki ustrezajo MediaWiki:Visualeditor-cite-tool-name-web itd.
• Pove katere ikone želite uporabiti pri vsakem tipu navedka.
  • Obstajajo standardne štiri, "ref-cite-web", "ref-cite-book", "ref-cite-news" in "ref-cite-journal", ki ustrezajo razredom CSS classes z ikono SVG slike ozadja imenovao oo-ui-icon-ref-cite-news itd.

Ko ste skreirali MediaWiki:Cite-tool-definition.json konfiguracijsko sporočilo, bo orodje za navajanje v nekaj minutah postalo delujoče za vse VisualEditor uporabnike na vašem wikiju.

Dodatni tipi

Če razmišljate o dodajanju dodatnih tipov, bi se najprej ekipa razvijalcev rada pogovorila z vami, da vam da nasvete, da vam pomaga pri kreaciji ustrezne ikone. Na ta način lahko razmislimo o tem, če bi bil ta tip lahko na volju tudi drugim wikijem.

Za dodajanje dodatnega tipa morate narediti sledeče:

1. Odločite se kateri tip želite ustvariti
   • V tem primeru, recimo da želite imeti sklic na podatkovno bazo, lahko svoj tip poimenujete "database".
2. Zanj ustvarite oznako
   • Na primer, ustvarite lahko ime oznake "db" in oznako dodate v MediaWiki:Visualeditor-cite-tool-name-db z vrednostjo "database". To morate narediti na vašem wikiju. Če vaš wiki uporablja več jezikov ali skript, boste mogoče morali ustvariti več teh oznak.
3. Zanj ustvarite ikono
   • Na primer, ustavrite lahko oznako ikone "ref-cite-dbase", in skreirate ikono kot SVG datoteko, ki jo naložite v Zbirko, skreirate razred ikone "oo-ui-icon-ref-cite-dbase" v MediaWiki:Common.css in dodate ikono, ki jo želite z "background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)" in podobno.

Zgledi

Zgled definicije sporočil si lahko ogledate na angleški in poljski Wikipediji. Copy the code to your wiki and adapt the names to the local context.

Template type mapping

In addition to MediaWiki:Cite-tool-definition.json, you also need to create MediaWiki:Citoid-template-type-map.json to specify which types of citations map to which templates. You can see an example on the English Wikipedia.

"Citation needed" tool

The "citation needed" tool.

"Citation needed" templates can be configured to show an "Add a citation" button in the editor by configuring MediaWiki:Visualeditor-template-tools-definition.json with a citationNeeded key.

The configuration value lists templates (which can contain multiple titles for redirects) and parameter mappings. Currently supported keys are:

• reason - shows the reason a citation is needed in the context item
• date - shows the date "citation needed" template was added in the context item
• encapsulate - text which has been wrapped by the template, and which should be unwrapped when a citation is added

The value of these mappings is the name of the parameter(s) in the local template:

{
	"citationNeeded": [
		// This key is always "citationNeeded" in every language
		// Each item of this list represents a single template
		{
			"title": [
				// Title can be a string, or list of redirects
				"Citation needed",
				"Cn",
				...
			],
			"params": {
				"reason": "reason",
				"date": "date"
			}
		},
		// This template is defined separately as it supports the
		// "encapsulate" param. On some wikis this is the same
		// template as the one above.
		{
			"title": [
				"Citation needed span",
				"Cite needed span",
				...
			],
			"params": {
				// Parameters can be a string or list of aliases
				"encapsulate": [ "1", "text" ],
				"reason": "reason",
				"date": "date"
			}
		}
	]
}

See the example definition on English Wikipedia.

Odpravljanje napak

Če greste na Posebno:Različica in imate inštaliran TemplateData, polja pa se neprikazujejo v pogovornem oknu za navajanje, boste mogoče morali odpreti v urejevalskem načinu predlogo za navajanje, nič spremeniti,in jo ponovno shraniti. Ta problem je nastal zaradi hrošča kjer se TemplateData, ki je vključen (tj. vključena v Predloga:Navedi_splet/dok in ne direktno v Predloga:Navedi_splet), ne naloži v bazo podatkov dokler se ne uredi starševska predloga; glejte task T52372.

Bodite pozorni na to, da se bo uporabniška izkušnja na vašem wikiju rahlo razlikovala ob uporabi vaših lastnih predlog kot standardnih 4. Na primer, seznam polj se ne bo privzeto prikazal ob startu pogovornega okna za navajanje, lahko pa boste dosegali seznam vseh obstoječih polj s klikom na gumb.