Sintaxis de la documentación

La documentación utiliza Markdown y la sintaxis Texy con algunas extensiones.

Enlaces

Para los enlaces internos se utiliza la notación entre corchetes [enlace]. Ya sea en la forma con barra vertical [texto del enlace |destino del enlace], o de forma abreviada [texto del enlace], si el destino es idéntico al texto (después de la transformación a minúsculas y guiones):

• [Page name |Page name] → <a href="/es/page-name">Page name</a>
• [texto del enlace |Page name] → <a href="/es/page-name">texto del enlace</a>

Podemos enlazar a otra versión lingüística o a otra sección. Por sección se entiende una librería de Nette (p. ej., forms, latte, etc.) o secciones especiales como best-practices, quickstart, etc.:

• [cs:Page name |cs:Page name] → <a href="/cs/page-name">Page name</a> (misma sección, diferente idioma)
• [tracy:Page name |tracy:Page name] → <a href="//tracy.nette.org/es/page-name">Page name</a> (diferente sección, mismo idioma)
• [tracy:cs:Page name |tracy:cs:Page name] → <a href="//tracy.nette.org/cs/page-name">Page name</a> (diferente sección e idioma)

Usando # también es posible apuntar a un encabezado específico en la página.

• [#Heading |#Heading] → <a href="#toc-heading">Heading</a> (encabezado en la página actual)
• [Page name#Heading |Page name#Heading] → <a href="/es/page-name#toc-heading">Page name</a>

Enlace a la página de inicio de la sección: (@home es una expresión especial para la página de inicio 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

Siempre indíquelos únicamente mediante esta notación:

• [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 nombres completamente calificados solo en la primera mención. Para enlaces posteriores, use el 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 comienza con ```lang y termina con ```. Los lenguajes admitidos son php, latte, neon, html, css, js y sql. Para la indentación, use siempre tabuladores.

 ```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 renderizará de esta manera:

public function renderPage($id)
{
}

Encabezados

El encabezado más alto (es decir, el nombre de la página) debe subrayarse con asteriscos (***). Para separar secciones, use signos de igual (===). Subraye los encabezados de nivel inferior con signos de igual (===) y luego con guiones (---):

Aplicaciones MVC y presenters
*****************************
...


Creación de enlaces
===================
...


Enlaces en plantillas
---------------------
...

Recuadros y estilos

Marcamos el perex con la clase .[perex]

Marcamos una nota con la clase .[note]

Marcamos un consejo con la clase .[tip]

Marcamos una advertencia con la clase .[caution]

Marcamos una advertencia más fuerte con la clase .[warning]

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

Escriba las clases antes de la línea:

.[perex]
Este es el perex.

Tenga en cuenta que los recuadros como .[tip] “atraen” la vista, por lo que se utilizan para enfatizar, no para información menos importante. Por lo tanto, úselos con la máxima moderación.

Tabla de contenidos

La tabla de contenidos (enlaces en el menú derecho) se genera automáticamente para todas las páginas cuyo tamaño supere los 4000 bytes, aunque este comportamiento predeterminado se puede modificar mediante la metaetiqueta {{toc}}. El texto que forma la tabla de contenidos se toma por defecto directamente del texto de los encabezados, pero mediante el modificador .{toc} es posible mostrar un texto diferente en la tabla de contenidos, lo cual es útil principalmente para encabezados más largos.

Encabezado largo e inteligente .{toc: Cualquier otro texto mostrado en la tabla de contenidos}
==============================================================================================

Metaetiquetas

• establecer un título de página personalizado (en <title> y navegación de migas de pan) {{title: Otro título}}
• redirección {{redirect: pla:cs}} – ver enlaces
• forzar {{toc}} o deshabilitar {{toc: no}} la tabla de contenidos automática (recuadro con enlaces a encabezados individuales)