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

[raeburn]

raeburn		Sun Dec 31 21:45:03 2023 EDT

  Modified files:              
    /rat	lonwrapper.pm 
  Log:
  - Update POD.
  
  
Index: rat/lonwrapper.pm
diff -u rat/lonwrapper.pm:1.85 rat/lonwrapper.pm:1.86
--- rat/lonwrapper.pm:1.85	Sat Nov 18 21:50:06 2023
+++ rat/lonwrapper.pm	Sun Dec 31 21:45:03 2023
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Wrapper for external and binary files as standalone resources
 #
-# $Id: lonwrapper.pm,v 1.85 2023/11/18 21:50:06 raeburn Exp $
+# $Id: lonwrapper.pm,v 1.86 2023/12/31 21:45:03 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -537,7 +537,9 @@
 
 =over
 
-=item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height,$reuse,$is_supp)
+=item wrapper()
+
+Args: $r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height,$reuse,$is_supp
 
 =over
 
@@ -642,6 +644,36 @@
 
 Returns markup for the entire page.
 
+=item create_link()
+
+Args: $url,$anchor,$title,$linktext
+
+=over
+
+=item $url
+
+URL to link to
+
+=item $anchor
+
+optional.  Will be the anchor to append to the URL, if there is one.
+
+=item $title
+
+optional. If provided will be the title displayed above the link. If
+one is not provided, then $env{'form.title'} will be used, unless empty.
+
+=item $linktext
+
+The text to inlcude between the <a href="$url"> and </a> tags.
+
+=back
+
+Returns HTML needed to show a link which can be followed to display the
+part of the original URL following the initial /adm/wrapper part 
+in the original request, in the case where an iframe is not going to be
+used to embed the content available at the URL in the existing page.
+
 =item handler()
 
 Content handler for requests for: /adm/wrapper/...