Bluefish Wiki - User contributions [en]

Notes for Bluefish 2 Manual

2010-07-12T12:32:45Z

Bill Valaski: /* Enable/desable scanner */

== Bluefish 1.3 features ==
from: http://bluefish.openoffice.nl/features.html<br />
Bluefish 1.3 (the development version) mostly has the same features with some notable exceptions or additions:

* In-line spell checker which is programing language aware (spell check comments and strings, but not code), requires libenchant during compilation.
* Code block folding
* Highlighting matching block start and end markers (both brackets and tags)
* Auto-completion for many programming languages, and even for nested languages (e.g. css inside html)
* Auto-recovery of changes in modified documents after a crash, kill or shutdown
* Character map of all unicode characters (requires libgucharmap during compilation)
* Upload / download synchronisation
* Full screen editing
* In-line reference information (move your mouse over a function name or tag name) for various programming languages
* Many new tools (tabs to spaces, join lines, etc. etc.)

=== Bluefish 2.0 new features ===
* Right margin
* [[Templates]] function (XHTML 1.0, HTML 5, C Header, C Header GPL and PHP
* Tab key indent a block, tab / shift tab for indent/unindent
* toggle bookmark on doubleclick (to add to [[Man 2 ch06s04]])

== scanner ==
Bluefih can Highlight the syntax of a lot of languages, 22 actually:<br />
Ada, ASP-VBScript, ASP, C, C++, CSS, D, HTML, Java, JavaScript, JSP, NSIS, Perl, PHP, gettext PO, Python, Ruby, Shell, Smarty, VBScript, XHTML, XML.
=== Enable/disable scanner ===
Use Document > Highligt Syntax.

=== Edit preferences ===

[[File:Man2 Generic HTML Textstyle.png|500px|thumb|left|Edit preferences Generic HTML Textstyle]]
<br style="clear:both;" />

=== Contributing ===
A lot of informations are available in these two files in bluefish/data/bflang/ :<br />
[https://bluefish.svn.sourceforge.net/svnroot/bluefish/trunk/bluefish/data/bflang/bflang2.bflang2 bflang2.bflang2] [https://bluefish.svn.sourceforge.net/svnroot/bluefish/trunk/bluefish/data/bflang/sample.bflang2 sample.bflang2]

In Bluefish 2 Custom menu is replaced by Snippets in left panel.<br />
Bluefish_2 become without any snippets, you have to [[:Category:Snippets repository|import]] or create them.
{{note|text= To import your Bluefish_1 Custom menu in snippets you can use Olivier's python script [[convert_custom_menu_to_snippets.py]].
*put convert_custom_menu_to_snippets.py in ~/.bluefish/ directory
*make the script executable: chmod a+x convert_custom_menu_to_snippets.py and run the script.}}

== Editing Snippets ==

[[Category:Manual 2]]

Man 2 ch12s08

2010-07-09T10:17:24Z

Bill Valaski: moved Man 2 ch12s08 to Development - Translations: Title updates (BV)

#REDIRECT [[Development - Translations]]

Development - Translations

2010-07-09T10:17:24Z

Bill Valaski: moved Man 2 ch12s08 to Development - Translations: Title updates (BV)

__NOTOC__
__NOEDITSECTION__
{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=8. Translations
|prev=Man 2 ch12s07
|Subtitle=Chapter XII. Development guidelines
|next=Man 2 ch12s09
}}
== 8. Translations ==
<div style="float:right; background-color:#E5ECF9;border:1px solid #3061C2;">
*[[#8.1. Introduction|8.1. Introduction]]
*[[#8.2. PO files basics| 8.2. PO files basics]]
*[[#8.3. Shortcut keys| 8.3. Shortcut keys]]
*[[# 8.4. How to contribute| 8.4. How to contribute]]
</div>
=== 8.1. Introduction ===
Bluefish has been translated into more than 15 different languages and this is only the beginning.

Translation process is not a difficult task but you will need some time because there are more than one thousand strings to be translated. The good news are you don't need to be a programmer to make Bluefish speak your language and the only tool you need is a text editor (Vim, Emacs, bluefish, etc.)

Bluefish uses po (Portable Object) files. A po file is just a plain text file that you can edit with your favorite text editor.

=== 8.2. PO files basics ===
In a typical po file there are five major types of entries:

# Those which begin with "#:" showing the places in the source code that contains the string being translated (there may be one or more) as: '<tt><nowiki>#: ../src/about.c:123</nowiki></tt>'
# Those which begin with "#," containing some flags (not always present) as: '<tt><nowiki>#, c-format</nowiki></tt>'
# Those which begin with "msgid" containing the English string being translated (it may be spanned in several lines) as: '<tt>msgid "Authentication is required for %s."</tt>'
# Those which begin with "msgstr" containing the translated string as: '<tt>msgstr "Une autorisation est requise pour accéder à %s."</tt>'
# Those which begin with "#~ " containing obsolete strings as: '<tt><nowiki>#~ msgid "Save document as"</nowiki></tt>'

[[File:Man2_warning.png]] When an entry is tagged as fuzzy (i.e. when the line begins with "<tt><nowiki>#, fuzzy</nowiki></tt>"), that means it is probably incorrect.

[[File:Man2_warning.png]] You have to make sure the translation is correct and then delete either the "<tt><nowiki>#, fuzzy</nowiki></tt>" line if this is the only flag on the line, or the "<tt>, fuzzy</tt>" part of the line if there are some other flags on the same line, like in "<tt><nowiki>#, fuzzy, c-format</nowiki></tt>".

[[File:Man2_warning.png]] Remember that as long as a translation is marked "fuzzy", it will NOT actually be used!

[[File:Man2_warning.png]] As far as obsolete strings are concerned, it is up to you to decide if you want to remove them. On one hand they can be reused in a latter version of the po file, on the other hand they make the po file bigger.

Hence, your task as a translator is to:

# Translate all empty msgstr entries
# Check all fuzzy entries, correct them if they are wrong and remove all fuzzy tags
# Optionally, remove obsolete strings
# Check that the po file ends with a blank line

=== 8.3. Shortcut keys ===
Shortcut keys, known as hotkeys or even accelerator keys, are defined as follows (look at the underscore, please):

<nowiki># src/toolbars.c:482</nowiki>
<nowiki>#: ../src/filebrowser.c:1453</nowiki>
msgid "/_Refresh"
msgstr "/_Actualizar"

It means that in the English locale the user have to press '''Alt'''+'''R''' to activate this particular GUI element. On the other hand if your locale is Spanish your shortcut key will be '''Alt'''+'''A'''.

[[File:Man2_warning.png]] You have to keep in mind that two GUI elements must not have the same shortcut key at the same level.

=== 8.4. How to contribute ===
It is really easy. Just drop me a line at [mailto:wecharri(at)arnet.com.ar wecharri(at)arnet.com.ar] and I will send you your po file ready to be translated. When you have finished the translation work, just send it me back (use gzip or bzip2 if possible, please). Then I will check it and if everything is right I will add it into SVN.

About ten days before a new release I will send a new fresh po copy to each translator to repeat this process.

All po files will be named as follows:

date-foo.po.gz (date: day-month-year)

Example:

12-12-2004.es.po.gz (for Spanish po file)

Please, remember:

* Do not rename it (I need it for tracking stuff)
* Send it me back as soon as possible in zipped format too.
* Do not mix it without any local copy you have.
* Remember they are in UTF-8 format
* Subject in my mail will be ***New Bluefish PO File !***

And at last, do not start a new translation before contacting me or contact Olivier and do not post your po file at the list, please.

If you have some doubts, do not hesitate contact me at [mailto:wecharri(at)arnet.com.ar wecharri(at)arnet.com.ar].

{{Man2bottom
|prev=Man 2 ch12s07
|up=Man 2 ch12
|next=Man 2 ch12s09
|prevname= 7. Patches
|nextname=9. Some tips
}}

Man 2 ch12s07

2010-07-09T10:16:48Z

Bill Valaski: moved Man 2 ch12s07 to Development - Patches: Title updates (BV)

#REDIRECT [[Development - Patches]]

Development - Patches

2010-07-09T10:16:48Z

Bill Valaski: moved Man 2 ch12s07 to Development - Patches: Title updates (BV)

__NOTOC__
__NOEDITSECTION__
{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=7. Patches
|prev=Man 2 ch12s06
|Subtitle=Chapter XII. Development guidelines
|next=Man 2 ch12s08
}}

'''PLEASE SEE [[Sending Patches]] !'''
== 7. Patches ==
Before starting to code:

# Update your SVN tree, or alternatively download the latest snapshot
# Copy this original tree, so you can make a patch against this tree

Before creating the patch:

# Run '''make distclean && ./configure && make''' and test if it runs successfully
# If you have the possibility do this both with gcc-2.95 and gcc-3.x as compiler

Now create the patch. Assuming that you have two directories, original-tree and my-tree:

# Run '''make distclean''' in both trees
# cd to the parent directory of both trees
# Run '''diff -Naur original-tree my-tree | bzip2 -9c > patchbla.diff.bz2'''

{{Man2bottom
|prev=Man 2 ch12s06
|up=Man 2 ch12
|next=Man 2 ch12s08
|prevname= 6. File reference
|nextname=8. Translations
}}

Man 2 ch12s04

2010-07-09T10:15:27Z

Bill Valaski: moved Man 2 ch12s04 to Development - Header Files: Title updates (BV)

#REDIRECT [[Development - Header Files]]

Development - Header Files

2010-07-09T10:15:27Z

Bill Valaski: moved Man 2 ch12s04 to Development - Header Files: Title updates (BV)

__NOTOC__
__NOEDITSECTION__
{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=4. Header files
|prev=Man 2 ch12s03
|Subtitle=Chapter XII. Development guidelines
|next=Man 2 ch12s05
}}
== 4. Header files ==
Only functions that are used from outside the file itself should be in the header file, in the order in which they are found in the .c file itself. Basically these are all non-static functions in the .c file.

{{Man2bottom
|prev=Man 2 ch12s03
|up=Man 2 ch12
|next=Man 2 ch12s05
|prevname= 3. Declaring procedures
|nextname=5. New files
}}

Man 2 ch12s03

2010-07-09T10:14:40Z

Bill Valaski: moved Man 2 ch12s03 to Development - Declaring Procedures: Title updates (BV)

#REDIRECT [[Development - Declaring Procedures]]

Development - Declaring Procedures

2010-07-09T10:14:40Z

Bill Valaski: moved Man 2 ch12s03 to Development - Declaring Procedures: Title updates (BV)

__NOTOC__
__NOEDITSECTION__
{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=3. Declaring procedures
|prev=Man 2 ch12s02
|Subtitle=Chapter XII. Development guidelines
|next=Man 2 ch12s04
}}
== 3. Declaring procedures ==
All local functions should be static!

Callback functions (called for events such as button clicks) should have prefix ''_cb'', or ''_lcb'' for local callbacks.

For GTK callback functions, use the name of the signal in the name.

{{Man2bottom
|prev=Man 2 ch12s02
|up=Man 2 ch12
|next=Man 2 ch12s04
|prevname= 2. Naming
|nextname=4. Header files
}}

Man 2 ch12s02

2010-07-09T10:13:57Z

Bill Valaski: moved Man 2 ch12s02 to Development - Naming: Title updates (BV)

#REDIRECT [[Development - Naming]]

Development - Naming

2010-07-09T10:13:57Z

Bill Valaski: moved Man 2 ch12s02 to Development - Naming: Title updates (BV)

__NOTOC__
__NOEDITSECTION__
{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=2. Naming
|prev=Man 2 ch12
|Subtitle=Chapter XII. Development guidelines
|next=Man 2 ch12s03
}}
== 2. Naming ==
For non-local functions, the name should preferably include a prefix that shows the part of bluefish it is used for. There are, furthermore, many often used abbreviations in the bluefish code, such as:

'''Abbreviations used in the Bluefish code'''

doc

A function for handling a specific document

bfwin

A function for handling a specific Bluefish window

cb

Callback, a function called after a button click or some other event

lcb

Local callback, a function called after an event, only used in this .c file

Here are such function names that show where they are from, what they handle, and/or what they do

'''Examples of function names in Bluefish'''

bmark_set_for_doc

Bookmark code, sets bookmarks for a document

spell_check_cb

Spell check code, this is a callback function (for a button)

project_open_from_file

Project code, opens a new project from a given file name

{{Man2bottom
|prev=Man 2 ch12
|up=Man 2 ch12
|next=Man 2 ch12s03
|prevname= Chapter XII. Development guidelines
|nextname=3. Declaring procedures
}}

Man 2 ch12

2010-07-09T10:13:16Z

Bill Valaski: moved Man 2 ch12 to Development - Indenting and Formatting: Title updates (BV)

#REDIRECT [[Development - Indenting and Formatting]]

Development - Indenting and Formatting

2010-07-09T10:13:16Z

Bill Valaski: moved Man 2 ch12 to Development - Indenting and Formatting: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=Chapter XII. Development guidelines
|prev=Man 2 ch11s05
|Subtitle=Part 3. Developing Bluefish
|next=Man 2 ch12s02
}}

<div style="float:right; background-color:#E5ECF9;border:1px solid #3061C2;">
*[[# Indenting and formating style|1. Indenting and formating style]]
*[[Man 2 ch12s02|2. Naming]]
*[[Man 2 ch12s03|3. Declaring procedures]]
*[[Man 2 ch12s04|4. Header files]]
*[[Man 2 ch12s05|5. New files]]
*[[Man 2 ch12s06|6. File reference]]
*[[Man 2 ch12s07|7. Patches]]
*[[Man 2 ch12s08|8. Translations]]
**[[Man 2 ch12s08#|po-files-introduction 8.1. Introduction]]
**[[Man 2 ch12s08#|po-files-basics 8.2. PO files basics]]
**[[Man 2 ch12s08#|po-files-shortcuts 8.3. Shortcut keys]]
**[[Man 2 ch12s08#|po-files-contribute 8.4. How to contribute]]
*[[Man 2 ch12s09|9. Some tips]]
*[[Man 2 ch12s10|10. Making releases]]
*[[Man 2 ch12s11|11. Useful stuff]]
</div>
Work hard but have fun!

== 1. Indenting and formating style ==
Indenting can be done with the '''indent''' command line tool. Bluefish uses tabs - not spaces, and I'll explain why.

Some programmers prefer a lot of indenting, 8 characters, some prefer less, 3 characters. If Bluefish code was indented with spaces, these programmers had a problem, they would have to change the files to view it in their favourite layout. But because we use tabs, these programmers can simply set the tab width to a different value, and without changing the files it looks good for both programmers!

To indent properly with '''indent''', issue this command:

<tt>'''$''' indent --line-length 100 --k-and-r-style --tab-size 4 \</tt>
<tt>-bbo --ignore-newlines bluefishcode.c</tt>

Comment all public functions like it is done in bf_lib.c and gtk_easy.c (javadoc style, with some small differences), this can be used to create a function reference.

{{Man2bottom
|prev=Man 2 ch11s05
|up=Man 2 pt03
|next=Man 2 ch12s02
|prevname= 5. Options in the Images Tab
|nextname=2. Naming
}}

Man 2 ch11s05

2010-07-09T09:38:21Z

Bill Valaski: moved Man 2 ch11s05 to Images Tab Options: Title updates (BV)

#REDIRECT [[Images Tab Options]]

Images Tab Options

2010-07-09T09:38:21Z

Bill Valaski: moved Man 2 ch11s05 to Images Tab Options: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=5. Options in the Images Tab
|prev=Man 2 ch11s04
|Subtitle=Chapter XI. Reference
|next=Man 2 ch12
}}

'''Table XI.5. Images Tab Reference'''

{| border=1
! colspan="2" | <center>Option</center>
! colspan="2" | <center>Configuration</center>

|-
! <center>Category</center>
! <center>Label</center>
! <center>Name</center>
! <center>File</center>

|-
| Thumbnails
| Thumbnails suffix
| <tt>image_thumbnailstring</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Thumbnails
| Thumbnails filetype
| <tt>image_thumbnailtype</tt>
| $HOME/.bluefish/rcfile_v2

|}

{{Man2bottom
|prev=Man 2 ch11s04
|up=Man 2 ch11
|next=Man 2 ch12
|prevname= 4. Options in the User interface Tab
|nextname=Chapter XII. Development guidelines
}}

Man 2 ch11s04

2010-07-09T09:37:39Z

Bill Valaski: moved Man 2 ch11s04 to User Interface Tab Options: Title updates (BV)

#REDIRECT [[User Interface Tab Options]]

User Interface Tab Options

2010-07-09T09:37:39Z

Bill Valaski: moved Man 2 ch11s04 to User Interface Tab Options: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=4. Options in the User interface Tab
|prev=Man 2 ch11s03
|Subtitle=Chapter XI. Reference
|next=Man 2 ch11s05
}}

'''Table XI.4. User interface Tab Reference'''

{| border=1
! colspan="2" | <center>Option</center>
! colspan="2" | <center>Configuration</center>

|-
! <center>Category</center>
! <center>Label</center>
! <center>Name</center>
! <center>File</center>

|-
| Dimensions
| Restore last used dimensions
| <tt>restore_dimensions</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Dimensions
| Initial sidebar width
| <tt>left_panel_width</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Dimensions
| Initial window height
| <tt>main_window_height</tt>
| $HOME/.bluefish/session

|-
| Dimensions
| Initial window width
| <tt>main_window_width</tt>
| $HOME/.bluefish/session

|-
| General
| Make HTML dialogs transient
| <tt>transient_htdialogs</tt>
| $HOME/.bluefish/rcfile_v2

|-
| General
| External browsers in submenu
| <tt>ext_browsers_in_submenu</tt>
| $HOME/.bluefish/rcfile_v2

|-
| General
| External commands in submenu
| <tt>ext_commands_in_submenu</tt>
| $HOME/.bluefish/rcfile_v2

|-
| General
| External outputbox in submenu
| <tt>ext_outputbox_in_submenu</tt>
| $HOME/.bluefish/rcfile_v2

|-
| General
| Notebook tab font
| <tt>tab_font_string allow_the_use_of_font</tt>
| $HOME/.bluefish/rcfile_v2

|-
| General
| Document notebook tab position
| <tt>document_tabposition</tt>
| $HOME/.bluefish/rcfile_v2

|-
| General
| Sidebar notebook tab position
| <tt>leftpanel_tabposition</tt>
| $HOME/.bluefish/rcfile_v2

|-
| General
| Sidebar location
| <tt>left_panel_left</tt>
| $HOME/.bluefish/rcfile_v2

|}

{{Man2bottom
|prev=Man 2 ch11s03
|up=Man 2 ch11
|next=Man 2 ch11s05
|prevname= 3. Options in the Files Tab
|nextname=5. Options in the Images Tab
}}

Man 2 ch11s03

2010-07-09T09:36:51Z

Bill Valaski: moved Man 2 ch11s03 to Files Tab Options: Title updates (BV)

#REDIRECT [[Files Tab Options]]

Files Tab Options

2010-07-09T09:36:51Z

Bill Valaski: moved Man 2 ch11s03 to Files Tab Options: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=3. Options in the Files Tab
|prev=Man 2 ch11s02
|Subtitle=Chapter XI. Reference
|next=Man 2 ch11s04
}}

'''Table XI.3. HTML Tab Reference'''

{| border=1
! colspan="2" | <center>Option</center>
! colspan="2" | <center>Configuration</center>

|-
! <center>Category</center>
! <center>Label</center>
! <center>Name</center>
! <center>File</center>

|-
| Encoding
| Default character set
| <tt>newfile_default_encoding</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Encoding
| <nowiki>Auto set <meta> encoding tag on change</nowiki>
| <tt>auto_set_encoding_meta</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Backup
| Create backup on save
| <tt>backup_file</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Backup
| Backup file suffix
| <tt>backupfile_string</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Backup
| Action on backup failure
| <tt>backup_abort_action</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Backup
| Remove backupfile on close
| <tt>backup_cleanuponclose</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Misc
| Allow multi instances of a file
| <tt>allow_multi_instances</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Misc
| Open files in already running bluefish window
| <tt>open_in_running_bluefish</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Misc
| File modified on disk check
| <tt>modified_check_type</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Misc
| Number of files in "Open recent"
| <tt>max_recent_files</tt>
| $HOME/.bluefish/rcfile_v2

|-
| File browser
| Default basedir
| <tt>default_basedir</tt>
| $HOME/.bluefish/rcfile_v2

|-
| File browser
| Use separate file and directory view
| <tt>fb_two_pane_view</tt>
| $HOME/.bluefish/rcfile_v2

|-
| File browser
| Unknown icon
| <tt>fb_unknown_icon</tt>
| $HOME/.bluefish/rcfile_v2

|-
| File browser
| Directory icon
| <tt>fb_dir_icon</tt>
| $HOME/.bluefish/rcfile_v2

|}

{{Man2bottom
|prev=Man 2 ch11s02
|up=Man 2 ch11
|next=Man 2 ch11s04
|prevname= 2. Options in the HTML Tab
|nextname=4. Options in the User interface Tab
}}

Man 2 ch11s02

2010-07-09T09:35:51Z

Bill Valaski: moved Man 2 ch11s02 to HTML Tab Options

#REDIRECT [[HTML Tab Options]]

HTML Tab Options

2010-07-09T09:35:51Z

Bill Valaski: moved Man 2 ch11s02 to HTML Tab Options

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=2. Options in the HTML Tab
|prev=Man 2 ch11
|Subtitle=Chapter XI. Reference
|next=Man 2 ch11s03
}}

'''Table XI.2. HTML Tab Reference'''

{| border=1
! colspan="2" | <center>Option</center>
! colspan="2" | <center>Configuration</center>

|-
! <center>Category</center>
! <center>Label</center>
! <center>Name</center>
! <center>File</center>

|-
| HTML options
| Lowercase HTML tags
| <tt>lowercase_tags</tt>
| $HOME/.bluefish/rcfile_v2

|-
| HTML options
| Use deprecated tags
| <tt>allow_the_use_of_font</tt>
| $HOME/.bluefish/rcfile_v2

|-
| HTML options
| Use XHTML style tags
| <tt>use_xhtml</tt>
| $HOME/.bluefish/rcfile_v2

|-
| HTML options
| Automatically update author meta tag
| <tt>auto_update_meta_author</tt>
| $HOME/.bluefish/rcfile_v2

|-
| HTML options
| Automatically update date meta tag
| <tt>auto_update_meta_date</tt>
| $HOME/.bluefish/rcfile_v2

|-
| HTML options
| Automatically update generator meta tag
| <tt>auto_update_meta_generator</tt>
| $HOME/.bluefish/rcfile_v2

|}

{{Man2bottom
|prev=Man 2 ch11
|up=Man 2 ch11
|next=Man 2 ch11s03
|prevname= Chapter XI. Reference
|nextname=3. Options in the Files Tab
}}

Man 2 ch11

2010-07-09T09:35:19Z

Bill Valaski: moved Man 2 ch11 to Editor Tab Options: Title updates (BV)

#REDIRECT [[Editor Tab Options]]

Editor Tab Options

2010-07-09T09:35:19Z

Bill Valaski: moved Man 2 ch11 to Editor Tab Options: Title updates (BV)

__NOTOC__
{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=Chapter XI. Reference
|prev=Man 2 ch10s02
|Subtitle=Part 3. Developing Bluefish
|next=Man 2 ch11s02
}}

<div style="float:right; background-color:#E5ECF9;border:1px solid #3061C2;">
*[[#1. Options in the Editor Tab|1. Options in the Editor Tab]]
*[[Man 2 ch11s02|2. Options in the HTML Tab]]
*[[Man 2 ch11s03|3. Options in the Files Tab]]
*[[Man 2 ch11s04|4. Options in the User interface Tab]]
*[[Man 2 ch11s05|5. Options in the Images Tab]]
</div>
Here you will find the list of the configuration files and configuration names which match the options in the Preferences panel.

Each preferences tab is given a different table, and options in a table are sorted in the same order as they appear in the tab, which may not be the same order as they appear in the corresponding configuration file.

== 1. Options in the Editor Tab ==
'''Table XI.1. Editor Tab Reference'''

{| border=1
! colspan="2" | <center>Option</center>
! colspan="2" | <center>Configuration</center>

|-
! <center>Category</center>
! <center>Label</center>
! <center>Name</center>
! <center>File</center>

|-
| Editor startup options
| Show empty quickbar warning
| <tt>show_quickbar_tip</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Editor options
| Font
| <tt>editor_font_string</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Editor options
| Tab width
| <tt>editor_tab_width</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Editor options
| Smart cursor positioning at line start
| <tt>editor_smart_cursor</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Editor options
| Use spaces to indent, not tabs
| <tt>editor_indent_wspaces</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Editor options
| Word wrap default
| <tt>word_wrap</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Editor options
| Line numbers by default
| <tt>view_line_numbers</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Editor options
| Highlight syntax by default
| <tt>defaulthighlight</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Editor options
| Enable hightlighting PCRE UTF-8 support
| <tt>highlight_utf8</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Editor options
| Highlight # lines
| <tt>highlight_num_lines_count</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Undo
| Undo history size
| <tt>num_undo_levels</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Undo
| Clear undo history on save
| <tt>clear_undo_on_save</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Bookmark options
| Make permanent by default
| <tt>bookmarks_default_store</tt>
| $HOME/.bluefish/rcfile_v2

|-
| Bookmark options
| Bookmarks filename display
| <tt>bookmarks_filename_mode</tt>
| $HOME/.bluefish/rcfile_v2

|}

{{Man2bottom
|prev=Man 2 ch10s02
|up=Man 2 pt03
|next=Man 2 ch11s02
|prevname= 2. Filling a bug report
|nextname=2. Options in the HTML Tab
}}

Man 2 ch10

2010-07-09T09:30:10Z

Bill Valaski: moved Man 2 ch10 to Bugs - Using the Debugger: Title updates (BV)

#REDIRECT [[Bugs - Using the Debugger]]

Bugs - Using the Debugger

2010-07-09T09:30:10Z

Bill Valaski: moved Man 2 ch10 to Bugs - Using the Debugger: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=Chapter X. Debugging Bluefish
|prev=Man 2 pt03
|Subtitle=Part 3. Developing Bluefish
|next=Man 2 ch10s02
}}

<div style="float:right; background-color:#E5ECF9;border:1px solid #3061C2;">
*[[#1. Using the Debugger|1. Using the Debugger]]
*[[Man 2 ch10s02|2. Filling a bug report]]
</div>
== 1. Using the Debugger ==
Here are the detailed steps for sending a useful backtrace to the Bluefish Developer Team.

'''Procedure X.1. Running bluefish under gdb'''

# Get the latest SVN release (see [[Man 2 ch01s04|Section 4, “Latest Developmental Version”]] for info)
# From bluefish, the top directory of the bluefish source, run: <tt>'''./autogen.sh'''</tt><br/> You may have to set some environment variables before running '''autoconf''', as well as providing autoconf with some flags. Also, some patches may need to be applied, depending on your system.
# Then, run <tt>'''./configure --with-debugging-output'''</tt><br/> Again, you may have to add some flags, depending on your system.
# Once you succeed in configuring bluefish, run: <tt>'''make clean'''</tt> in order to remove all unnecessary files.
# Then, run <tt>'''make'''</tt> to compile bluefish.<br/> Do not run make install since it strips the debugging symbols from the executable.
# Execute bluefish under gdb with: <tt>'''gdb src/bluefish'''</tt>. This way, you will get access to a non stripped version of bluefish, which is not the case if you run <tt>'''gdb bluefish'''</tt> or '''gdb /usr/local/bin/bluefish''', since those binaries do not have any debugging symbols anymore.
# Once '''gdb''' has started, type <tt>'''r'''</tt> to start the debugging session.
# Try to reproduce the crash in bluefish.
# Copy and paste the last 50 lines of debugging output to a text file.
# Type <tt>'''bt'''</tt> in gdb to get the backtrace, and copy it to the text file too. If the backtrace is huge, copy only the first 50 lines.
# Save the text file and gzip it by running gzip textfile in a terminal.
# Quit gdb with <tt>'''q'''</tt>
# Fill in the bug report (see [[Man 2 ch10s02|Section 2, “Filling a bug report”]] for instructions).

{{Man2bottom
|prev=Man 2 pt03
|up=Man 2 pt03
|next=Man 2 ch10s02
|prevname= Part 3. Developing Bluefish
|nextname=2. Filling a bug report
}}

Man 2 ch10s02

2010-07-09T09:29:33Z

Bill Valaski: moved Man 2 ch10s02 to Bugs - Filing a Report: Title updates (BV)

#REDIRECT [[Bugs - Filing a Report]]

Bugs - Filing a Report

2010-07-09T09:29:33Z

Bill Valaski: moved Man 2 ch10s02 to Bugs - Filing a Report: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=2. Filling a bug report
|prev=Man 2 ch10
|Subtitle=Chapter X. Debugging Bluefish
|next=Man 2 ch11
}}
First make sure you have followed the instructions at [[Man 2 ch10#1. Using the Debugger| Section 1, “Using the Debugger”]] in case of bluefish crash.

You can use bug-buddy or go to [http://bugzilla.gnome.org/browse.cgi?product=bluefish http://bugzilla.gnome.org/browse.cgi?product=bluefish], the bluefish bugzilla page on bugzilla org gnome, to fill in the bug report.

The following instructions are related to bug-buddy. Nevertheless, though the form differs when filling a bug report from the bluefish bugzilla page, the necessary bits of information are the same.

{{Man2bottom
|prev=Man 2 ch10
|up=Man 2 ch10
|next=Man 2 ch11
|prevname= Chapter X. Debugging Bluefish
|nextname=Chapter XI. Reference
}}

Man 2 ch09s02

2010-07-09T00:25:27Z

Bill Valaski: moved Man 2 ch09s02 to HTML Shortcuts: Title updates (BV)

#REDIRECT [[HTML Shortcuts]]

HTML Shortcuts

2010-07-09T00:25:27Z

Bill Valaski: moved Man 2 ch09s02 to HTML Shortcuts: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=2. HTML Shortcuts
|prev=Man 2 ch09
|Subtitle=Chapter IX. Shortcuts available within Bluefish
|next=Man 2 pt03
}}

Here are the shortcuts that apply to documents containing HTML markup.

'''Table IX.2. Shortcuts for HTML Markup'''

{| border=1
! colspan="2" | <center>Action</center>
! colspan="2" | <center>EWA</center>
! colspan="2" | <center>Tool Bars</center>

|-
! <center>Keys</center>
! <center>Menus</center>
! <center>Ic.</center>
! <center>Bar</center>

|-
| Headings
| Quickstart...
| <center>'''Shift'''+'''Alt'''+'''Q'''</center>
| <center><tt>Dialogs → General</tt></center>
| <center>[[File:Man1_quick_start.png]]</center>
| <center>Std</center>

|-
|  
| Meta...
| <center>'''Shift'''+'''Alt'''+'''M'''</center>
| <center><tt>Dialogs → General</tt></center>
| <center> </center>
| <center> </center>

|-
|  
| Body...
| <center>'''Shift'''+'''Alt'''+'''B'''</center>
| <center><tt>Dialogs → General</tt></center>
| <center>[[File:Man1_body.png]]</center>
| <center>Std</center>

|-
| Header tags
| H1
| <center>'''Ctrl'''+'''Alt'''+'''1'''</center>
| <center><tt>Tags → Headings</tt></center>
| <center>[[File:Man1_headings.png]]</center>
| <center>Std<ref name="H">This is a pop up icon. Corresponding H1, H2, etc... icons are also accessible from the Fonts toolbar.</ref></center>

|-
|  
| H2
| <center>'''Ctrl'''+'''Alt'''+'''2'''</center>
| <center><tt>Tags → Headings</tt></center>
| <center>[[File:Man1_headings.png]]</center>
| <center>Std<ref name="H"/></center>

|-
|  
| H3
| <center>'''Ctrl'''+'''Alt'''+'''3'''</center>
| <center><tt>Tags → Headings</tt></center>
| <center>[[File:Man1_headings.png]]</center>
| <center>Std<ref name="H"/></center>

|-
|  
| H4
| <center>'''Ctrl'''+'''Alt'''+'''4'''</center>
| <center><tt>Tags → Headings</tt></center>
| <center>[[File:Man1_headings.png]]</center>
| <center>Std<ref name="H"/></center>

|-
|  
| H5
| <center>'''Ctrl'''+'''Alt'''+'''5'''</center>
| <center><tt>Tags → Headings</tt></center>
| <center>[[File:Man1_headings.png]]</center>
| <center>Std<ref name="H"/></center>

|-
|  
| H6
| <center>'''Ctrl'''+'''Alt'''+'''6'''</center>
| <center><tt>Tags → Headings</tt></center>
| <center>[[File:Man1_headings.png]]</center>
| <center>Std<ref name="H"/></center>

|-
| Layout
| Bold
| <center>'''Ctrl'''+'''Alt'''+'''B'''</center>
| <center><tt>Tags → Format by layout</tt></center>
| <center>[[File:Man1_bold.png]]</center>
| <center>Std</center>

|-
|  
| Italic
| <center>'''Ctrl'''+'''Alt'''+'''I'''</center>
| <center><tt>Tags → Format by layout</tt></center>
| <center>[[File:Man1_italic.png]]</center>
| <center>Std</center>

|-
|  
| Underline
| <center>'''Ctrl'''+'''Alt'''+'''U'''</center>
| <center><tt>Tags → Format by layout</tt></center>
| <center> </center>
| <center> </center>

|-
|  
| Strikeout
| <center>'''Ctrl'''+'''Alt'''+'''S'''</center>
| <center><tt>Tags → Format by layout</tt></center>
| <center> </center>
| <center> </center>

|-
|  
| Strong
| <center>'''Ctrl'''+'''Alt'''+'''G'''</center>
| <center><tt>Tags → Format by context</tt></center>
| <center>[[File:Man1_bold.png]]</center>
| <center>Font</center>

|-
|  
| Emphasis
| <center>'''Ctrl'''+'''Alt'''+'''E'''</center>
| <center><tt>Tags → Format by context</tt></center>
| <center>[[File:Man1_italic.png]]</center>
| <center>Font</center>

|-
|  
| Subscript
| <center> </center>
| <center> </center>
| <center>[[File:Man1_fontsub.png]]</center>
| <center>Font</center>

|-
|  
| Superscript
| <center> </center>
| <center> </center>
| <center>[[File:Man1_fontsuper.png]]</center>
| <center>Font</center>

|-
|  
| Context Formatting
| <center> </center>
| <center> </center>
| <center>[[File:Man1_context.png]]</center>
| <center>Font</center>

|-
|  
| Paragraph
| <center>'''Ctrl'''+'''Alt'''+'''P'''</center>
| <center><tt>Tags → Format general</tt></center>
| <center>[[File:Man1_paragraph.png]]</center>
| <center>Std</center>

|-
|  
| Break
| <center>'''Ctrl'''+'''Alt'''+'''K'''</center>
| <center><tt>Tags → Format general</tt></center>
| <center>[[File:Man1_brbreak.png]]</center>
| <center>Std</center>

|-
|  
| Break and Clear
| <center> </center>
| <center> </center>
| <center>[[File:Man1_breakall.png]]</center>
| <center>Std</center>

|-
|  
| Non-Breaking Space
| <center>'''Ctrl'''+'''Alt'''+'''N'''</center>
| <center><tt>Tags → Format general</tt></center>
| <center>[[File:Man1_nbsp.png]]</center>
| <center>Std</center>

|-
|  
| Preformatted Text
| <center>'''Ctrl'''+'''Alt'''+'''F'''</center>
| <center><tt>Tags → Format general</tt></center>
| <center>[[File:Man1_fontpre.png]]</center>
| <center>Font</center>

|-
|  
| Rule...
| <center>'''Shift'''+'''Alt'''+'''R'''</center>
| <center><tt>Dialogs → General</tt></center>
| <center>[[File:Man1_hrule.png]]</center>
| <center>Std</center>

|-
|  
| Center
| <center> </center>
| <center> </center>
| <center>[[File:Man1_center.png]]</center>
| <center>Std</center>

|-
|  
| Align right
| <center>'''Ctrl'''+'''Alt'''+'''R'''</center>
| <center><tt>Tags → Format general</tt></center>
| <center>[[File:Man1_right.png]]</center>
| <center>Std</center>

|-
| Special signs
| Division sign
| <center>'''Ctrl'''+'''Alt'''+'''/'''</center>
| <center><tt>Tags → Special → Math-Science</tt></center>
| <center> </center>
| <center> </center>

|-
|  
| Less-than sign
| <center>'''Ctrl'''+'''Alt'''+''','''</center>
| <center><tt>Tags → Special → Math-Science</tt></center>
| <center> </center>
| <center> </center>

|-
|  
| Greater-than sign
| <center>'''Ctrl'''+'''Alt'''+'''.'''</center>
| <center><tt>Tags → Special → Math-Science</tt></center>
| <center> </center>
| <center> </center>

|-
| Fonts
| Font...
| <center>'''Shift'''+'''Alt'''+'''F'''</center>
| <center><tt>Dialogs → General</tt></center>
| <center>[[File:Man1_font.png]]</center>
| <center>Font</center>

|-
|  
| Base Font Size...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_font_base.png]]</center>
| <center>Font</center>

|-
|  
| Font Size + 1
| <center>'''Ctrl'''+'''Alt'''+'''<nowiki>=</nowiki>'''</center>
| <center><tt>Tags → Format general</tt></center>
| <center>[[File:Man1_fontp1.png]]</center>
| <center>Font</center>

|-
|  
| Font Size - 1
| <center>'''Ctrl'''+'''Alt'''+'''-'''</center>
| <center><tt>Tags → Format general</tt></center>
| <center>[[File:Man1_fontm1.png]]</center>
| <center>Font</center>

|-
| Table
| Table Wizard...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_tablewhiz.png]]</center>
| <center>Tbl</center>

|-
|  
| Table...
| <center>'''Shift'''+'''Alt'''+'''T'''</center>
| <center><tt>Dialogs → Table</tt></center>
| <center>[[File:Man1_table.png]]</center>
| <center>Tbl</center>

|-
|  
| Table Row...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_table_tr.png]]</center>
| <center>Tbl</center>

