Difference between revisions of "API:EPrints/Box"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
−
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
+
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.
−
  -->{{Pod2Wiki}}{{API:Source|file=EPrints/Box.pm|package_name=EPrints::Box}}[[Category:API|Box]]<!-- End of Pod2Wiki -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/Box.pm|package_name=EPrints::Box}}[[Category:API|BOX]][[Category:API:EPrints/Box|BOX]]<div><!-- Edit below this comment -->
−
<!-- Pod2Wiki=head_name -->=NAME=
 
−
'''EPrints::Box''' - Class to render cute little Web 2.0ish boxes.
 
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
 
−
This just provides a function to render boxes in the EPrints style.
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
−
<!-- Pod2Wiki=item_render -->==render==
+
==NAME==
 +
'''EPrints::Box''' - Class to render cute little collapsable/expandable Web 2.0ish boxes.
  
−
  $box_xhtmldom = EPrints::Box::render( %options )
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
−
Render a cute box.
 
  
−
Options:
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_synopsis -->
 +
==SYNOPSIS==
 +
  use EPrints;
 +
 
 +
  # an XHTML DOM box with a title and some content that starts rolled up.
 +
  EPrints::Box(
 +
      handle =&gt; $handle,
 +
          id =&gt; "my_box",
 +
        title =&gt; $my_title_dom,
 +
      content =&gt; $my_content_dom,
 +
    collapsed =&gt; 1,
 +
  );
 +
 
  
−
<!-- End of Pod2Wiki -->
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
−
<!-- Pod2Wiki=item_session -->==session==
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
−
  session: Current $session (required)
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_box -->==box==
+
</div>
−
 
+
<!-- Pod2Wiki=head_description -->
−
  id: XML ID of box (required)
+
==DESCRIPTION==
−
 
+
This just provides a function to render boxes in the EPrints style.
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_title -->==title==
 
  
−
  title: XHTML DOM of title (required). Nb. Will not be cloned.
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_content -->==content==
 
  
−
  content: XHTML DOM of content (required). Nb. Will not be cloned.
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_render -->
 +
===$box_xhtmldom = EPrints::Box::render( %options )===
  
−
<!-- End of Pod2Wiki -->
+
Render a collapsable/expandable box to which content can be added. The box is in keeping with the eprints style
−
<!-- Pod2Wiki=item_collapsed_boolean_default_to_false -->==collapsed_boolean_default_to_false==
 
  
−
  collapsed: boolean. Default to false.
+
Required Options:
  
−
<!-- End of Pod2Wiki -->
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
−
<!-- Pod2Wiki=item_content_style_the_css_style_to_apply_to_the_content_box_for_example_overflow_y_auto_height_300px -->==content_style_the_css_style_to_apply_to_the_content_box_for_example_overflow_y_auto_height_300px==
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
−
  content-style: the css style to apply to the content box. For example; "overflow-y: auto; height: 300px;"
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_show_icon_url_and_hide_icon_url_the_icons_to_show_instead_of_the_default_and -->==show_icon_url_and_hide_icon_url_the_icons_to_show_instead_of_the_default_and==
+
</div>
 +
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
−
  show_icon_url and hide_icon_url: the icons to show instead of the default [+] and [-]
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
+
</div>
 +
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Revision as of 15:26, 16 December 2011

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

API: Core API

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.

User Comments


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,
 );

User Comments


DESCRIPTION

This just provides a function to render boxes in the EPrints style.

User Comments


$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:

User Comments


COPYRIGHT

User Comments


Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints/Box&oldid=10201’