Sintaxe da Documentação
A documentação usa Markdown e a sintaxe Texy com algumas extensões.
Links
Para links internos, utiliza-se a notação em colchetes [...]. Seja na forma com barra vertical
[texto do link |destino do link], ou abreviada [texto do link], se o destino for idêntico ao texto
(após transformação para minúsculas e hífens):
[Page name|Page name]→<a href="/en/page-name">Page name</a>[texto do link |Page name]→<a href="/en/page-name">link text</a>
Podemos criar links para uma versão de idioma diferente ou para uma seção diferente. Uma seção significa uma biblioteca
Nette (por exemplo, forms, latte, etc.) ou seções especiais como best-practices,
quickstart, etc.:
[cs:Page name]→<a href="/cs/page-name">Page name</a>(mesma seção, idioma diferente)[tracy:Page name]→<a href="//tracy.nette.org/en/page-name">Page name</a>(seção diferente, mesmo idioma)[tracy:cs:Page name]→<a href="//tracy.nette.org/cs/page-name">Page name</a>(seção e idioma diferentes)
Usando #, também é possível direcionar para um título específico na página.
[#Heading]→<a href="#toc-heading">Heading</a>(título na página atual)[Page name#Heading]→<a href="/en/page-name#toc-heading">Page name</a>
Link para a página inicial da seção: (@home é uma expressão especial para a página inicial da seção)
[texto do link |@home]→<a href="/en/">link text</a>[texto do link |tracy:]→<a href="//tracy.nette.org/en/">link text</a>
Links para a Documentação da API
Utilize sempre apenas esta notação:
[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
Use nomes totalmente qualificados apenas na primeira menção. Para links subsequentes, use o nome simplificado:
[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]→ Form::setTranslator()
Links para a Documentação do PHP
[php:substr]→ substr
Código-Fonte
Um bloco de código começa com ` `lang ` e termina com ` `
. Os idiomas suportados são `php, latte, neon, html, css,
js e sql. Use sempre tabulações para a indentação.
```php
public function renderPage($id)
{
}
```
Também pode especificar o nome do arquivo como ` `php .{file: ArrayTest.php} ` e o bloco de código será
renderizado desta forma:
public function renderPage($id)
{
}
Títulos
Sublinhe o título mais alto (ou seja, o nome da página) com asteriscos (***). Use sinais de igual
(===) para separar secções principais. Sublinhe os títulos de nível inferior com sinais de igual
(===) e depois com hífens (---):
Aplicações MVC & Presenters
***************************
...
Criação de Links
================
...
Links em Templates
------------------
...
Caixas e Estilos
Marcamos o perex com a classe .[perex]
Marcamos uma nota com a classe .[note]
Marcamos uma dica com a classe .[tip]
Marcamos um aviso com a classe .[caution]
Marcamos um aviso mais forte com a classe .[warning]
Número da versão .{data-version:2.4.10}
Escreva as classes antes da linha:
.[perex]
Este é o perex.
Por favor, esteja ciente de que caixas como .[tip] chamam a atenção, portanto, são usadas para enfatizar, e
não para informações menos importantes. Use-as com moderação.
Sumário
O sumário (links no menu direito) é gerado automaticamente para todas as páginas cujo tamanho exceda 4 000 bytes. Este
comportamento padrão pode ser modificado usando a meta tag {{toc}}. O texto que forma
o sumário é retirado por padrão diretamente do texto dos títulos, mas usando o modificador .{toc}, é possível
exibir um texto diferente no sumário, o que é útil principalmente para títulos mais longos.
Título longo e inteligente .{toc: Qualquer outro texto exibido no sumário}
==========================================================================
Meta Tags
- definir um título de página personalizado (em
<title>e na navegação breadcrumb){{title: Outro título}} - redirecionamento
{{redirect: pla:cs}}– veja Links - forçar
{{toc}}ou desabilitar{{toc: no}}o sumário automático (caixa com links para títulos individuais)
