Extension:SyntaxHighlight

Bu uzantı MediaWiki 1.21 ve üstü ile gelir. Böylece tekrar indirmek zorunda değilsiniz. Ancak, verilen diğer talimatları izlemeniz gerekir.

Kaynak düzenleyiciyi kullanırken vikimetinin sözdizimi vurgulaması için CodeMirror uzantısına veya Remember the dot ve Cacycle kullanıcı kodlarına bakın.

MediaWiki manüel uzantıları

SyntaxHighlight Sürüm durumu: kararlı
Uygulama	Etiket
Açıklama	Viki sayfalarında kaynak kodun sözdiziminin vurgulanmasına izin verir
Yazar(lar)	Brion Vibber, Tim Starling, Rob Church, Ori Livneh
En son sürüm	continuous updates
Uyumluluk politikası	usta
MediaWiki	1.25+
Veritabanı değişiklikleri	Hayır
Lisans	GNU Genel Kamu Lisansı 2.0 veya üstü
İndir	Uzantıyı indir Git [?]: Git master'ı indir depoyu göz at (GitHub) geçmişi işleyin veri deposu katkıda bulunanlar (GitHub) kod incelemesi README
Parametreler $wgPygmentizePath
Etiketler <syntaxhighlight>
Kullanılan kancalar ApiFormatHighlight ContentGetParserOutput ParserFirstCallInit ResourceLoaderRegisterModules
Translatewiki.net adresinde mevcutsa, SyntaxHighlight uzantısını çevirin
Kullanım ve sürüm matrisini kontrol edin.
Sorunlar	Açık görevler · Hata bildir

Daha önce SyntaxHighlight_GeSHi olarak bilinen SyntaxHighlight uzantısı, <syntaxhighlight> etiketini kullanarak kaynak kodunun zengin biçimlendirmesini sağlar. Pygments kütüphanesi tarafından desteklenmektedir ve yüzlerce farklı programlama dilini ve dosya biçimini desteklemektedir.

<pre> ve <poem > etiketleri gibi, metin de yazıldıkları gibi işlenir ve beyaz boşluk korunur.

Kullanım

Kurulduktan sonra, wiki sayfalarında "syntaxhighlight" etiketlerini kullanabilirsiniz. Örneğin,

1 def quick_sort(arr):
2 	less = []
3 	pivot_list = []
4 	more = []
5 	if len(arr) <= 1:
6 		return arr
7 	else:
8 		pass

aşağıdaki vikimetin işaretlemesinin sonucudur:

<syntaxhighlight lang="python" line='line'>
def quick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