|-
|  
| Table Header...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_table_th.png]]</center>
| <center>Tbl</center>

|-
|  
| Table Data...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_table_td.png]]</center>
| <center>Tbl</center>

|-
|  
| Table
| <center>'''Ctrl'''+'''Alt'''+'''T'''</center>
| <center><tt>Tags → Table</tt></center>
| <center>[[File:Man1_table2.png]]</center>
| <center>Tbl</center>

|-
|  
| Table Row
| <center> </center>
| <center> </center>
| <center>[[File:Man1_table_tr2.png]]</center>
| <center>Tbl</center>

|-
|  
| Table Header
| <center> </center>
| <center> </center>
| <center>[[File:Man1_table_th2.png]]</center>
| <center>Tbl</center>

|-
|  
| Table Data
| <center> </center>
| <center> </center>
| <center>[[File:Man1_table_td2.png]]</center>
| <center>Tbl</center>

|-
|  
| Table Caption
| <center> </center>
| <center> </center>
| <center>[[File:Man1_table_capt.png]]</center>
| <center>Tbl</center>

|-
| Frame
| Frame Wizard...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_framewhiz.png]]</center>
| <center>Fr.</center>

|-
|  
| Frameset...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_frameset.png]]</center>
| <center>Fr.</center>

|-
|  
| Frame...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_frame.png]]</center>
| <center>Fr.</center>

