MediaWiki

Manual:Sayfa içerik modelleri

This page is a translated version of the page Manual:Page content models and the translation is 100% complete.
Other languages:
Uzantılar:

MediaWiki 1.21 ile sunulan ContentHandler, vikimetin dışında yeni içerik modelleri eklemenize izin verir. Viki sayfalarının vikimetin dışındaki verilerden oluşmasını ve herhangi bir şekilde temsil edilmesini mümkün kılar. Örneğin: Markdown, reStructuredText, icalendar veya özel bir XML biçimi. Bu içerik modellerinin görüntülenmesi ve düzenlenmesi özel yollarla (örn. farklı sözdizimi vurgulama veya tamamen yeni veri giriş formları) ele alınabilir.

Bu sayfada, bir uzantıda yeni bir içerik modelinin nasıl oluşturulacağı açıklanmaktadır. Genel uzantı geliştirme uygulamalarına biraz aşinalık olduğunu varsayar. Gereksinimlerin kısa bir özeti için, bu sayfanın altındaki Özet bölümüne bakın.

Örnekler için anlamsız bir "Goat" içerik modeli kullanılacaktır. Extension:Examples parçası olan DataPages uzantısını da inceleyebilirsiniz.

Kayıt

Her şeyden önce, içerik modelinin adını ve işleyici sınıfını extension.json dosyanıza ekleyin: 

"ContentHandlers": {
	"goat": "MediaWiki\\Extension\\GoatExt\\GoatContentHandler"
}
  • Buradaki sol taraftaki değer içerik türünün adıdır, istediğiniz herhangi bir benzersiz dize olabilir ve beş yerleşik içerik türü ile birlikte yaşar: 'wikitext', 'JavaScript', 'CSS', 'plain text', 'JSON'. Bu değer, Special:ChangeContentModel ve sayfa bilgisi ​​gibi yerlerde kullanıcılara gösterilir.
  • Sağ taraftaki değer, ContentHandler genişleyen bir sınıfın tam nitelikli adıdır.

Bu, \MediaWiki\Extension\GoatExt\GoatContent ve \MediaWiki\Extension\GoatExt\GoatContentHandler olmak üzere iki yeni sınıfın AutoloadClasses ile eklenmesini gerektirecektir (ad alanları AutoloadNamespaces değilse). Bu sınıflar hakkında daha fazla bilgi aşağıda verilmiştir.

İsteğe bağlı içerik modeli sabitleri

Yukarıdaki 'goat' dizesi içerik modelidir (genellikle kodda $modelId olarak adlandırılır) ve genellikle sabit olarak da tanımlanır. Bu sabitler tüm yerleşik içerik modelleri için tanımlanmıştır ve birçok belge "CONTENT_MODEL_XXX" sabitlerini ifade eder. Onları tanımlamadıysanız, bu biraz kafa karıştırıcı olabilir. Tanım, extension.json içindeki geri çağrı öğesi aracılığıyla yapılmalıdır. Örneğin:

extension.json içinde: 

"callback": "MediaWiki\\Extension\\GoatExt\\Hooks::registrationCallback"

includes/Hooks.php içinde: 

namespace MediaWiki\Extension\GoatExt;
class Hooks {
    public static function registrationCallback() {
        // Must match the name used in the 'ContentHandlers' section of extension.json
        define( 'CONTENT_MODEL_GOAT', 'goat' );
    }
}

Bunu bu şekilde yapmak zorunda değilsiniz ve yalnızca dizeyi kullanabilirsiniz.

İçerik modellerini sayfalara atama

Tüm bir viki ad alanının varsayılan içerik modeline sahip olmasını istiyorsanız, bunu extension.json içinde olduğu gibi tanımlayabilirsiniz: 

"namespaces": [
	{
		"id": 555,
		"constant": "NS_GOAT",
		"name": "Goat",
		"subpages": false,
		"content": true,
		"defaultcontentmodel": "goat"
	},
	{
		"id": 556,
		"constant": "NS_GOAT_TALK",
		"name": "Goat_talk",
		"subpages": true,
		"content": false,
		"defaultcontentmodel": "wikitext"
	}
]

