Sync the Yaf documentation with doc-en at ddcf673

Follow up on the Yaf rewrite in php/doc-en#5809: remove the 17 pages that
only re-documented inherited methods, add the 11 pages it introduced, and
bring the remaining pages in line with the English at ddcf673 (052c737e
for the three pages a later commit touched).

Every page is translated: the description, parameter and return blocks
that doc-en fills are filled here too, and warn.undocumented.func is gone
from the pages that are now documented. Code comments and example strings
are in Spanish, and the outputs match the code they follow.

Several examples were stale or wrong and are fixed along the way:
Yaf_Route_Map::__construct had controller and action swapped in both
outputs, Yaf_Application::execute had lost the body of main() and its
output, Yaf_Dispatcher::registerPlugin was truncated before the closing
brace, Yaf_Response_Abstract::response called a translated method name,
Yaf_View_Simple::assignRef still described a bug fixed in Yaf 2.1.4,
Yaf_View_Simple::__construct used APPLICATOIN_PATH and a dropped option,
and Yaf_Route_Supervar::__construct documented another supervar than the
one its own example registered.

Also ignore /en, so a local doc-en checkout cannot be committed again.

Author: lacatoire

.gitignore

@@ -2,3 +2,4 @@ entities.*.xml
 output
 .docker/built
 temp/
+/en

reference/yaf/appconfig.xml

@@ -1,7 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision$ -->
-<!-- EN-Revision: f4ff30a7a6a555fc825577d2cb877e3a07094d6b Maintainer: Marqitos Status: ready -->
-<!-- Reviewed: no -->
+<!-- EN-Revision: ddcf673c59d1708557680946fbffeee361d7fca6 Maintainer: Marqitos Status: ready -->
 
 <chapter xml:id="yaf.appconfig" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <title xmlns="http://docbook.org/ns/docbook">Configuración de la Aplicación</title>
@@ -180,10 +178,10 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       La extensión de fichero del script de PHP, usado en la autocarga de clases
       (<classname>Yaf_Loader</classname>).
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.view.ext">
@@ -192,9 +190,9 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       La extensión de fichero de los script de plantilla de vistas.
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.modules">
@@ -203,13 +201,13 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       Una lista separada por comas de los módulos registrados, usada en el proceso de
       enrutamiento, especialmente mientras existan más de tres segmentos en PATH_INFO,
-     </para>
-     <para>
+     </simpara>
+     <simpara>
       Yaf necesita una forma de averiguar si el primer segmento es un nombre de módulo o no.
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.library">
@@ -218,16 +216,16 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       El directorio de bibliotecas local, véase <classname>Yaf_Loader</classname> y
       <link linkend="ini.yaf.library">yaf.library</link>.
-     </para>
+     </simpara>
      <note>
-      <para>
+      <simpara>
        Después de Yaf 2.1.6, esta entrada de configuración puede ser un array. La ruta de la biblioteca
        intentará emplear los ítems establecidos en <link
        linkend="configuration.yaf.library.directory">application.library.directory</link>
-      </para>
+      </simpara>
      </note>
     </listitem>
    </varlistentry>
@@ -237,11 +235,11 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       Alias de <link
       linkend="configuration.yaf.library">application.library</link>. Introducido
       en Yaf 2.1.6
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.library.namespace">
@@ -250,12 +248,12 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       Un prefijo separado por comas de nombres de espacios de bibliotecas locales.
-     </para>
-     <para>
+     </simpara>
+     <simpara>
       Introducido en Yaf 2.1.6
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.bootstrap">
@@ -264,9 +262,9 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       Una ruta absoluta del script de la clase Bootstrap.
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.baseuri">
@@ -275,16 +273,16 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       Usado para eliminar un prefijo fijo de un uri de petición en el proceso de enrutamiento.
       Como ejemplo, una petición con la uri de petición
       "/prefix/controller/action". Si se establece application.baseUri a
       "/prefix", solamente se tomará "/controller/action" como PATH_INFO en
       el proceso de enrutamiento.
-     </para>
-     <para>
+     </simpara>
+     <simpara>
       En general, no hay necesidad de establecer este valor.
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.dispatcher.throwexception">
@@ -293,10 +291,10 @@ yaf.dispatcher.catchException = 0
      <type>bool</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       Si es On, Yaf lanzará una excepción mientras ocurra algún error.
       Véase también <methodname>Yaf_Dispatcher::throwException</methodname>.
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.dispatcher.catchexception">
@@ -305,11 +303,11 @@ yaf.dispatcher.catchException = 0
      <type>bool</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       Si es On, Yaf remitirá al controlador/acción de errores mientras
       exista una excepción no capturada. Véase también
       <methodname>Yaf_Dispatcher::catchException</methodname>.
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.dispatcher.defaulRoute">
@@ -318,11 +316,11 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       El enrutamiento por defecto, si no se especifica se usará un enrutamiento estático
       como predeterminado. Véase
       <methodname>Yaf_Router::addRoute</methodname>.
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.dispatcher.defaultmodule">
@@ -331,10 +329,10 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       El nombre de módulo predeterminado, véase también
       <methodname>Yaf_Dispatcher::setDefaultModule</methodname>.
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.dispatcher.defaultcontroller">
@@ -343,10 +341,10 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       El nombre de controlador predeterminado, véase también
       <methodname>Yaf_Dispatcher::setDefaultController</methodname>.
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="configuration.yaf.dispatcher.defaultaction">
@@ -355,10 +353,10 @@ yaf.dispatcher.catchException = 0
      <type>string</type>
     </term>
     <listitem>
