Merge pull request #556 from drgrice1/pod-fixes

Fix POD generation errors.

doc/MathObjects/README.pod

@@ -184,3 +184,5 @@ sin 2x return sin(2x) rather than (sin(2))x.
 
 Shows how to switch contexts (in this case, to complex and to vector
 contexts), and how this affects the parsing.
+
+=back

lib/PGcore.pm

@@ -199,8 +199,7 @@ up the results of problem processing for delivery back to WeBWorK.
 The HEADER_TEXT(), TEXT(), and ANS() macros add to the header text string,
 body text string, and answer evaluator queue, respectively.
 
-=cut
-
+=over
 
 =item HEADER_TEXT()
 
@@ -598,6 +597,8 @@ sub encode_pg_and_html {
     return $input;
 }
 
+=back
+
 =head2   Message channels
 
 There are three message channels

lib/Value/AnswerChecker.pm

@@ -26,7 +26,7 @@ use PGcore;
 #
 $Value::defaultContext->{cmpDefaults} = {};
 
-=head5 $mathObject->cmp_defaults()
+=head4 $mathObject->cmp_defaults()
 
 #  Internal use.
 #  Set default flags for the answer checker in this object

lib/Value/Matrix.pm

@@ -20,7 +20,9 @@ L<http://webwork.maa.org/moodle/mod/forum/discuss.php?d=2978>
 
 Files interacting with Matrices:
 
-L<lib/MatrixReal1.pm> L<http://webwork.maa.org/pod/pg_TRUNK/macros/MatrixReduce.pl.html>
+L<lib/MatrixReal1.pm>
+
+L<macros/MatrixReduce.pl>
 
 L<lib/Matrix.pm> 
 

lib/WeBWorK/EquationCache.pm

