[BACK]Return to lonhtmlcommon.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonhtmlcommon.pm between versions 1.358 and 1.365

version 1.358, 2014/12/20 15:35:40 version 1.365, 2015/05/28 12:20:16
Line 451  sub radio { Line 451  sub radio {
 &date_setter returns html and javascript for a compact date-setting form.  &date_setter returns html and javascript for a compact date-setting form.
 To retrieve values from it, use &get_date_from_form.  To retrieve values from it, use &get_date_from_form.
   
 Inputs  
   
 =over 4  =over 4
   
   =item Inputs
   
   =over
   
 =item $dname   =item $dname 
   
 The name to prepend to the form elements.    The name to prepend to the form elements.  
Line 482  the date/time fields are left empty. Line 484  the date/time fields are left empty.
 =item $state  =item $state
   
 Specifies the initial state of the form elements.  Either 'disabled' or empty.  Specifies the initial state of the form elements.  Either 'disabled' or empty.
 Defaults to empty, which indiciates the form elements are not disabled.   Defaults to empty, which indicates the form elements are not disabled.
   
   =item $no_hh_mm_ss
   
   If true, text boxes for hours, minutes and seconds are omitted.
   
   =item $defhour
   
   Default value for hours (a default of 0 is used otherwise).
   
   =item $defmin
   
   Default value for minutes (a default of 0 is used otherwise).
   
   =item defsec
   
   Default value for seconds (a default of 0 is used otherwise).
   
   =item $nolink
   
   If true, a "Select calendar" link (to pop-up a calendar) is not displayed
   to the right of the items.
   
   =item $no_mm_ss
   
   If true, text boxes for minutes and seconds are omitted.
   
   =item $no_ss
   
   If true, text boxes for seconds are omitted.
   
 =back  =back
   
 Bugs  =item Bugs
   
 The method used to restrict user input will fail in the year 2400.  The method used to restrict user input will fail in the year 2400.
   
   =back
   
 =cut  =cut
   
 ##############################################  ##############################################
 ##############################################  ##############################################
 sub date_setter {  sub date_setter {
     my ($formname,$dname,$currentvalue,$special,$includeempty,$state,      my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
         $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink) = @_;          $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink,$no_mm_ss,$no_ss) = @_;
     my $now = time;      my $now = time;
   
     my $tzname;      my $tzname;
Line 649  ENDJS Line 682  ENDJS
         $result .= &mt('[_1] [_2] [_3] ',          $result .= &mt('[_1] [_2] [_3] ',
                        $monthselector,$dayselector,$yearselector).                         $monthselector,$dayselector,$yearselector).
                    $tzone;                     $tzone;
         if (!$nolink) {      } elsif ($no_mm_ss) {
             $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');          $result .= &mt('[_1] [_2] [_3] [_4]',
         }                        $monthselector,$dayselector,$yearselector,
                         $hourselector).
                      $tzone;
   
       } elsif ($no_ss) {
           $result .= &mt('[_1] [_2] [_3] [_4] [_5]m',
                         $monthselector,$dayselector,$yearselector,
                         $hourselector,$minuteselector).
                      $tzone;
   
     } else {      } else {
         $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s ',          $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s ',
                       $monthselector,$dayselector,$yearselector,                        $monthselector,$dayselector,$yearselector,
                       $hourselector,$minuteselector,$secondselector).                        $hourselector,$minuteselector,$secondselector).
                    $tzone;                     $tzone;
         if (!$nolink) {      }
             $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');      if (!$nolink) {
         }          $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');
     }      }
     $result .= "</span>\n<!-- end $dname date setting form -->\n";      $result .= "</span>\n<!-- end $dname date setting form -->\n";
     return $result;      return $result;
