svn commit: r932037 - /pdfbox/site/src/site/xdoc/userguide/dot_net.xml

[da...@apache.org]

Author: danielwilson
Date: Thu Apr  8 18:04:15 2010
New Revision: 932037

URL: http://svn.apache.org/viewvc?rev=932037&view=rev
Log:
documentation for PDFBOX-675

Modified:
    pdfbox/site/src/site/xdoc/userguide/dot_net.xml

Modified: pdfbox/site/src/site/xdoc/userguide/dot_net.xml
URL: http://svn.apache.org/viewvc/pdfbox/site/src/site/xdoc/userguide/dot_net.xml?rev=932037&r1=932036&r2=932037&view=diff
==============================================================================
--- pdfbox/site/src/site/xdoc/userguide/dot_net.xml (original)
+++ pdfbox/site/src/site/xdoc/userguide/dot_net.xml Thu Apr  8 18:04:15 2010
@@ -30,6 +30,35 @@
             required DLL files.  For the command line applications that are available in the Java version a native windows executable is
             also included.  This page contains information that is specific to using the .NET version of PDFBox.
         </p>
+        <section name="How to Build for .Net">
+          <p>
+                The Apache Ant build supports building for .NET via IKVM.  At present, the Maven build does not.
+                <ol>
+                    <li>Download and install version 0.42 of the <a href="http://www.ikvm.net">IKVM binaries</a>.  Unfortunately, our build script is version-specific.  It is 
+                        designed for 0.42 (at the time of this writing the latest release version). It will not work with 0.38 or earlier.</li>
+                    <li>Edit your build.xml file for the Apache Ant build to set the <b>ikvm.dir</b> property to the path in which you installed IKVM. You're looking for the line that says "&lt;property name="ikvm.dir" value="."/&gt;"</li>
+                    <li>Type <b>ant build.NET</b> to build.</li>
+                </ol>
+          </p>
+          </subsection>
+          <section name="How to Strong-name Your PDFBox Assembly">
+          <p>
+            Assuming the basic build process above is working, strong-naming is not difficult.
+                <ol>
+                    <li>Create your .snk file using the sn program that comes with MS Visual Studio.</li>
+                    <li>Edit your build.xml file to add  &lt;arg value="-keyfile:pdfbox.snk" /&gt; to each of the &lt;exec executable="${ikvmc}"&gt; sections building a DLL.  Those building EXE's do not need them.</li>
+                    <li>Type <b>ant build.NET</b> to build.</li>
+                </ol>
+          </p>
+          </subsection>
+          <section name="Other Userful IKVM Build Options">
+          <p>
+                <ul>
+                    <li> To assign a version number to your DLL include the -version argument with a 4-part version number, e.g. &lt;arg value="-version:1.2.0.2" /&gt; </li>
+                    <li>To generate debug information include &lt;arg value="-debug" /&gt; </li>
+                </ul>
+          </p>
+          </subsection>
         <subsection name="log4j">
           <p>
           PDFBox no longer requires log4j!  Older versions used to require you to configure log4j before using it in .NET