@@ -72,6 +72,8 @@ sub new {
 Looks up a TeX string in the database. A unique identifier for the cached image
 is returned. If necessary, the string is added to the database.
 
+=back
+
 =cut
 
 sub lookup {

macros/AppletObjects.pl

@@ -22,7 +22,7 @@ =head1 DESCRIPTION
 The subroutines in this file provide mechanisms to insert Flash applets, Java applets, HTML 5
 Canvas applets, and Geogebra web applets into a WeBWorK problem.
 
-See also L<http://webwork.maa.org/pod/pg_TRUNK/lib/Applet.html>.
+See also L<Applet.pm>.
 
 =cut
 

macros/LinearProgramming.pl

@@ -246,6 +246,8 @@ sub lp_solve {
 	return($a_ref, $endcode, $piv_count);
 }
 
+=back
+
 =head2 lp_current_value
 
 Takes a simplex tableau and returns the value of a particular variable.

macros/MatrixReduce.pl

@@ -118,8 +118,6 @@ =head1 DESCRIPTION
 	COMMENT('MathObject version.');
 	ENDDOCUMENT();
 
-=back
-
 =head1 AUTHORS
 
 Paul Pearson, Hope College, Department of Mathematics

macros/PG.pl

@@ -1024,8 +1024,9 @@ =head1 USAGE
 be the last executable statement of every problem. It can only appear once. It
 returns a list consisting of:
 
+=back
 
-
+=over
 
 =item *
 

macros/PGessaymacros.pl

@@ -21,7 +21,7 @@ =head1 NAME
 
 PGessaymacros.pl - Macros for building answer evaluators.
 
-=head SYNPOSIS
+=head2 SYNPOSIS
 
 Answer Evaluators:
 

macros/PGmorematrixmacros.pl

@@ -567,7 +567,7 @@ sub vec_list_string{
 
 
 
-=head5 ans_array_filter
+=head4 ans_array_filter
 
 	(this filter is not necessary when using MathObjects.  It may someday be useful
 	again if the AnswerEvaluator pipeline is used to its fullest extent. )

macros/contextCongruence.pl

@@ -14,7 +14,7 @@
 # Artistic License for more details.
 ################################################################################
 
-
+=encoding UTF-8
 =head1 NAME
 
 

macros/extraAnswerEvaluators.pl

@@ -496,7 +496,7 @@ sub number_list_cmp {
 }
 
 
-=heads equation_cmp
+=head2 equation_cmp
 
 Compares an equation.  This really piggy-backs off of fun_cmp.  It looks
 at LHS-RHS of the equations to see if they agree up to constant multiple.

macros/source.pl

@@ -18,29 +18,25 @@ sub NoSourceButton {
 
 =head3   sourceButton
 
-########################
-# activating the source button
-########################
+activating the source button
 
-# In order for this button to work the course needs to have a link from 
+In order for this button to work the course needs to have a link from 
 
-#   myCourse/html/show-source.cgi   back to webwork2/htdocs/show-source.cgi
+	myCourse/html/show-source.cgi to webwork2/htdocs/show-source.cgi
 
-#   in the directory myCourse/html
-#   execute the following command (you will need command line access to the server to do this)
-#   ln -s /opt/webwork/webwork2/htdocs/show-source.cgi    show-source.cgi
-#    
-#   You need to make sure that the file webwork2/htdocs/show-source.cgi is executable by the 
-#   apache webserver.  
-#
-#   To accomplish this you need to uncomment this line in webwork.apache2-config
-#
-#   ScriptAliasMatch /webwork2_course_files/([^/]*)/show-source.cgi/(.*) /opt/webwork/courses/$1/html/show-source.cgi/$2
-#
-#
-#   The show-source.cgi script may also have to be customized to set $root to the webwork2 directory
+in the directory myCourse/html.  To create this link execute the following
+command (you will need command line access to the server to do this)
 
+	ln -s /opt/webwork/webwork2/htdocs/show-source.cgi    show-source.cgi
+ 
+You need to make sure that the file webwork2/htdocs/show-source.cgi is executable by the 
+apache webserver.  
 
+To accomplish this you need to uncomment this line in webwork.apache2-config
+
+	ScriptAliasMatch /webwork2_course_files/([^/]*)/show-source.cgi/(.*) /opt/webwork/courses/$1/html/show-source.cgi/$2
+
+The show-source.cgi script may also have to be customized to set C<$root> to the webwork2 directory
 
 =cut
 

macros/tableau.pl

@@ -26,8 +26,6 @@ =head2 TODO
 	row. 
 	(do we need a second objective function row? -- think we can skip this for now.)
 	
-=cut	
-
 =head2 DESCRIPTION
 
  # We're going to have several types
@@ -75,11 +73,9 @@ =head2 DESCRIPTION
 	FIXME: ?? allow c to be a 2 by n matrix so that you can do phase1 calculations easily 
 
 
-=cut
-
-
 =head2 Package main
 
+=over
 
 =item tableauEquivalence 
 
@@ -95,9 +91,6 @@ =head2 Package main
  # since the order of the equations is unimportant.  This applies to tableaus for 
  # Linear Optimization Problems being solved using the simplex method.
  
-=cut
-
-
 =item  get_tableau_variable_values
  	(DEPRECATED -- use Tableau->statevars method )
 	Parameters: ($MathObjectMatrix_tableau, $MathObjectSet_basis)
@@ -128,9 +121,7 @@ =head2 Package main
 Replaces commas with line breaks in the latex presentations of the answer checker.
 Used most often when $constraints is a LinearInequality math object.
 
-
-=cut 
-
+=back
 
 =head3 References:
 
@@ -140,11 +131,9 @@ =head3 References:
 
 More references: L<lib/Matrix.pm>
 
-=cut
-
 =head2 Package tableau
 
-=cut
+=over
 
 =item new
 
@@ -578,18 +567,19 @@ sub assemble_tableau {
 	                # is not in this part of the matrix
 }
 
+=back
+
 =head2 Accessors and mutators
 
+=over
+
 =item  basis_columns
 
 	ARRAY reference = $self->basis_columns()
 	[3,4]           = $self->basis_columns([3,4])
 	
 	Sets or returns the basis_columns as an ARRAY reference
 	
-=cut 
-
-
 =item  objective_row
 
 		$self->objective_row
@@ -1517,6 +1507,8 @@ sub submatrix {
 	
 	perhaps "assign" would be a better name for this?
 	
+=back
+
 =cut
 
 #  This was written by Davide Cervone.

macros/unionLists.pl

@@ -16,40 +16,37 @@
 
 =head2 unionLists.pl
 
- ######################################################################
- #
- #  Usage:  BeginList(type,options);
- #
- #  Produces <OL> and <UL> lists.  Type must be either "OL" or "UL",
- #  (and defaults to "OL").  The options are
- #
- #    type => "type"            Specifies the type of marker
- #                              (default is none specified)
- #
- #    value => num or string    Specified the initial value of the
- #                              item numbering
- #
- #    tex_par => 1 or 0         Set paragraph spacing in TeX mode
- #                              (default is 0)
- #
- #    noTopSkip => 1 or 0       Remove top skip produced by enumerate
- #                              in TeX mode
- #                              (default is 0)
- #
- #  Example:
- #
- #    BEGIN_TEXT
- #      \{BeginList("OL")\}
- #      $ITEM This is the first item
- #      $ITEM This is the second
- #      \{EndList("OL")\}
- #    END_TEXT
- #
- #
- #  Usage:  EndList(type)
- #
- #  where type is the list type (and must match the BeginList type).
- #
+  Usage:  BeginList(type,options);
+
+  Produces <OL> and <UL> lists.  Type must be either "OL" or "UL",
+  (and defaults to "OL").  The options are
+
+    type => "type"            Specifies the type of marker
+                              (default is none specified)
+
+    value => num or string    Specified the initial value of the
+                              item numbering
+
+    tex_par => 1 or 0         Set paragraph spacing in TeX mode
+                              (default is 0)
+
+    noTopSkip => 1 or 0       Remove top skip produced by enumerate
+                              in TeX mode
+                              (default is 0)
+
+  Example:
+
+    BEGIN_TEXT
+      \{BeginList("OL")\}
+      $ITEM This is the first item
+      $ITEM This is the second
+      \{EndList("OL")\}
+    END_TEXT
+
+
+  Usage:  EndList(type)
+
+  where type is the list type (and must match the BeginList type).
 
 =cut
 
@@ -73,16 +70,6 @@ sub BeginList {
   );
 }
 
-=pod
-
-#
-#  Usage:  EndList(type)
-#
-#  where type is the list type (and must match the BeginList type).
-#
-
-=cut
-
 sub EndList {
   my $LIST = shift; $LIST = 'OL' unless defined $LIST;
   my $enum = ($LIST eq 'OL' ? "enumerate" : "itemize");