Author: junrue Date: Tue Mar 21 03:00:29 2006 New Revision: 62
Added: trunk/docs/manual/miscellaneous.texinfo Modified: trunk/README.txt trunk/build.lisp trunk/docs/manual/glossary.texinfo trunk/docs/manual/overview.texinfo trunk/docs/manual/packages.texinfo trunk/docs/manual/reference.texinfo Log: documentation updates
Modified: trunk/README.txt ============================================================================== --- trunk/README.txt (original) +++ trunk/README.txt Tue Mar 21 03:00:29 2006 @@ -6,6 +6,12 @@ on the Windows(R) platform. Graphic-Forms is licensed under the terms of the BSD License.
+Please provide feedback via the development mailing list: + http://www.common-lisp.net/mailman/listinfo/graphic-forms-devel + +and/or patches via the patch tracker: + http://sourceforge.net/tracker/?atid=826147&group_id=163034&func=bro... +
Dependencies ------------ @@ -44,7 +50,7 @@
4. Load ASDF into your Lisp image if it is not already present.
-5. Execute the following forms from your REPL ( +5. Execute the following forms from your REPL
(load "config.lisp")
@@ -53,9 +59,9 @@ ;; (setf gfsys::*imagemagick-dir* "c:/path/to/your/ImageMagick/install/")
- ;; Update these variables as needed for your specific environment to + ;; setf these variables as needed for your specific environment to ;; load the other dependencies besides ImageMagick. Or if your Lisp - ;; image already has these systems loaded, set these variables to nil. + ;; image already has these systems loaded, set the variables to nil. ;; ;; gfsys::*cffi-dir* ;; gfsys::*closer-mop-dir* @@ -94,7 +100,11 @@
(asdf:operate 'asdf:load-op :graphic-forms-tests)
- (chdir "c:/some/path/graphic-forms/src/tests/uitoolkit/") + ;; Change the working directory to the uitoolkit tests + ;; directory. + ;; + + (chdir "c:/example/path/graphic-forms/src/tests/uitoolkit/")
;; then execute one or more of the following: ;;
Modified: trunk/build.lisp ============================================================================== --- trunk/build.lisp (original) +++ trunk/build.lisp Tue Mar 21 03:00:29 2006 @@ -31,11 +31,16 @@ ;;;; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ;;;;
+;;; NOTE: This is local build configuration that I (Jack Unrue) +;;; use for development purposes only. It's not intended for +;;; public use. +;;; + (load "config.lisp")
(in-package #:graphic-forms-system)
-(defvar *library-root* "c:/third_party/") +(defvar *library-root* "c:/projects/third_party/") (defvar *asdf-repo-root* (concatenate 'string *library-root* "asdf-repo/")) (defvar *project-root* "c:/projects/public/")
@@ -44,6 +49,7 @@ (setf *imagemagick-dir* "c:/Program Files/ImageMagick-6.2.6-Q16/") (setf *lw-compat-dir* (concatenate 'string *asdf-repo-root* "lw-compat/")) (setf *gf-dir* (concatenate 'string *project-root* "graphic-forms/")) +(setf *lisp-unit-file* (concatenate 'string *library-root* "lisp-unit"))
(defvar *gf-build-dir* "c:/projects/public/build/graphic-forms/") (defvar *gf-tests-dir* (concatenate 'string *gf-dir* "src/tests/uitoolkit/"))
Modified: trunk/docs/manual/glossary.texinfo ============================================================================== --- trunk/docs/manual/glossary.texinfo (original) +++ trunk/docs/manual/glossary.texinfo Tue Mar 21 03:00:29 2006 @@ -10,20 +10,23 @@ @node Glossary @chapter Glossary
-Terms and definitions. +Terms and definitions. Content will be added in due time.
@table @samp @item control -A control is a thing. +@cindex control +A control is a system-defined window class that accepts user input +and/or generates notification events.
@item dialog -A dialog is something else. +@cindex dialog +A dialog is a mechanism for collecting user input or showing +information. The system defines common dialogs for tasks like +choosing files, fonts, or colors. Custom dialogs can be defined +by application code.
@item menu +@cindex menu A collection of menu items.
@end table - -@cindex control -@cindex dialog -@cindex menu
Added: trunk/docs/manual/miscellaneous.texinfo ============================================================================== --- (empty file) +++ trunk/docs/manual/miscellaneous.texinfo Tue Mar 21 03:00:29 2006 @@ -0,0 +1,13 @@ + +@c This file is part of the documentation source for +@c the Graphic-Forms library. +@c +@c Copyright (c) 2006, Jack D. Unrue + +@c =================================================================== +@c CHAPTER: Miscellaneous Topics + +@node Miscellaneous Topics +@chapter Miscellaneous Topics + +@strong{TBD}
Modified: trunk/docs/manual/overview.texinfo ============================================================================== --- trunk/docs/manual/overview.texinfo (original) +++ trunk/docs/manual/overview.texinfo Tue Mar 21 03:00:29 2006 @@ -43,15 +43,45 @@
The remainder of this chapter provides basic information for programmers that want to use Graphic-Forms in their projects as well -as maintainers/contributors. +as contributors. + +@strong{Caution:} The information provided in this manual is subject +to change. The author and contributors reserve the right to make API +changes unless and until the interfaces are deemed stable, at which +time a policy for backwards compatibility will be published.
The main project website: @* @indicateurl{http://common-lisp.net/project/graphic-forms%7D
- @section Dependencies
-The libraries that Graphic-Forms relies upon. +The libraries that Graphic-Forms relies upon are: + +@table @code +@item ASDF +@indicateurl{http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/cclan/asdf%7D + +@item CFFI +@indicateurl{http://common-lisp.net/project/cffi%7D + +@item lw-compat +@indicateurl{http://common-lisp.net/project/cl-containers/lw-compat/lw-compat_latest.tar.... + +@item Closer to MOP +@indicateurl{http://common-lisp.net/project/cl-containers/closer-mop/closer-mop_latest.ta... + +@item ImageMagick +@indicateurl{http://www.imagemagick.org/download/binaries/ImageMagick-6.2.6-5-Q16-windows... + +@item lisp-unit +@indicateurl{http://www.cs.northwestern.edu/academics/courses/325/readings/lisp-unit.html... +@end table + + +@section Building the Library and Running Tests + +For the time being, please see the @code{README.txt} file included in the +distribution for instructions on how to load the ASDF system and run tests.
@section Mailing Lists and Bug Reports @@ -72,8 +102,4 @@ @section Submitting Patches
Please use the SourceForge patch tracking mechanism to contribute patches: - - -@section Running the Library Tests - -How to run unit-tests and ad-hoc tests. +@indicateurl{http://sourceforge.net/tracker/?atid=826147&group_id=163034&func=bro...
Modified: trunk/docs/manual/packages.texinfo ============================================================================== --- trunk/docs/manual/packages.texinfo (original) +++ trunk/docs/manual/packages.texinfo Tue Mar 21 03:00:29 2006 @@ -12,17 +12,33 @@
General comments about the packages.
-@section Intrinsics -@cindex Intrinsics Package - @section Graphics @cindex Graphics Package
+Nickname: GFG + +This package represents graphical functionality, particularly drawing +operations. Support for the ImageMagick library is defined here. This +package along with GFW constitute the bulk of the public API for +Graphic-Forms. + @section System @cindex System Package
+Nickname: GFS + +The symbols in this package correspond to system-level functionality, +examples of which include bindings for Win32 API functions and associated +constants. + @section Tests @cindex Tests Package
+This package contains the symbols corresponding to test programs. + @section Widgets @cindex Widgets Package + +This package contains symbols for all of the widgets, event methods, +and other UI objects defined by Graphic-Forms. This package and GFG +together constitute the bulk of the public API.
Modified: trunk/docs/manual/reference.texinfo ============================================================================== --- trunk/docs/manual/reference.texinfo (original) +++ trunk/docs/manual/reference.texinfo Tue Mar 21 03:00:29 2006 @@ -42,16 +42,20 @@ @end deftp @end macro
-@macro GFI -@acronym{GFW} +@macro ASDF +@acronym{ASDF} +@end macro + +@macro CFFI +@acronym{CFFI} @end macro
@macro GFG -@acronym{GFW} +@acronym{GFG} @end macro
@macro GFS -@acronym{GFW} +@acronym{GFS} @end macro
@macro GFW @@ -138,9 +142,11 @@ @majorheading Major Topics List
@menu -* Overview:: Notes on using Graphic-Forms and how to get help. -* Glossary:: Terms and definitions. -* Packages:: Summary of the library packages. +* Overview:: Basic information about Graphic-Forms. +* Packages:: Summary of the library packages. +* Miscellaneous Topics:: Various topics germane to Windows programming + and Graphic-Forms. +* Glossary:: Terms and definitions. * Master Index:: @end menu
@@ -149,6 +155,7 @@ @include overview.texinfo @include glossary.texinfo @include packages.texinfo +@include miscellaneous.texinfo
@c =================================================================== @c Index