Man 1 ch07s04

From Bluefish Wiki
Jump to: navigation, search


Please consider to upgrade to Bluefish 2!

Please consider to edit the Manual 2!

How To edit the Wiki Manual
4. Function reference
Prev 
Chapter VII. More than a Text Editor
 Next

4. Function reference

The function reference browser contains reference information for different programming and markup languages. Currently, Bluefish comes with a PHP reference, a CSS 2.0 reference, an HTML reference, and a Python reference. The functions are grouped, depending on the language, by type, module, object, etc.

The function reference browser will display an info window on the bottom by checking the Show info window check box. In this window, information about the currently selected item is shown. The type of information shown can be configured in the right-click context menu (see Info Type later in this text).

In the reference browser's contextual menu, you can simply insert the text for the selected item by choosing Insert. Or, you can get a little help using Dialog, which launches a dialog window containing fields for the currently selected item's attributes or parameters. For a summary of an item's usage, choose Info. The contextual menu is also accessible on a group of functions and at the top level of a reference.

Man1 browser reference right click.png

Figure VII.3. The Reference Browser Contextual Menu

The Options menu accessible via the contextual menu offers three actions:

Man1 browser reference options.png

Figure VII.4. The Reference Browser Options Menu

  • Rescan reference files in case you have customized one of them, so that the new items be available.
  • Left doubleclick action, which can be:
    • Insert to insert the function in the document for latter parametrizing if needed
    • Dialog to insert the function in the document while filling in the parameters in a dialog window:
      Man1 browser reference dialog.png
      Figure VII.5. A Function Reference Dialog Window
    • Info to display a window with all available info about the function:
      Man1 browser reference info window.png
      Figure VII.6. Info available for a Function
  • Info Type: this is where you can customize what appears in the info window. It can be:
    • the function Description (this is the default)
    • the Attributes/Parameters of the function
    • some Notes about the function


Prev 
Up
 Next
3. Spell checker
Home | ToC
 5. HTML