Manual 2 ToC: Difference between revisions

From Bluefish Wiki
Jump to navigation Jump to search
(Moved "Editing area" to the updated part of the ToC)
 
(18 intermediate revisions by 2 users not shown)
Line 14: Line 14:
|}
|}


{{Note|text=Note that the manual is currently being reworked. Many pages are outdated, others not yet available. They will be made available in the near future.}}


'''Bluefish 2.0 Manual'''  
Here an overview of what has been done so far:
{|class="wikitable" style="margin:auto"
!As per
!What has been done
|-
|2022-12-21
|All unnumbered sections under ''Preface'' and ''Getting and Installing Bluefish'' have been updated
|-
|2022-12-22
|Finished reviewing all sections under ''Preface'' and ''Getting and Installing Bluefish'', reviewed and updated ''Starting Bluefish''
|}


== [[Man 2 pr01|Preface]] ==
'''Bluefish 2.2 Manual'''
About this Manual ¤ What is Bluefish? ¤ History of Bluefish ¤ Main Features of Bluefish ¤ How Stable is Bluefish? ¤ Contact Us
== [[Man 2 pt01|Getting and Installing Bluefish]]  ==
;For Bluefish 2, please see: [[Installing Bluefish]] / [[Compiling Bluefish from source]]
old pages from Bluefish 1 Manual:
=== [[Man 2 ch01|<del>Getting Bluefish</del>]] ===
Choosing a Version ¤ How and When Updates are Released ¤ Operating Systems Supported by Bluefish<br />
[[Man 2 ch01s02|2. Latest Stable Version]] ¤ [[Man 2 ch01s03|3. Latest Snapshot Version]] ¤ [[Man 2 ch01s04|4. Latest Developmental Version]]


