Difference between revisions of "API:EPrints/Box"
Line 1: | Line 1: | ||
− | + | <!-- Pod2Wiki=_preamble_ | |
+ | This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost. | ||
+ | --> | ||
+ | __NOTOC__ | ||
+ | {{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Box.pm|package_name=EPrints::Box}}[[Category:API|Box]]<div><!-- Edit below this comment --> | ||
+ | |||
+ | |||
+ | <!-- Pod2Wiki=head_name --></div> | ||
+ | ==NAME== | ||
+ | '''EPrints::Box''' - Class to render cute little collapsable/expandable Web 2.0ish boxes. | ||
+ | |||
+ | <div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
+ | <h4><span style='display:none'>User Comments</span></h4> | ||
+ | <!-- Edit below this comment --> | ||
+ | |||
+ | |||
+ | <!-- Pod2Wiki=head_synopsis --></div> | ||
+ | ==SYNOPSIS== | ||
+ | use EPrints; | ||
+ | |||
+ | # an XHTML DOM box with a title and some content that starts rolled up. | ||
+ | EPrints::Box( | ||
+ | handle => $handle, | ||
+ | id => "my_box", | ||
+ | title => $my_title_dom, | ||
+ | content => $my_content_dom, | ||
+ | collapsed => 1, | ||
+ | ); | ||
+ | |||
+ | |||
+ | <div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
+ | <h4><span style='display:none'>User Comments</span></h4> | ||
+ | <!-- Edit below this comment --> | ||
+ | |||
+ | |||
+ | <!-- Pod2Wiki=head_description --></div> | ||
+ | ==DESCRIPTION== | ||
+ | This just provides a function to render boxes in the EPrints style. | ||
+ | |||
+ | <div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
+ | <h4><span style='display:none'>User Comments</span></h4> | ||
+ | <!-- Edit below this comment --> | ||
+ | |||
+ | |||
+ | <!-- Pod2Wiki=item_render --></div> | ||
+ | ===$box_xhtmldom = EPrints::Box::render( %options )=== | ||
+ | |||
+ | Render a collapsable/expandable box to which content can be added. The box is in keeping with the eprints style | ||
+ | |||
+ | Required Options: | ||
+ | |||
+ | <div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
+ | <h4><span style='display:none'>User Comments</span></h4> | ||
+ | <!-- Edit below this comment --> | ||
+ | |||
+ | |||
+ | <!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment --> |
Revision as of 13:08, 20 August 2009
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
NAME
EPrints::Box - Class to render cute little collapsable/expandable Web 2.0ish boxes.
SYNOPSIS
use EPrints; # an XHTML DOM box with a title and some content that starts rolled up. EPrints::Box( handle => $handle, id => "my_box", title => $my_title_dom, content => $my_content_dom, collapsed => 1, );
DESCRIPTION
This just provides a function to render boxes in the EPrints style.
$box_xhtmldom = EPrints::Box::render( %options )
Render a collapsable/expandable box to which content can be added. The box is in keeping with the eprints style
Required Options: