Синтаксис на Уикипедия
Документация използва синтаксиса на Markdown и Texy с няколко подобрения.
Връзки
За вътрешните препратки се използва обозначението в квадратни скоби
[link]
се използва. Това е или под формата на вертикална лента
[link text |link target]
, или в съкратен вид [link text]
ако целта е
същата като текста (след преобразуване в малки букви и тирета):
[Page name]
→<a href="/en/page-name">Page name</a>
[link text |Page name]
→<a href="/en/page-name">link text</a>
Можем да се свържем с друг език или друг раздел. Разделът е библиотека
на Nette (например forms
, latte
и т.н.) или специални раздели като
best-practices
, quickstart
и т.н:
[cs:Page name]
→<a href="/en/page-name">Page name</a>
(същият раздел, различен език)[tracy:Page name]
→<a href="//tracy.nette.org/en/page-name">Page name</a>
(друг раздел, същият език)[tracy:cs:Page name]
→<a href="//tracy.nette.org/en/page-name">Page name</a>
(различен раздел и език)
Също така е възможно да се насочите към определено заглавие на
страницата с помощта на #
.
[#Heading]
→<a href="#toc-heading">Heading</a>
(заглавие на текущата страница)[Page name#Heading]
→<a href="/en/page-name#toc-heading">Page name</a>
Връзка към началната страница на раздела: (@home
е специален
термин за началната страница на раздела)
[link text |@home]
→<a href="/en/">link text</a>
[link text |tracy:]
→<a href="//tracy.nette.org/en/">link text</a>
Връзки към документацията на API
Винаги използвайте следните означения:
[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
Напълно квалифицираните имена се използват само при първото споменаване. За останалите връзки използвайте опростено име:
[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]
→ Form::setTranslator()
Връзки към документацията на PHP
[php:substr]
→ substr
Изходен код
Блокът с код започва с ```lang
и завършва с ```
Поддържаните
езици са php
, latte
, neon
, html
, css
, js
и
sql
. Винаги използвайте табулатори за отстъпите.
```php
public function renderPage($id)
{
}
```
Можете също така да посочите името на файла като
```php .{file: ArrayTest.php}
и блокът с код ще бъде визуализиран по
този начин:
public function renderPage($id)
{
}
Заглавия
Горното заглавие (името на страницата) се подчертава със звездички
(*
). For normal headings use equal signs (=
) and then hyphens (-
).
MVC Applications & Presenters
*****************************
...
Link Creation
=============
...
Links in Templates
------------------
...
Кутии и стилове
Водещ параграф, маркиран с клас .[perex]
Бележки, отбелязани с клас .[note]
Съвет, отбелязан с клас .[tip]
Предупреждение, отбелязано с клас .[caution]
Силно предупреждение, отбелязано с клас .[warning]
Номер на версията .{data-version:2.4.10}
Класовете трябва да се изписват преди съответния ред:
.[note]
This is a note.
Моля, обърнете внимание, че полета като .[tip]
привличат
вниманието и затова трябва да се използват за подчертаване, а не за
по-малко важна информация.
Съдържание
Съдържанието (връзките в страничната лента) се генерира автоматично,
когато страницата е по-дълга от 4 000 байта. Това поведение по
подразбиране може да бъде променено с {{toc}}
мета
тага. Текстът за TOC се взема по подразбиране от заглавието, но е
възможно да се използва различен текст с помощта на .{toc}
модификатор. Това е особено полезно за по-дълги заглавия.
Long and Intelligent Heading .{toc: A Different Text for TOC}
=============================================================
Метаетикети
- задаване на собствено заглавие на страницата (в
<title>
и трохи){{title: Another name}}
- пренасочване
{{redirect: pla:cs}}
– показване на връзки - налагане
{{toc}}
или деактивиране{{toc: no}}
таблица на съдържанието