embedding/config/readme.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4   <title>Embedding distribution information</title>
   5 </head>
   6   <body>
   7
   8 <h2>Introduction</h2>
   9
  10 <p>This is the Embedding distribution of <a
  11  href="http://www.mozilla.org/">Mozilla</a>. It     serves as a reference
  12 and smoketest distribution to demonstrate a typical     subset of Mozilla
  13 needed to embed it into another application. The     distribution contains
  14 sample applications for testing and development purposes.</p>
  15
  16 <p>Please note the phrase<i> typical subset</i>! If you want to use a different
  17      subset then see the <a href="#cust">customizing the embedding distribution</a>
  18      section below.</p>
  19
  20 <h2>Where can I find more information about embedding? </h2>
  21
  22 <p>Mozilla.org - <a href="http://www.mozilla.org/">http://www.mozilla.org/</a>.</p>
  23
  24 <p>The Embedding project page - <a
  25  href="http://www.mozilla.org/projects/embedding/">http://www.mozilla.org/projects/embedding/</a>.
  26      This page should serve as your main point of information for learning
  27 how to     embed Mozilla in your own applications.</p>
  28
  29 <p>The Embedding Frequently Asked Questions (FAQ) page - <a
  30  href="http://www.mozilla.org/projects/embedding/faq.html">http://www.mozilla.org/projects/embedding/faq.html</a>. </p>
  31
  32 <p>The Embedding newsgroup - <a
  33  href="news:netscape.public.mozilla.embedding">news:netscape.public.mozilla.embedding</a>.</p>
  34
  35 <p>The Embedding QA page - <a
  36  href="http://www.mozilla.org/quality/embed/">http://www.mozilla.org/quality/embed/</a>.</p>
  37
  38 <p>Instructions for building Mozilla (including Embedding) - <a
  39  href="http://www.mozilla.org/build/">http://www.mozilla.org/build/</a>.</p>
  40
  41 <p>Instructions for fetching Mozilla source code (including Embedding) - <a
  42  href="http://www.mozilla.org/source.html">http://www.mozilla.org/source.html</a>.</p>
  43
  44 <h2>Contents </h2>
  45
  46 <p>The distribution contains, libraries, resources and chrome. All of this
  47      is a subset of Mozilla, repackaged for embedding. The layout follows
  48 the     usual Mozilla directory, i.e. </p>
  49
  50 <ul>
  51         <li>./ - Test applications, launch scripts and core libraries (xpcom,
  52 nspr         etc.)</li>
  53         <li>./components/ - XPCOM components (network, graphics, layout,
  54 content,          etc.).</li>
  55         <li>./chrome/ - chrome files. In embedding most of the chrome has
  56 been         re-packaged into a single embed.jar file to make it more manageable.</li>
  57         <li>./res/ - miscellaneous rendering and parser files.</li>
  58         <li>./defaults/ - default preference settings</li>
  59
  60 </ul>
  61
  62 <h3>Unix</h3>
  63
  64 <h4>TestGtkEmbed</h4>
  65
  66 <p>A simple browser application built using the GTK+ Browser Widget.</p>
  67
  68 <h4>GTK+ Browser Widget</h4>
  69
  70 <p>A GTK+ widget for embedding Mozilla into GTK+/GNOME applications such as
  71 <a href="http://galeon.sourceforge.net/">Galeon</a>.     More information
  72 about the widget may be found here <a
  73  href="http://www.mozilla.org/unix/gtk-embedding.html">http://www.mozilla.org/unix/gtk-embedding.html</a>.
  74 </p>
  75
  76 <h3>Windows</h3>
  77
  78 <h4>MFCEmbed</h4>
  79
  80 <p>A complete browser application written in MFC and the Gecko embedding APIs.
  81     This application demonstrates and exercises the functionality necessary
  82 to     put together a fully featured browser using Gecko.</p>
  83
  84 <h4>Mozilla ActiveX Control</h4>
  85
  86 <p>An ActiveX browser control built with the embedding APIs. You may use the
  87     control to embed a browser inside applications     written in VB, Delphi
  88 etc. More information about the control including     installation instructions
  89 may be found at <a href="http://www.iol.ie/%7Elocka/mozilla/mozilla.htm">http://www.iol.ie/~locka/mozilla/mozilla.htm</a>.
  90      </p>
  91
  92 <h3>Macintosh </h3>
  93
  94 <p>PPEmbed is built as part of the standard Mac embedding build. Work on <a
  95  href="http://www.mozilla.org/ports/fizzilla/Mach.html">Fizilla     Mach</a>
  96 may also yield a Mac embedding distribution in the future. </p>
  97
  98 <h2>Installation and Usage </h2>
  99
 100 <h3>Unix</h3>
 101
 102 <ol>
 103         <li>Untar the embedding distribution into an empty directory of your
 104          choice.</li>
 105         <li>From the command-line, cd into the directory and type
 106  './run-mozilla.sh ./TestGtkEmbed'</li>
 107
 108 </ol>
 109
 110 <h3>Windows </h3>
 111
 112 <ol>
 113         <li>Unzip the embedding distribution into an empty directory of your
 114          choice.</li>
 115         <li>Double-click on mfcembed.exe</li>
 116
 117 </ol>
 118
 119 <h2><a name="cust">Customizing the embedding distribution</a></h2>
 120
 121 <p>The embedding distribution is produced by first building the full Mozilla
 122      source and cherry picking files and chrome into a separate embedding
 123 directory.     Basically the steps are:</p>
 124
 125 <ol>
 126         <li>Build Mozilla as usual</li>
 127         <li>cd mozilla/embedding/config</li>
 128         <li>make</li>
 129 </ol>
 130
 131 <p><strong>Note:</strong> When using an objdir, cd into
 132 &lt;objdir&gt;/embedding/config instead, and run make there.</p>
 133
 134 <p>The embedding distribution will appear in mozilla/dist/Embed.</p>
 135
 136 <p>The build process works by reading a file called basebrowser-win (or
 137   basebrowser-unix, basebrowser-mac-macho etc.) and copying the listed files
 138 from     mozilla/dist/bin into mozilla/dist/Embed. It then reads a file called
 139 embed-jar.mn     and repackages the specified chrome files and directories
 140 into a single     embed.jar.<br>
 141  </p>
 142
 143 <p>This process can be customized in one of two ways:<br>
 144  </p>
 145
 146 <ol>
 147    <li>Edit basebrowser-foo (where foo = win, unix etc.) and remove/add the
 148 items you require</li>
 149    <li>Create a new file called client-foo and add the items you require.
 150 This file is detected by the build process and will be run <i>after</i> the
 151 contents of basebrowser-foo have been copied.</li>
 152
 153 </ol>
 154  The latter is the best probably approach to take since the embedder can
 155 maintain these files without modifying ones in Mozilla<i></i>. The client-foo
 156 file      allows embedders to specify files to be added or removed from the
 157 default      embedding distribution. A minus sign in front of a filename
 158 deletes that      file.
 159 <p>For example if you wanted a distribution containing extra character converters,
 160 but not the ActiveX control and not XMLExtras you might define a     client-win
 161 like this:</p>
 162
 163 <pre>[Embed]<br>components\ucvja.dll<br>components\ucvko.dll<br>components\ucvcn.dll<br>components\ucvtw.dll<br>components\ucvtw2.dll<br>components\ucvibm.dll<br>-mozctl.dll<br>-mozctlx.dll<br>-components\xmlextras.dll<br>-components\xmlextras.xpt<br></pre>
 164
 165 <p></p>
 166  <br>
 167  <br>
 168 </body>
 169 </html>