Responsive web Framework

DOCUMENTATION

General Organization

It has tried to maintain the most standardized files, directories and functionalities

NOT AVAILABLE FOR TINY SCREENS

(minimum width: 480px)

Directories and archives

It has been sought that each of the files are grouped according to their nature in directories that reflect the common purpose or characteristic between them. Thus, the javascript files are in a directory called js / , the equivalence dictionaries in lang / , information about modules or services in mod / and so on.

If the file is part of the system's own delivery, it will be at the root level. If you have any special functionality you will find it in a corresponding directory. And if it is a library or function outside the system or provided by a third party, but necessary for the correct operation of the system will be in a subdirectory called lib/.

Imagine the following structure:

  • js/
    • custom.js
    • lib/
      • jquery.min.js
      • modernizr.min.js
    • sup/
      • validate.min.js
    • tabslet/
      • jquery.tabslet.js
      • jquery.tabslet.min.js
      • tabslet.jquery.json
This is the javascript directory, where the script custom.js is used by that particular installation. sup / is validate.js that requires the system, as well as third-party jquery.min.js and modernizr scripts. Min.js in the lib / folder. There is also a jquery script called tabslet which is not basic for system operation but is used in this case and stored in an exprofesso directory with the same name.

Tables, Functions, Objects, and Examples

Due to the nature of data and programming languages, even though it has been sought to preserve standards as much as possible, it has not been achieved for that reason. It has been tried that certain archives or libraries contain the same functionality throughout the system, as far as the notation or capacities of the language allow.

Although they retain the same name as the files, objects and functions, notation can vary. Thus, a call to retrieve a value passed as a parameter changes from envGet("valor"); on Perl to $env->envGet("valor"); on Php, because the first one only emulates objects.

Due to the very nature of the information and its functionality, it has not been possible to include examples of all functionalities, which is why they are shown in a bare manner. It has not been intended to do extensive documentation or supported by external systems since the system being developed in open source, allows a valuation and modification of the code, facilitating its understanding for a programmer.

Equivalences and independency

Even with the same name and same purpose, not all libraries and their functionalities are available in each of the languages. The following is a list of libraries that are available in more than two languages:

Js
Perl
Php
crypt
SI
SI
debug
SI
SI
sup_db
SI
SI
sup_env
SI
SI
sup_user
SI
SI
validate
SI
SI

It has been tried that many of the functions and libraries can be executed independently, so that they can be applied to other systems. These are:

Css:
  • layout.css
  • typo.css
  • effects.css
Javascript:
  • validate.js
Perl:
  • crypt.pl
  • debug.pl
  • validate.pl
Php:
  • crypt.php
  • debug.php