Difference between revisions of "Windows installer"

From Gramps
Jump to: navigation, search
(Additional plugins)
(Additional plugins)
Line 85: Line 85:
 
* The Relationship Graph can not use PDF as output format unless there is an installation of [http://pages.cs.wisc.edu/~ghost/ ghostscript]. After installation, if gsview32.exe or gsview32c.exe is in the path, PDF should appear as one of the formats in the graphical Relationship Graph report.
 
* The Relationship Graph can not use PDF as output format unless there is an installation of [http://pages.cs.wisc.edu/~ghost/ ghostscript]. After installation, if gsview32.exe or gsview32c.exe is in the path, PDF should appear as one of the formats in the graphical Relationship Graph report.
 
* '''Spell-checking:'''
 
* '''Spell-checking:'''
** For spell-checking to work you first need [http://www.abisource.com/projects/enchant/  Enchant library] and python bindings [http://www.rfk.id.au/software/pyenchant/ PyEnchant]. Enchant appears to be a generic spell checking library. You can request dictionaries from it, ask if a word is correctly spelled, get corrections for a misspelled word, etc... PyEnchant is a set of language bindings and some wrapper classes to make the excellent Enchant spellchecker available as a Python module. Both are available for windows as single setup file:
+
*# For spell-checking to work you first need [http://www.abisource.com/projects/enchant/  Enchant library] and python bindings [http://www.rfk.id.au/software/pyenchant/ PyEnchant]. Enchant appears to be a generic spell checking library. You can request dictionaries from it, ask if a word is correctly spelled, get corrections for a misspelled word, etc... PyEnchant is a set of language bindings and some wrapper classes to make the excellent Enchant spellchecker available as a Python module. Both are available for windows as single setup file:
*** [http://pypi.python.org/packages/any/p/pyenchant/pyenchant-1.5.3.win32.exe pyenchant-1.5.3.win32.exe]
+
*#* [http://pypi.python.org/packages/any/p/pyenchant/pyenchant-1.5.3.win32.exe pyenchant-1.5.3.win32.exe]
 +
*# Secondly you need [http://www.pygtk.org/pygtkspell/ PyGTKSpell] from [http://www.pygtk.org/about.html gnome-python-extras] which is bindings allowing to run Python programs using the [http://gtkspell.sourceforge.net/ GtkSpell library], that extends GTK+'s GtkTextView widget with support for spell-checking. Depending of yours Python version download and install one of these:
 +
*#* [http://www.gramps-project.org/wiki/index.php?title=Image:PyGTKSpell-2.25.3.win32-py2.5.zip PyGTKSpell-2.25.3.win32-py2.5.exe] for Python 2.5
 +
*#* [http://www.gramps-project.org/wiki/index.php?title=Image:PyGTKSpell-2.25.3.win32-py2.6.zip PyGTKSpell-2.25.3.win32-py2.6.exe] for Python 2.6
  
 
==Limitations==
 
==Limitations==

Revision as of 20:03, 12 July 2009

GRAMPS has been designed to use the multi-platform tool sets Python and GTK, a few volunteers have created a Windows installer that has been reported to work without too many obvious issues. But there are currently no GRAMPS developers committed to this platform.

Because the software is not formally tested and we get little feedback about it, we suggest the following:

  • Work with a copy of your main database and keep regular backups in the GRAMPS XML format.
  • Join the GRAMPS Windows mailing list to share your experiences, especially if you are a developer able to contribute to a Windows port.
  • See also GRAMPS and Windows for a collection of hints to run GRAMPS on MS Windows

Installation

1. Close any gtk-based applications that are running, such as the GIMP or Pidgin. See Common Problems below.

2. Install the packages in the following order:

For Gramps 3.1.x and later
Order Package Name Download Size From Comment
1 Python 2.5.4 python-2.5.4.msi 11 MB python.org
2 GTK+ 2.12.9 gtk-dev-2.12.9-win32-2.exe 17.17 MB gladewin32 includes glade / See Common Problems and Note below
3 pygtk 2.12.1 pygtk-2.12.1-2.win32-py2.5.exe 1.9 MB acc.umu.se See Common Problems and Note below
4 pygobject 2.12.3 pygobject-2.12.3-1.win32-py2.5.exe 163 KB gnome.org
5 pycairo 1.2.6 pycairo-1.2.6-1.win32-py2.5.exe 82 KB acc.umu.se

Note: For Gramps 3.0.x and earlier use:

3. Re-boot the computer after installing the above dependencies, prior to installing GRAMPS.

4. Install GRAMPS for Windows. You can install the last stable version:

Common Problems

Installer complains pygtk is missing

This is a very common error to see when all dependencies are not installed or installed correctly. Please make sure that each of the packages required have installed correctly, and re-boot the computer prior to running the GRAMPS installer. We often see users attempting to use other packages to satisfy these requirements that omit something necessary (e.g., glade) which produce this error.

In rare occasions, the installer will complain that pygtk is not installed even though everything is correct. Canceling and re-running the installer seems to fix this problem, although if it happens repeatedly, the error is the more severe situation discussed above. (Anyone know why? Please tell us on the gramps-windows email list.)

GTK+ Installer Error

If you already have GTK+ installed, perhaps because you have installed The GIMP, Pidgin, or Gnu Cash, the GTK+ installer will not be able to write to some files if one of those applications is running. If you see errors with the GTK+ installer, select Cancel, shut down the other GTK+ applications and run the installer again. (This issue has been reported as GTK+ Installer doesn't handle locked files well to the kind people who make the GTK+ installer for windows.)

Additional plugins

There are some features of Gramps that need additional programs to work. There are several different kinds of reports, and the following features need extra configuration to work on Windows.

  • The Relationship Graph reports (both graphical report and code generator) need an installation of Graphviz. There is a bug in the current stable release, see this example.
  • The Relationship Graph can not use PDF as output format unless there is an installation of ghostscript. After installation, if gsview32.exe or gsview32c.exe is in the path, PDF should appear as one of the formats in the graphical Relationship Graph report.
  • Spell-checking:
    1. For spell-checking to work you first need Enchant library and python bindings PyEnchant. Enchant appears to be a generic spell checking library. You can request dictionaries from it, ask if a word is correctly spelled, get corrections for a misspelled word, etc... PyEnchant is a set of language bindings and some wrapper classes to make the excellent Enchant spellchecker available as a Python module. Both are available for windows as single setup file:
    2. Secondly you need PyGTKSpell from gnome-python-extras which is bindings allowing to run Python programs using the GtkSpell library, that extends GTK+'s GtkTextView widget with support for spell-checking. Depending of yours Python version download and install one of these:

Limitations

At this time, there is no intent to package all the dependencies and the GRAMPS package into one installer. This creates a very complex coordination condition between GRAMPS and these other projects. It also means a single 30+ MB download every version change.

There have been discussions about trying to install compiled distillations (dynamic link libraries) of these core dependencies to avoid having to install the entire Python and GTK environment, but this work never progressed beyond discussion. For more about this and other Windows issues, see the email list archive.

See also