# [LON-CAPA-cvs] cvs: rat / lonratedt.pm lonwrapper.pm

jms lon-capa-cvs-allow@mail.lon-capa.org
Thu, 20 Nov 2008 14:38:00 -0000

This is a MIME encoded message

--jms1227191880
Content-Type: text/plain

jms		Thu Nov 20 14:38:00 2008 EDT

Modified files:
/rat	lonratedt.pm lonwrapper.pm
Log:
Reformatted POD, moved to bottom of file

--jms1227191880
Content-Type: text/plain
Content-Disposition: attachment; filename="jms-20081120143800.txt"

Index: rat/lonratedt.pm
diff -u rat/lonratedt.pm:1.90 rat/lonratedt.pm:1.91
--- rat/lonratedt.pm:1.90	Mon Oct 13 11:54:54 2008
+++ rat/lonratedt.pm	Thu Nov 20 14:38:00 2008
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Edit Handler for RAT Maps
#
-# $Id: lonratedt.pm,v 1.90 2008/10/13 11:54:54 bisitz Exp$
+# $Id: lonratedt.pm,v 1.91 2008/11/20 14:38:00 jms Exp$
#
# Copyright Michigan State University Board of Trustees
#
@@ -29,141 +29,6 @@

package Apache::lonratedt;

-=pod
-
-
-Apache::lonratedt: simple resource assembly tool
-
-
-lonratedt provides the routines and the handler for the Advanced
-    Resource Assembly Tool (RAT), and ties the various pieces together
-    with Javascript.
-
-
-
-=begin latex
-
-%
-\begin{figure}
-\begin{center}\includegraphics[%
-  width=0.55\paperwidth,bb = 0 0 200 100, draft, type=eps]{Map_Example}\end{center}
-
-
-\end{figure}
-%
-\begin{figure}
-\begin{lyxcode}
-<map>
-
-~~<resource~id=\char\"{}1\char\"{}
-
-~~~~src=\char\"{}/res/msu/korte/phy231welcome.html\char\"{}
-
-~~~~type=\char\"{}start\char\"{}
-
-~~~~title=\char\"{}Start\char\"{}>
-
-~~~~</resource>
-
-~~<resource~id=\char\"{}2\char\"{}
-
-~~~~src=\char\"{}\char\"{}~type=\char\"{}finish\char\"{}
-
-~~~~title=\char\"{}Finish\char\"{}>
-
-~~~~</resource>
-
-~~<resource~id=\char\"{}6\char\"{}
-
-~~~~src=\char\"{}/res/msu/korte/tests/units.problem\char\"{}
-
-~~~~type=\char\"{}mandatory\char\"{}
-
-~~~~title=\char\"{}Physical~Units~Test\char\"{}>
-
-~~~~</resource>
-
-~~<resource~id=\char\"{}9\char\"{}
-
-~~~~src=\char\"{}/res/msu/korte/chapters/onedim.sequence\char\"{}
-
-~~~~title=\char\"{}Motion~in~One~Dimension\char\"{}>
-
-~~~~</resource>
-
-~~<resource~id=\char\"{}11\char\"{}
-
-~~~~src=\char\"{}/res/msu/bauer/bridges/units.sequence\char\"{}
-
-~~~~title=\char\"{}Physical~Units~Refresher\char\"{}>
-
-~~~~</resource>
-
-~~<condition~id=\char\"{}19\char\"{}
-
-~~~~type=\char\"{}stop\char\"{}
-
-~~~~value=\char\"{}user.assessments{[}this./res/msu/korte/tests/units.problem{]}.status=solved\char\"{}>
-
-~~~~</condition>
-
-~~<link~from=\char\"{}1\char\"{}~to=\char\"{}6\char\"{}></link>
-
-~~<link~from=\char\"{}6\char\"{}~to=\char\"{}9\char\"{}~condition=\char\"{}19\char\"{}></link>
-
-~~<link~from=\char\"{}6\char\"{}~to=\char\"{}11\char\"{}></link>
-
-~~<link~from=\char\"{}11\char\"{}~to=\char\"{}6\char\"{}></link>
-
-~~</map>
-\end{lyxcode}
-
-\caption{\label{XML}XML for Map in Figure \ref{Map_In_Advanced_Editor}}
-\end{figure}
-
-=end latex
-
-Fig. "XML for Map in Figure" shows the XML representation of the
-resource map shown in Fig. "Example of a Map in the Advanced Editor",
-which is the format in which maps are stored. In the figure, however,
-Resource Assembly Tool is not displayed. This graphical information is
-optional to re-generate the same graphical layout when the map is
-brought up again in the Resource Assembly Tool, and is not needed for
-any other system functionality.
-
-Maps can be generated by tools other than the Resource Assembly
-Tool. In particular, an author might have some other representation of
-a course sequence, which can be converted into a map using scripts. If
-this map then were to be brought up in the Resource Assembly Tool, the
-Tool would automatically generate a graphical layout for it. Each
-entry of the map (resources, conditions and links) is stored in a
-separate tag.
-
-Resources and conditionsX<conditions> have to have unique ID
-numbers. These numbers are automatically generated by the Resource
-Assembly Tool when the entry is first created, or added to the entries
-when a map generated outside the Resource Assembly Tool is first
-retrieved. They can also be assigned by custom scripts or added in by
-hand.
-
-In the XML example, entry 1 is the start resource of the map. When
-this map is accessed, the source (src) URL of this tag will be the
-first resource rendered. Entry 2 is the finish resource of this
-map. This resource will be the last resource in the sequence of
-resources. Entry 6 is a problem resource with the given URL and title,
-as well as the priority "mandatory". Entry 19 is a condition, which is
-used by the link between entries 6, the problem, and 9, a
-sequence. I<The final syntax for conditions has not yet been
-determined.>
-
-=cut
-
use strict;
use Apache::Constants qw(:common);
use Apache::lonnet;
@@ -907,7 +772,140 @@

