[LON-CAPA-cvs] cvs: loncom /interface lonmeta.pm

[jms]

jms		Mon Nov 10 15:15:29 2008 EDT

  Modified files:              
    /loncom/interface	lonmeta.pm 
  Log:
  Added POD documentation
  
Index: loncom/interface/lonmeta.pm
diff -u loncom/interface/lonmeta.pm:1.212 loncom/interface/lonmeta.pm:1.213
--- loncom/interface/lonmeta.pm:1.212	Thu Mar  6 20:20:18 2008
+++ loncom/interface/lonmeta.pm	Mon Nov 10 15:15:29 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Metadata display handler
 #
-# $Id: lonmeta.pm,v 1.212 2008/03/06 20:20:18 www Exp $
+# $Id: lonmeta.pm,v 1.213 2008/11/10 15:15:29 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,6 +26,141 @@
 # http://www.lon-capa.org/
 
 
+=head1 NAME
+
+Apache::lonmeta - display meta data
+
+=head1 SYNOPSIS
+
+Handler to display meta data
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 HANDLER SUBROUTINE
+
+handler()
+
+=head1 OTHER SUBROUTINES
+
+=over
+
+=item *
+
+&get_dynamic_metadata_from_sql($url) :
+
+Queries sql database for dynamic metdata
+Returns a hash of hashes, with keys of urls which match $url
+Returned fields are given below.
+
+Examples:
+
+    %DynamicMetadata = &Apache::lonmeta::get_dynmaic_metadata_from_sql
+    ('/res/msu/korte/');
+
+    $DynamicMetadata{'/res/msu/korte/example.problem'}->{$field}
+
+=item *
+
+dynamicmeta() : Fetch and evaluate dynamic metadata
+
+=item *
+
+access_count()
+
+=item *
+
+alttag() : Try to make an alt tag if there is none
+
+=item *
+
+authordisplay() : Author display
+
+=item *
+
+evalgraph() : Pretty display
+
+=item *
+
+diffgraph()
+
+=item *
+
+fieldnames()
+
+=item *
+
+portfolio_linked_path()
+
+=item *
+
+get_port_path_and_group()
+
+=item *
+
+portfolio_display_uri()
+
+=item *
+
+pre_select_course()
+
+=item *
+
+select_course()
+
+=item *
+
+prettyprint() : Pretty printing of metadata field
+
+=item *
+
+direct() : Pretty input of metadata field
+
+=item *
+
+selectbox()
+
+=item *
+
+relatedfield()
+
+=item *
+
+prettyinput()
+
+=item *
+
+report_bombs()
+
+=item *
+
+present_uneditable_metadata()
+
+=item *
+
+present_editable_metadata()
+
+=item *
+
+store_metadata()
+
+=item *
+
+store_transferred_addedfields()
+
+=item *
+
+store_portfolio_metadata()
+
+=item *
+
+update_metadata_table()
+
+=back
+
+=cut
+
+
 package Apache::lonmeta;
 
 use strict;
@@ -42,24 +177,6 @@
 use LONCAPA qw(:DEFAULT :match);
 
 
-############################################################
-############################################################
-##
-## &get_dynamic_metadata_from_sql($url)
-## 
-## Queries sql database for dynamic metdata
-## Returns a hash of hashes, with keys of urls which match $url
-## Returned fields are given below.
-##
-## Examples:
-## 
-## %DynamicMetadata = &Apache::lonmeta::get_dynmaic_metadata_from_sql
-##     ('/res/msu/korte/');
-##
-## $DynamicMetadata{'/res/msu/korte/example.problem'}->{$field}
-##
-############################################################
-############################################################
 sub get_dynamic_metadata_from_sql {
     my ($url) = shift();
     my ($authordom,$author)=($url=~m{^/res/($match_domain)/($match_username)/});