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

[raeburn]

raeburn		Thu May 28 12:20:16 2015 EDT

  Modified files:              
    /loncom/interface	lonhtmlcommon.pm 
  Log:
  - Update perldoc for &breadcrumbs() routine.
  
  
Index: loncom/interface/lonhtmlcommon.pm
diff -u loncom/interface/lonhtmlcommon.pm:1.364 loncom/interface/lonhtmlcommon.pm:1.365
--- loncom/interface/lonhtmlcommon.pm:1.364	Thu May 28 02:53:29 2015
+++ loncom/interface/lonhtmlcommon.pm	Thu May 28 12:20:16 2015
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common html routines
 #
-# $Id: lonhtmlcommon.pm,v 1.364 2015/05/28 02:53:29 raeburn Exp $
+# $Id: lonhtmlcommon.pm,v 1.365 2015/05/28 12:20:16 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -1804,6 +1804,8 @@
 
 =item $component_help
 
+the help item filename (without .tex extension).
+
 =item $menulink
 
 boolean, controls whether to include a link to /adm/menu
@@ -1820,6 +1822,21 @@
 
 optional flag, 1 if &mt() is _not_ to be applied to $component when including the text on the right
 
+=item $CourseBreadcrumbs
+
+optional flag, 1 if &breadcrumbs called from &docs_breadcrumbs, because breadcrumbs are being
+used to display hierarchy for current folder shown in the Course Editor. 
+
+=item $topic_help
+
+optional help item to be displayed on right side of the breadcrumbs row, using 
+loncommon::help_open_topic() to generate the link. 
+
+=item $topic_help_text
+
+text to include in the link in the optional help item ($topic_help) on the right
+side of the breadcrumbs row.
+
 =back
 
 =back