Changes between Version 5 and Version 6 of TolPackageRulesAndComments

Timestamp:

Jun 17, 2010, 6:23:58 PM (15 years ago)

Author:

Víctor de Buen Remiro

Comment:

--

TolPackageRulesAndComments

@@ +1 @@
+[[PageOutline]]
+
 = !TolPackage: Un sistema de desarrollo modular en red  =
 
@@ -18 +20 @@
 sino que son ellos mismos quienes se autogestionan.
 
-Por último, hay que permitir que cada paquete evolucione sin excesivas 
-ataduras de compatibilidad hacia atrás para que pueda progresar pero sin
-dejar tirados a los usuarios que por motivos de seguridad no pueden 
-arriesgarse a actualizarse cada poco tiempo.
+También resulta de vital importancia permitir que cada paquete evolucione 
+sin excesivas ataduras de compatibilidad hacia atrás para que pueda 
+progresar pero sin dejar tirados a los usuarios que por motivos de seguridad 
+no pueden arriesgarse a actualizarse cada poco tiempo.
+
+Por último, debe ser muy fácil de usar. Una vez cargado, el paquete es 
+siempre global aunque se haya llamado desde un ámbito local puesto que 
+tratándose de herramientas de uso general no tiene sentido tener tantos 
+miramientos. Como contrapartida, un paquete no se puede descargar de 
+la memoria una vez que ha sido cargado, pero eso tampoco es problema 
+puesto que no ocupan un espacio significativo en comparación con los datos 
+de los problemas que pueden resolver.
 
 == Arquitectura ==
@@ -48 +58 @@
 == Creación de paquetes ==
  
- * Un paquete se crea como un NameBlock en un fichero principal del mismo 
-   nombre con extensión .tol y dentro de un directorio raíz llamado igual. El 
-   fichero principal puede cargar con #Embed los archivos auxiliares que 
-   necesite con nombre libre pero ubicación paralela o en subdirectorios del 
-   raíz.
- * En [source:/tolp/OfficialTolArchiveNetwork] pueden verse ejemplos de 
-   paquetes. Cada subdirectorio es un paquete.
- * Los nombres de los paquetes deben seguir el estilo CamelCase 
- * Cuando un paquete requiere de otros se debe incluir las correspondientes
-   sentencias #Require antes de la declaración del primer miembro.
+Un paquete se crea como un NameBlock pero con una serie de restricciones de 
+obligado cumplimiento
+
+=== Estructura ===
+
+ * Debe crearse en un fichero principal del mismo nombre con extensión .tol 
+   y dentro de un directorio raíz llamado igual. El fichero principal puede cargar 
+   con #Embed los archivos auxiliares que necesite con nombre libre pero ubicación 
+   paralela o en subdirectorios del raíz.
  * Los miembros obligatorios del NameBlock de un paquete son:
   * Text _.autodoc.brief = "Descripción cortísima en una línea".
@@ -68 +77 @@
   * Real _.autodoc.version.low = 1;
   * Set _.autodoc.dependencies = [["paquete1","paquete2", ...]];
+
+=== Nomenclatura ===
+
+ * Los nombres de los paquetes deben seguir el estilo CamelCase 
+ * El nombre del archivo de una versión concreta de un paquete se obtiene
+   como la concatenación del nombre del paquete seguido de un punto, el número 
+   _.autodoc.version.high, otro punto y el número _.autodoc.version.low
+ * El nombre del NameBlock sin embargo es el mismo siempre por lo que se invocará 
+   sin usar los número de versión.
+ * No es posible por tanto cargar dos versiones distintas de un mismo paquete en
+   la misma sesión TOL.
+ * Sí es posible cargar diferentes versiones de un mismo NameBlock en una misma
+   máquina en sesiones de TOL distintas, coincidentes o no en el tiempo. 
+
+=== Código declarativo ===
+
  * Puesto que un paquete se almacena como un módulo OZA, está terminantemente 
    prohibido que un NameBlock ejecute acciones de ningún tipo durante su creación.
@@ -79 +104 @@
    tener un método [[BR]] {{{ Real StartActions(Real void) { ... }; }}} [[BR]] el 
    cual será llamado justo después de ser cargado por el #Require por vez primera.
- * El nombre del archivo de una versión concreta de un paquete se obtiene
-   como la concatenación del nombre del paquete seguido de un punto, el número 
-   _.autodoc.version.high, otro punto y el número _.autodoc.version.low
+
+=== Dependencias ===
+
+ * Cuando un paquete requiere de otros se debe incluir las correspondientes
+   sentencias #Require antes de la declaración del primer miembro.
  * Si no se especifica números de versión el #Require cargará la versión más 
    actual que corresponderá siempre al archivo con el nombre del paquete nada 
@@ -102 +129 @@
    caería en un ciclo infinito y no hay forma de detectarlo luego es 
    responsabilidad de los desarrollodares del repositorio el evitarlo.
+
+=== Documentación y chequeo de calidad ===
+
  * Cada paquete debe estar dotado de documentación autocontenida de manera 
    que cualquier usuario pueda aprender a usarlo por sí mismo. Queda por ver si 
@@ -110 +140 @@
    colgando directamente de la raíz del paquete.
 
+En [source:/tolp/OfficialTolArchiveNetwork] pueden verse ejemplos de paquetes. 
+Cada subdirectorio es un paquete.
+
 == Creación de repositorios ==
+
+En el archivo [source:/tolp/OfficialTolArchiveNetwork/_upload.tol]
+   puede verse como ejemplo el programa de creación y subida de 
+[http://packages.tol-project.org/OfficialTolArchiveNetwork/ 
+OfficialTolArchiveNetwork], el repositorio oficial de paquetes del equipo de 
+desarrollo de TOL.
 
  * El repositorio es un directorio plano con unos archivos obligatorios:
@@ -117 +156 @@
   * index.csv: Listado de los paquetes y su información asociada: fecha,
     versión, dependencias, etc.
- * En el archivo [source:/tolp/OfficialTolArchiveNetwork/_upload.tol]
-   puede verse como ejemplo el programa de creación y subida de [http://packages.tol-project.org/OfficialTolArchiveNetwork/ OfficialTolArchiveNetwork], el repositorio
-   oficial de paquetes del equipo de desarrollo de TOL.
  * Debe haber un comité o alguien responsable de probar todos los paquetes de
    un repositorio antes de publicar las actualizaciones de los paquetes para