+=pod
+
+
+Apache::lonratedt: simple resource assembly tool
+
+
+lonratedt provides the routines and the handler for the Advanced
+    Resource Assembly Tool (RAT), and ties the various pieces together
+    with Javascript.
+
+
+
+=begin latex
+
+%
+\begin{figure}
+\begin{center}\includegraphics[%
+  width=0.55\paperwidth,bb = 0 0 200 100, draft, type=eps]{Map_Example}\end{center}
+
+
+\end{figure}
+%
+\begin{figure}
+\begin{lyxcode}
+<map>
+
+~~<resource~id=\char\"{}1\char\"{}
+
+~~~~src=\char\"{}/res/msu/korte/phy231welcome.html\char\"{}
+
+~~~~type=\char\"{}start\char\"{}
+
+~~~~title=\char\"{}Start\char\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char\"{}2\char\"{}
+
+~~~~src=\char\"{}\char\"{}~type=\char\"{}finish\char\"{}
+
+~~~~title=\char\"{}Finish\char\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char\"{}6\char\"{}
+
+~~~~src=\char\"{}/res/msu/korte/tests/units.problem\char\"{}
+
+~~~~type=\char\"{}mandatory\char\"{}
+
+~~~~title=\char\"{}Physical~Units~Test\char\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char\"{}9\char\"{}
+
+~~~~src=\char\"{}/res/msu/korte/chapters/onedim.sequence\char\"{}
+
+~~~~title=\char\"{}Motion~in~One~Dimension\char\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char\"{}11\char\"{}
+
+~~~~src=\char\"{}/res/msu/bauer/bridges/units.sequence\char\"{}
+
+~~~~title=\char\"{}Physical~Units~Refresher\char\"{}>
+
+~~~~</resource>
+
+~~<condition~id=\char\"{}19\char\"{}
+
+~~~~type=\char\"{}stop\char\"{}
+
+~~~~value=\char\"{}user.assessments{[}this./res/msu/korte/tests/units.problem{]}.status=solved\char\"{}>
+
+~~~~</condition>
+
+~~<link~from=\char\"{}1\char\"{}~to=\char\"{}6\char\"{}></link>
+
+~~<link~from=\char\"{}6\char\"{}~to=\char\"{}9\char\"{}~condition=\char\"{}19\char\"{}></link>
+
+~~<link~from=\char\"{}6\char\"{}~to=\char\"{}11\char\"{}></link>

+~~<link~from=\char\"{}11\char\"{}~to=\char\"{}6\char\"{}></link>
+
+~~</map>
+\end{lyxcode}
+
+\caption{\label{XML}XML for Map in Figure \ref{Map_In_Advanced_Editor}}
+\end{figure}
+
+=end latex
+
+Fig. "XML for Map in Figure" shows the XML representation of the
+resource map shown in Fig. "Example of a Map in the Advanced Editor",
+which is the format in which maps are stored. In the figure, however,
+Resource Assembly Tool is not displayed. This graphical information is
+optional to re-generate the same graphical layout when the map is
+brought up again in the Resource Assembly Tool, and is not needed for
+any other system functionality.
+
+Maps can be generated by tools other than the Resource Assembly
+Tool. In particular, an author might have some other representation of
+a course sequence, which can be converted into a map using scripts. If
+this map then were to be brought up in the Resource Assembly Tool, the
+Tool would automatically generate a graphical layout for it. Each
+entry of the map (resources, conditions and links) is stored in a
+separate tag.
+
+Resources and conditionsX<conditions> have to have unique ID
+numbers. These numbers are automatically generated by the Resource
+Assembly Tool when the entry is first created, or added to the entries
+when a map generated outside the Resource Assembly Tool is first
+retrieved. They can also be assigned by custom scripts or added in by
+hand.
+
+In the XML example, entry 1 is the start resource of the map. When
+this map is accessed, the source (src) URL of this tag will be the
+first resource rendered. Entry 2 is the finish resource of this
+map. This resource will be the last resource in the sequence of
+resources. Entry 6 is a problem resource with the given URL and title,
+as well as the priority "mandatory". Entry 19 is a condition, which is
+used by the link between entries 6, the problem, and 9, a
+sequence. I<The final syntax for conditions has not yet been
+determined.>
+
+=cut

Index: rat/lonwrapper.pm
diff -u rat/lonwrapper.pm:1.29 rat/lonwrapper.pm:1.30
--- rat/lonwrapper.pm:1.29	Mon Nov 10 13:22:23 2008
+++ rat/lonwrapper.pm	Thu Nov 20 14:38:00 2008
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Wrapper for external and binary files as standalone resources
#
-# $Id: lonwrapper.pm,v 1.29 2008/11/10 13:22:23 jms Exp$
+# $Id: lonwrapper.pm,v 1.30 2008/11/20 14:38:00 jms Exp$
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,23 +26,6 @@
# http://www.lon-capa.org/
#

-=pod
-
-
-Apache::lonwrapper - External and binary file management.
-
-
-Wrapper for external and binary files as standalone resources. Edit handler for rat maps; TeX content handler.
-
-This is part of the LearningOnline Network with CAPA project
-described at http://www.lon-capa.org.
-
-
-=cut
-

package Apache::lonwrapper;

@@ -173,7 +156,32 @@
1;
__END__

+=pod

+
+Apache::lonwrapper - External and binary file management.
+
+
+Wrapper for external and binary files as standalone resources. Edit handler for rat maps; TeX content handler.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=over
+
+
+=item wrapper()
+
+=item handler()
+
+=back
+
+=cut

--jms1227191880--