Changeset 9347

May 2, 2008, 5:15:38 PM (12 years ago)

updated and expanded build-application docs

1 edited


  • trunk/source/doc/src/ide.xml

    r9199 r9347  
    216216        (<parameter>creator-string</parameter> <replaceable>"OMCL"</replaceable>)
    217217        (<parameter>directory</parameter> <replaceable>(current-directory)</replaceable>)
     218        (<parameter>copy-ide-resources</parameter> <replaceable>t</replaceable>)
    218219        (<parameter>nibfiles</parameter> <replaceable>NIL</replaceable>)
    219220        (<parameter>main-nib-name</parameter> <replaceable>NIL</replaceable>)
    283284            typical value might be <code>"/Users/foo/Desktop/"</code>
    284285            (assuming, of course, that your username is "foo").</para>
     286        </listitem>
     287      </varlistentry>
     289      <varlistentry>
     290        <term><varname>copy-ide-resources</varname></term>
     291        <listitem>
     292          <para>Whether to copy the resource files from the IDE's
     293            application bundle. By
     294            default, <code>BUILD-APPLICATION</code> copies nibfiles
     295            and other resources from the IDE to the newly-created
     296            application bundle. This option is often useful when you
     297            are developing a new application, because it enables your
     298            built application to have a fully-functional user
     299            interface even before you have finished designing one. By
     300            default, the application uses the application menu and
     301            other UI elements of the IDE until you specify
     302            otherwise. Once your application's UI is fully
     303            implemented, you may choose to pass <literal>NIL</literal>
     304            for the value of this parameter, in which case the IDE
     305            resources are not copied into your application
     306            bundle.</para>
    285307        </listitem>
    286308      </varlistentry>
    342364    </variablelist>
    344     <para>Please note that <code>BUILD-APPLICATION</code> is a work in
     366    <para><code>BUILD-APPLICATION</code> creates a folder named
     367      "<replaceable>name</replaceable>.app" in the
     368      directory <replaceable>directory</replaceable>. Inside that
     369      folder, it creates the "Contents" folder that Mac OS X
     370      application bundles are expected to contain, and populates it
     371      with the "MacOS" and "Resources" folders, and the "Info.plist"
     372      and "PkgInfo" files that must be present in a working
     373      application bundle. It takes the contents of the "Info.plist"
     374      and "PkgInfo" files from the parameters
     375      to <code>BUILD-APPLICATION</code>. If <replaceable>copy-ide-resources</replaceable>
     376      is true then it copies the contents of the "Resources" folder
     377      from the "Resources" folder of the running IDE.</para>
     379    <para>The work needed to produce a running Cocoa application is
     380    very minimal. In fact, if you
     381    supply <code>BUILD-APPLICATION</code> with a valid nibfile and
     382    pathnames, it builds a running Cocoa application that displays
     383    your UI. It doesn't need you to write any code at all to do
     384    this. Of course, the resulting application doesn't do anything
     385    apart from displaying the UI defined in the nibfile. If you want
     386    your UI to accomplish anything, you need to write the code to
     387    handle its events. But the path to a running application with your
     388    UI in it is very short indeed.</para>
     390   <para>Please note that <code>BUILD-APPLICATION</code> is a work in
    345391    progress. It can easily build a working Cocoa application, but it
    346392    still has limitations that may in some cases prove
    349395    default. If you find the current limitations
    350396    of <code>BUILD-APPLICATION</code> too restrictive, and want to try
    351     extending it for your use, you can find the source code for it
    352     in "ccl/cocoa-ide/build-application.lisp".</para>
     397    extending it for your use, you can find the source code for it in
     398    "ccl/cocoa-ide/build-application.lisp". You can see the default
     399    values used to populate the "Info.plist" file in
     400    "ccl/cocoa-ide/builder-utilities.lisp".</para>
    354402    <para>For more information on how to
Note: See TracChangeset for help on using the changeset viewer.