[Bio] / Sprout / Sprout.pm Repository:
ViewVC logotype

Diff of /Sprout/Sprout.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.108, Thu Feb 14 19:13:33 2008 UTC revision 1.115, Sun Sep 7 03:13:32 2008 UTC
# Line 14  Line 14 
14      use BasicLocation;      use BasicLocation;
15      use CustomAttributes;      use CustomAttributes;
16      use RemoteCustomAttributes;      use RemoteCustomAttributes;
17        use CGI;
18        use WikiTools;
19      use base qw(ERDB);      use base qw(ERDB);
20    
21  =head1 Sprout Database Manipulation Object  =head1 Sprout Database Manipulation Object
# Line 146  Line 148 
148          my $user = ($FIG_Config::arch eq 'win' ? 'self' : scalar(getpwent()));          my $user = ($FIG_Config::arch eq 'win' ? 'self' : scalar(getpwent()));
149          $retVal->{_ca} = CustomAttributes->new(user => $user);          $retVal->{_ca} = CustomAttributes->new(user => $user);
150      }      }
151        # Insure we have access to the stem module.
152        WikiUse('Lingua::Stem');
153        $retVal->{stemmer} = Lingua::Stem->new();
154        $retVal->{stemmer}->stem_caching({ -level => 2 });
155      # Return it.      # Return it.
156      return $retVal;      return $retVal;
157  }  }
# Line 465  Line 471 
471      return $retVal;      return $retVal;
472  }  }
473    
474  =head3 GeneMenu  =head3 GenomeMenu
475    
476      my $selectHtml = $sprout->GeneMenu(\%attributes, $filterString, \@params, $selected);      my $html = $sprout->GenomeMenu(%options);
477    
478  Return an HTML select menu of genomes. Each genome will be an option in the menu,  Generate a genome selection control with the specified name and options.
479  and will be displayed by name with the ID and a contig count attached. The selection  This control is almost but not quite the same as the genome control in the
480  value will be the genome ID. The genomes will be sorted by genus/species name.  B<SearchHelper> class. Eventually, the two will be combined.
481    
482  =over 4  =over 4
483    
484  =item attributes  =item options
485    
486    Optional parameters for the control (see below).
487    
488    =item RETURN
489    
490  Reference to a hash mapping attributes to values for the SELECT tag generated.  Returns the HTML for a genome selection control on a form (sometimes called a popup menu).
491    
492  =item filterString  =back
493    
494    The valid options are as follows.
495    
496  A filter string for use in selecting the genomes. The filter string must conform  =over 4
 to the rules for the C<< ERDB->Get >> method.  