-     <para>
+     <simpara>
       El nombre de acción predeterminado, véase también
       <methodname>Yaf_Dispatcher::setDefaultAction</methodname>.
-     </para>
+     </simpara>
     </listitem>
    </varlistentry>
 

reference/yaf/book.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- EN-Revision: bd23019549a09eb15f5c772987c76781ab5f5f09 Maintainer: seros Status: ready -->
-<!-- Reviewed: yes Maintainer: seros -->
+<!-- EN-Revision: ddcf673c59d1708557680946fbffeee361d7fca6 Maintainer: seros Status: ready -->
 
 <book xml:id="book.yaf" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <?phpdoc extension-membership="pecl" ?>
@@ -9,18 +8,40 @@
 
  <preface xml:id="intro.yaf">
   &reftitle.intro;
-  <para>
-   La extensión <literal>Yet Another Framework</literal> (<acronym>Yaf</acronym>) -Otro Framework Más, en español-
-   es un framework de PHP usado para desarrollar aplicaciones web.
-  </para>
-  <para>
-   Se puede encontrar una comparativa sencilla en <link
-   xlink:href="&url.yaf.benchmarks;">Rendimiento de Yaf</link>.
-  </para>
-  <para>
-   Para una guía rápida, consulte la sección <link
-   linkend="yaf.tutorials">Turoriales</link>.
-  </para>
+  <simpara>
+   La extensión <literal>Yet Another Framework</literal>
+   (<acronym>Yaf</acronym>) es un framework de PHP usado para desarrollar
+   aplicaciones web.
+  </simpara>
+  <simpara>
+   A diferencia de los frameworks PHP típicos, Yaf está escrito en C y
+   compilado como extensión: las clases del framework, el autocargador, el
+   router y el bucle de despacho se ejecutan en código compilado, por lo que
+   la sobrecarga del framework por petición se mide en microsegundos en lugar
+   de milisegundos, y no hay ficheros PHP del framework que cargar. Está
+   diseñado para aplicaciones de alto tráfico donde el coste de arranque
+   importa, y para entornos de ejecución de servicios de larga duración (como
+   Swoole) donde cada petición necesita un ciclo de despacho limpio.
+  </simpara>
+  <simpara>
+   Yaf implementa la arquitectura <acronym>MVC</acronym> clásica con un único
+   script de entrada, un fichero de configuración con secciones de entorno,
+   hooks de bootstrap, un sistema de plugins con siete hooks de despacho,
+   seis tipos de rutas integrados, un autocargador de estilo PSR-0
+   (<classname>Yaf_Loader</classname>) y una vista de plantilla PHP ligera
+   (<classname>Yaf_View_Simple</classname>).
+  </simpara>
+  <simpara>
+   Se puede encontrar una comparativa sencilla de Yaf en
+   <link xlink:href="&url.yaf.benchmarks;">Rendimiento de Yaf</link>. Para una
+   guía rápida, consulte la sección <link linkend="yaf.tutorials">Tutoriales</link>.
+  </simpara>
+  <note>
+   <simpara>
+    Yaf requiere PHP 7.0 o posterior (la rama master de su repositorio
+    fuente); una rama php5 soporta PHP 5.2 y posterior.
+   </simpara>
+  </note>
  </preface>
 
  &reference.yaf.setup;

reference/yaf/constants.xml

@@ -1,10 +1,18 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- EN-Revision: 86e6094e86b84a51d00ab217ac50ce8dde33d82a Maintainer: seros Status: ready -->
-<!-- Reviewed: yes Maintainer: seros -->
+<!-- EN-Revision: ddcf673c59d1708557680946fbffeee361d7fca6 Maintainer: seros Status: ready -->
 
 <appendix xml:id="yaf.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  &reftitle.constants;
  &extension.constants;
+ <simpara>
+  Cuando se produce un error durante el arranque, el enrutamiento, el
+  despacho o la carga automática, Yaf lanza una subclase de
+  <exceptionname>Yaf_Exception</exceptionname> cuyo código de excepción es
+  una de las constantes <literal>YAF_ERR_*</literal>, o desencadena un error
+  PHP del tipo correspondiente; véase
+  <methodname>Yaf_Dispatcher::throwException</methodname> y
+  <methodname>Yaf_Application::getLastErrorNo</methodname>.
+ </simpara>
  <para>
   <variablelist>
    <varlistentry xml:id="constant.yaf-version">