|-
|  
| Frameset
| <center> </center>
| <center> </center>
| <center>[[File:Man1_frameset2.png]]</center>
| <center>Fr.</center>

|-
|  
| Frame
| <center> </center>
| <center> </center>
| <center>[[File:Man1_frame2.png]]</center>
| <center>Fr.</center>

|-
|  
| Noframes
| <center> </center>
| <center> </center>
| <center>[[File:Man1_frame_no.png]]</center>
| <center>Fr.</center>

|-
|  
| Target
| <center> </center>
| <center> </center>
| <center>[[File:Man1_frame_base.png]]</center>
| <center>Fr.</center>

|-
| Forms
| Form...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form.png]]</center>
| <center>Form</center>

|-
|  
| Input Button...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form_submit.png]]</center>
| <center>Form</center>

|-
|  
| Input Text...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form_text.png]]</center>
| <center>Form</center>

|-
|  
| Input Hidden...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form_hidden.png]]</center>
| <center>Form</center>

|-
|  
| Textarea...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form_textarea.png]]</center>
| <center>Form</center>

|-
|  
| Input Radio Button...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form_radio.png]]</center>
| <center>Form</center>

|-
|  
| Input Check Box...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form_check.png]]</center>
| <center>Form</center>

|-
|  
| Select...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form_select.png]]</center>
| <center>Form</center>

