VisualEditor/Citeren

Het hulpmiddel voor het citeren in de VisualEditor staat gebruikers toe om uw wiki's sjablonen voor het citeren te gebruiken in de VisualEditor. Om het hulpmiddel in te schakelen heeft u het volgende nodig: een werkende installatie van VisualEditor en Parsoid , sjablonen op uw wiki voor het citeren die TemplateData gebruiken om aan te geven hoe ze aangeroepen worden en een speciaal .json bericht om de hook VisualEditor en de sjablonen samen te koppelen.

Sjablonen voor het citeren importeren

U heeft sjablonen om te citeren in uw wiki's database nodig om de functies van het citeren te kunnen gebruiken. U kunt ze bijvoorbeeld bij een nieuwe installatie kopiëren van Wikipedia. Als u deze sjablonen al heeft, dan kunt u deze stappen overslaan.

1. Installeer Extension:Scribunto , Extension:ParserFunctions , Extension:Cite/nl , Extension:TemplateData . De meeste sjablonen om te citeren gebruiken de programmeertaal Lua die Scribunto beschikbaar maakt, ze gebruiken ook deextensie parserfuncties. Met de extensie Cite kunt u de tags ‎<ref> gebruiken. Bij alle Wikipedia's en andere WMF wiki's zijn deze zaken al geïnstalleerd.
2. Exporteer 'citation' sjablonen van Wikipedia: Manual:Using content from Wikipedia . Exporteer Cite web, Cite news, Cite journal, Cite book is een goede plek om te starten. Recente versies van deze sjablonen op de Engelse en andere Wikipedia's hebben ook ondersteuning van Lua modules nodig.
3. Upload de sjablonen via de Special:Import pagina op uw wiki (bijvoorbeeld: http://localhost/index.php/Special:Import).

Sjabloongegevens

U heeft Extension:TemplateData nodig voor het hulpmiddel om te citeren, het laadt de sjabloongegevens in de velden van VisualEditor. Van elk sjabloon moeten de sjabloongegevens zijn gedefinieerd. Hier staan voorbeelden van het scherm om te citeren met/zonder die gegevens en een uitleg: VisualEditor/TemplateData

Definitie hulpmiddel citeren

Om het hulpmiddel in te schakelen dient u een configuratie-bericht aan te maken: MediaWiki:Cite-tool-definition.json. Omdat elke wiki verschilt is er een configuratie van de functies van het hulpmiddel nodig. Zo kunnen de namen van de gebruikte sjablonen per wiki verschillen.

Doel van het bericht voor configuratie

Het configuratie-bericht:

• Geeft aan welke (maximaal 5) sjablonen uw wiki gebruikt voor het citeren.
  • Elk sjabloon moet TemplateData hebben gedefinieerd, anders wordt het systeem moeilijker te begrijpen voor de gebruikers. Als uw systeem nog geen sjablonen gebruikt voor het citeren, dan worden meestal die van de Engelse Wikipedia gekopieerd.
• Geeft per citaattype aan welk label u wenst te gebruiken.
  • Er zijn er standaard vier, "web", "book", "news" en "journal", die overeenkomen met MediaWiki:Visualeditor-cite-tool-name-web enz.
• Geeft per citaattype het icoon aan dat u wilt gebruiken.
  • Er zijn er standaard vier, "ref-cite-web", "ref-cite-book", "ref-cite-news" en "ref-cite-journal", die overeenkomen met de CSS classes met het pictogram als achtergrond SVG afbeelding oo-ui-icon-ref-cite-news enz.

Na het aanmaken van het MediaWiki:Cite-tool-definition.json configuratie-bericht, zal het hulpmiddel voor citaten voor al uw VisualEditor gebruikers op uw wiki binnen een paar minuten werken.

Aanvullende types

Als u een citaattype wilt toevoegen, overleg dan eerst met het ontwikkelteam voor advies, ondersteuning bij het aanmaken van een geschikt icoon en of dit een type is dat niet voor een wiki handig is maar voor alle wiki's.

Om een citaattype toe te voegen:

1. Beslis welk type u wilt toevoegen
   • Stel: u wilt als type een referentie naar een database toevoegen, het citaattype is dan "database".
2. Maak er een label voor aan
   • Die labelnaam zou dan "db" zijn en het label van MediaWiki:Visualeditor-cite-tool-name-db heeft dan de waarde "database". Deze waarde moet dan in uw wiki's taalinhoud. Als uw wiki meertalig is of scripts bevat dan heeft u mogelijk meer labels nodig.
3. Maak er een icoon voor aan.
   • In het voorbeeld zou het icoonlabel "ref-cite-dbase" kunnen zijn, voeg het icoon als een SVG-bestand door uploaden toe aan Commons, maak de 'icon class' "oo-ui-icon-ref-cite-dbase" in MediaWiki:Common.css aan en voeg het icoon toe met iets als "background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)".

Voorbeelden

Voorbeelden definitie berichten op de Engelse Wikipedia, Poolse Wikipedia, Franse Wikipedia en de Italiaanse Wikipedia. Kopieer de code naar uw wiki en pass de namen toe aan de lokale context.

Sjabloontype koppeling

Naast MediaWiki:Cite-tool-definition.json moet u ook MediaWiki:Citoid-template-type-map.json maken om op te geven welke soorten citaten aan welke sjablonen zijn gekoppeld. U kunt een voorbeeld zien op de Engelstalige Wikipedia.

Hulpmiddel "Citeren nodig"

Hulpmiddel "Citeren nodig"

Een "Citeren nodig" sjabloon kan worden geconfigureerd om een knop "Citaat toevoegen" in de editor te tonen, stel MediaWiki:Visualeditor-template-tools-definition.json in met een citationNeeded key.

De configuratiewaarde bevat sjablonen (die meerdere titels voor doorverwijzingen kunnen bevatten) en parametertoewijzingen. De nu ondersteunde 'keys'ː

• reason - toont de reden waarom een bronvermelding nodig is in het contextitem
• date - toont de datum waarop de sjabloon "citation needed" is toegevoegd in het contextitem
• encapsulate - tekst die door het sjabloon ingepakt is en die moet worden uitgepakt wanneer er een bronvermelding wordt toegevoegd

De waarde van deze toewijzingen is de naam van de parameter(s) in de lokale sjabloon:

{
	"citationNeeded": [
		// De waarde van deze key is altijd "citationNeeded", ongeacht de taal
		// Elk item van deze lijst vertegenwoordigt één sjabloon
		{
			"title": [
				// Titel kan een tekenreeks zijn of een lijst met doorverwijzingen
				"Citation needed",
				"Cn",
				...
			],
			"params": {
				"reason": "reason",
				"date": "date"
			}
		},
		// Dit sjabloon wordt afzonderlijk gedefinieerd omdat het ondersteunt de
		// "encapsulate" parameter. Op sommige wiki's is dit hetzelfde
		// sjabloon als de bovenstaande.
		{
			"title": [
				"Citation needed span",
				"Cite needed span",
				...
			],
			"params": {
				// Parameters kunnen een tekenreeks of een lijst met aliassen zijn
				"encapsulate": [ "1", "text" ],
				"reason": "reason",
				"date": "date"
			}
		}
	]
}

Voorbeeld definitie op de Engelse Wikipedia.

Probleemoplossing

Ga naar Special:Version, als TemplateData geïnstalleerd is, maar de velden worden niet getoond in de citeer-dialoog, dan moet u het sjabloon voor het citeren openen om te bewerken. Doe echter geen bewerking, maar sla het opnieuw op. Door het transcluden van TemplateData (het zit in het Template:Cite_web/doc i.p.v. in het Template:Cite_web) wordt het niet geladen in de database totdat het bovenliggende sjabloon is 'bewerkt'. taak T52372.

Bij het gebruik van een eigen sjabloon in plaats van de standaard vier kan de gebruikerservaring wat anders zijn. Een lijst van mogelijke velden is dan niet direct beschikbaar in de citeer-dialoog maar de gebruiker moet op een knop drukken om ze op te halen.