Sintaxis de la documentación

La documentación usa Markdown y la sintaxis de Texy con varias mejoras.

Enlaces

Para los enlaces internos se usa la notación entre corchetes [enlace]. Puede ser en la forma con barra vertical [texto del enlace |destino del enlace], o en la forma abreviada [texto del enlace] si el destino coincide con el texto (tras convertirlo a minúsculas y guiones):

[Nombre de la página] → <a href="/es/nombre-de-la-pagina">Nombre de la página</a>
[texto del enlace |Nombre de la página] → <a href="/es/nombre-de-la-pagina">texto del enlace</a>

Podemos enlazar a otra versión de idioma o a otra sección. Una sección se refiere a una biblioteca de Nette (p. ej. forms, latte, etc.) o a secciones especiales como best-practices, quickstart, etc.:

[cs:Nombre de la página] → <a href="/cs/nombre-de-la-pagina">Nombre de la página</a> (misma sección, otro idioma)
[tracy:Nombre de la página] → <a href="//tracy.nette.org/es/nombre-de-la-pagina">Nombre de la página</a> (otra sección, mismo idioma)
[tracy:cs:Nombre de la página] → <a href="//tracy.nette.org/cs/nombre-de-la-pagina">Nombre de la página</a> (otra sección y otro idioma)

También es posible apuntar a un encabezado concreto de la página con #.

[#Encabezado] → <a href="#toc-encabezado">Encabezado</a> (encabezado de la página actual)
[Nombre de la página#Encabezado] → <a href="/es/nombre-de-la-pagina#toc-encabezado">Nombre de la página</a>

Enlace a la página principal de la sección: (@home es un término especial para la página principal de la sección)

[texto del enlace |@home] → <a href="/es/">texto del enlace</a>
[texto del enlace |tracy:] → <a href="//tracy.nette.org/es/">texto del enlace</a>

Enlaces a la documentación de la API

Use siempre la notación siguiente:

[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 los nombres completamente cualificados solo en la primera mención. En los enlaces siguientes use un nombre simplificado:

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

Enlaces a la documentación de PHP

[php:substr] → substr

Código fuente

Un bloque de código empieza con ```lang y termina con ```. Los lenguajes soportados son php, latte, neon, html, css, js y sql. Use siempre tabuladores para la indentación.

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

También puede indicar el nombre del archivo como ```php .{file: ArrayTest.php}, y el bloque de código se renderizará así:

public function renderPage($id)
{
}

Encabezados

El encabezado superior (el nombre de la página) se subraya con asteriscos (*). Use signos de igual (=) para separar las secciones. Los encabezados se subrayan primero con signos de igual (=) y después con guiones (-):

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


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


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

Recuadros y estilos

Perex marcado con la clase .[perex]

Nota marcada con la clase .[note]

Consejo marcado con la clase .[tip]

Precaución marcada con la clase .[caution]

Advertencia fuerte marcada con la clase .[warning]

Número de versión .{data-version:2.4.10}

Las clases se escriben antes de la línea a la que se aplican:

.[perex]
Esto es el perex.

Tenga en cuenta que los recuadros como .[tip] llaman la atención y por tanto deberían usarse para destacar información importante, no detalles menos significativos. Úselos con moderación.

Tabla de contenidos

La tabla de contenidos (los enlaces de la barra lateral derecha) se genera automáticamente para todas las páginas que superan los 4000 bytes de tamaño. Este comportamiento predeterminado se puede modificar con la Metaetiquetas {{toc}}. De forma predeterminada, el texto de la tabla de contenidos se toma directamente de los encabezados, pero es posible mostrar un texto distinto con el modificador .{toc}, lo que resulta útil en los encabezados más largos.



Encabezado largo e inteligente .{toc: Un texto distinto para la TOC}
====================================================================

Metaetiquetas

Establecer un título de página propio (en <title> y en las migas de pan): {{title: Otro nombre}}
Redirección: {{redirect: pla:cs}} – vea Enlaces
Forzar {{toc}} o desactivar {{toc: no}} la tabla de contenidos automática (el recuadro con enlaces a los encabezados).
Establecer el menú izquierdo {{leftbar: utils:@left-menu}} o desactivarlo {{leftbar: no}}.