Składnia Wiki
Wiki używa składni Markdown i Texy z pewnymi rozszerzeniami.
Linki
Dla linków wewnętrznych stosuje się zapis w nawiasach kwadratowych [odkaz]
. Albo w formie z pionowym paskiem
[text odkazu |cíl odkazu]
, lub w skrócie [text odkazu]
jeśli cel jest identyczny z tekstem (po
przekształceniu na małe litery i myślniki):
[Page name]
→<a href="/en/page-name">Page name</a>
[link text |Page name]
→<a href="/en/page-name">link text</a>
Możemy linkować do innego języka lub innego działu. Sekcja oznacza bibliotekę Nette (np. forms
,
latte
, itd.) lub sekcje specjalne jak best-practices
, quickstart
, itd:
[cs:Page name]
→<a href="/en/page-name">Page name</a>
(ta sama sekcja, inny język)[tracy:Page name]
→<a href="//tracy.nette.org/en/page-name">Page name</a>
(inny dział, ten sam język)[tracy:cs:Page name]
→<a href="//tracy.nette.org/en/page-name">Page name</a>
(inny dział i język)
Możesz również użyć #
, aby skierować się do konkretnego nagłówka na stronie.
[#Heading]
→<a href="#toc-heading">Heading</a>
(nagłówek na bieżącej stronie)[Page name#Heading]
→<a href="/en/page-name#toc-heading">Page name</a>
Link do strony głównej sekcji: (@home
to specjalne określenie dla strony głównej sekcji)
[link text |@home]
→<a href="/en/">link text</a>
[link text |tracy:]
→<a href="//tracy.nette.org/en/">link text</a>
Linki do dokumentacji API
Zawsze odwołuj się wyłącznie do tego zapisu:
[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
Używaj w pełni kwalifikowanych nazw tylko w pierwszej wzmiance. Do dalszych odniesień używaj uproszczonej nazwy:
[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]
→ Form::setTranslator()
Linki do dokumentacji PHP
[php:substr]
→ substr
Kod źródłowy
Blok kodu zaczyna się od ```lang
i kończy na ```
. Obsługiwane języki to: php
,
latte
, neon
, html
, css
, js
oraz sql
. Zawsze używaj
tabulatorów do wcięć.
```php
public function renderPage($id)
{
}
```
Możesz również podać nazwę pliku jak ```php .{file: ArrayTest.php}
i blok kodu zostanie wyrenderowany w ten
sposób:
public function renderPage($id)
{
}
Nagłówki
Podkreśl gwiazdkami górny nagłówek (czyli tytuł strony). Użyj nawiasów, aby oddzielić sekcje. Podkreśl nagłówki za pomocą nawiasów klamrowych, a następnie myślników:
MVC Aplikace & presentery .[#toc-mvc-applications-presenters]
*************************************************************
...
Tvorba odkazů .[#toc-link-creation]
===================================
...
Odkazy v šablonách .[#toc-links-in-templates]
---------------------------------------------
...
Ramy i style
Perex zostanie oznaczony klasą .[perex]
Oznacz notatkę klasą .[note]
Oznaczyć podpowiedź klasą .[tip]
Oznaczaj ostrzeżenia klasą .[caution]
Silniejsze ostrzeżenia są oznaczone klasą .[warning]
Numer wersji .{data-version:2.4.10}
Napisz klasy przed linią:
.[perex]
Tohle je perex.
Należy pamiętać, że ramki np. .[tip]
„ciągnie“ za sobą oczy, dzięki czemu są one używane do
podkreślania, a nie do mniej istotnych informacji. Dlatego w miarę możliwości należy używać ich oszczędnie.
Treść
Treść (linki w prawym menu) jest generowana automatycznie dla wszystkich stron, których rozmiar przekracza 4000 bajtów, a
to domyślne zachowanie można zmienić za pomocą meta tagu {{toc}}
. Tekst tworzący
treść jest domyślnie pobierany bezpośrednio z tekstu nagłówków, ale przy użyciu modyfikatora .{toc}
modyfikator, możliwe jest wyświetlenie innego tekstu w spisie treści, co jest szczególnie przydatne w przypadku dłuższych
nagłówków.
Dlouhý a inteligentní nadpis .{toc: Libovolný jiný text zobrazený v obsahu}
===========================================================================
Meta tagi
- ustawienie własnej nazwy strony (w
<title>
i nawigacji breadcrumb){{title: Jiný název}}
- przekierowanie
{{redirect: pla:cs}}
– zobacz linki - wykonanie
{{toc}}
lub wyłączenie{{toc: no}}
zawartość automatyczna (ramka z linkami do poszczególnych nagłówków)