6.2.2. resources

Last page update: September 22, 2015

A resources folder is thought to speed up your work, because it is used to keep all the stuff that you need to use over and over in a Genro project.

We’ll call resources all the files that you keep in a resources folder. In particular, your resources can be:

• javascript and CSS files: you probably know everything about javascript and css. What you don’t know is how they interact with Genro. For more information, check the CSS and the javascript pages
• components, or, more generally, other Python modules

You can define your resources as public resources or private resources:

• A public resource is a file that can be used in ANY project.
• A private resource is a file that can be used only in the project in which the resource has been defined.

6.2.2.1. public resource

Definition: a public resource is a file that can be used in ANY project.

Description: to make public a resource, you have to create your resources files into a resources folder that is set into this path:

projectName/packages/packageName/resources

where projectName is the name of your project, packages is the folder that contains the packages, packageName is the name of your package, resources is the folder where you have to put your resources files.

Example: If you have a project called my_project and a package called base, then you will have this tree for your public resources:

Now, if you would want to keep in your public resources some images, a CSS file and some other stuff, your project tree might be the following one:

Some notes:

• The images folder it is not mandatory, but we have created it to keep order in the project (we’ll put all the images there). With the same reason you could create a folder for your javascript files, one folder for your python modules and one folder for your CSS files.

• The tables folder is required to use some additional features, like:

  • adding some batches
  • adding some print features
  • usage of the TableHandler component

  For more information on this folder, check the tables section.

Usage: in order to use the public resources, you have to:

1. import the name of the package (that includes the resources you want to use) into the <packages> tag of your instanceconfig file.

   Warning

   don’t forget to import your own package, too!

   Example: if you need to add the agenda, the staff and the admin packages to your project, you have to add three tags into your <packages> tag:

   <?xml version='1.0' encoding='UTF-8'?>
   <GenRoBag>
       <packages>
           <admin />
           <agenda />
           <staff />
       </packages>
       <!-- Here lies other instanceconfig tags... -->
   </GenRoBag>
   

   Remember to import your own package, too (if you defined some public resources in it, obviously): for example, if your package is called base, your instanceconfig file will become:

   <?xml version='1.0' encoding='UTF-8'?>
    <GenRoBag>
        <packages>
            <base /> <!-- Hint: keep it as the first package imported, so you
                          can always rapidly check if you have imported your
                          own package or if you forgot it! -->
            <admin />
            <agenda />
            <staff />
        </packages>
        <!-- Here lies other instanceconfig tags... -->
    </GenRoBag>
   

2. call the resource you need in the webpage in which you will use it through a webpages variable:

   • py_requires for Genro components and other Python modules
   • js_requires for the javascript files
   • css_requires for the CSS files

   For more information (and examples) on webpages variables, check the webpage variables section.

6.2.2.2. private resource

Definition: a private resource is a file that can be used only in the project in which the resource has been defined.

Description: to make private a resource, you have to create your resources files into a resources folder that is set into the following path:

projectName/resources

where projectName is the name of your project and resources is the folder where you have to put your resources files (as well as one of the four main sub-folders of your project)

Example: If you have a project called my_project then you will have this tree for your private resources:

Now, if you would want to keep in your private resources some images, a CSS file and a javascript file, your project tree might be the following one:

Where my_project is the name of your project - the images folder it is not mandatory, but we have created it to keep order in the project (we’ll put all the images there). With the same reason you could create a folder for your javascript files, one folder for your python modules and one folder for your CSS files.

Note

if you read the example of the public resource section you will notice that we added a tables folder.

That folder MUST be created into your public resources.

Usage: in order to use the private resources, you have to:

1. call the resource you need in the webpage in which you will use it through a webpages variable:

   • py_requires for the Python files
   • js_requires for the javascript files
   • css_requires for the CSS files

   For more information, check the webpage variables section.

Footnotes:

[1]	For more information on how to use CSS in Genro, check the CSS page

[2]	For more information on Genro components, check the components page