VisualEditor/Källverktyg

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page VisualEditor/Citation tool and the translation is 80% complete.
Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Cymraeg • ‎English • ‎Tiếng Việt • ‎Türkçe • ‎català • ‎dansk • ‎español • ‎euskara • ‎français • ‎italiano • ‎português • ‎português do Brasil • ‎slovenščina • ‎suomi • ‎svenska • ‎български • ‎українська • ‎հայերեն • ‎فارسی • ‎ქართული • ‎中文 • ‎日本語

Källverktyget i VisualEditor låter användare använda din wikis källmallar i VisualEditor. To enable the tool, you'll need the following: a working installation of VisualEditor and Parsoid, citation templates on your wiki that use TemplateData to specify how they are invoked, and a special .json message in order to hook VisualEditor and the templates together.

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 Extension:Scribunto, Extension:ParserFunctions, Extension:Cite, och Extension:TemplateData. De flesta källmallar på Wikipedia använder programmeringsspråket Lua vilket tillhandahålls av Scribunto, och de använder även utökningens funktioner för språkanalys. Källutökningen låter dig använda markeringen <ref>.

All Wikipedias and other WMF wikis already have all of these things installed.

  1. Exportera källmallar från wikipedia: Manual:Using_content_from_Wikipedia. Det är lämpligt att börja med att exportera Template:Cite_web, Template:Cite_news, Template:Cite_journal och Template:Cite_book. Recent versions of these templates at the English Wikipedia and some others also require the supporting Lua modules.
  2. 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 Extension:TemplateData för att källmallverktyget ska kunna ladda mallinformation i VisualEditor, och makllen 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:Visualeditor-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:Visualeditor-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. Copy the code to your wiki and adapt the names to the local context.

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

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.