=== [[Man 2 ch02|<del>Installing Bluefish</del>]] ===
== [[Preface|Preface]] ==
[[Man 2 ch02#1. Requirements|1. Requirements]] ¤ [[Man 2 ch02s02|2. Quick Standard Installation]] ¤ [[Man 2 ch02s03|3. System Specific Installation Issues]]<br />
*[[About this Manual]]
[[Man 2 ch02s04|4. Installing a Bluefish Source Distribution]] ¤ Quick Installation Overview ¤ Installing from Development Source Tree|4.2. Installing from Development Source Tree ¤ Problems Compiling?<br />
*[[What is Bluefish?]]
[[Man 2 ch02s05|5. Configure Options]] ¤ Standard configuration flags ¤ Flags personal to bluefish<br />
*[[History of Bluefish]]
[[Man 2 ch02s06|6. Installing a Binary Distribution]] ¤ [[Man 2 ch02s07|7. Post-installation Setup]]
*[[Main Features of Bluefish]]
*[[How Stable is Bluefish?]]
*[[Contact Us]]
== [[Getting and Installing Bluefish|Getting and Installing Bluefish]] ==
*[[Operating Systems Supported by Bluefish]]
*[[Man 2 ch02#1. Requirements|Requirements]]
*[[Choosing a Version]]
*[[Latest Stable Version|Latest Stable Version]]
*[[Getting Bluefish - Latest Snapshot|Latest Snapshot Version]]
*[[Getting Bluefish - Latest Development Version|Latest Developmental Version]]
*[[How and When Updates are Released]]
*[[Installing Bluefish]]
*[[Installing Bluefish - System Issues| System Specific Installation Issues]]
*[[Installing Bluefish - Install from Source Code|Installing a Bluefish Source Distribution]]
*[[Compiling Bluefish from source]]
*[[Installing Bluefish - Install from Source Code Options|Configure Options]]
*[[Installing Bluefish - Install from Binary Distribution|Installing a Binary Distribution]]
*[[Installing Bluefish - Post-Installation Checklist|Post-installation Setup]]<br />


== [[Man 2 pt02|Using Bluefish]]  ==
 
=== [[Man 2 ch03|Starting Bluefish]] ===
== [[Using Bluefish|Using Bluefish]]  ==
[[Man 2 ch03#1. Launching Bluefish|1. Launching Bluefish]] ¤ [[Man 2 ch03s02|2. Command line options]]
*[[Launching Bluefish|Starting Bluefish]]
=== [[Man 2 ch04|The user interface]] ===
*[[Editing Area#1. Editing Area|Editing Area]]
[[Man 2 ch04#1. Editing Area|1. Editing Area]] ¤ [[Man 2 ch04s02|2. Menus and Tool Bars]] ¤ [[Man 2 ch04s03|3. Side Panel]] ¤ [[Man 2 ch04s04|4. Status Bar]] ¤ [[Man 2 ch04s05|5. Help Menu]]
 
=== [[Editing Area|The user interface]] ===
[[Menus and Tool Bars|2. Menus and Tool Bars]] ¤ [[Side Panel|3. Side Panel]] ¤ [[Interface - Status Bar|4. Status Bar]] ¤ [[Interface - Help Menu|5. Help Menu]]
=== [[Preferences|Preferences]] ===  
=== [[Preferences|Preferences]] ===  
=== [[Man 2 ch05|Working with files and folders]] ===
=== [[Creating Files|Working with files and folders]] ===
[[Man 2 ch05#1. Creating files|1. Creating files]] ¤ [[Man 2 ch05s02|2. Managing directories]] ¤ [[Man 2 ch05s03|3. Opening files]] ¤ [[Man 2 ch05s04|4. Saving files]] ¤ [[Man 2 ch05s05|5. Renaming files]] ¤ [[Man 2 ch05s06|6. Deleting files]] ¤ [[Man 2 ch05s07|7. Closing files]] ¤ [[Man 2 ch05s08|8. Inserting files]]<br />
[[Creating Files#1. Creating files|1. Creating files]] ¤ [[Managing Directories|2. Managing directories]] ¤ [[Opening Files|3. Opening files]] ¤ [[Saving Files|4. Saving files]] ¤ [[Renaming Files|5. Renaming files]] ¤ [[Deleting files|6. Deleting files]] ¤ [[Closing Files|7. Closing files]] ¤ [[Inserting files|8. Inserting files]]<br />
[[Man 2 ch05s09|9. Editing]] ¤ Undo and Redo ¤ Cut, Copy, and Paste ¤ Input methods<br />
[[Editing|9. Editing]] ¤ Undo and Redo ¤ Cut, Copy, and Paste ¤ Input methods<br />
[[Man 2 ch05s10|10. 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<br />
[[Basic Find and Replace|10. 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<br />
[[Man 2 ch05s11|11. File types]] ¤ Syntax highlighting<br />
[[File Types (1/2)|11. File types]] ¤ Syntax highlighting<br />
[[Man 2 ch05s12|12. More on files]] ¤ Remote files ¤ Character encoding ¤ Open advanced
[[File Types (2/2)|12. More on files]] ¤ Remote files ¤ Character encoding ¤ Open advanced
=== [[Man 2 ch06|Navigation and Managing documents]] ===  
=== [[Navigating through a document|Navigation and Managing documents]] ===  
Navigating through a document<br />
Navigating through a document<br />
[[Man 2 ch06s02|2. Navigating through many documents]] ¤ [[Man 2 ch06s03|3. Projects]]<br />
[[Go Menu and Document Navigation|2. Navigating through many documents]] ¤ [[Projects|3. Projects]]<br />
[[Man 2 ch06s04|4. Bookmarks]] ¤ Generating several bookmarks at once]]<br />
[[Bookmarks|4. Bookmarks]] ¤ Generating several bookmarks at once]]<br />
[[Man 2 ch06s05|5. Find and Replace]] ¤ Find Again ¤ Find from Selection ¤ Find and Replace Using Regular Expressions<br />
[[Find and Replace|5. Find and Replace]] ¤ Find Again ¤ Find from Selection ¤ Find and Replace Using Regular Expressions<br />
[[Man 2 Templates| Templates]]
[[Templates| Templates]]
=== [[Man 2 ch07|More than a Text Editor]] ===  
=== [[Indenting|More than a Text Editor]] ===  
[[Man 2 ch07#1. Indenting|1. Indenting]] ¤ [[Man 2 ch07s02|2. Autocompletion]] was Auto tag closing ¤ [[Man 2 ch07s03|3. Spell checker]] ¤ [[Man 2 ch07s04|4. Function reference]]<br />
[[Indenting#1. Indenting|1. Indenting]] ¤ [[Autocompletion|2. Autocompletion]] ¤ [[Hidden features]] ¤ [[Spell checker|3. Spell checker]] ¤ [[Programming and Markup Languages Function Reference|4. Function reference]]<br />
[[Man 2 ch07s05|5. HTML]] ¤ Special find and replace features ¤ Thumbnail generation<br />
[[HTML Editing|5. HTML]] ¤ Special find and replace features ¤ Thumbnail generation<br />
[[Man 2 ch07s06|6. Customizing the Quick bar]]<br />
[[Quick Bar Customization|6. Customizing the Quick bar]]<br />
[[Man 2 ch07s07|7. Snippets plugin]] (was Custom menu in Bluefish 1) ¤ Adding a snippet dialog ¤ Adding a snippet replace dialog<br />
[[Snippets plugin|7. Snippets plugin]] (was Custom menu in Bluefish 1) ¤ Adding a snippet dialog ¤ Adding a snippet replace dialog<br />
[[Man 2 ch07s08|8. External programs, filters]] ¤  Customizing browsers ¤ Customizing Commands menu ¤ Customizing Ouputbox menu  
[[External Programs and Filters|8. External programs, filters]] ¤  Customizing browsers ¤ Customizing Commands menu ¤ Customizing Ouputbox menu
=== [[Man 2 ch08|Customising Bluefish]] ===   
 
=== [[Modifying shortcut keys|Customising Bluefish]] ===   
Modifying shortcut keys<br />
Modifying shortcut keys<br />
[[Man 2 ch08s02|2. Showing hidden files and folders]] ¤ [[Man 2 ch08s03|3. Showing backup files]] ¤ [[Man 2 ch08s04|4. Editor appearance]] ¤ [[Man 2 ch08s05|5. Customizing the bookmarks path]] ¤ [[Man 2 ch08s06|6. Customizing the html tags style]] ¤ [[Man 2 ch08s07|7. Changing the author meta tag on the fly]]<br />
[[Invisible Files and Folders|2. Showing hidden files and folders]] ¤ [[Showing backup files|3. Showing backup files]] ¤ [[Editor Appearance Customization|4. Editor appearance]] ¤ [[Bookmarks Path Customization|5. Customizing the bookmarks path]] ¤ [[HTML Tags Style Customization|6. Customizing the html tags style]] ¤ [[Author Meta Tag|7. Changing the author meta tag on the fly]]<br />
[[Man 2 ch08s08|8. Customizing files handling and browsing]] ¤ Setting the encoding meta tag on save ¤ Setting the default base directory ¤ Merging file browser views ¤ 8.4. Backup files ¤ 8.5. Using multiple instances of a file<br />
[[File Handling and Browsing Customization|8. Customizing files handling and browsing]] ¤ Setting the encoding meta tag on save ¤ Setting the default base directory ¤ Merging file browser views ¤ 8.4. Backup files ¤ 8.5. Using multiple instances of a file<br />
[[Man 2 ch08s09|9. Customizing the user interface]] ¤ [[Man 2 ch08s10|10. Modifying file types]] ¤ [[Man 2 ch08s11|11. Modifying the files filters]] ¤ [[Man 2 ch08s12|12. Modifying the highlighting patterns]]
[[User Interface Customization|9. Customizing the user interface]] ¤ [[File Types Handling|10. Modifying file types]] ¤ [[File Filters|11. Modifying the files filters]] ¤ [[Highlight Patterns Modification|12. Modifying the highlighting patterns]]
*[[Man 2 ch09|IX. Shortcuts available within Bluefish]] ¤ [[Man 2 ch09#1. General Shortcuts|1. General Shortcuts]] ¤ [[Man 2 ch09s02|2. HTML Shortcuts]]
*[[General Shortcuts|IX. Shortcuts available within Bluefish]] ¤ [[General Shortcuts#1. General Shortcuts|1. General Shortcuts]] ¤ [[HTML Shortcuts|2. HTML Shortcuts]]


== [[Man 2 pt03|Developing Bluefish]]  ==
== [[Developing Bluefish|Developing Bluefish]]  ==
=== [[Man 2 ch10|Debugging Bluefish]] ===
=== [[Bugs - Using the Debugger|Debugging Bluefish]] ===
[[Man 2 ch10#1. Using the Debugger|1. Using the Debugger]] ¤ [[Man 2 ch10s02|2. Filling a bug report]]
[[Bugs - Using the Debugger#1. Using the Debugger|1. Using the Debugger]] ¤ [[Bugs - Filing a Report|2. Filling a bug report]]
=== [[Man 2 ch11|Reference]] ===  
=== [[Editor Tab Options|Reference]] ===  
[[Man 2 ch11#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]]
[[Editor Tab Options#1. Options in the Editor Tab|1. Options in the Editor Tab]] ¤ [[HTML Tab Options|2. Options in the HTML Tab]] ¤ [[Files Tab Options|3. Options in the Files Tab]] ¤ [[User Interface Tab Options|4. Options in the User interface Tab]] ¤ [[Images Tab Options|5. Options in the Images Tab]]
=== [[Man 2 ch12|Development guidelines]] ===
=== [[Development - Indenting and Formatting|Development guidelines]] ===
Indenting and formating style<br />
Indenting and formating style<br />
[[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]]<br />
[[Development - Naming|2. Naming]] ¤ [[Development - Declaring Procedures|3. Declaring procedures]] ¤ [[Development - Header Files|4. Header files]] ¤ [[Development - New Files|5. New files]] ¤ [[Development - File Reference|6. File reference]] ¤ [[Development - Patches|7. Patches]]<br />
[[Man 2 ch12s08|8. Translations]] ¤ Introduction ¤ PO files basics ¤  
[[Development - Translations|8. Translations]] ¤ Introduction ¤ PO files basics ¤  
Shortcut keys ¤ How to contribute<br />
Shortcut keys ¤ How to contribute<br />
[[Man 2 ch12s09|9. Some tips]] ¤ [[Man 2 ch12s10|10. Making releases]] ¤ [[Man 2 ch12s11|11. Useful stuff]]
[[Development - Some tips|9. Some tips]] ¤ [[Development - Making Releases|10. Making releases]] ¤ [[Development - Useful Stuff|11. Useful stuff]]


== [[Man 2 ToC2|'''Man 2 ToC part 2''']] ==
== [[Table of Contents (2/3)|'''Table of Contents (2/3)''']] ==


{| style="width:100%;background-color:#D4D4D4;border:1px solid #E1E1E1;color:#4D4D4D"
{| style="width:100%;background-color:#D4D4D4;border:1px solid #E1E1E1;color:#4D4D4D"

Latest revision as of 16:54, 24 December 2022

Bluefish: The Definitive Guide

Table of Contents (part 1)

 
see also:  Notes for Bluefish 2 Manual
Guidelines for Writing this Manual
Man2 note.gif Note that the manual is currently being reworked. Many pages are outdated, others not yet available. They will be made available in the near future.

Here an overview of what has been done so far:

As per What has been done
2022-12-21 All unnumbered sections under Preface and Getting and Installing Bluefish have been updated
2022-12-22 Finished reviewing all sections under Preface and Getting and Installing Bluefish, reviewed and updated Starting Bluefish

Bluefish 2.2 Manual

Preface[edit]

Getting and Installing Bluefish[edit]


Using Bluefish[edit]

The user interface[edit]

2. Menus and Tool Bars ¤ 3. Side Panel ¤ 4. Status Bar ¤ 5. Help Menu

Preferences[edit]

Working with files and folders[edit]

1. Creating files ¤ 2. Managing directories ¤ 3. Opening files ¤ 4. Saving files ¤ 5. Renaming files ¤ 6. Deleting files ¤ 7. Closing files ¤ 8. Inserting files
9. Editing ¤ Undo and Redo ¤ Cut, Copy, and Paste ¤ Input methods
10. 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
11. File types ¤ Syntax highlighting
12. More on files ¤ Remote files ¤ Character encoding ¤ Open advanced

Navigation and Managing documents[edit]

Navigating through a document
2. Navigating through many documents ¤ 3. Projects
4. Bookmarks ¤ Generating several bookmarks at once]]
5. Find and Replace ¤ Find Again ¤ Find from Selection ¤ Find and Replace Using Regular Expressions
Templates

More than a Text Editor[edit]

1. Indenting ¤ 2. Autocompletion ¤ Hidden features ¤ 3. Spell checker ¤ 4. Function reference
5. HTML ¤ Special find and replace features ¤ Thumbnail generation
6. Customizing the Quick bar
7. Snippets plugin (was Custom menu in Bluefish 1) ¤ Adding a snippet dialog ¤ Adding a snippet replace dialog
8. External programs, filters ¤ Customizing browsers ¤ Customizing Commands menu ¤ Customizing Ouputbox menu

Customising Bluefish[edit]

Modifying shortcut keys
2. Showing hidden files and folders ¤ 3. Showing backup files ¤ 4. Editor appearance ¤ 5. Customizing the bookmarks path ¤ 6. Customizing the html tags style ¤ 7. Changing the author meta tag on the fly
8. Customizing files handling and browsing ¤ Setting the encoding meta tag on save ¤ Setting the default base directory ¤ Merging file browser views ¤ 8.4. Backup files ¤ 8.5. Using multiple instances of a file
9. Customizing the user interface ¤ 10. Modifying file types ¤ 11. Modifying the files filters ¤ 12. Modifying the highlighting patterns

Developing Bluefish[edit]

Debugging Bluefish[edit]

1. Using the Debugger ¤ 2. Filling a bug report

Reference[edit]

1. Options in the Editor Tab ¤ 2. Options in the HTML Tab ¤ 3. Options in the Files Tab ¤ 4. Options in the User interface Tab ¤ 5. Options in the Images Tab

Development guidelines[edit]

Indenting and formating style
2. Naming ¤ 3. Declaring procedures ¤ 4. Header files ¤ 5. New files ¤ 6. File reference ¤ 7. Patches
8. Translations ¤ Introduction ¤ PO files basics ¤ Shortcut keys ¤ How to contribute
9. Some tips ¤ 10. Making releases ¤ 11. Useful stuff

Table of Contents (2/3)[edit]

 
Home