Ya da, viki sayfası adına yarı dosya türü bir sonek ekleyerek içerik türünü belirlemek istiyorsanız, ContentHandlerDefaultModelFor kancasını kullanabilirsiniz. Örneğin: 

namespace MediaWiki\Extension\GoatExt;
class Hooks {
	public static function onContentHandlerDefaultModelFor( \Title $title, &$model ) {
		// Any page title (in any namespace) ending in '.goat'.
		$ext = '.goat';
		if ( substr( $title->getText(), -strlen( $ext ) ) === $ext ) {
			// This is the constant you defined earlier.
			$model = CONTENT_MODEL_GOAT;
			// If you change the content model, return false.
			return false;
		}
		// If you don't change it, return true.
		return true;
	}
}

ContentHandler

Tanımlanacak bir sonraki şey, bu içerik türünün hangi formatta (bu durumda metin) depolanacağını da belirlediğimiz GoatContentHandler sınıfıdır. ContentHandlers, herhangi bir belirli sayfa içeriği hakkında hiçbir şey bilmiyor, ancak içeriğin genel yapısını ve depolanmasını belirliyor. 

<?php

namespace MediaWiki\Extension\GoatExt;

class GoatContentHandler extends \ContentHandler {

	public function __construct( $modelId = 'goat' ) {
		parent::__construct( $modelId, [ CONTENT_FORMAT_TEXT ] );
	}

	public function serializeContent( \Content $content, $format = null ) {
	}

	public function unserializeContent( $blob, $format = null ) {
	}

	public function makeEmptyContent() {
		return new GoatContent();
	}

	public function supportsDirectEditing() {
		return true;
	}
}

İçerik

GoatContent sınıfı, içeriğin verilerinin temsilidir ve sayfalar, revizyonlar veya veritabanında nasıl depolandığı hakkında hiçbir şey bilmiyor. Gerekli yedi kalıtımsal yöntemin yanı sıra, etki alanına özgü diğer genel yöntemler de ekleyebilirsiniz; bu durumda keçinin adını alabilmek istiyoruz. 

<?php

namespace MediaWiki\Extension\GoatExt;

class GoatContent extends \AbstractContent {

	public function __construct( $modelId = 'goat' ) {
		parent::__construct( $modelId );
	}

	public function getTextForSearchIndex() {
	}

	public function getWikitextForTransclusion() {
	}

	public function getTextForSummary( $maxLength = 250 ) {
	}

	public function getNativeData() {
	}

	public function getSize() {
	}

	public function copy() {
	}

	public function isCountable( $hasLinks = null ) {
	}

	public function getName() {
		return 'Garry';
	}
}

Düzenleme formu