|-
|  
| Option...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form_option.png]]</center>
| <center>Form</center>

|-
|  
| Option Group...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form_optiongroup.png]]</center>
| <center>Form</center>

|-
|  
| Button...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_form_submit.png]]</center>
| <center>Form</center>

|-
| Lists
| Quicklist...
| <center>'''Shift'''+'''Alt'''+'''L'''</center>
| <center><tt>Dialogs → General</tt></center>
| <center>[[File:Man1_list.png]]</center>
| <center>List</center>

|-
|  
| Unordered List
| <center>'''Ctrl'''+'''Alt'''+'''L'''</center>
| <center><tt>Tags → List</tt></center>
| <center>[[File:Man1_list_ul.png]]</center>
| <center>List</center>

|-
|  
| Ordered List
| <center>'''Ctrl'''+'''Alt'''+'''O'''</center>
| <center><tt>Tags → List</tt></center>
| <center>[[File:Man1_list_ol.png]]</center>
| <center>List</center>

|-
|  
| List Item
| <center>'''Ctrl'''+'''Alt'''+'''M'''</center>
| <center><tt>Tags → List</tt></center>
| <center>[[File:Man1_list_li.png]]</center>
| <center>List</center>

|-
|  
| Definition List
| <center> </center>
| <center> </center>
| <center>[[File:Man1_list_dl.png]]</center>
| <center>List</center>

