Bureaucrats, emailconfirmed, Administrators
149
edits
Changes
Jump to navigation
Jump to search
Line 2:
Line 2: − + − + + + − − = [[File:art.png]] Create a new box = − Every standard box is stocked inside the directory '''htdocs/core/boxes'''. − + − Change its content to match the new name and define informations you want to show inside the box.+ + − + − + Line 35:
Line 35: − + + + +
Tried to clarify some terms
{{TemplateDocDevEn}}
{{TemplateDocDevEn}}
A box is a rectangular area that can be displayed on some pages (like the home page). These are described using files in a specific directory.
A box is a rectangular area that can be displayed on some pages (only the home page for moment). These are described by files in a specific directory.
Boxes content is left to the developer's imagination (graphics, text, tables, …).
Boxes content is left to the developer's imagination (graphics, text, tables, …) but a basic framework allows for easy table based presentation.
= [[File:art.png]] Create a new box =
Every standard box is stored inside the '''htdocs/core/boxes''' directory.
There is one file for each box.
There is one file for each box.
Each file is a class inherited from the '''ModeleBoxes''' class.
Each file is a class inherited from the '''ModeleBoxes''' class.
To create a new box, copy an existing box file and rename it, for example to '''box_myownbox.php'''.
To create a new box, you may copy an existing box file, rename it, for example to '''box_myownbox.php''' and change its content to match the new name.
You can now define the informations you want to show inside the box.
However if you plan distributing your box to other users, you should create a module instead and store your box files inside your module.
However if you plan distributing your box to other users, you must create a module and store your box files inside your module.
* Go to [[Module development]] page to learn how to create a module
* Go to [[Module development]] page to learn how to create a module
* Copy the box file to '''htdocs/mymodule/core/boxes/'''
* Create your box file into '''htdocs/mymodule/core/boxes/'''
* Once your module descriptor is created, add these lines to declare your box file
* Once your module descriptor is created, add these lines to declare your box file
<source lang="php">
<source lang="php">
= [[File:art.png]] Activate a box =
= [[File:art.png]] Activate a box =
To activate a box, go to '''Home - Setup - Boxes''' page and click activate on the box you want to see. It will be displayed on the page for which you have activated the box.
To activate a box, go to '''Home - Setup - Boxes''' page and click activate on the box you want to see.
It will be displayed on the page for which you have activated the box.