Cumulus Wiki

UserReports: Difference between revisions

UserReports (view source)

Revision as of 14:39, 7 January 2022

224 bytes added ,  14:39, 7 January 2022
m
→‎How to use - Layout advise
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{|align=right
  |__TOC__
  |}
== Introduction ==
== Introduction ==
''CumulusUtils'' provides the module ''UserReports'' which is a bit similar to the processing feature of ''CumulusMX'' itself. This gives the possibility to create whatever report the user wishes from within the ecosystem of ''CumulusUtils''. When a text file containing [[webtags]] is offered to ''CumulusUtils'' it is processed and the resulting text file is stored on the website.
''CumulusUtils'' provides the module ''UserReports'' which is a bit similar to the processing feature of ''CumulusMX'' itself. This gives the possibility to create whatever report the user wishes from within the ecosystem of ''CumulusUtils''. When a text file containing [[webtags]] is offered to ''CumulusUtils'' it is processed and the resulting text file is stored on the website.
Line 18: Line 21:


== How to use - Layout advise ==
== How to use - Layout advise ==
A short instruction is given [https://cumulus.hosiene.co.uk/viewtopic.php?p=160007#p160007 on the forum]. Read that first, it may suffice!
UserReports are especially useful if you wish to make reports for the printer or to store certain moments on file. Just create your template text and insert the [[Webtags]] where you want the values to appear. Only the '''<#''' is reserved as indicator of the Webtags. As long as the file is plain text it will be handled correctly. Other file formats may be tried but are not guaranteed to be parsed / substituted correctly.
UserReports are especially useful if you wish to make reports for the printer or to store certain moments on file. Just create your template text and insert the [[Webtags]] where you want the values to appear. Only the '''<#''' is reserved as indicator of the Webtags. As long as the file is plain text it will be handled correctly. Other file formats may be tried but are not guaranteed to be parsed / substituted correctly.


Line 23: Line 28:


If you wish to create a page to be displayed in the ReportView (the right part of the website display where the charts are) you need to take into account the following:
If you wish to create a page to be displayed in the ReportView (the right part of the website display where the charts are) you need to take into account the following:
# The whole context of the website is 'As Is' and your HTML is inserted into the DIV that defines the right part, seven column (out of 12) Bootstrap block with a height of approximately 75vh (see the HTML units page).
* The whole context of the website is 'As Is' and your HTML is inserted into the DIV that defines the right part, seven column (out of 12) Bootstrap block with a height of approximately 75vh (see the [https://www.w3schools.com/cssref/css_units.asp HTML/CSS units] page).
# You could analyse the HTML context yourself by editing index.html in an appropriate editor which is able to make the file readable (e.g. Visual Studio Code). Note thios is HTML which is generated with colours and other information from you cumulusutils.ini file. You are not supposed to change this, changes will inevitably disappear again.
* You could analyse the HTML context yourself by editing index.html in an appropriate editor which is able to make the file readable (e.g. Visual Studio Code). Note thios is HTML which is generated with colours and other information from you cumulusutils.ini file. You are not supposed to change this, changes will inevitably disappear again.
# The basic structure of the index.html is as follows:
* The basic structure of the index.html is as follows:


     <nowiki><!DOCTYPE HTML>
     <nowiki><!DOCTYPE HTML>
Line 89: Line 94:
</nowiki>
</nowiki>
And your UserReport will  be inserted in the <nowiki><div id='CUReportView' class='scrollable CUReport'></div></nowiki> DIV. This means you have all libraries which are included at your disposal (especially Bootstrap, jQuery, Leaflet and HighCharts) if you wish to used them. Experiment freely.
And your UserReport will  be inserted in the <nowiki><div id='CUReportView' class='scrollable CUReport'></div></nowiki> DIV. This means you have all libraries which are included at your disposal (especially Bootstrap, jQuery, Leaflet and HighCharts) if you wish to used them. Experiment freely.
# The important thing here is that you can freely use CSS to give your HTML colouring and size attributes. If you wish to make your own CSS UserReport style you could put it into a file.
* The important thing here is that you can freely use CSS to give your HTML colouring and size attributes. If you wish to make your own CSS UserReport style you could put it into a file.
# Formatting the alignment of lists and values is best done with the TABLE html tag which also gives the possibility for more than one column.  
* Formatting the alignment of lists and values is best done with the TABLE html tag which also gives the possibility for more than one column.  
# Size of the font may increase/decrease information density
* Size of the font may increase/decrease information density
# You may use ''overflow'' to get a scrollbar on a table or div. Note that the usage of ''overflow'' may require some additional study.
* You may use ''overflow'' to get a scrollbar on a table or div. Note that the usage of ''overflow'' may require some additional study.
# If you wish to adhere to the CumulusUtils de facto standard of the thin line around the report (see e.g. Reports on your site) then the standard CSS used for the DIV containing the report is:
* If you wish to adhere to the CumulusUtils de facto standard of the thin line around the report (see e.g. Reports on your site) then the standard CSS used for the DIV containing the report is:
     <nowiki>#report{
     <nowiki>#report{
       font-family: arial;
       font-family: arial;
Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/10126...10134"