CumulusUtils: Difference between revisions

15 bytes added ,  20:41, 23 March 2021
m
Added headers Assumption and Output
m (Added headers Assumption and Output)
Line 1: Line 1:
== Goals and Assumptions ==
== Goals ==


The goal of ''CumulusUtils'' (abbr: Cutils) is to facilitate website creation for users of CumulusMX without exposure to coding in e.g. PHP or javascript. Having a meteo-website should not be privileged to users with great IT-skills. Making charts should not be demanding for programming skills in SQL or making it otherwise impossible to create charts without diving deep into the technique involved in CumulusMX (which actually is also the case with SQL).  
The goal of ''CumulusUtils'' (abbr: Cutils) is to facilitate website creation for users of CumulusMX without exposure to coding in e.g. PHP or javascript. Having a meteo-website should not be privileged to users with great IT-skills. Making charts should not be demanding for programming skills in SQL or making it otherwise impossible to create charts without diving deep into the technique involved in CumulusMX (which actually is also the case with SQL).  


== Assumptions ==
''CumulusUtils'' positions itself as a configurable application for which the understanding of how to run it and how to configure it is the most important thing to know. For configuration ''CumulusUtils'' uses ''cumulusutils.ini'' file which resides in the CumulusMX directory. All other files related to ''CumulusUtils'' are in the utils directory.
''CumulusUtils'' positions itself as a configurable application for which the understanding of how to run it and how to configure it is the most important thing to know. For configuration ''CumulusUtils'' uses ''cumulusutils.ini'' file which resides in the CumulusMX directory. All other files related to ''CumulusUtils'' are in the utils directory.


The user is assumed to have basic computer skills and knowledge about the Operating System and directory structure. The user must also be aware of the directory infrastructure of CumulusMX and needs to be aware  of the meaning of the terms ''webroot'' and ''FTProot'' and ''Working Directory''.
The user is assumed to have basic computer skills and knowledge about the Operating System and directory structure. The user must also be aware of the directory infrastructure of CumulusMX and needs to be aware  of the meaning of the terms ''webroot'' and ''FTProot'' and ''Working Directory''.


== Output ==
The output of ''CumulusUtils'' consists of mainly of text files (extension: .txt) which are generated on demand. In Cutils idiom ''modules''. These text files can be incorporated in a website the user has or is making. Ultimately when using the website generator feature,  ''CumulusUtils'' generates a complete website, uploaded to the user domain and extendable through a user defined  menu. When using the ''Charts Compiler'', the user can define his own charts and place the output where he wants just like other modules.
The output of ''CumulusUtils'' consists of mainly of text files (extension: .txt) which are generated on demand. In Cutils idiom ''modules''. These text files can be incorporated in a website the user has or is making. Ultimately when using the website generator feature,  ''CumulusUtils'' generates a complete website, uploaded to the user domain and extendable through a user defined  menu. When using the ''Charts Compiler'', the user can define his own charts and place the output where he wants just like other modules.