Line 703  sub build_url { Line 745  sub build_url {
   
 get_date_from_form retrieves the date specified in an &date_setter form.  get_date_from_form retrieves the date specified in an &date_setter form.
   
 Inputs:  =over
   
   =item Inputs:
   
 =over 4  =over 4
   
Line 717  The unix time to use as the default in c Line 761  The unix time to use as the default in c
   
 =back  =back
   
   =back
   
 Returns: Unix time represented in the form.  Returns: Unix time represented in the form.
   
 =cut  =cut
Line 888  sub javascript_docopen { Line 934  sub javascript_docopen {
 Returns html for a selection box which allows the user to choose the  Returns html for a selection box which allows the user to choose the
 enrollment status of students.  The selection box name is 'Status'.  enrollment status of students.  The selection box name is 'Status'.
   
 Inputs:  =over
   
   =item Inputs:
   
 $status: the currently selected status.  If undefined the value of  $status: the currently selected status.  If undefined the value of
 $env{'form.Status'} is taken.  If that is undefined, a value of 'Active'  $env{'form.Status'} is taken.  If that is undefined, a value of 'Active'
Line 902  $size: the size (number of lines) of the Line 950  $size: the size (number of lines) of the
 $onchange: javascript to use when the value is changed.  Enclosed in   $onchange: javascript to use when the value is changed.  Enclosed in 
 double quotes, ""s, not single quotes.  double quotes, ""s, not single quotes.
   
   =back
   
 Returns: a perl string as described.  Returns: a perl string as described.
   
 =cut  =cut
Line 949  sub StatusOptions { Line 999  sub StatusOptions {
   
 =pod  =pod
   
 =item Progess Window Handling Routines  =item Progress Window Handling Routines
   
 These routines handle the creation, update, increment, and closure of   These routines handle the creation, update, increment, and closure of 
 progress windows.  The progress window reports to the user the number  progress windows.  The progress window reports to the user the number
Line 963  of items completed and an estimate of th Line 1013  of items completed and an estimate of th
 Writes javascript to the client to open a progress window and returns a  Writes javascript to the client to open a progress window and returns a
 data structure used for bookkeeping.  data structure used for bookkeeping.
   
 Inputs  =over
   
 =over 4  =item Inputs
   
   =over
   
 =item $r Apache request  =item $r Apache request
   
Line 973  Inputs Line 1025  Inputs
   
 =back  =back
   
 Returns a hash containing the progress state data structure.  =back
   
   Returns a hash containing the progress state data structure.
   
 =item &Update_PrgWin()  =item &Update_PrgWin()
   
 Updates the text in the progress indicator.  Does not increment the count.  Updates the text in the progress indicator.  Does not increment the count.
 See &Increment_PrgWin.  See &Increment_PrgWin.
   
 Inputs:  =over
   
   =item Inputs:
   
 =over 4  =over 4
   
Line 993  Inputs: Line 1048  Inputs:
   
 =back  =back
   
   =back
   
 Returns: none  Returns: none
   
   
 =item Increment_PrgWin()  =item &Increment_PrgWin()
   
 Increment the count of items completed for the progress window by $step or 1 if no step is provided.  Increment the count of items completed for the progress window by $step or 1 if no step is provided.
   
 Inputs:  =over
   
   =item Inputs:
   
 =over 4  =over 4
   
 =item $r Apache request  =item $r 
   
 =item $prog_state Pointer to the data structure returned by Create_PrgWin  Apache request
   
   =item $prog_state
   
   Pointer to the data structure returned by Create_PrgWin
   
   =item $extraInfo
   
   A description of the items being iterated over.  Typically 'student'.
   
   =item $step
   
 =item $extraInfo A description of the items being iterated over.  Typically  (optional) counter step. Will be set to default 1 if ommited. step must be greater than 0 or empty.
 'student'.  
   
 =item $step (optional) counter step. Will be set to default 1 if ommited. step must be greater than 0 or empty.  =back
   
 =back  =back
   
Line 1022  Returns: none Line 1090  Returns: none
   
 Closes the progress window.  Closes the progress window.
   
 Inputs:  =over
   
   =item Inputs:
   
 =over 4   =over 4 
   
Line 1032  Inputs: Line 1102  Inputs:
   
 =back  =back
   
   =back
   
 Returns: none  Returns: none
   
 =back  =back
Line 1306  sub htmlareaselectactive { Line 1378  sub htmlareaselectactive {
     }      }
           
     function startRichEditor(id) {      function startRichEditor(id) {
           // fix character entities inside <m>
           // NOTE: this is not fixing characters inside <parse>
           // NOTE: < and > inside <chem> should fix automatically because there should not be a letter after <.
           var ta = document.getElementById(id);
           var value = ta.value;
           var in_m = false; // in the m element
           var in_text = false; // in the text inside the m element
           var im = -1; // position of <m>
           var it = -1; // position of the text inside
           for (var i=0; i<value.length; i++) {
               if (value.substr(i, 2) == "<m") {
                   // ignore previous <m> if found twice
                   in_m = true;
                   in_text = false;
                   im = i;
                   it = -1;
               } else if (in_m) {
                   if (!in_text) {
                       if (value.charAt(i) == ">") {
                           in_text = true;
                           it = i+1;
                       }
                   } else if (value.substr(i, 4) == "</m>") {
                       in_m = false;
                       var text = value.substr(it, i-it);
                       var l1 = text.length;
                       text = text.replace(/</g, "&lt;");
                       text = text.replace(/>/g, "&gt;");
                       var l2 = text.length;
                       value = value.substr(0, it) + text + "</m>" + value.substr(i+4);
                       i = i + (l2-l1);
                   }
               }
           }
           ta.value = value;
     CKEDITOR.replace(id,       CKEDITOR.replace(id, 
     {      {
     customConfig: "/ckeditor/loncapaconfig.js",      customConfig: "/ckeditor/loncapaconfig.js",
Line 1317  sub htmlareaselectactive { Line 1424  sub htmlareaselectactive {
           
     function destroyRichEditor(id) {      function destroyRichEditor(id) {
     CKEDITOR.instances[id].destroy();      CKEDITOR.instances[id].destroy();
           // replace character entities &lt; and &gt; in <m> and <chem>
           // and "&amp;fctname(" by "&fctname("
           // and the quotes inside functions: "&fct(1, &quot;a&quot;)" -> "&fct(1, "a")"
           var ta = document.getElementById(id);
           var value = ta.value;
           var in_element = false; // in the m or chem element
           var tagname = ""; // m or chem
           var in_text = false; // in the text inside the element
           var im = -1; // position of start tag
           var it = -1; // position of the text inside
           for (var i=0; i<value.length; i++) {
               if (value.substr(i, 2) == "<m" || value.substr(i, 5) == "<chem") {
                   // ignore previous tags if found twice
                   in_element = true;
                   if (value.substr(i, 2) == "<m")
                       tagname = "m";
                   else
                       tagname = "chem";
                   in_text = false;
                   im = i;
                   it = -1;
               } else if (in_element) {
                   if (!in_text) {
                       if (value.charAt(i) == ">") {
                           in_text = true;
                           it = i+1;
                       }
                   } else if (value.substr(i, 3+tagname.length) == "</"+tagname+">") {
                       in_element = false;
                       var text = value.substr(it, i-it);
                       var l1 = text.length;
                       text = text.replace(/&lt;/g, "<");
                       text = text.replace(/&gt;/g, ">");
                       var l2 = text.length;
                       value = value.substr(0, it) + text + value.substr(i);
                       i = i + (l2-l1);
                   }
               }
           }
           // fix function names
           value = value.replace(/&amp;([a-zA-Z_]+)\(/g, "&$1(");
           // fix quotes in functions
           var pos_next_fct = value.search(/&[a-zA-Z_]+\(/);
           var depth = 0;
           for (var i=0; i<value.length; i++) {
               if (i == pos_next_fct) {
                   depth++;
                   var sub = value.substring(i+1);
                   var pos2 = sub.search(/&[a-zA-Z_]+\(/);
                   if (pos2 == -1)
                       pos_next_fct = -1;
                   else
                       pos_next_fct = i + 1 + pos2;
               } else if (depth > 0) {
                   if (value.charAt(i) == ")")
                       depth--;
                   else if (value.substr(i, 6) == "&quot;")
                       value = value.substr(0, i) + "\"" + value.substr(i+6);
               }
           }
           // replace the text value
           ta.value = value;
     }      }
           
     function editorHandler(event) {      function editorHandler(event) {
Line 1623  A link to help for the component will be Line 1792  A link to help for the component will be
   
 All inputs can be undef without problems.  All inputs can be undef without problems.
   
 Inputs: $component (the text on the right side of the breadcrumbs trail),  =over
         $component_help  
         $menulink (boolean, controls whether to include a link to /adm/menu)  =item Inputs:
         $helplink (if 'nohelp' don't include the orange help link)  
         $css_class (optional name for the class to apply to the table for CSS)  =over
         $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component  
            when including the text on the right.  =item $component
   
   the text on the right side of the breadcrumbs trail
   
   =item $component_help
   
   the help item filename (without .tex extension).
   
   =item $menulink
   
   boolean, controls whether to include a link to /adm/menu
   
   =item $helplink
   
   if 'nohelp' don't include the orange help link
   
   =item $css_class
   
   optional name for the class to apply to the table for CSS
   
   =item $no_mt 
   
   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
   
 Returns a string containing breadcrumbs for the current page.  Returns a string containing breadcrumbs for the current page.
   
 =item &clear_breadcrumbs()  =item &clear_breadcrumbs()
Line 1657  returns: nothing Line 1868  returns: nothing
           
     sub breadcrumbs {      sub breadcrumbs {
         my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt,           my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, 
             $CourseBreadcrumbs) = @_;              $CourseBreadcrumbs,$topic_help,$topic_help_text) = @_;
         #          #
         $css_class ||= 'LC_breadcrumbs';          $css_class ||= 'LC_breadcrumbs';
   
Line 1764  returns: nothing Line 1975  returns: nothing
                                                          $component_help,                                                           $component_help,
                                                          $faq,$bug);                                                           $faq,$bug);
         }          }
           if ($topic_help && $topic_help_text) {
              $icons .= ' '.&Apache::loncommon::help_open_topic($topic_help,&mt($topic_help_text),'',
                                                                undef,600);
           }
         #          #
   
   
Line 1776  returns: nothing Line 1991  returns: nothing
         }          }
   
   
         if ($component) {          if (($component) || ($topic_help && $topic_help_text)) {
             $links = &htmltag('span',               $links = &htmltag('span', 
                              ( $no_mt ? $component : mt($component) ).                               ( $no_mt ? $component : mt($component) ).
                              ( $icons ? $icons : '' ),                               ( $icons ? $icons : '' ),
Line 1831  Adds $html to $category of the breadcrum Line 2046  Adds $html to $category of the breadcrum
 $html is usually a link to a page that invokes a function on the currently   $html is usually a link to a page that invokes a function on the currently 
 displayed data (e.g. print when viewing a problem)  displayed data (e.g. print when viewing a problem)
   
 Currently there are 3 possible values for $category:   =over
   
   =item Currently there are 3 possible values for $category: 
   
 =over   =over 
   
Line 1845  remaining items in right of breadcrumbs Line 2062  remaining items in right of breadcrumbs
 advanced tools shown in a separate box below breadcrumbs line   advanced tools shown in a separate box below breadcrumbs line 
   
 =back  =back
    
   =back
   
 returns: nothing  returns: nothing
   
 =cut  =cut
Line 1884  returns: nothing Line 2103  returns: nothing
 Creates html for breadcrumb tools (categories navigation and tools) and inserts   Creates html for breadcrumb tools (categories navigation and tools) and inserts 
 \$breadcrumbs at the correct position.  \$breadcrumbs at the correct position.
   
 input: \$breadcrumbs - a reference to the string containing prepared   =over
 breadcrumbs.  
   =item input: 
   
   =over
   
   =item \$breadcrumbs - a reference to the string containing prepared breadcrumbs.
   
   =back
   
   =back
   
 returns: nothing  returns: nothing
   
Line 1911  returns: nothing Line 2139  returns: nothing
 Creates html for advanced tools (category advtools) and inserts \$breadcrumbs   Creates html for advanced tools (category advtools) and inserts \$breadcrumbs 
 at the correct position.  at the correct position.
   
 input: \$breadcrumbs - a reference to the string containing prepared   =over
 breadcrumbs (after render_tools call).  
   =item input:
   
   =over
   
   =item \$breadcrumbs - a reference to the string containing prepared breadcrumbs (after render_tools call).
   
   =back
   
   =back
   
 returns: nothing  returns: nothing
   
Line 3410  sub scripttag { Line 3647  sub scripttag {
   
 Constructs a XHTML list from \@array.  Constructs a XHTML list from \@array.
   
 input:   =over
   
   =item input: 
   
 =over  =over
   
Line 3424  Attributes for <ul> and <li> passed in a Line 3663  Attributes for <ul> and <li> passed in a
 See htmltag() for more details.  See htmltag() for more details.
   
 =back  =back
    
   =back
   
 returns: XHTML list as String.   returns: XHTML list as String. 
   
 =cut     =cut   
Line 3543  should be included in this list. Line 3784  should be included in this list.
   
 If the optional headline text is not provided, a default text will be used.  If the optional headline text is not provided, a default text will be used.
   
   =over
   
   =item Related routines:
   
 Related routines:  
 =over 4  =over 4
 add_item_funclist  
 end_funclist  =item add_item_funclist
   
   =item end_funclist
   
 =back  =back
   
   =back
   
 Inputs: (optional) headline text  Inputs: (optional) headline text
   
Line 3576  sub start_funclist { Line 3823  sub start_funclist {
   
 Adds an item to the list of available functions  Adds an item to the list of available functions
   
 Related routines:  =over
   
   =item Related routines:
   
 =over 4  =over 4
 start_funclist  
 end_funclist  =item start_funclist
   
   =item end_funclist
   
   =back
   
 =back  =back
   
 Inputs: content item with text and link to function  Inputs: content item with text and link to function
Line 3602  sub add_item_funclist { Line 3857  sub add_item_funclist {
   
 End list of available functions  End list of available functions
   
 Related routines:  =over
 =over 4  
 start_funclist  =item Related routines:
 add_item_funclist  
    start_funclist
    add_item_funclist
   
 =back  =back
   
 Inputs: ./.  Inputs: ./.
   
 Returns: HTML code with function list end  Returns: HTML code with function list end
   
 =cut  =cut
   
 sub end_funclist {  sub end_funclist {
Line 3637  A string that's used as visually highlig Line 3896  A string that's used as visually highlig
 it's value evaluates to false.  it's value evaluates to false.
   
 =back  =back
    
 returns: XHTML list as string.   returns: XHTML list as string. 
   
 =back  =back
Line 3650  sub funclist_from_array { Line 3909  sub funclist_from_array {
     $args->{legend} ||= mt('Functions');      $args->{legend} ||= mt('Functions');
     return list_from_array( [$args->{legend}, @$items],       return list_from_array( [$args->{legend}, @$items], 
                { listattr => {class => 'LC_funclist'} });                 { listattr => {class => 'LC_funclist'} });
 }     }
   
 =pod  =pod
   
   =over
   
 =item &actionbox( \@array )  =item &actionbox( \@array )
   
 Constructs a XHTML list from \@array with the first item being visually  Constructs a XHTML list from \@array with the first item being visually
Line 3670  e.g. a file operation in Authoring Space Line 3931  e.g. a file operation in Authoring Space
 A reference to the array containing text. Details: sub funclist_from_array  A reference to the array containing text. Details: sub funclist_from_array
   
 =back  =back
    
 Returns: XHTML div as string.   Returns: XHTML div as string. 
   
 =back  =back
Removed from v.1.358  
changed lines
  Added in v.1.365

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>