Şimdi iskeleti kurduk, bir Goat düzenlemeyi denemek isteyeceğiz. Bunu yapmak için, GoatContentHandler::getActionOverrides() oluştururuz ve hangi eylemleri hangi sınıflara eşlemek istediğimizi belirleriz. Başlangıç ​​olarak, sadece 'düzenle' ile ilgileneceğiz (URL'de ?action=edit ile karşılık gelir). 

	public function getActionOverrides() {
		return [
			'edit' => GoatEditAction::class,
		];
	}

Ve yeni GoatEditAction sınıfımızı oluşturacağız, temelde EditAction ile aynı, ancak kendi GoatEditPage kullanarak: 

<?php

namespace MediaWiki\Extension\GoatExt;

class GoatEditAction extends \EditAction {

	public function show() {
		$this->useTransactionalTimeLimit();
		$editPage = new GoatEditPage( $this->page );
		$editPage->setContextTitle( $this->getTitle() );
		$editPage->edit();
	}

}

Yeni GoatEditPage sınıfımız, eylemin gerçekleştiği yerdir (kelime oyununu bağışlayın): 

<?php

namespace MediaWiki\Extension\GoatExt;

class GoatEditPage extends \EditPage {

	protected function showContentForm() {
		$out = $this->context->getOutput();

		// Get the data.
		$name = $this->getCurrentContent()->getGoatName();

		// Create the form.
		$nameField = new \OOUI\FieldLayout(
			new \OOUI\TextInputWidget( [ 'name' => 'goat_name', 'value' => $name ] ),
			[ 'label' => 'Name', 'align' => 'left' ]
		);
		$out->addHTML( $nameField );
	}

}

Artık bir sayfayı düzenleyebilmeli ve formunuzu görebilmelisiniz. Ancak içine veri koyduğunuzda ve 'önizleme' düğmesine tıkladığınızda, işlerin henüz tam olarak çalışmadığını ve çıkış alamadığınızı veya gönderdiğiniz metnin formda tekrar gösterilmediğini göreceksiniz.

Bu nedenle, yeni bir GoatSubmitAction sınıfı ve GoatContentHandler::getActionOverrides() yöntemimize 'submit' => GoatSubmitAction::class, ilavesi ile 'gönder' eylemini de geçersiz kılmalıyız. GoatSubmitAction sınıfımız çekirdek sınıfımızla aynı olmalı, ancak GoatEditAction üzerinden miras almalıdır.

Görüntüleme

Görüntü için gerekli herhangi bir çıkışının üretilmesinden bir içerik modeli sorumludur. Bu genellikle, ayrıştırıcı çıkışına eklemek için verileriyle çalışmayı ve bir şekilde HTML üretmeyi içerir. 

<?php

namespace MediaWiki\Extension\GoatExt;

class GoatContent extends \AbstractContent {

	protected function fillParserOutput(
		Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output
	) {
		// e.g. $output->setText( $html );
	}

}

Bir açıklama/belgelendirme görüntüle

Bazen, JSON gibi özel bir içerik modeline sahip bir makale için bazı bilgileri veya bazı belgeleri görüntülemek isteyebilirsiniz. Aslında, bu tür sayfaların üzerinde bazı metinleri görüntülemek için sistem mesajları yoktur (yalnızca JavaScript ve CSS sayfalarının üzerinde gösterilen MediaWiki:Clearyourcache haricinde). Daha fazla ayrıntı için phab:T206395 görmek isteyebilirsiniz.

Revizyonları karşılaştırma

GoatDifferenceEngine sınıfı, keçi içerikleri arasındaki farkın temsilidir. Bir fark oluşturmak için varsayılan generateContentDiffBody yöntemini geçersiz kılıyoruz. 

<?php

namespace MediaWiki\Extension\GoatExt;

class GoatDifferenceEngine extends \DifferenceEngine {

	public function generateContentDiffBody( Content $old, Content $new ) {
	}
}

MediaWiki'ye GoatDifferenceEngine kullanmasını söylemek için GoatContentHandler sınıfımızdaki getDiffEngineClass üzerine yazıyoruz. 

<?php

namespace MediaWiki\Extension\GoatExt;

class GoatContentHandler extends \ContentHandler {

	public function getDiffEngineClass() {
		return GoatDifferenceEngine::class;
	}
}

Özet

Özel bir düzenleme formuyla yeni bir içerik modeli uygulamak için aşağıdakileri oluşturun: 

<?php

namespace MediaWiki\Extension\GoatExt;

class GoatContent extends \AbstractContent  {
	public function __construct( $modelId = 'goat' ) {
		parent::__construct($modelId);
	}
	protected function fillParserOutput( \Title $title, $revId, \ParserOptions $options, $generateHtml, \ParserOutput &$output) {}
	public function getTextForSearchIndex() {}
	public function getWikitextForTransclusion() {}
	public function getTextForSummary( $maxLength = 250 ) {}
	public function getNativeData() {}
	public function getSize() {}
	public function copy() {}
	public function isCountable( $hasLinks = null ) {}
}

<?php

namespace MediaWiki\Extension\GoatExt;

class GoatContentHandler extends \ContentHandler {	
	public function __construct( $modelId = CONTENT_MODEL_GOAT, $formats = ['text/x-goat'] ) {
		parent::__construct($modelId, $formats);
	}
	protected function getContentClass() {}
	public function supportsDirectEditing() {}
	public function serializeContent( \Content $content, $format = null ) {}
	public function unserializeContent( $blob, $format = null ) {}
	public function makeEmptyContent() {}
	public function getActionOverrides() {}
}

Ayrıca bakınız

Retrieved from "https://www.mediawiki.org/w/index.php?title=Manual:Page_content_models/tr&oldid=4635236"