[LON-CAPA-cvs] cvs: loncom /interface lontest.pm /xml lonplot.pm lontex.pm lontexconvert.pm lonxml.pm

jms lon-capa-cvs-allow@mail.lon-capa.org
Mon, 24 Nov 2008 17:18:01 -0000


jms		Mon Nov 24 17:18:01 2008 EDT

  Modified files:              
    /loncom/xml	lontexconvert.pm lonxml.pm lonplot.pm lontex.pm 
    /loncom/interface	lontest.pm 
  Log:
  POD comments added/altered
  
Index: loncom/xml/lontexconvert.pm
diff -u loncom/xml/lontexconvert.pm:1.90 loncom/xml/lontexconvert.pm:1.91
--- loncom/xml/lontexconvert.pm:1.90	Tue Nov 18 10:02:56 2008
+++ loncom/xml/lontexconvert.pm	Mon Nov 24 17:17:51 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # TeX Conversion Module
 #
-# $Id: lontexconvert.pm,v 1.90 2008/11/18 10:02:56 hauer Exp $
+# $Id: lontexconvert.pm,v 1.91 2008/11/24 17:17:51 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -79,10 +79,7 @@
 
 $Apache::lontexconvert::messedup=0;
 
-# we need this routine because &converted can get called from inside
-# of the safespace (through &xmlparse('<m>stuff</m>') which doesn't
-# allow the opcode for alarm, so we need to compile this before we get
-# into the safe space since opcode checks only occur at compile time
+
 sub convert_real {
     my ($texstring)=@_;
     my ($xmlstring,$errorstring);
@@ -419,8 +416,78 @@
 __END__
 
 
+=pod
+
+=head1 NAME
+
+Apache::lontexconvert;
+
+=head1 SYNOPSIS
+
+Access to tth/ttm
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=head1 SUBROUTINES
+
+=over
+
+=item init_tth()
+
+Header
+
+=item convert_real()
+
+ we need this routine because &converted can get called from inside
+ of the safespace (through &xmlparse('<m>stuff</m>') which doesn't
+ allow the opcode for alarm, so we need to compile this before we get
+ into the safe space since opcode checks only occur at compile time
+
+=item tth_converted()
+
+
+=item clean_out_math_mode()
+
+
+=item displaystyle()
+
+
+=item jsMath_converted()
+
+
+=item tex_engine()
+
+
+=item init_math_support()
+
+
+=item mimetex_converted()
+
+
+=item converted()
+
+
+=item to_convert()
+
+message display
+
+=item smiley()
+
+???
+
+=item msgtexconverted()
+
+=item algebra()
+
+=item prepare_algebra()
+
+=item postprocess_algebra()
 
+=back
 
+=cut
 
 
 
Index: loncom/xml/lonxml.pm
diff -u loncom/xml/lonxml.pm:1.488 loncom/xml/lonxml.pm:1.489
--- loncom/xml/lonxml.pm:1.488	Mon Oct 27 19:15:35 2008
+++ loncom/xml/lonxml.pm	Mon Nov 24 17:17:52 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # XML Parser Module 
 #
-# $Id: lonxml.pm,v 1.488 2008/10/27 19:15:35 raeburn Exp $
+# $Id: lonxml.pm,v 1.489 2008/11/24 17:17:52 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -37,6 +37,25 @@
 # to any other parties under any circumstances.
 #
 
+=pod
+
+=head1 NAME
+
+Apache::lonxml
+
+=head1 SYNOPSIS
+
+XML Parsing Module
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=head1 SUBROUTINES
+
+=cut
+
+
 
 package Apache::lonxml; 
 use vars 
Index: loncom/xml/lonplot.pm
diff -u loncom/xml/lonplot.pm:1.148 loncom/xml/lonplot.pm:1.149
--- loncom/xml/lonplot.pm:1.148	Tue Sep  2 19:55:23 2008
+++ loncom/xml/lonplot.pm	Mon Nov 24 17:17:52 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Dynamic plot
 #
-# $Id: lonplot.pm,v 1.148 2008/09/02 19:55:23 raeburn Exp $
+# $Id: lonplot.pm,v 1.149 2008/11/24 17:17:52 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,6 +26,9 @@
 # http://www.lon-capa.org/
 #
 
+
+
+
 package Apache::lonplot;
 
 use strict;
@@ -57,6 +60,8 @@
 }
 
 
+=pod
+
 ## 
 ## Description of data structures:
 ##
@@ -88,6 +93,8 @@
 ##                                                               ##
 ###################################################################
 
+=cut
+
 my $max_str_len = 50;    # if a label, title, xlabel, or ylabel text
                          # is longer than this, it will be truncated.
 
@@ -2016,3 +2023,118 @@
 __END__
 
 
+=head1 NAME
+
+Apache::lonplot.pm
+
+=head1 SYNOPSIS
+
+XML-based plotter of graphs
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=head1 SUBROUTINES (parsing and edit rendering)
+
+=over
+
+=item start_gnuplot()
+
+=item end_gnuplot()
+
+=item start_xtics()
+
+=item end_xtics()
+
+=item start_ytics()
+
+=item end_ytics()
+
+=item get_font()
+
+=item start_key()
+
+=item end_key()
+
+=item parse_label()
+
+=item replace_entities()
+
+=item start_title()
+
+=item end_title()
+
+=item start_xlabel()
+
+=item end_xlabel()
+
+=item start_ylabel()
+
+=item end_label()
+
+=item start_curve()
+
+=item end_curve()
+
+=item start_function()
+
+=item end_function()
+
+=item start_data()
+
+=item end_data()
+
+=item start_axis()
+
+=item end_axis
+
+=back
+
+=head1 SUBROUTINES (Utility)
+
+=over
+
+=item set_defaults()
+
+=item get_attributes()
+
+=item write_gnuplot_file()
+
+=item check_inputs()
+
+=item edit_attributes()
+
+=back
+
+=head1 SUBROUTINES (Insertion functions for editing plots)
+
+=over
+
+=item insert_gnuplot()
+
+=item insert_tics()
+
+=item insert_xtics()
+
+=item insert_key()
+
+=item insert_axis()
+
+=item insert_title()
+
+=item insert_xlabel()
+
+=item insert_ylabel()
+
+=item insert_label()
+
+=item insert_curve()
+
+=item insert_function()
+
+=item insert_data()
+
+=back
+
+=cut
Index: loncom/xml/lontex.pm
diff -u loncom/xml/lontex.pm:1.12 loncom/xml/lontex.pm:1.13
--- loncom/xml/lontex.pm:1.12	Wed May 17 22:08:08 2006
+++ loncom/xml/lontex.pm	Mon Nov 24 17:17:52 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # TeX Content Handler
 #
-# $Id: lontex.pm,v 1.12 2006/05/17 22:08:08 albertel Exp $
+# $Id: lontex.pm,v 1.13 2008/11/24 17:17:52 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -113,6 +113,32 @@
 1;
 __END__
 
+=pod
+
+=head1 NAME
+
+Apache::lontex.pm
+
+=head1 SYNOPSIS
+
+Handler for tex files (somewhere in modules)
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=head1 SUBROUTINES
+
+=over
+
+=item footer()
+
+Main Handler
+
+=back
+
+=cut
+
 
 
 
Index: loncom/interface/lontest.pm
diff -u loncom/interface/lontest.pm:1.21 loncom/interface/lontest.pm:1.22
--- loncom/interface/lontest.pm:1.21	Thu Nov 20 15:19:39 2008
+++ loncom/interface/lontest.pm	Mon Nov 24 17:18:01 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # A debugging harness.
 #
-# $Id: lontest.pm,v 1.21 2008/11/20 15:19:39 jms Exp $
+# $Id: lontest.pm,v 1.22 2008/11/24 17:18:01 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -149,7 +149,7 @@
 1;
 __END__
 
-
+=pod
 
 =head1 NAME