Ferry Documentation

v0.1

Introduction

Ferry is an open-source customizable text editing component with Unicode support. Ferry is primarily targeted for source code editing. It properly handles mixed Hebrew, Arabic, Thai and other complex scripts.

Project home is http://ferry.sf.net.

So far it is available for MS Windows only.

Ferry is written in modern C++ with limited use of STL. The Windows port uses WinAPI as well.

Ferry provides full Unicode support:

i_can_eat_glass.png

Ferry supports syntax highlighting. Ferry relies on use of external libraries for this. So far Ferry can use Scintilla lexers or Colorer for syntax highlighting:

i_can_eat_glass.scintilla.png

Proper Unicode support combined with the use of widely adopted syntax highlighting engines is the quick answer for the skeptic "Why another text editing component?" question. See Features and Implementation Details pages to get more reasoning why use Ferry.

Features

See Features page.

Details

See Implementation Details page.

License Terms

Ferry project consists of two top-level modules: Ferry Core library and Ferry Extensions library. Each top-level module is licensed under its own terms.

Ferry Core Library License Terms

--------------------------------------------------------------------------
                Ferry - Unicode text editing component
Copyright (C) 2006-2008 Alexey Semenyuk. All rights reserved.

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License (GPL) as published by
the Free Software Foundation, version 2.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

--------------------------------------------------------------------------

                *** Exemption to the GNU GPL ***

Linking Ferry statically or dynamically with other modules is making
a combined work based on Ferry. Thus, the terms and conditions of
the GNU General Public License cover the whole combination.

In addition, as a special exception, the copyright holder of Ferry gives
you permission to dynamically link Ferry library with programs or libraries
released under any license terms, even that incompatible with the terms
of the GNU GPL, provided that such libraries or programs don't call
Fe_CreateEditor() function exported from Ferry library.

--------------------------------------------------------------------------

                            *** NOTE ***

If you find inappropriate to use Ferry under the GNU GPL in your programs
because you are unable to provide them in open source code form, please,
contact the copyright holder of Ferry, to find another license terms for
Ferry to use with your programs.

--------------------------------------------------------------------------

Ferry Extensions Library License Terms

Ferry text editing component extensions (FE_EXT) license
--------------------------------------------------------------------------

FE_EXT is licensed under the terms of the MIT license reproduced below.
This means that FE_EXT is free software and can be used for both academic
and commercial purposes at absolutely no cost.

--------------------------------------------------------------------------

Copyright (C) 2006-2008 Alexey Semenyuk. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

--------------------------------------------------------------------------

Licensing Explained

Ferry Core library - the main module, is licensed under the GNU GPL. If you find inadmissible to use Ferry Core library in your projects just because of GNU GPL limitations you can request the author to let you use Ferry Core library under a different license. Please, consider using the address to discuss custom licensing of Ferry Core library.

Ferry Extensions library - optional module with extensions to customize Ferry text editing components, is licensed under the MIT License. If you want to contribute to Ferry Extensions library or implement your own proprietary extensions library to use with Ferry Core library, you are not restricted with the GNU GPL terms covering Ferry Core library usage, provided that your extension doesn't call Fe_CreateEditor() function exported from Ferry Core library and that your extension is compiled in a binary that links Ferry Core library dynamically only.

Please, consider http://groups.google.com/group/ferry-discuss mailing list to ask general questions about Ferry licensing.

Acknowledgements

Ferry uses Scintilla and Colorer libraries to implement syntax highlighting extensions. Ferry uses third-party code for conversion between various transformation formats of Unicode characters.

These libraries are freely available and distributed in source code form at:

Supported Platforms

Build Notes

See Build notes.

HOWTO

See HOWTO page.

Generated on Tue Nov 18 21:08:22 2008 for Ferry by doxygen 1.5.7.1
http://sourceforge.net