SourceForge Logo

 

News


About


Features


Press


Download


Docs
 - Wiki
 - Installation
 - Upgrading
 - Media
 - Readme
 - Privacy
 - Developers


Support


Edit Online


Contributing


 
 How to create a help link

Function print_help_link()

The function print_help_link will print a customized help link. The link will print the following:
  • A popup windows with the help text
  • Help image if theme uses it otherwise text
  • Javascript description in statusbar
Arguments

The following arguments are used:
  • $help: The help text to be displayed. This used without $pgv_lang.
  • $helpText: The text to be displayed if help images are not used.
  • $show_desc (optional): The Javascript description to be displayed in the statusbar. If not specified, the value of $help will be displayed.
  • $use_print_text (optional): If this is set to true, it will use the function print_text for displaying the $show_desc variable. This is necessary for variables that contain other variables to be printed.
Example

The following example will open a popup window with the help text in $pgv_lang["gedcom_title_help"]. If no icon is used by the the theme, the text in variable $pgv_lang["qm"] is displayed. When the user hovers the mouse over the link the text in variable $pgv_lang[gedcom_title] is displayed in the statusbar using the function print_text() because true is specified.

  print_help_link("gedcom_title_help", "qm", "gedcom_title", true);



Copyright © 2009 PhpGedView Team Members
ADVERTISEMENT