Changes between Version 5 and Version 6 of Packages

Timestamp:

Feb 8, 2016, 10:12:34 AM (9 years ago)

Author:

Pedro Gea

Comment:

--

Packages

@@ -19 +19 @@
 = Packages =
 
-{{{
-#!div style="background:#fcc; border: 1px solid red; color:red; padding-left:1em; margin-right:1em"
-To do. See [wiki:TolPackageRulesAndComments].
-}}}
-
 == Introduction ==
 
 The idea of a package comes from the concept of modularity and the possibility of loading and
-distributing a whole module as a unit. A TOL package is essentially no more than a NameBlock
+distributing a whole module as a unit. A TOL package is essentially a NameBlock
 distributed in an .oza file. 
 
-In the TOL programming frame, we identify the package with the NameBlock that contains
-the set of classes, structurs, variables, functions and definitions. This is distributed and loaded as
-an unit of the TOL package system.
+The package distribution is usually accompanied by other complementary resources that can be: files containing icons or images,
+documentation, libraries of compiled functions (written in C++ and distributed in .dll or .so files)
+and even uncompiled TOL code (.tol files) used as examples.
 
-Looking more from a distribution-focused point of view, a package is a compressed file
-(specifically a .zip file) that contains the nameblock serialisation (an .oza file). This is
-accompanied by other complementary resources that can be: files containing icons or images,
-documentation, libraries of compiled functions (written in C++ and distributed in .dll or .so files)
-and even uncompiled TOL code ( .tol files) by way of example.
+On a programming-focused point of view, the package is the mentioned NameBlock containing a set of classes, structures, variables, functions and definitions.
 
 == Names and versions ==
@@ -44 +35 @@
 A TOL package is identifed by its name and version.
 
-The name of the package matches with the name of the nameblock that represents it. It generally
+The '''name''' of the package matches with the name of the nameblock that represents it. It generally
 follows a CamelCase structure.
 
-The version consists of integers. The first (the high version number) shows if there has been an
-important change in the structure and functionality; one which could break the compatability
-with the user-code in use. The second however (the low version number) shows that changes
-have been made to the package that maintain package-use compatibility. These changes could
-be corrections or the inclusion of new functionalities.
+The '''version''' consists of integers. The first (the high version number) shows if there has been an
+important change in the structure and functionality. This new version could incorporate changes that break the compatibility
+with previous code in use. The second number (the low version number) however shows changes that maintain the package-use compatibility. These changes could be corrections or new functionalities.
 
 The package identifier is created by linking the name and two version numbers
-<name>.<version.high>.<version.low> with a full-stop (.).
+{{{<name>.<version.high>.<version.low>}}} with a full-stop ({{{.}}}).
 For example, the identifier {{{GuiTools.3.5}}} makes reference to version 3.5 of GuiTools, which
 includes utilities for TOLBase graphical integration.
 
+Some packages (usually those that contain binary libraries) show an additional name indicating the '''platform''' for which the package is compatible. This name appears after the name concatenated a number sign ({{{#}}}). For example, {{{TclCore#Win32GNU.8.407}}} is the {{{TclCore.8.407}}} package for TOL GNU-GCC compiled for Windows 32-bits.
+
+== Official TOL Archive Network ==
+
+The official repository of TOL packages is called '''OTAN''' ('''O'''fficial '''T'''OL '''A'''rchive '''N'''etwork). In this link: [wiki:OTAN] you can browse the full list of public packages.
+
+Other local or private repositories can also be available.
+
 == TolPackage ==
 
-The TOL kernel provides a module to manage packages: TolPackage.
-
+The TOL kernel provides a module to manage packages: TolPackage. 
 This module allow TOL users to download, update or upgrade packages. It provides also utilities for creating and uploading packages. For more details, see [wiki:TolPackage].
 
-== Requiring a package ==
+=== Requiring a package ===
 
 TOL provides a preevaluation directive: {{{#Require}}} to indicate the package requeriments.
@@ -73 +69 @@
 }}}
 
-When you ''compile'' a package requirement, TolPackage try to load the package, searching into the repositories, downloading it and intalling it if necessary.
-
-== Official TOL Archive Network ==
-
-The official repository of TOL packages is called '''OTAN''' ('''O'''fficial '''T'''OL '''A'''rchive '''N'''etwork). In this link: [wiki:OTAN] you can browse the full list of public packages.
+When you ''compile'' a package requirement, TolPackage try to load the package, searching into the repositories, downloading and installing it if necessary.
 
 == Package manager in TOLBase ==
@@ -89 +81 @@
 The interface offers a list of all available packages from all of the of the repositories to which they have access for installation, updates or upgrades.
 
-Different package states are displayed in the form of various different icons:
- * [[Image(source:tolp/trunk/tolbase/lib/toltk/images/p_no.gif)]]: New, not installed.
- * [[Image(source:tolp/trunk/tolbase/lib/toltk/images/p_upd.gif)]]: Update required; a more recent package of an identical version is available.
- * [[Image(source:tolp/trunk/tolbase/lib/toltk/images/p_upg.gif)]]: Upgrade required, a package with a superior version is available.
- * [[Image(source:tolp/trunk/tolbase/lib/toltk/images/p_unu.gif)]]: Upgrade and update required, both of these are required periodically.
- * [[Image(source:tolp/trunk/tolbase/lib/toltk/images/p_ok.gif)]]: Package okay, currently installed without requirement for update or upgrade.
+The package states are displayed with different icons:
+ * [[Image(source:tolp/trunk/tolbase/lib/toltk/images/p_no.gif)]] '''New:''' the package is not installed.
+ * [[Image(source:tolp/trunk/tolbase/lib/toltk/images/p_upd.gif)]] '''Update required:''' a more recent package of an identical version (an update) is available.
+ * [[Image(source:tolp/trunk/tolbase/lib/toltk/images/p_upg.gif)]] '''Upgrade required:''' a package with a superior version (an upgrade) is available.
+ * [[Image(source:tolp/trunk/tolbase/lib/toltk/images/p_unu.gif)]] '''Upgrade and update required:''' both an update and an upgrade are available for this package.
+ * [[Image(source:tolp/trunk/tolbase/lib/toltk/images/p_ok.gif)]] '''OK:''' the package is installed and does not need an update nor an upgrade.
 
 Various actions can be carried out on packages. These are offered in the contextual menu.