497    
498  =item params  =item name
499    
500  Reference to a list of values to be substituted in for the parameter marks in  Name to give this control for use in passing it to the form. The default is C<myGenomeControl>.
501  the filter string.  Terrible things will happen if you have two controls with the same name on the same page.
502    
503  =item selected (optional)  =item filter
504    
505  ID of the genome to be initially selected.  If specified, a filter for the list of genomes to display. The filter should be in the form of a
506    list reference. The first element of the list should be the filter string, and the remaining elements
507    the filter parameters.
508    
509  =item fast (optional)  =item multiSelect
510    
511  If specified and TRUE, the contig counts will be omitted to improve performance.  If TRUE, then the user can select multiple genomes. If FALSE, the user can only select one genome.
512    
513  =item RETURN  =item size
514    
515  Returns an HTML select menu with the specified genomes as selectable options.  Number of rows to display in the control. The default is C<10>
516    
517    =item id
518    
519    ID to give this control. The default is the value of the C<name> option. Nothing will work correctly
520    unless this ID is unique.
521    
522    =item selected
523    
524    A comma-delimited list of selected genomes, or a reference to a list of selected genomes. The
525    default is none.
526    
527    =item class
528    
529    If specified, a style class to assign to the genome control.
530    
531  =back  =back
532    
533  =cut  =cut
534    
535  sub GeneMenu {  sub GenomeMenu {
536      # Get the parameters.      # Get the parameters.
537      my ($self, $attributes, $filterString, $params, $selected, $fast) = @_;      my ($self, %options) = @_;
538      my $slowMode = ! $fast;      # Get the control's name and ID.
539      # Default to nothing selected. This prevents an execution warning if "$selected"      my $menuName = $options{name} || $options{id} || 'myGenomeControl';
540      # is undefined.      my $menuID = $options{id} || $menuName;
541      $selected = "" unless defined $selected;      Trace("Genome menu name = $menuName with ID $menuID.") if T(3);
542      Trace("Gene Menu called with slow mode \"$slowMode\" and selection \"$selected\".") if T(3);      # Compute the IDs for the status display.
543      # Start the menu.      my $divID = "${menuID}_status";
544      my $retVal = "<select " .      my $urlID = "${menuID}_url";
545          join(" ", map { "$_=\"$attributes->{$_}\"" } keys %{$attributes}) .      # Compute the code to show selected genomes in the status area.
546          ">\n";      my $showSelect = "showSelected('$menuID', '$divID', '$urlID', 1000)";
547      # Get the genomes.      # Check for single-select or multi-select.
548      my @genomes = $self->GetAll(['Genome'], $filterString, $params, ['Genome(id)',      my $multiSelect = $options{multiSelect} || 0;
549                                                                       'Genome(genus)',      # Get the style data.
550                                                                       'Genome(species)',      my $class = $options{class} || '';
551                                                                       'Genome(unique-characterization)']);      # Get the list of pre-selected items.
552      # Sort them by name.      my $selections = $options{selected} || [];
553      my @sorted = sort { lc("$a->[1] $a->[2]") cmp lc("$b->[1] $b->[2]") } @genomes;      if (ref $selections ne 'ARRAY') {
554      # Loop through the genomes, creating the option tags.          $selections = [ split /\s*,\s*/, $selections ];
555      for my $genomeData (@sorted) {      }
556          # Get the data for this genome.      my %selected = map { $_ => 1 } @{$selections};
557          my ($genomeID, $genus, $species, $strain) = @{$genomeData};      # Extract the filter information. The default is no filtering. It can be passed as a tab-delimited
558          # Get the contig count.      # string or a list reference.
559          my $contigInfo = "";      my $filterParms = $options{filter} || "";
560          if ($slowMode) {      if (! ref $filterParms) {
561              my $count = $self->ContigCount($genomeID);          $filterParms = [split /\t|\\t/, $filterParms];
562              my $counting = ($count == 1 ? "contig" : "contigs");      }
563              $contigInfo = "[$count $counting]";      my $filterString = shift @{$filterParms};
564          }      # Get a list of all the genomes in group order. In fact, we only need them ordered
565          # Find out if we're selected.      # by name (genus,species,strain), but putting primary-group in front enables us to
566          my $selectOption = ($selected eq $genomeID ? " selected" : "");      # take advantage of an existing index.
567          # Build the option tag.      my @genomeList = $self->GetAll(['Genome'], "$filterString ORDER BY Genome(primary-group), Genome(genus), Genome(species), Genome(unique-characterization)",
568          $retVal .= "<option value=\"$genomeID\"$selectOption>$genus $species $strain ($genomeID)$contigInfo</option>\n";                                     $filterParms,
569                                       [qw(Genome(primary-group) Genome(id) Genome(genus) Genome(species) Genome(unique-characterization) Genome(taxonomy) Genome(contigs))]);
570        # Create a hash to organize the genomes by group. Each group will contain a list of
571        # 2-tuples, the first element being the genome ID and the second being the genome
572        # name.
573        my %gHash = ();
574        for my $genome (@genomeList) {
575            # Get the genome data.
576            my ($group, $genomeID, $genus, $species, $strain, $taxonomy, $contigs) = @{$genome};
577            # Compute its name. This is the genus, species, strain (if any), and the contig count.
578            my $name = "$genus $species ";
579            $name .= "$strain " if $strain;
580            my $contigCount = ($contigs == 1 ? "" : ", $contigs contigs");
581            # Now we get the domain. The domain tells us the display style of the organism.
582            my ($domain) = split /\s*;\s*/, $taxonomy, 2;
583            # Now compute the display group. This is normally the primary group, but if the
584            # organism is supporting, we blank it out.
585            my $displayGroup = ($group eq $FIG_Config::otherGroup ? "" : $group);
586            # Push the genome into the group's list. Note that we use the real group
587            # name for the hash key here, not the display group name.
588            push @{$gHash{$group}}, [$genomeID, $name, $contigCount, $domain];
589        }
590        # We are almost ready to unroll the menu out of the group hash. The final step is to separate
591        # the supporting genomes by domain. First, we extract the NMPDR groups and sort them. They
592        # are sorted by the first capitalized word. Groups with "other" are sorted after groups
593        # that aren't "other". At some point, we will want to make this less complicated.
594        my %sortGroups = map { $_ =~ /(other)?(.*)([A-Z].+)/; "$3$1$2" => $_ }
595                             grep { $_ ne $FIG_Config::otherGroup } keys %gHash;
596        my @groups = map { $sortGroups{$_} } sort keys %sortGroups;
597        # Remember the number of NMPDR groups.
598        my $nmpdrGroupCount = scalar @groups;
599        # Loop through the supporting genomes, classifying them by domain. We'll also keep a list
600        # of the domains found.
601        my @otherGenomes = @{$gHash{$FIG_Config::otherGroup}};
602        my @domains = ();
603        for my $genomeData (@otherGenomes) {
604            my ($genomeID, $name, $contigCount, $domain) = @{$genomeData};
605            if (exists $gHash{$domain}) {
606                push @{$gHash{$domain}}, $genomeData;
607            } else {
608                $gHash{$domain} = [$genomeData];
609                push @domains, $domain;
610            }
611        }
612        # Add the domain groups at the end of the main group list. The main group list will now
613        # contain all the categories we need to display the genomes.
614        push @groups, sort @domains;
615        # Delete the supporting group.
616        delete $gHash{$FIG_Config::otherGroup};
617        # Now it gets complicated. We need a way to mark all the NMPDR genomes. We take advantage
618        # of the fact they come first in the list. We'll accumulate a count of the NMPDR genomes
619        # and use that to make the selections.
620        my $nmpdrCount = 0;
621        # Create the type counters.
622        my $groupCount = 1;
623        # Get the number of rows to display.
624        my $rows = $options{size} || 10;
625        # If we're multi-row, create an onChange event.
626        my $onChangeTag = ( $rows > 1 ? " onChange=\"$showSelect;\" onFocus=\"$showSelect;\"" : "" );
627        # Set up the multiple-select flag.
628        my $multipleTag = ($multiSelect ? " multiple" : "" );
629        # Set up the style class.
630        my $classTag = ($class ? " class=\"$class\"" : "" );
631        # Create the SELECT tag and stuff it into the output array.
632        my @lines = ("<SELECT name=\"$menuName\" id=\"$menuID\" $onChangeTag$multipleTag$classTag size=\"$rows\">");
633        # Loop through the groups.
634        for my $group (@groups) {
635            # Get the genomes in the group.
636            for my $genome (@{$gHash{$group}}) {
637                # If this is an NMPDR organism, we add an extra style and count it.
638                my $nmpdrStyle = "";
639                if ($nmpdrGroupCount > 0) {
640                    $nmpdrCount++;
641                    $nmpdrStyle = " Core";
642                }
643                # Get the organism ID, name, contig count, and domain.
644                my ($genomeID, $name, $contigCount, $domain) = @{$genome};
645                # See if we're pre-selected.
646                my $selectTag = ($selected{$genomeID} ? " SELECTED" : "");
647                # Compute the display name.
648                my $nameString = "$name ($genomeID$contigCount)";
649                # Generate the option tag.
650                my $optionTag = "<OPTION class=\"$domain$nmpdrStyle\" title=\"$group\" value=\"$genomeID\"$selectTag>$nameString</OPTION>";
651                push @lines, "    $optionTag";
652            }
653            # Record this group in the nmpdrGroup count. When that gets to 0, we've finished the NMPDR
654            # groups.
655            $nmpdrGroupCount--;
656      }      }
657      # Close the SELECT tag.      # Close the SELECT tag.
658      $retVal .= "</select>\n";      push @lines, "</SELECT>";
659        if ($rows > 1) {
660            # We're in a non-compact mode, so we need to add some selection helpers. First is
661            # the search box. This allows the user to type text and change which genomes are
662            # displayed. For multiple-select mode, we include a button that selects the displayed
663            # genes. For single-select mode, we use a plain label instead.
664            my $searchThingName = "${menuID}_SearchThing";
665            my $searchThingLabel = ($multiSelect ? "<INPUT type=\"button\" name=\"MacroSearch\" class=\"button\" value=\"Select genomes containing\" onClick=\"selectShowing('$menuID', '$searchThingName'); $showSelect;\" />"
666                                                 : "Show genomes containing");
667            push @lines, "<br />$searchThingLabel&nbsp;" .
668                         "<INPUT type=\"text\" id=\"$searchThingName\" name=\"$searchThingName\" size=\"30\" onKeyup=\"showTyped('$menuID', '$searchThingName');\" />" .
669                         Hint("GenomeControl", "Type here to filter the genomes displayed.") . "<br />";
670            # For multi-select mode, we also have buttons to set and clear selections.
671            if ($multiSelect) {
672                push @lines, "<INPUT type=\"button\" name=\"ClearAll\" class=\"bigButton\"  value=\"Clear All\" onClick=\"clearAll('$menuID'); $showSelect\" />";
673                push @lines, "<INPUT type=\"button\" name=\"SelectAll\" class=\"bigButton\" value=\"Select All\" onClick=\"selectAll('$menuID'); $showSelect\" />";
674                push @lines, "<INPUT type=\"button\" name=\"NMPDROnly\" class=\"bigButton\"  value=\"Select NMPDR\" onClick=\"selectSome('$menuID', $nmpdrCount, true); $showSelect;\" />";
675            }
676            # Add a hidden field we can use to generate organism page hyperlinks.
677            push @lines, "<INPUT type=\"hidden\" id=\"$urlID\" value=\"$FIG_Config::cgi_url/wiki/rest.cgi/NmpdrPlugin/SeedViewer?page=Organism;organism=\" />";
678            # Add the status display. This tells the user what's selected no matter where the list is scrolled.
679            push @lines, "<DIV id=\"$divID\" class=\"Panel\"></DIV>";
680        }
681        # Assemble all the lines into a string.
682        my $retVal = join("\n", @lines, "");
683        # Return the result.
684        return $retVal;
685    }
686    
687    
688    =head3 Stem
689    
690        my $stem = $sprout->Stem($word);
691    
692    Return the stem of the specified word, or C<undef> if the word is not
693    stemmable. Note that even if the word is stemmable, the stem may be
694    the same as the original word.
695    
696    =over 4
697    
698    =item word
699    
700    Word to convert into a stem.
701    
702    =item RETURN
703    
704    Returns a stem of the word (which may be the word itself), or C<undef> if
705    the word is not stemmable.
706    
707    =back
708    
709    =cut
710    
711    sub Stem {
712        # Get the parameters.
713        my ($self, $word) = @_;
714        # Declare the return variable.
715        my $retVal;
716        # See if it's stemmable.
717        if ($word =~ /^[A-Za-z]+$/) {
718            # Compute the stem.
719            my $stemList = $self->{stemmer}->stem($word);
720            my $stem = $stemList->[0];
721            # Check to see if it's long enough.
722            if (length $stem >= 3) {
723                # Yes, keep it.
724                $retVal = $stem;
725            } else {
726                # No, use the original word.
727                $retVal = $word;
728            }
729        }
730      # Return the result.      # Return the result.
731      return $retVal;      return $retVal;
732  }  }
733    
734    
735  =head3 Build  =head3 Build
736    
737      $sprout->Build();      $sprout->Build();
# Line 683  Line 869 
869  =item RETURN  =item RETURN
870    
871  Returns a list of the feature's contig segments. The locations are returned as a list in a list  Returns a list of the feature's contig segments. The locations are returned as a list in a list
872  context and as a comma-delimited string in a scalar context.  context and as a comma-delimited string in a scalar context. An empty list means the feature
873    wasn't found.
874    
875  =back  =back
876    
# Line 692  Line 879 
879  sub FeatureLocation {  sub FeatureLocation {
880      # Get the parameters.      # Get the parameters.
881      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
882        # Declare the return variable.
883        my @retVal = ();
884      # Get the feature record.      # Get the feature record.
885      my $object = $self->GetEntity('Feature', $featureID);      my $object = $self->GetEntity('Feature', $featureID);
886      Confess("Feature $featureID not found.") if ! defined($object);      # Only proceed if we found it.
887        if (defined $object) {
888      # Get the location string.      # Get the location string.
889      my $locString = $object->PrimaryValue('Feature(location-string)');      my $locString = $object->PrimaryValue('Feature(location-string)');
890      # Create the return list.      # Create the return list.
891      my @retVal = split /\s*,\s*/, $locString;          @retVal = split /\s*,\s*/, $locString;
892        }
893      # Return the list in the format indicated by the context.      # Return the list in the format indicated by the context.
894      return (wantarray ? @retVal : join(',', @retVal));      return (wantarray ? @retVal : join(',', @retVal));
895  }  }
# Line 1773  Line 1964 
1964      if ($featureID =~ /^fig\|(\d+\.\d+)/) {      if ($featureID =~ /^fig\|(\d+\.\d+)/) {
1965          $retVal = $1;          $retVal = $1;
1966      } else {      } else {
1967            # Find the feature by alias.
1968            my ($realFeatureID) = $self->FeaturesByAlias($featureID);
1969            if ($realFeatureID && $realFeatureID =~ /^fig\|(\d+\.\d+)/) {
1970                $retVal = $1;
1971            } else {
1972                # Use the external table.
1973                my ($org) = $self->GetFlat(['ExternalAliasOrg'], "ExternalAliasOrg(id) = ?",
1974                                           [$featureID], "ExternalAliasOrg(org)");
1975                if ($org) {
1976                    $retVal = $org;
1977                } else {
1978          Confess("Invalid feature ID $featureID.");          Confess("Invalid feature ID $featureID.");
1979      }      }
1980            }
1981        }
1982      # Return the value found.      # Return the value found.
1983      return $retVal;      return $retVal;
1984  }  }
# Line 2613  Line 2817 
2817      return @retVal;      return @retVal;
2818  }  }
2819    
 =head3 GetProperties  
   
     my @list = $sprout->GetProperties($fid, $key, $value, $url);  
   
 Return a list of the properties with the specified characteristics.  
   
 Properties are the Sprout analog of the FIG attributes. The call is  
 passed directly to the CustomAttributes or RemoteCustomAttributes object  
 contained in this object.  
   
 This method returns a series of tuples that match the specified criteria. Each tuple  
 will contain an object ID, a key, and one or more values. The parameters to this  
 method therefore correspond structurally to the values expected in each tuple. In  
 addition, you can ask for a generic search by suffixing a percent sign (C<%>) to any  
 of the parameters. So, for example,  
   
     my @attributeList = $sprout->GetProperties('fig|100226.1.peg.1004', 'structure%', 1, 2);  
   
 would return something like  
   
     ['fig}100226.1.peg.1004', 'structure', 1, 2]  
     ['fig}100226.1.peg.1004', 'structure1', 1, 2]  
     ['fig}100226.1.peg.1004', 'structure2', 1, 2]  
     ['fig}100226.1.peg.1004', 'structureA', 1, 2]  
   
 Use of C<undef> in any position acts as a wild card (all values). You can also specify  
 a list reference in the ID column. Thus,  
   
     my @attributeList = $sprout->GetProperties(['100226.1', 'fig|100226.1.%'], 'PUBMED');  
   
 would get the PUBMED attribute data for Streptomyces coelicolor A3(2) and all its  
 features.  
   
 In addition to values in multiple sections, a single attribute key can have multiple  
 values, so even  
   
     my @attributeList = $sprout->GetProperties($peg, 'virulent');  
   
 which has no wildcard in the key or the object ID, may return multiple tuples.  
   
 =over 4  
   
 =item objectID  
   
 ID of object whose attributes are desired. If the attributes are desired for multiple  
 objects, this parameter can be specified as a list reference. If the attributes are  
 desired for all objects, specify C<undef> or an empty string. Finally, you can specify  
 attributes for a range of object IDs by putting a percent sign (C<%>) at the end.  
   
 =item key  
   
 Attribute key name. A value of C<undef> or an empty string will match all  
 attribute keys. If the values are desired for multiple keys, this parameter can be  
 specified as a list reference. Finally, you can specify attributes for a range of  
 keys by putting a percent sign (C<%>) at the end.  
   
 =item values  
   
 List of the desired attribute values, section by section. If C<undef>  
 or an empty string is specified, all values in that section will match. A  
 generic match can be requested by placing a percent sign (C<%>) at the end.  
 In that case, all values that match up to and not including the percent sign  
 will match. You may also specify a regular expression enclosed  
 in slashes. All values that match the regular expression will be returned. For  
 performance reasons, only values have this extra capability.  
   
 =item RETURN  
   
 Returns a list of tuples. The first element in the tuple is an object ID, the  
 second is an attribute key, and the remaining elements are the sections of  
 the attribute value. All of the tuples will match the criteria set forth in  
 the parameter list.  
   
 =back  
   
 =cut  
   
 sub GetProperties {  
     # Get the parameters.  
     my ($self, @parms) = @_;  
     # Declare the return variable.  
     my @retVal = $self->{_ca}->GetAttributes(@parms);  
     # Return the result.  
     return @retVal;  
 }  
   
