src/Tools/jEdit/README_BUILD

document some known problems with Mac OS;

Requirements to build from sources
==================================

* Proper Java JRE/JDK from Sun, e.g. 1.6.0_18
  http://java.sun.com/javase/downloads/index.jsp

* Netbeans 6.8
  http://www.netbeans.org/downloads/index.html

* Scala for Netbeans: version 6.8v1.1
  http://sourceforge.net/project/showfiles.php?group_id=192439&package_id=256544
  http://blogtrader.net/dcaoyuan/category/NetBeans
  http://wiki.netbeans.org/Scala

* jEdit 4.3.1 (final)
  http://www.jedit.org/
  Netbeans Project "jEdit": install official sources as ./contrib/jEdit/.

* jEdit plugins:
  Netbeans Library "Console" = $HOME/.jedit/jars/Console.jar
  Netbeans Library "SideKick" = $HOME/.jedit/jars/SideKick.jar
  Netbeans Library "ErrorList" = $HOME/.jedit/jars/ErrorList.jar
  Netbeans Library "Hyperlinks" = $HOME/.jedit/jars/Hyperlinks.jar

* Cobra Renderer 0.98.4
  http://lobobrowser.org/cobra.jsp
  Netbeans Library "Cobra-Renderer" = .../cobra.jar
  Netbenas Library "Rhino-JavaScript" = .../js.jar

* Isabelle/Pure Scala components
  Netbeans Library "Isabelle-Pure" = ~~/lib/classes/Pure.jar

* Scala Compiler
  Netbeans Library "Scala-compiler" = $SCALA_HOME/lib/scala-compiler.jar


Running the application within Netbeans
=======================================

* Project properties: add "Run" argument like
    -noserver -nobackground -settings=/home/makarius/isabelle/isabelle-jedit/dist

* The Isabelle environment is obtained automatically via
  "$ISABELLE_HOME/bin/isabelle getenv", where ISABELLE_HOME is determined as follows:

    (1) via regular Isabelle settings,
    e.g. "isabelle env netbeans"

    (2) or via ISABELLE_HOME from raw process environment,
    	e.g. "env ISABELLE_HOME=.../Isabelle netbeans"

    (3) or via JVM system properties (cf. "Run / VM Options")
    	e.g. -Disabelle.home=.../Isabelle


Misc notes
==========

- Netbeans config/Editors/Preferences/...-CustomPreferences.xml

    <entry javaType="java.lang.Integer" name="caret-blink-rate" xml:space="preserve">
        <value><![CDATA[0]]></value>
    </entry>

-----------------------------------------------------------------------
To run jedit with remote debugging enabled, I use the following
command: "java
-agentlib:jdwp=transport=dt_socket,suspend=y,server=y,address=XXXX
-jar jedit.jar"

where XXXX is any open port number you wish. The above invocation
works for Sun's JDK 5.0.  There's an alternate incantation for earlier
releases. (See
http://java.sun.com/j2se/1.5.0/docs/guide/jpda/conninv.html)
-----------------------------------------------------------------------


Known problems with Mac OS
==========================

- The MacOSX plugin disrupts regular C-X/C/V operations, e.g. between
  the editor and the Console plugin, which is a standard swing text
  box.  Similar for search boxes etc.

- Anti-aliasing does not really work as well as for Linux or Windows.
  (General Apple/Swing problem?)

- Font.createFont mangles the font family of non-regular fonts,
  e.g. bold.