|-
|  
| Definition Term
| <center> </center>
| <center> </center>
| <center>[[File:Man1_list_dt.png]]</center>
| <center>List</center>

|-
|  
| Definition
| <center> </center>
| <center> </center>
| <center>[[File:Man1_list_dd.png]]</center>
| <center>List</center>

|-
| Anchors
| Anchor...
| <center>'''Shift'''+'''Alt'''+'''A'''</center>
| <center><tt>Dialogs → General</tt></center>
| <center>[[File:Man1_anchor.png]]</center>
| <center>Std</center>

|-
| Email
| Email...
| <center>'''Shift'''+'''Alt'''+'''E'''</center>
| <center><tt>Dialogs → General</tt></center>
| <center>[[File:Man1_email.png]]</center>
| <center>Std</center>

|-
| Images
| Insert Image...
| <center>'''Shift'''+'''Alt'''+'''I'''</center>
| <center><tt>Dialogs → General</tt></center>
| <center>[[File:Man1_image.png]]</center>
| <center>Std</center>

|-
|  
| Insert Thumbnail...
| <center>'''Shift'''+'''Alt'''+'''N'''</center>
| <center><tt>Dialogs → General</tt></center>
| <center>[[File:Man1_thumbnail.png]]</center>
| <center>Std</center>