2820  =head3 FeatureProperties  =head3 FeatureProperties
2821    
2822      my @properties = $sprout->FeatureProperties($featureID);      my @properties = $sprout->FeatureProperties($featureID);
# Line 3000  Line 3118 
3118      # Get the parameters.      # Get the parameters.
3119      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
3120      # Get the list of names.      # Get the list of names.
3121      my @retVal = $self->GetFlat(['HasRoleInSubsystem'], "HasRoleInSubsystem(from-link) = ?",      ##HACK: we do a join to the Subsystem table because we have missing subsystems in
3122        ## the Sprout database!
3123        my @retVal = $self->GetFlat(['HasRoleInSubsystem', 'Subsystem'], "HasRoleInSubsystem(from-link) = ?",
3124                                  [$featureID], 'HasRoleInSubsystem(to-link)');                                  [$featureID], 'HasRoleInSubsystem(to-link)');
3125      # Return the result, sorted.      # Return the result, sorted.
3126      return sort @retVal;      return sort @retVal;
# Line 3896  Line 4016 
4016      # Get the parameters.      # Get the parameters.
4017      my ($self, $searchExpression) = @_;      my ($self, $searchExpression) = @_;
4018      # Perform the standard cleanup.      # Perform the standard cleanup.
4019      my $retVal = $self->ERDB::CleanKeywords($searchExpression);      my $words = $self->ERDB::CleanKeywords($searchExpression);
4020      # Fix the periods in EC and TC numbers.      # Fix the periods in EC and TC numbers.
4021      $retVal =~ s/(\d+|\-)\.(\d+|-)\.(\d+|-)\.(\d+|-)/$1_$2_$3_$4/g;      $words =~ s/(\d+|\-)\.(\d+|-)\.(\d+|-)\.(\d+|-)/$1_$2_$3_$4/g;
4022      # Fix non-trailing periods.      # Fix non-trailing periods.
4023      $retVal =~ s/\.(\w)/_$1/g;      $words =~ s/\.(\w)/_$1/g;
4024      # Fix non-leading minus signs.      # Fix non-leading minus signs.
4025      $retVal =~ s/(\w)[\-]/$1_/g;      $words =~ s/(\w)[\-]/$1_/g;
4026      # Fix the vertical bars and colons      # Fix the vertical bars and colons
4027      $retVal =~ s/(\w)[|:](\w)/$1'$2/g;      $words =~ s/(\w)[|:](\w)/$1'$2/g;
4028        # Now split up the list so that each keyword is in its own string. We keep the delimiters
4029        # because they may contain boolean expression data.
4030        my @words = split /([^A-Za-z'0-9_]+)/, $words;
4031        # We'll convert the stemmable words into stems and re-assemble the result.
4032        my $retVal = "";
4033        for my $word (@words) {
4034            my $stem = $self->Stem($word);
4035            if (defined $stem) {
4036                $retVal .= $stem;
4037            } else {
4038                $retVal .= $word;
4039            }
4040        }
4041        Trace("Cleaned keyword list for \"$searchExpression\" is \"$retVal\".") if T(3);
4042      # Return the result.      # Return the result.
4043      return $retVal;      return $retVal;
4044  }  }
# Line 4034  Line 4168 
4168  }  }
4169    
4170    
4171    =head3 Hint
4172    
4173        my $htmlText = SearchHelper::Hint($wikiPage, $hintText);
4174    
4175    Return the HTML for a small question mark that displays the specified hint text when it is clicked.
4176    This HTML can be put in forms to provide a useful hinting mechanism.
4177    
4178    =over 4
4179    
4180    =item wikiPage
4181    
4182    Name of the wiki page to be popped up when the hint mark is clicked.
4183    
4184    =item hintText
4185    
4186    Text to display for the hint. It is raw html, but may not contain any double quotes.
4187    
4188    =item RETURN
4189    
4190    Returns the html for the hint facility. The resulting html shows a small button-like thing that
4191    uses the standard FIG popup technology.
4192    
4193    =back
4194    
4195    =cut
4196    
4197    sub Hint {
4198        # Get the parameters.
4199        my ($wikiPage, $hintText) = @_;
4200        # Escape the single quotes in the hint text.
4201        my $quotedText = $hintText;
4202        $quotedText =~ s/'/\\'/g;
4203        # Convert the wiki page name to a URL.
4204        my $wikiURL = join("", map { ucfirst $_ } split /\s+/, $wikiPage);
4205        $wikiURL = "$FIG_Config::cgi_url/wiki/view.cgi/FIG/$wikiURL";
4206        # Compute the mouseover script.
4207        my $mouseOver = "doTooltip(this, '$quotedText')";
4208        # Create the html.
4209        my $retVal = "&nbsp;<a href=\"$wikiURL\"><img src=\"$FIG_Config::cgi_url/Html/button-h.png\" class=\"helpicon\" onmouseover=\"$mouseOver\"/></a>";
4210        # Return it.
4211        return $retVal;
4212    }
4213    
4214  1;  1;

Legend:
Removed from v.1.108  
changed lines
  Added in v.1.115

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3