---
name: "Jifty::Plugin::Halo"
section: "3pm"
platform: "linux"
package: "libjifty-perl"
version: "1.10518+dfsg-2"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/Jifty::Plugin::Halo"
---

# Jifty::Plugin::Halo(3pm)

Provides halos

## NAME

Jifty::Plugin::Halo - Provides halos

## DESCRIPTION

This plugin provides \<http://seaside.st\|Seasidesque\> halos for your application. It's included by default when using Jifty with DevelMode turned on.

### init

Only enable halos in DevelMode. Add our instrumentation to Template::Declare.

### around\_template

This is called to instrument Template::Declare templates. We also draw a halo around the template itself.

### halo\_header frame -\> string

This will give you the halo header which includes links to the various information displays for this template.

### halo\_footer frame -\> string

This will give you the halo footer which includes the actual information to be displayed when the user pokes the halo.

### new\_frame -\> hashref

Gives you a new frame for storing halo information.

### push\_frame -\> frame

Creates and pushes a frame onto the render stack. Mason's halos do not support *arounding* a component, so we fake it with an explicit stack.

This also triggers `"halo_pre_template"` for plugins adding halo data.

### pop\_frame -\> frame

Pops a frame off the render stack. Mason's halos do not support `"arounding"` a component, so we fake it with an explicit stack.

This also triggers `"halo_post_template"` for plugins adding halo data.

### is\_proscribed FRAME

Returns true if the given `"FRAME"` should not have a halo around it.