Eski sürümlerde (MediaWiki 1.16'dan önce), uzantı <source> etiketini kullandı. Bu hala desteklenmektedir, ancak kullanımdan kaldırılmıştır. Bunun yerine <syntaxhighlight> kullanılmalıdır.

Stil

Görüntülenen kod çok büyükse, vikinizdeki MediaWiki:Common.css sayfasına aşağıdakileri koyarak kodu ayarlayabilirsiniz (yoksa bu kodu oluşturun):

/* Buraya yerleştirilen CSS tüm görünümlere uygulanacak */
.mw-highlight pre {
	font-size: 90%;
}

Kod bloklarını kenarlıklara yerleştirmek, yukarıdaki bölüme border: 1px dashed blue; gibi bir çizgi eklenerek yapılabilir. Kullanılan font family üzerindeki kontrol, yukarıdaki bölüme font-family: "Courier New", monospace; gibi bir satır eklenerek de kullanılabilir.

Sözdizimi vurgulama hatası kategorisi

Uzantı, bir izleme kategorisi içine $sözdizimi etiketinde kötü lang özelliği olan sayfaları ekler. MediaWiki:syntaxhighlight-error-category mesaj tuşu kategori adını belirler; bu vikideki Category:Pages with syntax highlighting errors.

Bu kategoriyle etiketlenen sayfalara yol açan en yaygın hata, lang özelliği olmayan bir <syntaxhighlight> etiketidir, çünkü bu uzantının eski sürümleri "$wgSyntaxHighlightDefaultLang" tanımını destekledi. Bunlar genellikle <pre> ile değiştirilebilir veya etikete lang="bash" veya lang="text" eklenebilir.

Kategori de eklenebilir ve 1000'den fazla satır veya 100 kB'den fazla metin varsa içerik vurgulanmaz.

Parametreler

lang

lang="name" niteliği, hangi lexerin kullanılması gerektiğini tanımlar. Dil, uzantının kaynak kodunu nasıl vurguladığını etkiler. Desteklenen dillerin ayrıntıları için Desteklenen diller sayfasına bakın.

def quick_sort(arr):
    less = []

<syntaxhighlight lang="python">
..
</syntaxhighlight>

Geçersiz veya bilinmeyen bir ad belirtilmesi, sayfayı bir izleme kategorisiyle etiketler. Ayrıntılar için bu sayfadaki Sözdizimi vurgulama hata kategorisi bölümüne bakın.

line

line özelliği satır numaralarını etkinleştirir.

1 def quick_sort(arr):
2 	less = []

<syntaxhighlight lang="python" line>
..
</syntaxhighlight>

start

start özniteliği (line ile birlikte) kod bloğunun ilk satır numarasını tanımlar. Örneğin, line start="55" satır numaralandırmayı 55'de başlatacaktır.

55 def quick_sort(arr):
56     less = []

<syntaxhighlight lang="python" line start="55">
..
</syntaxhighlight>

highlight

highlight özelliği, işaretlenmesi gereken bir veya daha fazla satırı belirtir (bu satırları farklı bir arka plan rengiyle vurgulayarak). İki satır numarası ve tire (örneğin, highlight="5-7") kullanarak virgülle (örneğin, highlight="1,4,8") veya aralıklarla ayrılmış birden fazla satır numarası belirleyebilirsiniz. Satır numarası belirtiminin, görüntülenen satır numaralarının start özniteliğiyle yeniden numaralandırılmasını yok saydığını unutmayın.

3 def quick_sort(arr):
4     less = []
5     pivot_list = []
6     more = []
7     if len(arr) <= 1:
8         return arr

sonucu

<syntaxhighlight lang="python" highlight="1,5-7" start='3' line>
..
</syntaxhighlight>

inline

MediaWiki sürümü:

≥ 1.26

Özellik, kaynak kodunun paragrafın bir parçası olarak (kendi bloğunun aksine) satır içinde olması gerektiğini belirtir. Bu seçenek MediaWiki 1.26'dan itibaren kullanılabilir. Geriye dönük uyumluluk için enclose="none" özelliği aynı davranışla sonuçlanır.

"enclose" parametresini kullanmanın kullanımdan kaldırıldığını unutmayın; "none" olarak ayarlanırsa, satır içi ile değiştirilmelidir; aksi takdirde tamamen çıkarılabilir.

Kaynak kodu class="nowrap" (onu destekleyen wikilerde; aşağıya bakın) veya style=white-space:nowrap kırılmaz olarak işaretlenmedikçe, açılış ve kapanış etiketleri arasındaki herhangi bir alanda satır sonları olabileceğini unutmayın.

Örneğin:

Aşağıdaki lambda x: x * 2 Python'da bir lambda anlamındadır.

Sonuç:

Aşağıdaki <syntaxhighlight lang="python" inline>lambda x: x * 2</syntaxhighlight> Python'da bir [[w:Lambda (programming)|lambda anlamındadır]].

class

inline kullanıldığında, class="nowrap" (bunu destekleyen vikilerde; MediaWiki'nin kendisinde değil), kod bloğundaki boşluklarda satır kesmelerinin olmaması gerektiğini belirtir.

Örneğin:

class="nowrap" olmadan:

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxlambda x: x * 2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

With style="white-space:nowrap":

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxlambda x: x * 2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

style

style niteliği, CSS niteliklerinin doğrudan eklenmesine izin verir. Bu, bloğu <div> (<span> değil) etiketine dahil etmeye eşdeğerdir. tab‑size niteliği bu şekilde belirtilemez; aşağıda Gelişmiş altında açıklandığı gibi bir ek <span> etiketi gerektirir.

Örneğin:

def quick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass

Sonuç:

<syntaxhighlight lang="python" style="border:3px dashed blue">
def quick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

Desteklenen diller

Pygments kütüphanesi yüzlerce bilgisayar dili ve dosya biçimi için destek sağlar. Ocak 2020 itibariyle tam listesi:

Programlama dilleri

• ActionScript
• Ada
• Agda (okur yazar dahil)
• Alloy
• AMPL
• ANTLR
• APL
• AppleScript
• Assembly (çeşitli)
• Asymptote
• Augeas
• AutoIt
• Awk
• BBC Basic
• Befunge
• BlitzBasic
• Boa
• Boo
• Boogie
• BrainFuck
• C, C++ (Arduino gibi lehçeler dahil)
• C#
• Chapel
• Charm++ CI
• Cirru
• Clay
• Clean
• Clojure
• CoffeeScript
• ColdFusion
• Common Lisp
• Component Pascal
• Coq
• Croc (MiniD)
• Cryptol (Okuryazar Cryptol dahil)
• Crystal
• Cypher
• Cython
• D
• Dart
• DCPU-16
• Delphi
• Dylan (konsol dahil)
• Eiffel
• Elm
• Emacs Lisp
• Email
• Erlang (kabuk oturumları dahil)
• Ezhil
• Factor
• Fancy
• Fantom
• Fennel
• FloScript
• Fortran
• FreeFEM++
• F#
• GAP
• Gherkin (Cucumber)
• GLSL gölgelendiricileri
• Golo
• Gosu
• Groovy
• Haskell (Okuryazar Haskell dahil)
• HLSL
• HSpec
• Hy
• IDL
• Idris (Okuryazar Idris dahil)
• Igor Pro
• Io
• Jags
• Java
• JavaScript
• Jasmin
• Jcl
• Julia
• Kotlin
• Lasso (çiftleşme dahil)
• Limbo
• LiveScript
• Logtalk
• Logos
• Lua
• Mathematica
• Matlab
• Modelica
• Modula-2
• Monkey
• Monte
• MoonScript
• Mosel
• MuPad
• NASM
• Nemerle
• NesC
• NewLISP
• Nimrod
• Nit
• Notmuch
• NuSMV
• Objective-C
• Objective-J
• Octave
• OCaml
• Opa
• OpenCOBOL
• ParaSail
• Pawn
• PHP
• Perl 5
• Pike
• Pony
• PovRay
• PostScript
• PowerShell
• Praat
• Prolog
• Python (konsol oturumları ve geri izleme dahil)
• QBasic
• Racket
• Raku a.k.a. Perl 6
• REBOL
• Red
• Redcode
• Rexx
• Ride
• Ruby (irb oturumları dahil)
• Rust
• S, S-Plus, R
• Scala
• Scdoc
• Scheme
• Scilab
• SGF
• Kabuk betikleri (Bash, Tcsh, Fish)
• Shen
• Silver
• Slash
• Slurm
• Smalltalk
• SNOBOL
• Snowball
• Solidity
• SourcePawn
• Stan
• Standard ML
• Stata
• Swift
• Swig
• SuperCollider
• Tcl
• Tera Term language
• TypeScript
• TypoScript
• USD
• Unicon
• Urbiscript
• Vala
• VBScript
• Verilog, SystemVerilog
• VHDL
• Visual Basic.NET
• Visual FoxPro
• Whiley
• Xtend
• XQuery
• Zeek
• Zephir
• Zig

Şablon dilleri

• Açısal şablonları
• Çita şablonları
• ColdFusion
• Django / Jinja şablonları
• ERB (Ruby şablonlama)
• Evoque
• Genshi (Trac şablon dili)
• Gidonlar
• JSP (Java Sunucusu Sayfaları)
• Liquid
• Myghty (HTML::Mason tabanlı çerçeve)
• Mako (Myghty halefi)
• Slim
• Smarty şablonları (PHP şablonlama)
• Tea
• Twig

Diğer biçimlendirme

• Apache yapılandırma dosyaları
• Apache Pig
• BBCode
• CapDL
• Cap'n Proto
• CMake
• Csound skorları
• CSS
• Debian kontrol dosyaları
• Fark dosyaları
• Dockerfiles
• DTD
• EBNF
• E-posta başlıkları
• Extempore
• Flatline
• Gettext katalogları
• Gnuplot betiği
• Groff işaretlemesi
• Hexdumps
• HTML
• HTTP oturumları
• IDL
• Inform
• INI-style yapılandırma dosyaları
• IRC günlükleri (irssi stili)
• Isabelle
• JSGF gösterimi
• JSON, JSON-LD
• Yalın Teorem Prover
• Lighttpd yapılandırma dosyaları
• Linux çekirdek günlüğü (dmesg)
• LLVM montajı
• LSL betikleri
• Makefiles
• MoinMoin/Trac Viki işaretlemesi
• MQL
• MySQL
• NCAR komut dili
• Nginx yapılandırma dosyaları
• Nix dili
• NSIS betikleri
• Notmuch
• POV-Ray görüntüleri
• Puppet
• QML
• Ragel
• Redcode
• ReST
• Roboconf
• Robot Framework
• RPM spesifikasyon dosyaları
• Rql
• RSL
• Scdoc
• SPARQL
• SQL, ayrıca MySQL, SQLite
• Squid yapılandırması
• TADS 3
• Terraform
• TeX
• Thrift
• TOML
• Treetop dilbilgileri
• USD (Universal Scene Description)
• Varnish yapılandırmaları
• VGL
• Vim Script
• WDiff
• Windows toplu iş dosyaları
• XML
• XSLT
• YAML
• Windows Kayıt Defteri dosyaları

Doğru dil kodları için Pygments belgesindeki ayrıntılarının tümüne bakın ve bazı dil adları için GeSHi (tam listesi) tarafından desteklenen bazı eşlemeler vardır.

Pygments henüz bir "wikitext" veya "mediawiki" lexer (phab:T29828) sağlamaz. Bunun yerine "html+handlebars" veya "moin" kullanın.

Aşağıda, GeSHi'nin vurgulayabileceği kısmi bir dil listesi bulunmaktadır ve Pygments'a geçtikten sonra artık dil desteği verilmemektedir.

Kurulum

Bu uzantının MediaWiki 1.31 ile paketlenmiş sürümü, sunucuya Python sürüm 3'ün (python3) yüklenmesini gerektirir. Bu, Python sürüm 2 (python) kullanılan MediaWiki 1.30 ile birlikte gelen sürümdeki bir değişikliktir. python3 ikili dosyasının PHP yorumlayıcısının PATH yürütmesine yüklenmesi gerektiğini unutmayın.

Pygments güncellemesine (ve GeSHi'den uzakta) ve güncellenmiş adına rağmen, bu uzantı dahili olarak hala aşağıda belirtildiği gibi eski dosya adlarını kullanır.

• Dosyaları indirin ve extensions/ klasörünüzdeki SyntaxHighlight_GeSHi adlı dizine yerleştirin.
• Yalnızca git dizininden yüklerken, PHP bağımlılıklarını uzantı dizinine composer install --no-dev vererek yüklemek için Composer komutunu çalıştırın. (Potansiyel komplikasyonlar için görev T173141 sayfasına bakınız.)
• LocalSettings.php dosyanızın altına aşağıdaki kodu ekleyin:

  wfLoadExtension( 'SyntaxHighlight_GeSHi' );
  

• Linux'da, pygmentize ikili dosyası için yürütme izinlerini ayarlayın. Bunu yapmak için bir FTP istemcisi veya aşağıdaki kabuk komutunu kullanabilirsiniz:

chmod a+x /path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize

•  Yapıldı – Uzantının başarıyla yüklendiğini doğrulamak için vikinizde Special:Version seçeneğine gidin.

MediaWiki 1.24 veya önceki bir sürümü çalıştıran kullanıcılara:

Yukarıdaki talimatlar, bu eklentiyi wfLoadExtension() kullanarak kurmanın yeni yolunu açıklar. Bu uzantıyı önceki sürümlerine (MediaWiki 1.24 ve önceki sürümler) yüklemeniz gerekirse, wfLoadExtension( 'SyntaxHighlight_GeSHi' ); yerine kullanmanız gerekir:

require_once "$IP/extensions/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php";

Git'ten yüklerken, MediaWiki 1.26'dan başlayıp MediaWiki 1.31 ile biten bu uzantının Composer gerektirdiğini lütfen unutmayın.

Bu nedenle Git'ten kurulumdan sonra, uzantıyı içeren dizine geçin, ör. "../extensions/SyntaxHighlight_GeSHi/" ve composer install --no-dev komutunu çalıştırırken veya güncellerken: composer update --no-dev.

Alternatif olarak, ayrıca "extensions/SyntaxHighlight_GeSHi/composer.json" vikinizin kök dizinindeki "composer.local.json" dosyasına, ör.

{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/SyntaxHighlight_GeSHi/composer.json"
			]
		}
	}
}

