Belge Sözdizimi

Belgeler, birkaç geliştirmeyle birlikte Markdown ve Texy sözdizimini kullanır.

Bağlantılar

İç bağlantılar için köşeli parantez yazımı [link] kullanılır. Bu ya dikey çizgili biçimdedir [bağlantı metni |bağlantı hedefi] ya da hedef metinle aynıysa (küçük harfe ve tirelere dönüştürüldükten sonra) kısaltılmış biçimdedir [bağlantı metni]:

[Sayfa adı] → <a href="/tr/sayfa-adi">Sayfa adı</a>
[bağlantı metni |Sayfa adı] → <a href="/tr/sayfa-adi">bağlantı metni</a>

Başka bir dil sürümüne ya da başka bir bölüme bağlantı verebiliriz. Bölüm, bir Nette kütüphanesini (örneğin forms, latte vb.) ya da best-practices, quickstart gibi özel bölümleri anlatır:

[cs:Sayfa adı] → <a href="/cs/sayfa-adi">Sayfa adı</a> (aynı bölüm, farklı dil)
[tracy:Sayfa adı] → <a href="//tracy.nette.org/tr/sayfa-adi">Sayfa adı</a> (farklı bölüm, aynı dil)
[tracy:cs:Sayfa adı] → <a href="//tracy.nette.org/cs/sayfa-adi">Sayfa adı</a> (farklı bölüm ve dil)

# kullanarak sayfadaki belirli bir başlığı hedeflemek de mümkündür.

[#Başlık] → <a href="#toc-baslik">Başlık</a> (geçerli sayfadaki başlık)
[Sayfa adı#Başlık] → <a href="/tr/sayfa-adi#toc-baslik">Sayfa adı</a>

Bölümün ana sayfasına bağlantı: (@home, bölümün ana sayfası için özel bir terimdir)

[bağlantı metni |@home] → <a href="/tr/">bağlantı metni</a>
[bağlantı metni |tracy:] → <a href="//tracy.nette.org/tr/">bağlantı metni</a>

API Belgelerine Bağlantılar

Her zaman şu yazımı kullanın:

[api:Nette\SmartObject] → Nette\SmartObject
[api:Nette\Forms\Form::setTranslator()] → Nette\Forms\Form::setTranslator()
[api:Nette\Forms\Form::$onSubmit] → Nette\Forms\Form::$onSubmit
[api:Nette\Forms\Form::Required] → Nette\Forms\Form::Required

Tam nitelikli adları yalnızca ilk anıldığında kullanın. Sonraki bağlantılarda basitleştirilmiş bir ad kullanın:

[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()] → Form::setTranslator()

PHP Belgelerine Bağlantılar

[php:substr] → substr

Kaynak Kodu

Bir kod bloğu ```lang ile başlar ve ``` ile biter. Desteklenen diller php, latte, neon, html, css, js ve sql dilleridir. Girinti için her zaman sekme kullanın.

 ```php
	public function renderPage($id)
	{
	}
 ```

Dosya adını ```php .{file: ArrayTest.php} biçiminde de belirtebilirsiniz; kod bloğu o zaman şöyle render edilir:

public function renderPage($id)
{
}

Başlıklar

En üstteki başlığın (sayfa adının) altını yıldızlarla (*) çizin. Bölümleri ayırmak için eşittir işaretlerini (=) kullanın. Başlıkların altını önce eşittir işaretleriyle (=), sonra tirelerle (-) çizin:

MVC Applications & Presenters
*****************************
...


Link Creation
=============
...


Links in Templates
------------------
...

Kutular ve Stiller

.[perex] sınıfıyla işaretlenmiş perex

.[note] sınıfıyla işaretlenmiş not

.[tip] sınıfıyla işaretlenmiş ipucu

.[caution] sınıfıyla işaretlenmiş dikkat

.[warning] sınıfıyla işaretlenmiş güçlü uyarı

Sürüm numarası .{data-version:2.4.10}

Sınıflar, uygulandıkları satırın önüne yazılmalıdır:

.[perex]
Bu perex'tir.

.[tip] gibi kutuların dikkat çektiğini ve bu yüzden daha önemsiz ayrıntılar için değil, önemli bilgileri vurgulamak için kullanılması gerektiğini unutmayın. Onları ölçülü kullanın.

İçindekiler

Boyutu 4.000 baytı aşan tüm sayfalar için otomatik olarak bir içindekiler tablosu (sağ kenar çubuğundaki bağlantılar) üretilir. Bu varsayılan davranış {{toc}} Meta Etiketleri ile değiştirilebilir. TOC metni varsayılan olarak doğrudan başlıklardan alınır, ama uzun başlıklarda yararlı olan .{toc} değiştiricisiyle farklı bir metin göstermek mümkündür.



Uzun ve Akıllı Başlık .{toc: TOC için farklı bir metin}
=======================================================

Meta Etiketleri

Özel bir sayfa başlığı ayarlayın (<title> içinde ve breadcrumb'larda): {{title: Another name}}
Yönlendirme: {{redirect: pla:cs}} – bkz. Bağlantılar
Otomatik içindekiler tablosunu (başlıklara bağlantı içeren kutu) zorlayın {{toc}} ya da kapatın {{toc: no}}.
Sol menüyü ayarlayın {{leftbar: utils:@left-menu}} ya da kapatın {{leftbar: no}}.