-
-
Notifications
You must be signed in to change notification settings - Fork 282
/
syntax.texy
142 lines (87 loc) · 5.02 KB
/
syntax.texy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
Sintaxis Wiki
*************
Wiki utiliza la [sintaxis |https://texy.info/en/syntax] Markdown y [Texy |https://texy.info/en/syntax] con varias mejoras.
Enlaces .[#toc-links]
=====================
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 .[#toc-links-to-api-documentation]
-----------------------------------------------------------------------
Utilice siempre las siguientes notaciones:
- `[api:Nette\SmartObject]` -> [api:Nette\SmartObject]
- `[api:Nette\Forms\Form::setTranslator()]` -> [api:Nette\Forms\Form::setTranslator()]
- `[api:Nette\Forms\Form::$onSubmit]` -> [api:Nette\Forms\Form::$onSubmit]
- `[api:Nette\Forms\Form::Required]` -> [api: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() |api:Nette\Forms\Form::setTranslator()]
Enlaces a la documentación PHP .[#toc-links-to-php-documentation]
-----------------------------------------------------------------
- `[php:substr]` -> [php:substr]
Código fuente .[#toc-source-code]
=================================
El bloque de código comienza con <code>```lang</code> y termina con <code>```</code> 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 <code>```php .{file: ArrayTest.php}</code> y el bloque de código se mostrará de esta forma:
```php .{file: ArrayTest.php}
public function renderPage($id)
{
}
```
Encabezados .[#toc-headings]
============================
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 .[#toc-boxes-and-styles]
========================================
Párrafo principal marcado con la clase `.[perex]` .[perex]
Notas marcadas con clase `.[note]` .[note]
Consejo marcado con clase `.[tip]` .[tip]
Advertencia marcada con clase `.[caution]` .[caution]
Advertencia firme señalada con una clase `.[warning]` .[warning]
Número de versión `.{data-version:2.4.10}` .{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 .[#toc-table-of-contents]
================================
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 |#meta-tags]. 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 .[#toc-meta-tags]
===============================
- establecer su propio título de página (en `<title>` y migas de pan) `{{title: Another name}}`
- redirigir `{{redirect: pla:cs}}` - ver [enlaces |#links]
- forzar `{{toc}}` o desactivar `{{toc: no}}` tabla de contenido
{{priority: -1}}