|-
|  
| Multi Thumbnails...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_multithumbs.png]]</center>
| <center>Std</center>

|-
| Comment
|  
| <center>'''Ctrl'''+'''Alt'''+'''C'''</center>
| <center><tt>Tags</tt></center>
| <center>[[File:Man1_comment.png]]</center>
| <center>Std</center>

|-
| Stylesheets
| Create Style...
| <center>'''Shift'''+'''Alt'''+'''S'''</center>
| <center><tt>Dialogs → CSS</tt></center>
| <center>[[File:Man1_cssnewstyle.png]]</center>
| <center>CSS</center>

|-
|  
| Div...
| <center>'''Shift'''+'''Alt'''+'''D'''</center>
| <center><tt>Dialogs → CSS</tt></center>
| <center>[[File:Man1_cssdiv.png]]</center>
| <center>CSS</center>

|-
|  
| Span...
| <center> </center>
| <center> </center>
| <center>[[File:Man1_cssspan.png]]</center>
| <center>CSS</center>

|-
| Tags
| Editing
| <center>'''F3'''</center>
| <center><tt>Dialogs</tt></center>
| <center> </center>
| <center> </center>

|-
|  
| Autoclose
| <center>'''Ctrl'''+'''T'''</center>
| <center><tt>Document</tt></center>
| <center> </center>
| <center> </center>

|-
| colspan="6" | <references/>

|}

{{Man2bottom
|prev=Man 2 ch09
|up=Man 2 ch09
|next=Man 2 pt03
|prevname= Chapter IX. Shortcuts available within Bluefish
|nextname=Part 3. Developing Bluefish
}}

Man 2 ch08s12

2010-07-09T00:24:44Z

Bill Valaski: moved Man 2 ch08s12 to Highlight Patterns Modification: Title updates (BV)

#REDIRECT [[Highlight Patterns Modification]]

Highlight Patterns Modification

2010-07-09T00:24:44Z

Bill Valaski: moved Man 2 ch08s12 to Highlight Patterns Modification: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=12. Modifying the highlighting patterns
|prev=Man 2 ch08s11
|Subtitle=Chapter VIII. Customising Bluefish
|next=Man 2 ch09
}}

The highlight patterns are build from Perl compatible regular expressions. A pattern has options for coloring and styling the text it matches. Within a match other patterns can be used to color parts of that match. There are three types of patterns:

# Start pattern and end pattern: that is two distinct patterns, match from the start pattern to the end pattern
# Only start pattern: that is a unique pattern that matches from start to end
# Subpattern from parent: that is a subpattern from the parent pattern, specified by the range in the parent pattern.

One specific pattern can also be used within several other parent patterns. The parent-match option is a regular expression that defines all parents for a certain pattern. If empty it will default to ^top$, so basically it will be on the top level.

So how does it work? Lets take a look at a little example text, a piece of PHP code within some HTML code:

<nowiki><p align="center"></nowiki>
<nowiki><?php</nowiki>
// this is a comment ?>
?>

The first thing the highlighting engine does is finding the pattern that has the lowest match. Using the default patterns for PHP, the pattern named HTML:

[[File:Man2_highlighting_pattern1.png|none|frame|The HTML Pattern]]

has a match at position 0:

<nowiki><p align="center"></nowiki>

So now the highlighting engine searches for the lowest match in all subpatterns of HTML, in the region matched by a type 2 pattern. Again, the lowest match will count. The pattern named <nowiki><html> Tags</nowiki>:

[[File:Man2_highlighting_pattern2.png|none|frame|The <html> Tags Pattern]]

has a match at position 1. This pattern is a type 3 pattern, so it matches a subpattern of the parent:

p

The match from subpattern <nowiki><html> Tags</nowiki> ends at position 2 and it does not have any child patterns, so the highlighting engine continues at position 2 with all subpatterns from HTML. A type 2 pattern named HTML Attributes:

[[File:Man2_highlighting_pattern3.png|none|frame|The HTML Attributes Pattern]]

has the lowest match:

align="center"

This pattern does have a child pattern, again a type 3 pattern called HTML Attribute Contents:

[[File:Man2_highlighting_pattern4.png|none|frame|The HTML Attribute Contents Pattern]]

matching:

"center"

The pattern HTML Attribute Contents does not have any child patterns, and subpatterns of HTML Attributes do not have any more matches, and also HTML subpatterns do not have any more matches. So we are back on the main level, the remaining code to highlight is:

<nowiki><?php</nowiki>
// this is a comment ?>
?>

Now a pattern named PHP Block:

[[File:Man2_highlighting_pattern5.png|none|frame|The PHP Block Pattern]]

has the lowest match. This is a type 1 pattern, so the highlight engine continues with all the remaining code, but it will not only search for the lowest match of the child patterns of PHP Block, but it will also ue it for the end pattern of PHP Block. The lowest match in this example is a pattern named Comment (C++/single line):

[[File:Man2_highlighting_pattern6.png|none|frame|The Comment (C++/single line) Pattern]]

As you can see the ?> within the comment does not end the <tt>php</tt> pattern, because it lies within a subpattern of PHP Block:

// this is a comment ?>

The pattern Comment (C++/single line) does not have any child patterns, so the remaining code for the PHP subpatterns is:

?>

It is very obvious now, the lowest match will be the end pattern of the php pattern, so we're back on the main level, and we have matched all of the code!

[[File:Man2_syntax_highlighting_example.png|none|frame|Syntax Highlighting Example]]

The config file for highlighting is a colon separated array with the following content:

mode:
patternname:
case_sensitive(0-on/1-off):
start reg-ex:
end reg-ex:
start & end pattern(1), only start(2), subpattern(3):
parent-match:
foreground-color:
background-color:
don't change weight(0), non-bold(1), bold(2):
don't change style(0), non-italic(1), italic(2):

The same options are found in the syntax highlighting preferences.

As an exercise you may want to add the highlighting patterns for the xsl stylesheet file type created previously. They will be based on the xml patterns with just small changes.

{{note|text=If you check the force bold weight check box, you should also check that the font you use has a bold variant in the Editor tab of the Preferences panel.}}

{{Man2bottom
|prev=Man 2 ch08s11
|up=Man 2 ch08
|next=Man 2 ch09
|prevname= 11. Modifying the files filters
|nextname=Chapter IX. Shortcuts available within Bluefish
}}

Man 2 ch08s11

2010-07-09T00:23:24Z

Bill Valaski: moved Man 2 ch08s11 to File Filters

#REDIRECT [[File Filters]]

File Filters

2010-07-09T00:23:24Z

Bill Valaski: moved Man 2 ch08s11 to File Filters

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=11. Modifying the files filters
|prev=Man 2 ch08s10
|Subtitle=Chapter VIII. Customising Bluefish
|next=Man 2 ch08s12
}}

The files filters allow you to group files types from the usage point of view. Once a file filter is created, you can view, hide, or open files based on a filter in the File browser contextual menu.

The file filters consist of:

# a label.
# whether or not the filter as defined in the Filetypes in filter hides the retrieved files or shows them.
# a list of filetypes, as defined in the Filetypes part, separated by a colon.

