# Blocks

## Introduction

The Blocks plugin allows the project manager to customize the appearance of the project pages.

A block is a piece of HTML that will be displayed (if active) on a predefined location. Predefined location includes: project description and a user blocks (right side) at summary page, and headers on top of each tool (trackers, forums, etc.).

In case the HTML project description block is activated, it overwrites the short project description provided in text mode (the short project description is still used in the project tree).

It is not possible to create a new block.

## Activating and modifying blocks

- The project administrator logs in and enters his project.

- He clicks on the 'Admin' link to enter the administration area.

- He clicks on the 'Blocks admin' link.

- He can then edit a block to change its content and also activate or deactivate a block.

- Once submitted, the block is changed.

To edit the block, the HTML editor or a simple text area (showing the HTML code) will be used, depending whether the HTML editor is activated or not.

You might include images in the block as well as text.

It is a good idea to first activate the blocks you want to include, and have a look at the corresponding page before modifying them. This allows you check their placement in the page.

## Macros

When you activate a block, a predefined content is provided. The content will use macros.

For example, you might have :

`{boxHeader}Enter your text here{boxFooter}`

We recommend that you use these macros. Use of the macros will guarantee a consistent look and feel.

You can create boxes like the ones on the right site of summary page, by inserting the following sentences in the content:

- `{boxTop Hello}`: will create the top part of the box using Hello as title.

- `{boxMiddle Here}`: will create a middle part of a box using Here as title (optional).

- `{boxBottom}`: will create the end part of a box.

- `{boxHeader}`: will create a header before a text.

- `{boxFooter}`: will create a footer after a text.

You can create as many boxes as you want, but a `boxTop` has to be closed by a `boxBottom` and a `boxHeader` has to be closed by a `boxFooter`.

## Examples

You can, for example, use the summary_right block to display your project logo.

You can use the summary_description block to provide a more complete description of your project and also links to major project resources.

HTML blocks for tools can be used to explain purpose and usage of the different tools (ex: trackers).