Bluefish: The Definitive Guide

User's, Developer's, and Documentarian's Guide for Bluefish version 1.0

Daniel Blair

Michèle Garoche

Anita Lewis

Alastair Porter

Denny Reeh

Olivier Sessink

Scott White

Logo art: Dave Lyon


Table of Contents

Preface
About this Manual
What is Bluefish?
.. History of Bluefish
.. Main Features of Bluefish
.. How Stable is Bluefish?
.. Contact Us
1. Getting Bluefish
Choosing a Version
.. How and When Updates are Released
.. Operating Systems Supported by Bluefish
Latest Stable Version
Latest Developmental Version
2. Installing Bluefish
Requirements
Quick Standard Installation
System Specific Installation Issues
Installing a Bluefish Source Distribution
.. Quick Installation Overview
.. Installing from Development Source Tree
.. Problems Compiling?
Configure Options
.. Standard configuration flags
.. Flags personal to bluefish
Installing a Binary Distribution
Post-installation Setup
3. Using Bluefish
Starting Bluefish
.. Command line options
The user interface
Working with files
.. Creating files
.. Opening files
.. Saving files
.. Renaming files
.. Closing files
.. Inserting files
.. Editing
... Undo and Redo
... Cut, Copy, and Paste
... Input methods
.. Basic Find and Replace
... Searching for a word within a whole document
... Setting limits to the search scope
... Case sensitive search
... Overlapping searches
... Retrieving previous search strings
... More on find
... Replacing features
... Retrieving previous replace strings
... Changing letter case when replacing
... Choosing strings to replace
... More on replace
.. File types
... Syntax highlighting
.. More on files
... Remote files
... Character encoding
... Open advanced
Navigation and Managing documents
.. Navigating through a document
.. Navigating through many documents
.. Projects
.. Bookmarks
... Generating several bookmarks at once
.. Find and Replace
... Find Again
... Find from Selection
... Find and Replace Using Regular Expressions
More than a Text Editor
.. Indenting
.. Auto tag closing
.. Spell checker
.. Function reference
.. HTML
... Special find an replace features
... Thumbnail generation
.. Customizing the Quick bar
.. Custom menu
.. External programs, filters
Customising Bluefish
.. Modifying shortcut keys
.. Editor preferences
.. Modifying file types
.. Modifying the files filters
.. Modifying the highlighting patterns
4. Debugging Bluefish
Using the Debugger
5. Reference
6. Development guidelines
Indenting and formating style
Naming
Declaring procedures
Header files
New files
File reference
Patches
Translations
.. Introduction
.. PO files basics
.. Shortcut keys
.. How to contribute
Some tips
Making releases
Useful stuff
A. Credits
Bluefish developers
Bluefish package maintainers
Bluefish translators
Supporters to bluefish
B. Bluefish change history
Changes in release GTK2-port
Changes in release GTK1-version
C. Guidelines for Writing this Manual
Introduction to DocBook
Building the Manual
Conventions for Writing this Manual
.. The id Attribute
.. Using Screen shots
.. Referencing Bluefish interface elements
.. Using procedures
.. Using notes, tips, warnings
.. Using links
.. Others tags
.. Recommendation
.. Producing the final files
.. Contact us
D. GNU GENERAL PUBLIC LICENSE
Preamble
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
How to Apply These Terms to Your New Programs

List of Figures

3.1. Bluefish Editor Array
3.2. Bluefish Main Menu
3.3. Bluefish Main Tool Bar
3.4. Bluefish HTML Tool Bar
3.5. Bluefish Custom Tool Bar
3.6. Bluefish File Browser
3.7. Bluefish Function Reference Browser
3.8. Bluefish Bookmark Browser
3.9. Bluefish Status Bar
3.10. Bluefish View Menu
3.11. Bluefish About Window
3.12. Bluefish File Menu
3.13. Bluefish Open File Dialog
3.14. Filtering Files with the Bluefish File Browser
3.15. Info on open file with the Bluefish File Browser
3.16. Tool Tip for Modified File
3.17. Saving a File under a new Name
3.18. Moving a file to another location
3.19. Closing a file with the document tab icon
3.20. Closing a modified file
3.21. Closing all files
3.22. The Input Methods Contextual menu
3.23. Writing in Japanese with Bluefish
3.24. Finding a word in a document, from start to end
3.25. Unsuccessful search window
3.26. Highlighted search result in the document window
3.27. Setting the cursor location
3.28. Choosing a limited search method
3.29. Limited search result
3.30. Making the search case sensitive
3.31. Case sensitive search result
3.32. Finding overlapping strings
3.33. An overlapping string retrieved with the Find dialog
3.34. Retrieving recent searches
3.35. The Replace dialog
3.36. Changing letter case when replacing
3.37. The Replace confirm dialog
3.38. Opening an URL from the web
3.39. A style sheet opened via the Open URL menu
3.40. Using the Open Advanced dialog
3.41. Bluefish Go Menu
3.42. Using the Goto Line dialog
3.43. The Bluefish Project Menu
3.44. The Create Project dialog
3.45. Creating a New Project
3.46. Entering Bluefish Project Filename
3.47. Selecting a Bluefish Project
3.48. Opening a Bluefish Project
3.49. How bookmarks are marked
3.50. Bookmarks in the side panel
3.51. Contextual menu on bookmark in the side panel
3.52. Editing a bookmark
3.53. A named bookmark
3.54. The contextual menu on a document in the bookmark tab
3.55. Bookmarking with Posix regular expression
3.56. Bookmarks with Posix regular expression
3.57. Bookmarking Objective C functions via the Find menu
3.58. Bookmarking PHP functions via the Find menu
3.59. Nth occurrence with Find Again
3.60. Nth+1 occurrence with Find Again
3.61. Selecting a string for subsequent search
3.62. Finding a string from selection
3.63. The table before transformation
3.64. The table after transformation
3.65. Indenting part of a text
3.66. Bluefish Spell Checker
3.67. The reference browser contextual menu
3.68. The reference browser options menu
3.69. A function reference dialog window
3.70. Info available for a function
3.71. The HTML Tags menu
3.72. The HTML Dialogs menu
3.73. An HTML button with a three-dotted tool tip
3.74. A simple HTML tool tip button
3.75. The Replace special menu
3.76. The Insert thumbnail icon
3.77. The Multi thumbnail icon
3.78. The Insert thumbnail dialog
3.79. The Multi thumbnail dialog
3.80. The Table icon in the html tool bar
3.81. Adding an element to the Quick bar
3.82. The added element in the Quick bar
3.83. Adding a pop up menu element to the Quick bar
3.84. Removing an element from the Quick bar
3.85. Moving an element within the Quick bar
3.86. Accessing the custom menu
3.87. The Custom Menu Editor
3.88. Extract of the default custom menu path
3.89. The Custom Replace Dialog
3.90. A new custom entry in the Menu path list
3.91. A new menu in the custom menu tool bar
3.92. A block of selected text before activating the menu
3.93. A block of text after activating the menu
3.94. The new div with class dialog
3.95. The block of text after entering the value
3.96. Bluefish External Menu
3.97. Syntax highlighting example

List of Examples

3.1. Retrieving all sections in an xml book
3.2. Retrieving all functions in an Objective C file
3.3. Retrieving all functions in a PHP file
3.4. Transforming a table into a definition list