[graphic-forms-cvs] r43 - in trunk/docs: manual website
junrue at common-lisp.net
junrue at common-lisp.net
Wed Mar 15 19:40:07 UTC 2006
Author: junrue
Date: Wed Mar 15 14:40:07 2006
New Revision: 43
Added:
trunk/docs/manual/glossary.texinfo
trunk/docs/manual/overview.texinfo
trunk/docs/manual/packages.texinfo
trunk/docs/manual/reference.texinfo
trunk/docs/website/docs.html
trunk/docs/website/download.html
trunk/docs/website/screenshots.html
Removed:
trunk/docs/manual/graphic-forms-reference.texinfo
Modified:
trunk/docs/manual/Makefile
trunk/docs/website/index.html
trunk/docs/website/style.css
Log:
documentation updates
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Wed Mar 15 14:40:07 2006
@@ -32,15 +32,12 @@
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
-#
-# TODO: upgrade MSYS version of makeinfo so "--css-include=style.css" works
-#
docs:
- makeinfo --html graphic-forms-reference.texinfo
+ makeinfo --html --css-include=style.css reference.texinfo
clean:
find . \( -name "*.info" -o -name "*.aux" -o -name "*.cp" -o -name "*.fn" -o -name "*.fns" -o -name "*.ky" -o -name "*.log" -o -name "*.pg" -o -name "*.toc" -o -name "*.tp" -o -name "*.vr" -o -name "*.dvi" -o -name "*.cps" -o -name "*.vrs" \) -exec rm {} \;
- rm -rf graphic-forms-reference
+ rm -rf reference
#
# TODO: implement an upload target
Added: trunk/docs/manual/glossary.texinfo
==============================================================================
--- (empty file)
+++ trunk/docs/manual/glossary.texinfo Wed Mar 15 14:40:07 2006
@@ -0,0 +1,29 @@
+
+ at c This file is part of the documentation source for
+ at c the Graphic-Forms library.
+ at c
+ at c Copyright (c) 2006, Jack D. Unrue
+
+ at c ===================================================================
+ at c CHAPTER: Glossary
+
+ at node Glossary
+ at chapter Glossary
+
+Terms and definitions.
+
+ at table @samp
+ at item control
+A control is a thing.
+
+ at item dialog
+A dialog is something else.
+
+ at item menu
+A collection of menu items.
+
+ at end table
+
+ at cindex control
+ at cindex dialog
+ at cindex menu
Added: trunk/docs/manual/overview.texinfo
==============================================================================
--- (empty file)
+++ trunk/docs/manual/overview.texinfo Wed Mar 15 14:40:07 2006
@@ -0,0 +1,79 @@
+
+ at c This file is part of the documentation source for
+ at c the Graphic-Forms library.
+ at c
+ at c Copyright (c) 2006, Jack D. Unrue
+
+ at c ===================================================================
+ at c CHAPTER: Overview
+
+ at node Overview
+ at chapter Overview
+
+Graphic-Forms is a user interface library implemented in Common Lisp
+focusing on the Windows at registeredsymbol{} platform. Graphic-Forms is
+licensed under the terms of the BSD License.
+
+Graphic-Forms has two primary goals:
+
+ at itemize @bullet
+ at item
+in the short term, provide a toolkit encapsulating the underlying
+window system primitives, custom controls and dialogs, and
+platform-specific features
+
+ at item
+in the longer-term, implement an application framework on
+top of the toolkit -- as an analogy, consider the relationship between
+SWT and JFace in the Eclipse framework.
+ at end itemize
+
+Support for multiple Common Lisp implementations is planned; see the
+project website for up-to-date information on supported vendors and
+current known issues.
+
+Why implement another UI toolkit? The niche for Graphic-Forms is that
+it emphasizes the use of Windows at registeredsymbol{} features without
+comprising functionality due to portability constraints. Applications
+that need portability across windowing systems are already served by
+projects such as McCLIM and LTK in the open-source world or the
+toolkits provided by commercial vendors. Or you might consider helping
+new portable UI projects such as wxCL. This project is aimed
+specifically at Windows at registeredsymbol{} developers.
+
+The remainder of this chapter provides basic information for
+programmers that want to use Graphic-Forms in their projects as well
+as maintainers/contributors.
+
+The main project website: @*
+ at indicateurl{http://common-lisp.net/project/graphic-forms}
+
+
+ at section Dependencies
+
+The libraries that Graphic-Forms relies upon.
+
+
+ at section Mailing Lists and Bug Reports
+
+Announcements mailing list: @*
+ at indicateurl{http://www.common-lisp.net/mailman/listinfo/graphic-forms-announce}
+
+Developer mailing list (for both users and maintainers): @*
+ at indicateurl{http://www.common-lisp.net/mailman/listinfo/graphic-forms-devel}
+
+Source control log mailing list: @*
+ at indicateurl{http://www.common-lisp.net/mailman/listinfo/graphic-forms-cvs}
+
+The bug tracking system: @*
+ at indicateurl{http://sourceforge.net/tracker/?group_id=20959&atid=120959}
+
+
+ at section Submitting Patches
+
+Please use the SourceForge patch tracking mechanism to contribute patches:
+
+
+ at section Running the Library Tests
+
+How to run unit-tests and ad-hoc tests.
Added: trunk/docs/manual/packages.texinfo
==============================================================================
--- (empty file)
+++ trunk/docs/manual/packages.texinfo Wed Mar 15 14:40:07 2006
@@ -0,0 +1,28 @@
+
+ at c This file is part of the documentation source for
+ at c the Graphic-Forms library.
+ at c
+ at c Copyright (c) 2006, Jack D. Unrue
+
+ at c ===================================================================
+ at c CHAPTER: Packages
+
+ at node Packages
+ at chapter Packages
+
+General comments about the packages.
+
+ at section Intrinsics
+ at cindex Intrinsics Package
+
+ at section Graphics
+ at cindex Graphics Package
+
+ at section System
+ at cindex System Package
+
+ at section Tests
+ at cindex Tests Package
+
+ at section Widgets
+ at cindex Widgets Package
Added: trunk/docs/manual/reference.texinfo
==============================================================================
--- (empty file)
+++ trunk/docs/manual/reference.texinfo Wed Mar 15 14:40:07 2006
@@ -0,0 +1,160 @@
+\input texinfo @c -*- Mode: Texinfo; Mode: auto-fill -*-
+ at c %**start of header
+
+ at c This file is part of the documentation source for
+ at c the Graphic-Forms library.
+ at c
+ at c Copyright (c) 2006, Jack D. Unrue
+
+ at setfilename reference.info
+ at settitle Graphic-Forms Programming Reference
+ at exampleindent 2
+
+ at c ============================= Macros =============================
+
+ at macro Function {args}
+ at defun \args\
+ at end defun
+ at end macro
+
+ at macro Macro {args}
+ at defmac \args\
+ at end defmac
+ at end macro
+
+ at macro Accessor {args}
+ at deffn {Accessor} \args\
+ at end deffn
+ at end macro
+
+ at macro GenericFunction {args}
+ at deffn {Generic Function} \args\
+ at end deffn
+ at end macro
+
+ at macro Variable {args}
+ at defvr {Special Variable} \args\
+ at end defvr
+ at end macro
+
+ at macro Condition {args}
+ at deftp {Condition Type} \args\
+ at end deftp
+ at end macro
+
+ at macro GFI
+ at acronym{GFW}
+ at end macro
+
+ at macro GFG
+ at acronym{GFW}
+ at end macro
+
+ at macro GFS
+ at acronym{GFW}
+ at end macro
+
+ at macro GFW
+ at acronym{GFW}
+ at end macro
+
+ at macro impnote {text}
+ at quotation
+ at strong{Implementor's note:} @emph{\text\}
+ at end quotation
+ at end macro
+
+ at c Info "requires" that x-refs end in a period or comma, or ) in the
+ at c case of @pxref. So the following implements that requirement for
+ at c the "See also" subheadings that permeate this manual, but only in
+ at c Info mode.
+ at ifinfo
+ at macro seealso {name}
+ at ref{\name\}.
+ at end macro
+ at end ifinfo
+
+ at ifnotinfo
+ at alias seealso = ref
+ at end ifnotinfo
+
+ at c ==========================End Macros =============================
+
+ at c Coallesce all the index types into one master index.
+ at syncodeindex fn cp
+ at syncodeindex ky cp
+ at syncodeindex tp cp
+ at syncodeindex vr cp
+
+ at copying
+Copyright @copyright{} 2006, Jack D. Unrue <jdunrue at gmail.com> @*
+
+ at quotation
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+ 1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ 3. Neither the names of the authors nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+ at sc{THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DIS
+DISCLAIMED. IN NO EVENT SHALL THE AUTHORS AND CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.}
+ at end quotation
+ at end copying
+ at c %**end of header
+
+ at titlepage
+ at title Graphic-Forms Programming Reference
+ at c @subtitle Version 0.2.0
+ at c @author Jack D. Unrue
+
+ at page
+ at vskip 0pt plus 1filll
+ at insertcopying
+ at end titlepage
+
+ at ifnottex
+ at node Top
+ at top Graphic-Forms Programming Reference
+ at insertcopying
+ at end ifnottex
+
+ at majorheading Major Topics List
+
+ at menu
+* Overview:: Notes on using Graphic-Forms and how to get help.
+* Glossary:: Terms and definitions.
+* Packages:: Summary of the library packages.
+* Master Index::
+ at end menu
+
+ at contents
+
+ at include overview.texinfo
+ at include glossary.texinfo
+ at include packages.texinfo
+
+ at c ===================================================================
+ at c Index
+
+ at node Master Index
+ at unnumbered Master Index
+ at printindex cp
+
+ at bye
Added: trunk/docs/website/docs.html
==============================================================================
--- (empty file)
+++ trunk/docs/website/docs.html Wed Mar 15 14:40:07 2006
@@ -0,0 +1,24 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+<head>
+ <title>Graphic-Forms Documentation</title>
+ <link rel="stylesheet" type="text/css" href="style.css">
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+</head>
+
+<body>
+
+ <h3><a href="reference/index.html">Programming Reference</a></h3>
+
+ <h3>FAQ</h3>
+
+ <h3>Articles</h3>
+
+ <div class="footer">
+ <a class="footerleft" href="http://common-lisp.net">common-lisp.net home</a>
+ Copyright © 2006 by <a href="http://home.earthlink.net/~jdunrue/">Jack D. Unrue</a>
+ </div>
+
+</body>
+</html>
Added: trunk/docs/website/download.html
==============================================================================
--- (empty file)
+++ trunk/docs/website/download.html Wed Mar 15 14:40:07 2006
@@ -0,0 +1,38 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+<head>
+ <title>Graphic-Forms Source Control</title>
+ <link rel="stylesheet" type="text/css" href="style.css">
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+</head>
+
+<body>
+
+ <p>Graphic-Forms is distributed in source code form. Please choose from
+ one of the following options:
+
+ <ul>
+ <li>
+ <a href="http://sourceforge.net/project/showfiles.php?group_id=1355">Download</a>
+ a release tarball.
+ </li>
+ <li>
+ <a href="http://common-lisp.net/faq.shtml">Download</a>
+ the current development tree via anonymous Subversion.
+ Note: <i><project-name></i> is <i>graphic-forms</i>.
+ </li>
+ <li>
+ <a href="http://common-lisp.net/websvn/listing.php?repname=graphic-forms&path=%2F&sc=0">Browse</a>
+ the Subversion repository.
+ </li>
+ </ul>
+ </p>
+
+ <div class="footer">
+ <a class="footerleft" href="http://common-lisp.net">common-lisp.net home</a>
+ Copyright © 2006 by <a href="http://home.earthlink.net/~jdunrue/">Jack D. Unrue</a>
+ </div>
+
+</body>
+</html>
Modified: trunk/docs/website/index.html
==============================================================================
--- trunk/docs/website/index.html (original)
+++ trunk/docs/website/index.html Wed Mar 15 14:40:07 2006
@@ -1,18 +1,27 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-<title>Graphic-Forms project</title>
- <link rel="stylesheet" type="text/css" href="style.css">
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- </head>
+<head>
+ <title>Graphic-Forms project</title>
+ <link rel="stylesheet" type="text/css" href="style.css">
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+</head>
- <body>
+<body>
<div class="header">
<h1>Graphic-Forms</h1>
<h2>A user interface toolkit for the Windows® platform.</h2>
</div>
+ <div class="NavBar">
+ <a class="barfirst" href="http://awayrepl.blogspot.com/">News</a>
+ <a class="barcenter" href="screenshots.html">Screenshots</a>
+ <a class="barcenter" href="download.html">Download</a>
+ <a class="barcenter" href="docs.html">Documentation</a>
+ <a class="barlast" href="http://sourceforge.net/tracker/?group_id=1355&atid=101355">Bug Database</a>
+</div>
+
+
<h3>Introduction</h3>
<p>Graphic-Forms is a user interface library implemented in
@@ -44,45 +53,38 @@
in the open-source world or the toolkits provided by commercial
vendors. Or you might consider helping new portable UI projects
such as <a href="http://www.wxcl-project.org">wxCL</a>. <i>This
- project</i> is aimed specifically at Windows® developers.
+ project</i> is aimed specifically at Windows® developers.</p>
- <h3>Current Status</h3>
+ <h3>Status</h3>
- <p>The Subversion repository will be populated with an initial code
- drop in the near future. Additional documentation will be
- made available at that time, as will screenshots.</p>
+ <p>The first release will be version 0.2.0 and should be
+ available shortly.</p>
- <p>NOTE: This library is in the early implementation stage. Brave souls who
+ <p>This library is in the early implementation stage. Brave souls who
experiment with the code should expect significant API and
- behavior changes in the preliminary releases leading up to the 1.0 release.<p>
+ behavior changes in the preliminary releases leading up to the 1.0 release.</p>
- <h3>Mailing Lists</h3>
+ <h3 id="mailinglists">Mailing Lists</h3>
<ul>
<li>
<a href="http://www.common-lisp.net/mailman/listinfo/graphic-forms-devel">
graphic-forms-devel</a><br>for both developers and users</li>
<li>
<a href="http://www.common-lisp.net/mailman/listinfo/graphic-forms-cvs">
- graphic-forms-cvs</a><br>CVS log feed</li>
+ graphic-forms-cvs</a><br>Subversion log feed</li>
<li>
<a href="http://www.common-lisp.net/mailman/listinfo/graphic-forms-announce">
graphic-forms-announce</a><br>for announcements</li>
-
</ul>
- <h3>Download</h3>
-
- <p>This project has not released any files.</p>
-
- <h3>Revision Control</h3>
-
- <p>You can <a href="http://common-lisp.net/websvn/listing.php?repname=graphic-forms&path=%2F&sc=0">
-browse the Subversion repository</a> or download the current development tree via
- anonymous svn, as described <a href="http://common-lisp.net/faq.shtml">here</a>.</p>
-
- <div class="footer">
- Copyright © 2006 by <a href="http://home.earthlink.net/~jdunrue/">Jack D. Unrue</a>
- </div>
+ <div class="footer">
+ <a class="footerleft" href="http://common-lisp.net">common-lisp.net home</a>
+ Copyright © 2006 by <a href="http://home.earthlink.net/~jdunrue/">Jack D. Unrue</a>
+ </div>
+
+<!--
+ <a href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=20959" width="88" height="31" border="0" alt="SourceForge Logo"></a>
+-->
</body>
</html>
Added: trunk/docs/website/screenshots.html
==============================================================================
--- (empty file)
+++ trunk/docs/website/screenshots.html Wed Mar 15 14:40:07 2006
@@ -0,0 +1,20 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+<head>
+ <title>Graphic-Forms Screenshots</title>
+ <link rel="stylesheet" type="text/css" href="style.css">
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+</head>
+
+<body>
+
+ <p>Screenshots coming soon...stay tuned!</p>
+
+ <div class="footer">
+ <a class="footerleft" href="http://common-lisp.net">common-lisp.net home</a>
+ Copyright © 2006 by <a href="http://home.earthlink.net/~jdunrue/">Jack D. Unrue</a>
+ </div>
+
+</body>
+</html>
Modified: trunk/docs/website/style.css
==============================================================================
--- trunk/docs/website/style.css (original)
+++ trunk/docs/website/style.css Wed Mar 15 14:40:07 2006
@@ -24,19 +24,24 @@
.footer a:link {
font-weight:bold;
color:#ffffff;
- text-decoration:underline;
}
.footer a:visited {
font-weight:bold;
color:#ffffff;
- text-decoration:underline;
}
-.footer a:hover {
+:link.footerleft {
font-weight:bold;
- color:#002244;
- text-decoration:underline; }
+ float: left;
+ color:#ffffff;
+}
+
+:visited.footerleft {
+ font-weight:bold;
+ float: left;
+ color:#ffffff;
+}
.check {font-size: x-small;
text-align:right;}
@@ -52,3 +57,52 @@
.check a:hover { font-weight:bold;
color:#000000;
text-decoration:underline; }
+
+div.NavBar {
+ padding: 4px 0px 4px 0px;
+ float: right;
+ font-weight:bold;
+}
+
+.barfirst {
+ padding: 0px 5px 0px 5px;
+ margin: 0px 3px 0px 0px;
+ border-width: 0px 0px 0px 1px;
+ border-style: none none none solid;
+}
+
+.barcenter {
+ padding: 0px 5px 0px 5px;
+ margin: 0px 3px 0px 0px;
+ border-width: 0px 0px 0px 1px;
+ border-style: none none none solid;
+}
+
+.barlast {
+ padding: 0px 5px 0px 5px;
+ border-width: 0px 0px 0px 1px;
+ border-style: none none none solid;
+}
+
+:hover.barfirst {
+ padding: 0px 5px 0px 5px;
+ margin: 0px 3px 0px 0px;
+ border-width: 0px 0px 0px 1px;
+ border-style: none none none solid;
+ background-color:#e4e4e4;
+}
+
+:hover.barcenter {
+ padding: 0px 5px 0px 5px;
+ margin: 0px 3px 0px 0px;
+ border-width: 0px 0px 0px 1px;
+ border-style: none none none solid;
+ background-color:#e4e4e4;
+}
+
+:hover.barlast {
+ padding: 0px 5px 0px 5px;
+ border-width: 0px 0px 0px 1px;
+ border-style: none none none solid;
+ background-color:#e4e4e4;
+}
More information about the Graphic-forms-cvs
mailing list