You add, modify, delete, or move file types the same way it is described in [[Man 2 ch07s08#8.1. Customizing browsers|external-browsers Section 8.1, “Customizing browsers”]].

'''Example VIII.2. Adding a file filter'''

Following with our example in [[Man 2 ch08s10|Section 10, “Modifying file types”]], we can add a stylesheet filter to group css and xsl stylesheets together.

To add a stylesheet filter, execute the following steps:

# Click on the Preferences... icon in the main tool bar to access the Edit preferences panel.
# Click on the Filetypes tab to display the Filetypes panel.
# Click on the Add button in the Filefilters part at the bottom. A new line will be shown, with an Untitled label.
# Double-click on the label to allow editing, and enter the string you want to appear in the Label field. Here enter <tt>All stylesheets</tt>.
# Check the Inverse filter box.
# Click in the Filetypes in filter field and enter the filetypes you want to group together, separated with a colon. Here it is <tt>stylesheet:xsl stylesheet</tt>.
# Click on the OK button to save and close the panel.

{{important|text=The file types used in the Filetypes in filter match those defined in the Filetypes part. Do not confuse them with the file extensions. For example the C programming file filter matches c and image filetypes, i.e. files whose extensions are .c, .h, etc...}}

{{Man2bottom
|prev=Man 2 ch08s10
|up=Man 2 ch08
|next=Man 2 ch08s12
|prevname= 10. Modifying file types
|nextname=12. Modifying the highlighting patterns
}}

Man 2 ch08s10

2010-07-09T00:22:27Z

Bill Valaski: moved Man 2 ch08s10 to File Types Handling: Title updates (BV)

#REDIRECT [[File Types Handling]]

File Types Handling

2010-07-09T00:22:27Z

Bill Valaski: moved Man 2 ch08s10 to File Types Handling: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=10. Modifying file types
|prev=Man 2 ch08s09
|Subtitle=Chapter VIII. Customising Bluefish
|next=Man 2 ch08s11
}}

In the Filetypes tab of the Edit preferences panel you can define all file types that should be recognized by bluefish.

The file types consist of:

# a label (this label is also used in the file filters, and in the highlighting patterns).
# a list of extensions, separated by a colon (:).
# the highlighting update characters. Upon a key press of one of these characters, the highlighting engine will refresh the highlighting around the cursor. If this field is empty, any character will force the highlighting engine to refresh. Special characters like the tab and the newline can be entered as \t and \n, the backslash itself is entered as \\.
# the icon location for this file type.
# whether this file type is editable by Bluefish (whether or not Bluefish should try to open it after a double click).
# a regular expression that can be used to detect the file type if a file without extension is loaded.
# <nowiki>the auto-tag-closing mode. A value of 0 means that Bluefish should not close XML/HTML tags, a value of 1 means it should close the tags XML style (<br />), a value of 2 means HTML style.</nowiki>

You add, modify, delete, or move file types the same way it is described in [[Man 2 ch07s08# 8.1. Customizing browsers|external-browsers Section 8.1, “Customizing browsers”]].

'''Example VIII.1. Adding a file type'''

Let's say you use DocBook xsl stylesheets. Those files are recognized by bluefish as xml files, but they do not appear with the xml icon in the file browser as their extension (.xsl) is not listed in the Extensions field of the Filetypes tab of the Edit preferences panel.

On the other hand, adding them to the xml file type would impede to group them into a stylesheet filter, where they belong from a semantical point of view. And you cannot add them to the provided stylesheet filetype made for css stylesheet, since the highlighting patterns are different.

To add an xsl stylesheet file type, execute the following steps:

# Click on the Preferences... icon in the main tool bar to access the Edit preferences panel.
# Click on the Filetypes tab to display the Filetypes panel.
# Click on the Add button in the Filetypes part. A new line will be shown, with an Untitled label.
# Double-click on the label to allow editing, and enter the string you want to appear in the Label field. Here enter <tt>xsl stylesheet</tt>.
# Click in the Extensions zone and enter the extension: <tt>.xsl</tt>.
# Click in the Update chars field of the xml filetype line to copy and paste this field into the corresponding field of the xsl stylesheet filetype line. Once the field is highlighted, use '''Ctrl'''+'''C''' to copy the field. Click again in the Update chars field of the xsl stylesheet filetype line and use '''Ctrl'''+'''V''' to paste the field.
# For the icon field, you can either use the xml icon path used in the Icon field of the xml filetype line or better create a new icon based on the xml one by changing its colors with the Colormap Rotation filter of gimp, located under the FiltersColorsMap... menu.<br/> To do it, first copy the xml icon on your Desktop, apply the filter on it, and save it under bluefish_icon_xsl.png in a dedicated folder in your home directory, for example ~/Pictures for Mac users.<br/> Whichever icon you decided to use, click on the Icon field to enter its path.
# Check the Editable box, if it is not already checked.
# Copy and paste Content regex field of the xml filetype line into the corresponding field of the xsl stylesheet filetype line.
# Set the Auto close tags mode to 1.
# Click on the OK button to save and close the panel.

{{note|text=If you want to enter more than one extension in the Extensions field, you should separate them with a colon.}}

{{note|text=When you define a new filetype, you should also provide new highlighting patterns.}}

{{Man2bottom
|prev=Man 2 ch08s09
|up=Man 2 ch08
|next=Man 2 ch08s11
|prevname= 9. Customizing the user interface
|nextname=11. Modifying the files filters
}}

Man 2 ch08s09

2010-07-09T00:21:40Z

Bill Valaski: moved Man 2 ch08s09 to User Interface Customization: Title updates (BV)

#REDIRECT [[User Interface Customization]]

User Interface Customization

2010-07-09T00:21:40Z

Bill Valaski: moved Man 2 ch08s09 to User Interface Customization: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=9. Customizing the user interface
|prev=Man 2 ch08s08
|Subtitle=Chapter VIII. Customising Bluefish
|next=Man 2 ch08s10
}}

The User interface tab of the Edit preferences panel allows you to customize most part of the user interface:

[[File:Man2_prefs_ui_tab.png|none|frame|The User Interface Preference Panel]]

{{Man2bottom
|prev=Man 2 ch08s08
|up=Man 2 ch08
|next=Man 2 ch08s10
|prevname= 8. Customizing files handling and browsing
|nextname=10. Modifying file types
}}

Man 2 ch08s08

2010-07-09T00:20:54Z

Bill Valaski: moved Man 2 ch08s08 to File Handling and Browsing Customization: Title updates (BV)

#REDIRECT [[File Handling and Browsing Customization]]

File Handling and Browsing Customization

2010-07-09T00:20:54Z

Bill Valaski: moved Man 2 ch08s08 to File Handling and Browsing Customization: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=8. Customizing files handling and browsing
|prev=Man 2 ch08s07
|Subtitle=Chapter VIII. Customising Bluefish
|next=Man 2 ch08s09
}}

{{toc}}

The Files tab of the Edit preferences panel allows you to set some options related to the way files are handled and displayed in the file browser.

[[File:Man2_prefs_files_tab.png|none|frame|The Files Preference Panel]]

== 8.1. Setting the encoding meta tag on save ==
Apart from setting the default character encoding in the Files tab of the Edit preferences panel, you may also instruct bluefish to set the encoding meta tag when you modify the document character set encoding.

Note that, if the encoding meta tag does not exist, it is inserted in the file, otherwise it is changed. Either modification occurs immediately.

== 8.2. Setting the default base directory ==
You can set a default base directory in the Files tab of the Edit preferences panel.

This directory will serve as the initial point for the file browser.

== 8.3. Merging file browser views ==
By default, the file browser uses separate views for files and directories.

You can have a single view by unchecking the Use separate file and directory view option in the Files tab of the Edit preferences panel.

== 8.4. Backup files ==
By default, a backup file is created on save in the same directory as the original file based on the same filename with the exception that a '''~''' suffix is added. This backup file is deleted on closing the file.

You can change this behaviour in the Files tab of the Edit preferences panel.

When the backup fails to be created, you can choose what to do:

[[File:Man2_prefs_askonbackup.png|none|frame|Choosing an Action on Backup Failure]]

== 8.5. Using multiple instances of a file ==
A nice feature of bluefish is it allows you to open multiple instances of a file. Combined with either launching two instances of bluefish or opening the same file in two windows, it eases the modification of a file in one window while browsing it in another one.

This feature can be disabled in the Files tab of the Edit preferences panel.

{{warning|text=Be aware that the last closed instance of the file wins. Hence it is important that you remember which instance is the modified one. You can, for example, always open the file to be modified on the left side of your screen, the file to be browsed on the right side.}}

{{Man2bottom
|prev=Man 2 ch08s07
|up=Man 2 ch08
|next=Man 2 ch08s09
|prevname= 7. Changing the author meta tag on the fly
|nextname=9. Customizing the user interface
}}

