Sintaxis Wiki
Wiki utiliza la sintaxis Markdown y Texy con varias mejoras.
Enlaces
Para las referencias internas, se utiliza la notación entre corchetes [link]
. Se utiliza la forma con barra
vertical [link text |link target]
o en la forma abreviada [link text]
si el destino es el mismo que el
texto (previa transformación a minúsculas y guiones):
[Page name]
→<a href="/en/page-name">Page name</a>
[link text |Page name]
→<a href="/en/page-name">link text</a>
Podemos enlazar con otro idioma o con otra sección. Una sección es una biblioteca Nette (por ejemplo, forms
,
latte
, etc.) o secciones especiales como best-practices
, quickstart
, etc:
[cs:Page name]
→<a href="/en/page-name">Page name</a>
(misma sección, distinto idioma)[tracy:Page name]
→<a href="//tracy.nette.org/en/page-name">Page name</a>
(sección diferente, mismo idioma)[tracy:cs:Page name]
→<a href="//tracy.nette.org/en/page-name">Page name</a>
(sección e idioma diferentes)
También es posible seleccionar un título específico de la página con #
.
[#Heading]
→<a href="#toc-heading">Heading</a>
(título de la página actual)[Page name#Heading]
→<a href="/en/page-name#toc-heading">Page name</a>
Enlace a la página de inicio de la sección: (@home
es un término especial para la página de inicio de la
sección)
[link text |@home]
→<a href="/en/">link text</a>
[link text |tracy:]
→<a href="//tracy.nette.org/en/">link text</a>
Enlaces a la documentación de la API
Utilice siempre las siguientes notaciones:
[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
Los nombres completos sólo se utilizan en la primera mención. Para los demás enlaces, utilice un nombre simplificado:
[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]
→ Formulario::setTranslator()
Enlaces a la documentación PHP
[php:substr]
→ substr
Código fuente
El bloque de código comienza con ```lang
y termina con ```
Los lenguajes soportados son
php
, latte
, neon
, html
, css
, js
y sql
.
Utilice siempre tabuladores para la sangría.
```php
public function renderPage($id)
{
}
```
También puede especificar el nombre del archivo como ```php .{file: ArrayTest.php}
y el bloque de código se
mostrará de esta forma:
public function renderPage($id)
{
}
Encabezados
Encabezamiento superior (nombre de la página) subrayado con estrellas (*
). For normal headings use equal signs
(=
) and then hyphens (-
).
MVC Applications & Presenters
*****************************
...
Link Creation
=============
...
Links in Templates
------------------
...
Cajas y estilos
Párrafo principal marcado con la clase .[perex]
Notas marcadas con clase .[note]
Consejo marcado con clase .[tip]
Advertencia marcada con clase .[caution]
Advertencia firme señalada con una clase .[warning]
Número de versión .{data-version:2.4.10}
Las clases deben escribirse antes de la línea correspondiente:
.[note]
This is a note.
Tenga en cuenta que los recuadros como .[tip]
llaman la atención y, por lo tanto, deben utilizarse para resaltar,
no para información menos importante.
Índice
La tabla de contenidos (enlaces en la barra lateral) se genera automáticamente cuando la página tiene más de 4 000 bytes.
Este comportamiento predeterminado puede modificarse con una etiqueta {{toc}}
etiqueta
meta. El texto de la tabla de contenido se toma por defecto del encabezamiento, pero es posible utilizar un texto diferente
con un modificador .{toc}
modificador. Esto es especialmente útil para encabezados más largos.
Long and Intelligent Heading .{toc: A Different Text for TOC}
=============================================================
Metaetiquetas
- establecer su propio título de página (en
<title>
y migas de pan){{title: Another name}}
- redirigir
{{redirect: pla:cs}}
– ver enlaces - forzar
{{toc}}
o desactivar{{toc: no}}
tabla de contenido