Şimdi composer update --no-dev çalıştırın. Voilà!

Uyarı:

Uzantıyı FTP aracılığıyla yüklerken, ikili transfer türüyle pygments/pygmentize dosyasını yüklediğinizden emin olun.

Yapılandırma

Linux

• $wgPygmentizePath (isteğe bağlı): Pygments paketinin ``pygmentizein mutlak yolu. Uzantı, Pygments paketini ve $wgPygmentizePath noktalarını varsayılan olarak paketli sürüme işaret eder, ancak isterseniz farklı bir sürüme işaret edebilirsiniz. Örneğin: $wgPygmentizePath = "/usr/local/bin/pygmentize";.
• $wgSyntaxHighlightModels: Bazı viki sayfaları için varsayılan lexer'ı yapılandırın. Varsayılan olarak bu, javascript ve css sayfalarını vurgulayacaktır. Ek içerik modelleri uzantılarla yapılandırılabilir (örn. Lua, JSON,..). Örnek:
   $wgSyntaxHighlightModels[CONTENT_MODEL_SCRIBUNTO] = 'lua';

Windows

• MediaWiki'nizi bir Windows makinesinde barındırıyorsanız, Pygmentize.exe $wgPygmentizePath = "c:\\Python27\\Scripts\\pygmentize.exe"; yolunu ayarlamanız gerekir
  • pygmentize.exe yoksa, dosyayı oluşturmak için Scripts klasörü içindeki komut satırından easy_install Pygments komutunu çalıştırın.