Man 2 ch08s05

2010-07-09T00:19:49Z

Bill Valaski: moved Man 2 ch08s05 to Bookmarks Path Customization: Title updates (BV)

#REDIRECT [[Bookmarks Path Customization]]

Bookmarks Path Customization

2010-07-09T00:19:49Z

Bill Valaski: moved Man 2 ch08s05 to Bookmarks Path Customization: Title updates (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=5. Customizing the bookmarks path
|prev=Man 2 ch08s04
|Subtitle=Chapter VIII. Customising Bluefish
|next=Man 2 ch08s06
}}

When you add bookmarks to document, the name of the file it refers to is displayed from the base directory. You can choice another path from the Bookmarks filename display pop up menu in the Editor tab of the Edit preferences panel:

[[File:Man2_prefs_bookmarks_path.png|none|frame|The Bookmarks Path Pop up Menu in Preferences]]

{{Man2bottom
|prev=Man 2 ch08s04
|up=Man 2 ch08
|next=Man 2 ch08s06
|prevname= 4. Editor appearance
|nextname=6. Customizing the html tags style
}}

Man 2 ch08s07

2010-07-01T01:40:14Z

Bill Valaski: moved Man 2 ch08s07 to Author Meta Tag: Title updated (BV)

#REDIRECT [[Author Meta Tag]]

Author Meta Tag

2010-07-01T01:40:14Z

Bill Valaski: moved Man 2 ch08s07 to Author Meta Tag: Title updated (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=7. Changing the author meta tag on the fly
|prev=Man 2 ch08s06
|Subtitle=Chapter VIII. Customising Bluefish
|next=Man 2 ch08s08
}}

One interesting feature in the HTML tab of the Edit preferences panel is that you can let bluefish update the author meta tag on save.

Let's say you created an html file with an author meta tag while you were logged in as user ''foo''. On save bluefish will fill up the contents attribute of the author meta tag with the full name associated with the ''foo'' user:

[[File:Man2_author_meta_name1.png|none|frame|The Author Meta Tag filled in on Save]]

You share this html file with another user ''bar'' or you change the owner of the file to ''bar''. When you modify the html file while logged in as user ''bar'', the author meta tag is updated to reflect the new author on save, providing that the user ''bar'' has write permission on the file:

[[File:Man2_author_meta_name2.png|none|frame|Update of the Author Meta Tag on Save]]

{{warning|text=If you do not want that the author meta tag be changed while editing the file under another user's login, uncheck the box.}}

{{Man2bottom
|prev=Man 2 ch08s06
|up=Man 2 ch08
|next=Man 2 ch08s08
|prevname= 6. Customizing the html tags style
|nextname=8. Customizing files handling and browsing
}}

Man 2 ch08s06

2010-07-01T01:38:04Z

Bill Valaski: moved Man 2 ch08s06 to HTML Tags Style Customization: Title updated (BV)

#REDIRECT [[HTML Tags Style Customization]]

HTML Tags Style Customization

2010-07-01T01:38:04Z

Bill Valaski: moved Man 2 ch08s06 to HTML Tags Style Customization: Title updated (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=6. Customizing the html tags style
|prev=Man 2 ch08s05
|Subtitle=Chapter VIII. Customising Bluefish
|next=Man 2 ch08s07
}}

The HTML tab of the Edit preferences panel provides you with some options to change the style of the html tags:

[[File:Man2_prefs_html_tab.png|none|frame|The HTML Tab in Preferences]]

{{Man2bottom
|prev=Man 2 ch08s05
|up=Man 2 ch08
|next=Man 2 ch08s07
|prevname= 5. Customizing the bookmarks path
|nextname=7. Changing the author meta tag on the fly
}}

Man 2 ch08s04

2010-07-01T01:36:56Z

Bill Valaski: moved Man 2 ch08s04 to Editor Appearance Customization: Title updated (BV)

#REDIRECT [[Editor Appearance Customization]]

Editor Appearance Customization

2010-07-01T01:36:56Z

Bill Valaski: moved Man 2 ch08s04 to Editor Appearance Customization: Title updated (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=4. Editor appearance
|prev=Man 2 ch08s03
|Subtitle=Chapter VIII. Customising Bluefish
|next=Man 2 ch08s05
}}

Most of the editor appearance depends on your GKT theme, which may be customized through the ~/.gtkrc-2.0 resource file.

Parts that you may want to customize through that resource file are among others:

* the background color of the editor
* the colors of GUI elements
* the position of arrows in a drop down list

You will find examples of themes resource files while searching for a gtkrc file in a gtk-2.0 folder within the various directories under $prefix/share/themes/, where $prefix is your installation prefix (it may be /usr, /usr/local, /sw, /opt, etc.).

{{note|text=You should not customize those files, instead customize ~/.gtkrc-2.0. If the file does not already exist in your home directory, just create it with: <tt>'''$''' touch ~/.gtkrc-2.0</tt>}}

Here is an example made on a Crux theme:
style "bluefish"
{
<nowiki># For up and down arrows grouped together at right side</nowiki>
GtkNotebook::has_secondary_forward_stepper = 1
GtkNotebook::has_secondary_backward_stepper = 1

<nowiki># Editor background color </nowiki>
<nowiki># (background of editor view)</nowiki>
<nowiki>base[[Man 1 NORMAL]]="#fcfff5"</nowiki>

<nowiki># GUI normal background color</nowiki>
<nowiki># (most of the GUI)</nowiki>
<nowiki>bg[[Man 1 NORMAL]]="#dbe9e9"</nowiki>

<nowiki># GUI highlighted background color</nowiki>
<nowiki>#(GUI when mouse over elements)</nowiki>
<nowiki>bg[[Man 1 PRELIGHT]]="#c6e9e9"</nowiki>

<nowiki># GUI unactive background color</nowiki>
<nowiki>#(GUI disabled elements)</nowiki>
<nowiki>bg[[Man 1 INSENSITIVE]]="#9fb2b2"</nowiki>

<nowiki># GUI active background color</nowiki>
<nowiki>#(GUI enabled elements)</nowiki>
<nowiki>bg[[Man 1 ACTIVE]]="#c7d4d4"</nowiki>
}
class "GtkWidget" style "bluefish"

{{note|text=You may give any name to the style on the first line, provided that you use the same on the last line.}}

{{note|text=The customization applies to any Gtk application.}}

It will give this appearance to bluefish:

[[File:Man1_gui_appearance.png|none|frame|Bluefish with a customized Gtk Theme]]

Other options for the Editor are available in the Editor tab of the Edit preferences panel accessible via the Edit preferences... button in the main tool bar. In particular you may want to customize the font of the editor, the end of line wrapping, and the undo history size:

[[File:Man2_prefs_editor_tab.png|none|frame|The Editor Tab in Preferences]]

{{Man2bottom
|prev=Man 2 ch08s03
|up=Man 2 ch08
|next=Man 2 ch08s05
|prevname= 3. Showing backup files
|nextname=5. Customizing the bookmarks path
}}

Man 2 ch08s02

2010-07-01T01:36:14Z

Bill Valaski: moved Man 2 ch08s02 to Invisible Files and Folders: Title updated (BV)

#REDIRECT [[Invisible Files and Folders]]

Invisible Files and Folders

2010-07-01T01:36:14Z

Bill Valaski: moved Man 2 ch08s02 to Invisible Files and Folders: Title updated (BV)

{{Man2top
|lang=en
|rev=2.0.0
|st=d
|Title=2. Showing hidden files and folders
|prev=Man 2 ch08
|Subtitle=Chapter VIII. Customising Bluefish
|next=Man 2 ch08s03
}}

By default, invisible files and folders are not shown in the file browser tab of the side panel.

If you want to see them at a given level of the files system hierarchy, right click on the desired folder name in the file browser within the side panel and toggle Show hidden files in the contextual menu.

Here is how to view all visible files and folders in the whole system:

[[File:Man2_prefs_show_invisible.png|none|frame|Turning Files and Folders Visibility ON]]

{{tip|text=This feature is very convenient for Mac users when used with caution, since combined with the Delete contextual menu in the file browser, it allows you, for example, to get rid of files generated by cvs on conflicts within bluefish.}}

{{Man2bottom
|prev=Man 2 ch08
|up=Man 2 ch08
|next=Man 2 ch08s03
|prevname= Chapter VIII. Customising Bluefish
|nextname=3. Showing backup files
}}

Man 2 ch07s08

2010-07-01T01:32:20Z

Bill Valaski: moved Man 2 ch07s08 to External Programs and Filters: Title updated (BV)

#REDIRECT [[External Programs and Filters]]