Usually, it's just download, unzip & run; this page offers solutions for system-specific and comprehensive issues and special requirements. Older and for current TG-lab versions not applicable issues you can find on Troubleshooting (old).
If changing your institution is not possible on the login screen, try this way:
TextGridLab doesn't start: JVM error 13 (Windows, Linux)
You are using the wrong 32/64 bit variant of the TextGridLab. Download the other one and it will probably just start fine.
The TextGridLab variant must match that of the Java environment you are using. Windows users will typically use the 32-bit version, since Oracle's default Java installer seems to install a 32-bit Java even on 64-bit Windows systems.
XML Preview broken: TransformerConfigurationException
In the Lab-Preferences go to XML→ Experimental Feaitures and change the URL of the XSLT File to: https://raw.githubusercontent.com/TEIC/Stylesheets/released/html/html.xsl
Reopen the file afterwards.
TextGridLab doesn't start: The TextGridLab executable launcher was unable to locate its companion shared library
You have not properly unzipped the TextGridLab. After downloading TextGridLab, please use a proper unzip tool like 7zip to unzip the complete contents of the archive, don't just open the ZIP file in explorer. Don't move parts of the TextGridLab folder around, always move the whole folder instead. If you want a TextGridLab icon on your desktop or in your start menu, create a shortcut. Don't unzip to very deeply nested subdirectories – Windows has a length limit for the overall path name, and TextGridLab itself uses long names for technical reasons (the missing file, e.g., can be found in a TextGridLab subdirectory like
Help system does not work
Windows users that use a desktop firewall may observe that displaying the help contents or actual help topics does not work. The reason for this is that the TextGridLab help system starts a local web server which then offers the help documents to either your preferred browser or the included tooling.
Installation of, e.g., oXygen aborts reproducibly after some download time
Temporarily disable your virus scanner (problem observed with Avira).
Background: Installing oXygen requires downloading a rather large (~ 100MB) plugin file from their servers. This usually works fine, but Avira's anti-virus filter gets in the way: It redirects the download to a temporary location, scans the file for viruses after it has been completely downloaded and only after that passes the file on to TextGridLab's installation mechanism. To the TextGridLab's install and update component, this looks like the oXygen servers do not react to the Lab's request, and it will eventually abort with a timeout error. [TG-1965]
Users of "Avira Anti-Virus" reported troubles regarding the installation of oXygen (see above) and different tools. For example the preview within the XML editor is not available as long as a XSLT load external ressources. To get rid of this problem you can whitelist the TextGridLab for the "Realtime Protection" and the "WebGuard" or deactivate both scanners during your TextGridLab session. Furthermore users have to whitelist all external ressources for the WebGuard.
UPDATE!Browser components do not work
If you are using Linux and the welcome screen remains blank and you get an error message when trying to login, you need to install WebKit-GTK 1.x. On Ubuntu or Debian, you may click the link above or enter
sudo apt-get install libwebkitgtk-1.0-0
For TextGridLab versions up to 2.0.5 you will also need to install the SWT patch as described in bug #9717 comment 4. Up-to-date TextGridLab versions already include the patch.
webkit1 has been removed from the repository. We provide the needed packages and you may install them with
a dnf update or yum update may removes the older webkit when other packages provide the newer on. This happens because of the group «fedora-obsolete-packages». in this case use
to reset the webkit installation. :rolleyes:
UPDATE!Error “MOZILLA_FIVE_HOME not set“
If this error shows up at the startup of TextGridLab you are most likely missing libwebkit-gtk. Try to apply the solution described in "Browser components do not work (Linux)"
NEW!Problems using Wayland
TextGridLab.app cannot be opened because it is from a non-verified developer
It can hapen that OS X complains that the application is from a non-verified developer. Please right click on the TextGridLab.app and select "Open" (or press CTRL + left mouse click to open the context menu). This step needs to be done only once.
TextGridLab does not launch: an error has occured
The error window will tell you that more information is in the displayed log file path. Please open the displayed file and have a look at the end of the file. If you see an entry like
Caused by: java.lang.IllegalStateException: The platform metadata area could not be written: /private/var/folders/yr/gtbbgl915jbg74s4kb3_q3qm0000gn/T/AppTranslocation/1231F14F-D417-4A89-B029-31B546924E99/d/TextGridLab.app/Contents/MacOS/workspace/.metadata. By default the platform writes its content
under the current working directory when the platform is launched. Use the -data parameter to specify a different content area for the platform.
Then please do the following: Right click on the TextGridLab.app and select "Show package contents". Go to the folder "Contents". Right click on the file "Info.plist" and select "open with" other program ... and select TextEdit as editor. Now find the line <string>-showlocation</string> near the bottom and insert this new line after that line:
Save the file, close the Finder window and try to start the program TextGridLab again.
Plugin installation (from marketplace) fails
If an administrator has installed TGLab into /Applications and the user has an account without administration rights plugin installation will fail. Normal users are not allowed to modify the application folder.
- Ask the administrator to install the plugin as administrator. The plugins is then available for all users
- Install TG Lab locally: The easiest way is to make a copy of the TextGrid Lab Application. To do this Open the Finder, Click on Applications on the left, find TextGridLab, click on it with the left mouse button and leave the mouse button pressed. Then keep holding the ALT key on the keyboard (you must see a green plus icon) and drag the application to the desktop. Now release both things, the mouse button and the keyboard ALT key.
With this action you create a local copy of the application. Then start the application from the desktop with a double click and install the plugins as you like.
Advanced Installation Scenarios
Install the TextGridLab once for multiple users
The TextGridLab needs a writeable area on your hard disk to store settings and working data. By default, it will create and use a folder named
workspace in the current working directory – this will typically be the TextGridLab's application folder. If this directory is not writeable (e.g., because an administrator installs the TextGridLab for all users to a read-only directory), you need to tell it an alternative. There are two ways to do so:
As an administrator, you can edit the file
textgridlab.iniin the TextGridLab application directory. Before the line containing
-jvmArgs, add two lines:
This will cause the TextGridLab to use the directory
TextGridLab-Workspacein the current user's personal directory. The first line must always be
-data, the second line contains the target directory;
@user.homeis a macro that will be expanded to the user's home directory.
- Alternatively, you can start the TextGridLab with the command line arguments
-data @user.home/TextGridLab-Workspace(or likewise).