Paketlenmiş pygmentize ikili (extensions/SyntaxHighlight_GeSHi/pygments/pygmentize) kullanıyorsanız, web sunucunuzun bunu yürütmesine izin verildiğinden emin olun. Ana makineniz web dizininize yürütülebilir dosyalar eklemenize izin vermiyorsa, python-pygments'i yükleyin ve LocalSettings.php dosyasına $wgPygmentizePath = pygmentize ekleyin.

Sorun giderme

MediaWiki v1.26 ve üstü sürümlere güncelledikten sonra, bazı kullanıcılar uzantıyla ilgili sorunları bildirmeye başladı. Lua gibi bazı dillerin vurgulanamayacağı ve hata ayıklama öğesini açarak MediaWiki Notice: Failed to invoke Pygments: /usr/bin/env: python3: No such file or directory atabilir.

• LocalSettings.php dosyasında $wgPygmentizePath harici bir pigmentli ikiliye doğru işaret etmeyi deneyin.

• In shared hosting environments with cPanel, this can be done by setting up a new Python application through the "Setup Python App" menu, and activating the virtual environment for the app through SSH (source /virtualenv/python/3.5/bin/activate). After this, the Pygments module can be added to the Python app, for which navigate to the virtual environment path (cd virtualenv/python/3.5/bin/), download and install Pygments (./pip install Pygments) and then activate the module by adding "Pygments" under the "Existing applications" section of the "Setup Python App" menu. This will create the required file at path: virtualenv/python/3.5/bin/pygmentize

