VisualEditor/Källverktyg

Källverktyget i VisualEditor låter användare använda din wikis källmallar i VisualEditor. För att aktivera verktyget behöver du följande; en fungerande installation av VisualEditor och Parsoid , källmallar på din wiki som använder TemplateData för att ange hur de infogas och en speciellt .json-meddelande för att sätta ihop VisualEditor med mallar.

Importera källmallar

Du behöver källmallar i din wikis databas för att kunna använda källfunktionerna. Om du inte har några källmallar på din wiki (som till exempel vore fallet om din wiki är nyinstallerad) behöver du hämta dem. Det är lättast att kopiera dem från Wikipedia. Om du redan har källmallar på din wiki kan du hoppa över dessa steg.

1. Installera Tillägg:Scribunto , Extension:ParserFunctions , Tillägg:Cite , Tillägg:TemplateData (MallData) . De flesta källmallar på Wikipedia använder programmeringsspråket Lua vilket tillhandahålls av Scribunto, och de använder även tilläggets funktioner för språkanalys. Tillägget Cite låter dig använda markeringen ‎<ref>. Alla Wikipediaversioner och andra WMF-wikier har redan installerat alla de här sakerna.
2. Exportera källmallar från Wikipedia: Manual:Using content from Wikipedia . Det är lämpligt att börja med att exportera w:Template:Cite web, w:Template:Cite news, w:Template:Cite journal, w:Template:Cite book. Senare versioner av dessa mallar på engelskspråkiga Wikipedia och några andra kräver också stöd för Lua-moduler.
3. Ladda upp dina mallar med hjälp av specialsidan Special:Import på din wiki (t.ex. http://localhost/index.php/Special:Import).

Malldata

Du behöver Tillägg:TemplateData (MallData) för att källmallverktyget ska kunna ladda mallinformation i VisualEditor, och mallen måste ha MallData angiven. För mer information om hur du definierar MallData för källreferenser, och för skärmdumpar på hur källreferensrutan set ut med och utan MallData, se: Wikipedia:VisualEditor/TemplateData

Definiera källverktyg

För att aktivera VisualEditors källverktyg på din wiki måste du skapa ett speciellt konfigurationsmeddelande på din wiki: MediaWiki:Cite-tool-definition.json. Detta beror på att varje wiki är unik och därför måste anpassa vilka funktioner som ska användas, t.ex. namnen på mallarna som används på din wiki kan skilja sig från andra wikier.

Syfte med konfigurationssida

Konfigurationsmeddelande:

• Anger vilka mallar sin wiki använder för standardkällreferenser (du kan ange upp till 5).
  • Notera att varje mall måste ha MallData definerade, annars kommer systemed att vara mycket svårförstått för användare. Om din wiki i nuläget inte använder källmallar är det vanligt att kopiera mallarna från engelskspråkiga Wikipedia som en början.
• Anger vilken etikett du vill använda för varje källtyp.
  • Det finns fyra standardtyper, "webbref", "bokref", "nyhetsref" and "tidningsref", vilka motsvarar MediaWiki:Visualeditor-cite-tool-name-web etc.
• Anger vilken ikon du vill använda för varje källtyp.
  • Det finns fyra standardikoner, "ref-cite-web", "ref-cite-book", "ref-cite-news" och "ref-cite-journal", vilka motsvarar en CSS-klass med ikonen som en bakgrundsbild av SVG typ, kallad oo-ui-icon-ref-cite-news etc.

När MediaWiki:Cite-tool-definition.json konfigurationssidan har skapats kommer källverktyget att vara aktivt för alla VisualEditoranvändare på din wiki inom några minuter.

Ytterligare typer

Om du överväger att lägga till ytterligare typer skulle utvecklargruppen väldigt gärna vilja tala med dig först för att ge råd och hjälpa till att skapa en passande ikon, och så att vi kan fundera på om andra wikis kan vilja ha samma källtyp.

För att lägga till ytterligare källtyper måste du:

1. Bestämma dig för vilken källtyp du vill skapa
   • I detta exempel antar vi att du vill skapa en databasreferens kallad "databasref".
2. Skapa en etikett för den
   • I exemplet skulle du kunna använda etiketten "db" och lägga till en etikett till MediaWiki:Visualeditor-cite-tool-name-db med värdet "databas". Detta bör vara på din wikis språk. Om din wiki använder flera språk eller scripts kan du behöva skapa fler etiketter.
3. Skapa en ikon för den
   • I detta exempel skulle du kunna skapa en etikett för ikonen kallad "ref-cite-dbase", skapa ikonen som en SVG, ladda upp den till Commons, skapa ikonklassen "oo-ui-icon-ref-cite-dbase" i MediaWiki:Common.css och sedan lägga till ikonen med "background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)" eller liknande.

Exempel

Du kan se exempel på definitionssidorna på engelskspråkiga, polskspråkiga Wikipedia, franskspråkiga, italienskspråkiga Wikipedia. Kopiera koden till din wiki och anpassa namnen till sitt lokala sammanhang.

Kartläggning av malltyper

Utöver MediaWiki:Cite-tool-definition.json behöver du också skapa MediaWiki:Citoid-template-type-map.json för att ange vilka typer av referenser som pekar till vilka mallar. Du kan se ett exempel på engelskspråkiga Wikipedia.

"Källa behövs"-verktyget

"Källa behövs"-verktyget.

"Källa behövs"-mallar kan konfigureras för att visa ett "Lägg till källa"-knapp i redigeraren genom att konfigurera MediaWiki:Visualeditor-template-tools-definition.json med en citationNeeded-nyckel.

Konfigureringsvärdet listar mallar (som kan innehålla flera titlar för omdirigeringar) och parameterkartläggningar. För närvarande stöds nycklarna:

• reason - visar orsaken en referens behövs i sammanhangsobjektet
• date - visar att datummallen "citation needed" lades till i sammanhangsobjektet
• 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": [
		// Nyckeln är alltid "citationNeeded" på alla språk
		// Alla objekt i den här listan representerar en enda mall
		{
			"title": [
				// Titeln kan vara en sträng eller en lista över omdirigeringar
				"Citation needed",
				"Cn",
				...
			],
			"params": {
				"reason": "reason",
				"date": "date"
			}
		},
		// Denna mall definieras för sig då den stödjer
		// "encapsulate"-parametern. På vissa wikier är detta samma
		// mall som den ovanför.
		{
			"title": [
				"Citation needed span",
				"Cite needed span",
				...
			],
			"params": {
				// Parametrarna kan vara en sträng eller lista över alias
				"encapsulate": [ "1", "text" ],
				"reason": "reason",
				"date": "date"
			}
		}
	]
}

Se exempeldefiniering på engelskspråkiga Wikipedia.

Felsökning

Om du navigerar till Special:Version och MallData är installerad men fälten inte visas i källdialogrutan kan du behöva göra en tom redigering av källmallen - öppna mallen för redigering och spara den igen utan att ändra något. Detta beror på en bugg där MallData som inkluderas (d.v.s. på mallens dokumentationssida istället för på mallsidan) inte laddas i databasen förrän mallsidan redigeras. Se ärende T52372.

Observera att användarupplevelsen kommer att variera lite när du använder dina egna mallar utöver de standardiserade fyra. Till exempel kommer listan på mallparametrarna inledningsvis att inte visas i källdialogrutan, men du kan begära en lista på alla parametrarna genom att klicka en knapp.