Documentation: skins/page.php

Class Page - Help to build final web pages

This is a library of function to be used from within skin templates.

This template implements following access keys at all pages:

hit 1 to jump to the front page of the site
hit 2 to skip the header and jump to the main area of the page
9 to go to the control panel
0 to go to the help page

This script is a reference file of this system.

Licence: GNU Lesser General Public License

Auteurs:

Bernard Paques bernard.paques@bigfoot.com

Testeurs:

Agnes

body() - Start page body

function body()

This function generates a <body> tag with id and class. The id is the skin variant, as found in $context['skin_variant']. The class is set to 'extra' if $context['extra'] is not empty.

bread_crumbs() - Show bread crumbs

function bread_crumbs($start_level=1, $with_slogan=FALSE)

$start_level=1 - int index of the first link to display from list
$with_slogan=FALSE - boolean TRUE to display the site slogan when at top level, FALSE otherwise
returns a string to be send to the browser

Show the content of $content['path_bar'] as a list of links.

The length of the list depends of the value of the first parameter:

0 - prefix the list with a link to the front page
1 - use the list as it is
2 - remove first level of the list
n - remove n-1 levels of the list

content() - Send the main content of the page

function content($with_page_menu=TRUE)

$with_page_menu=TRUE - boolean TRUE to display the page menu, FALSE otherwise

extra_panel() - Show the extra panel of the page

function extra_panel()

footer() - Echo the standard footer

function footer($prefix='')

$prefix='' - string footer prefix, if any

side() - Show the side panel of the page

function side($with_extra=FALSE)

$with_extra=FALSE - boolean TRUE to also include extra information, FALSE otherwise

tabs() - Show site tabs

function tabs($with_home=TRUE, $with_reverse=FALSE)

$with_home=TRUE - boolean TRUE to add a tab to the front page, FALSE otherwise
$with_reverse=FALSE - boolean TRUE to reverse order of tabs, FALSE otherwise
returns a string to be send to the browser

Tabs are derivated by top-level sections of the server.

top_focus() - Identify top level of focus

function top_focus($prefix='tab_')

$prefix='tab_' - string prefix that applies
returns string for example: 'tab_home', or 'tab_section_123', or NULL