• Daha fazla öneri ve bilgi için phabricator görevine bakın.

Görsel Düzenleyici entegrasyonu

Eklenti Görsel Düzenleyici ile doğrudan düzenlemeyi mümkün kılar. Bir kullanıcı syntaxhighlight bölümlerini düzenlemek istediğinde bir açılır pencere açılır. Bunun çalışması için Görsel Düzenleyici'nin Parsoid için de geçerli olan en son git sürümünden yüklenmiş ve yapılandırılmış olması gerekir. Bu özellik eski Parsoid sürümlerinde rastgele çalışmaz. Ayrıntılar için Extension:SyntaxHighlight/VisualEditor sayfasına bakın

Gelişmiş

<pre> ve <code> etiketlerinin aksine,   gibi HTML karakter varlıklarının & karakterin & olarak kaçınılması gerekmez (ve olmamalıdır). <pre> etiketi gibi ancak <code> etiketinden farklı olarak, aralıktaki etiketlerin (kendi kapanış etiketi dışında) < sembolünün < olarak kaçmasına ve vikimetinin <nowiki> etiketi ile kaçmasına gerek yoktur.

Ayrıca, <pre> sekmesinin her 8 karakterde bir durduğunu varsayar ve oluşturulan metin kopyalandığında gerçek boşlukları kullanarak sekmeler oluşturur; <syntaxhighlight> 4 boşluklu sekme durakları kullanır (8 kullanan Internet Explorer hariç) ve işlenen metindeki sekme karakterlerini korur; ikincisi ekli bir <span style="-moz-tab-size:nn; -o-tab-size:nn; tab-size:nn;"> etiketi kullanılarak değiştirilebilir (<div> değil, kendi style özniteliğini kullanmadan). Firefox için -moz- öneki (sürüm 4.0'dan) ve Opera için -o- öneki (10.60'dan sürüm 15'e) gereklidir. (Viki düzenleme kutusunun 8 boşluklu sekmeler aldığını unutmayın.) Bu yalnızca gerçek kaydedilmiş sayfalar için geçerlidir; bir düzenleme kutusu veya Special:ExpandTemplates aracılığıyla oluşturulan önizlemeler farklı olabilir.

Ayrıca bakınız

• Pygments – Python syntax highlighter
• Buna bağlı uzantılar:
  • Extension:SyntaxHighlightPages – başlık eklerine göre sayfaları vurgular.
• Alternatif uzantılar:
  • Extension:GoogleCodePrettify – Google Code Prettify kitaplığını kullanan sözdizimi vurgulayıcı.
  • Extension:SyntaxHighlighter – SyntaxHighlighter kitaplığını kullanan sözdizimi vurgulayıcı.