Menu
▾
▴
[Oorexx-svn] SF.net SVN: oorexx:[4118] docs/trunk
|
From: <mie...@us...> - 2009-02-10 05:14:14
|
Revision: 4118
http://oorexx.svn.sourceforge.net/oorexx/?rev=4118&view=rev
Author: miesfeld
Date: 2009-02-10 05:14:03 +0000 (Tue, 10 Feb 2009)
Log Message:
-----------
Fix the Windows Extensions document so it builds as a book on its own.
Modified Paths:
--------------
docs/trunk/Makefile
docs/trunk/winextensions/Makefile
docs/trunk/winextensions/preface.sgml
docs/trunk/winextensions/winclasses.sgml
docs/trunk/winextensions/winextensions.sgml
Added Paths:
-----------
docs/trunk/winextensions/docbook-1.png
docs/trunk/winextensions/hyperref.cfg
docs/trunk/winextensions/oorexx.jpg
Modified: docs/trunk/Makefile
===================================================================
--- docs/trunk/Makefile 2009-02-10 03:19:40 UTC (rev 4117)
+++ docs/trunk/Makefile 2009-02-10 05:14:03 UTC (rev 4118)
@@ -41,7 +41,7 @@
#----------------------------------------------------------------------------
-SUBDIRS=oodialog readme rexxpg rexxref rxftp rxmath rxsock
+SUBDIRS=oodialog readme rexxpg rexxref rxftp rxmath rxsock winextensions
all:
for d in $(SUBDIRS); do (cd $$d && make all); done
Modified: docs/trunk/winextensions/Makefile
===================================================================
--- docs/trunk/winextensions/Makefile 2009-02-10 03:19:40 UTC (rev 4117)
+++ docs/trunk/winextensions/Makefile 2009-02-10 05:14:03 UTC (rev 4118)
@@ -2,7 +2,7 @@
#
# Description: Makefile for the Object Rexx Reference Documents.
#
-# Copyright (c) 2005-2007, Rexx Language Association. All rights reserved.
+# Copyright (c) 2005-2009, Rexx Language Association. All rights reserved.
#
# This program and the accompanying materials are made available under
# the terms of the Common Public License v1.0 which accompanies this
@@ -42,157 +42,48 @@
STYLESHEET = /usr/share/sgml/docbook/dsssl-stylesheets/print/docbook.dsl \
- ../shared/oorexx.print.dsl
+ ../shared/oorexx.print.dsl
+
HTML_STYLESHEET = /usr/share/sgml/docbook/dsssl-stylesheets/html/docbook.dsl \
- ../shared/oorexx.html.dsl
+ ../shared/oorexx.html.dsl
+SGML_FILES = winclasses.sgml \
+ wsheng.sgml \
+ ../shared/legalstuff.sgml \
+ ../shared/notices.sgml \
+ ../shared/gethelp.sgml \
+ ../shared/CPLv1.0.sgml
-SGML_FILES = collclasses.sgml \
- condtra.sgml \
- classes.sgml \
- streamclasses.sgml \
- utilityclasses.sgml \
- winclasses.sgml \
- dire.sgml \
- errnum.sgml \
- errnums.sgml \
- funct.sgml \
- fundclasses.sgml \
- instrc.sgml \
- intro.sgml \
- iostrms.sgml \
- mig.sgml \
- numarit.sgml \
- oneof.sgml \
- parsingch.sgml \
- preface.sgml \
- provide.sgml \
- resvkey.sgml \
- rexutil.sgml \
- rexxref.sgml \
- secman.sgml \
- spvard.sgml \
- usepcom.sgml \
- wsheng.sgml \
- xconcur.sgml \
- xintdeb.sgml \
- collectionclassmethods.sgml \
- mapcollectionclassmethods.sgml \
- orderedcollectionclassmethods.sgml \
- ../shared/legalstuff.sgml \
- ../shared/notices.sgml \
- ../shared/gethelp.sgml \
- ../shared/CPLv1.0.sgml
+IMAGE_FILES = docbook-1.png \
+ oorexx.jpg
-IMAGE_FILES = ooRexxObjectClass.png \
- ooRexxClassClass.png \
- ooRexxMethodClass.png \
- ooRexxMessageClass.png \
- ooRexxStringClass.png \
- ooRexxArrayClass.png \
- ooRexxCollectionsClass.png \
- ooRexxOrderedCollectionClass.png \
- ooRexxCircularQueueClass.png \
- ooRexxListClass.png \
- ooRexxQueueClass.png \
- ooRexxDirectoryClass.png \
- ooRexxPropertiesClass.png \
- ooRexxStemClass.png \
- ooRexxMapCollectionClass.png \
- ooRexxRelationClass.png \
- ooRexxTableClass.png \
- ooRexxSetCollectionClass.png \
- ooRexxSetClass.png \
- ooRexxBagClass.png \
- ooRexxStreamClass.png \
- ooRexxInputStreamClass.png \
- ooRexxInputOutputStreamClass.png \
- ooRexxOutputStreamClass.png \
- ooRexxComparableClass.png \
- ooRexxAlarmClass.png \
- ooRexxMonitorClass.png \
- ooRexxMutableBufferClass.png \
- ooRexxRegularExpressionClass.png \
- ooRexxSupplierClass.png \
- ooRexxComparatorClass.png \
- ooRexxCaselessColumnComparatorClass.png \
- ooRexxColumnComparatorClass.png \
- ooRexxCaselessComparatorClass.png \
- ooRexxCaselessDescendingComparatorClass.png \
- ooRexxDescendingComparatorClass.png \
- ooRexxInvertingComparatorClass.png \
- ooRexxIteratorClass.png \
- ooRexxCircularIteratorClass.png \
- ooRexxStreamSupplierClass.png \
- ooRexxRexxQueueClass.png \
- ooRexxDateTimeClass.png \
- ooRexxTimeSpanClass.png \
- ooRexxClasses1.png \
- ooRexxClasses2.png \
- ooRexxClasses3.png \
- ooRexxClasses4.png \
- ooRexxClasses5.png \
- ooRexxClasses6.png \
- ooRexxClasses7.png \
- doloopconcept.png \
- doloopcollection.png \
- parseconcepts1.png \
- parseconcepts2.png \
- parseconcepts3.png \
- filerecord.png \
- templates1.png \
- templates2.png \
- templates3.png \
- ReportObject.png \
- BallObject.png \
- BallObjectData.png \
- EncapsulatedObject.png \
- SimpleClass.png \
- IconClass.png \
- IconClassInstances.png \
- Subclasses.png \
- ScreenObject.png \
- MultipleInheritance.png \
- Modules.png \
- MultipleRequires.png \
- EarlyReply.png \
- BeforeReply.png \
- AfterReply.png \
- IndirectRecursion.png \
- externalFunction.png \
- externalFileSearch.png \
- oorexx.jpg \
- docbook-1.png \
- new_rexxla.jpg
-
JADETEXFMT = ./pdfjadetex.fmt
HYPERREFCFG = ./hyperref.cfg
TEXMF = /usr/share/texmf
export TEXFORMATS=.:
-
all: pdf html
-pdf: rexxref.pdf
+pdf: winextensions.pdf
-html: rexxref-html.zip
+html: winextensions-html.zip
-rexxref.pdf: $(IMAGE_FILES) $(STYLESHEET) $(JADETEXFMT) genindex.sgml svnrev.tmp
- docbook2pdf -d ../shared/oorexx.print.dsl rexxref.sgml
+winextensions.pdf: $(IMAGE_FILES) $(STYLESHEET) $(JADETEXFMT) genindex.sgml svnrev.tmp
+ docbook2pdf -d ../shared/oorexx.print.dsl winextensions.sgml
book1.htm: $(IMAGE_FILES) $(HTML_STYLESHEET) genindex.sgml svnrev.tmp
- docbook2html -d ../shared/oorexx.html.dsl rexxref.sgml
+ docbook2html -d ../shared/oorexx.html.dsl winextensions.sgml
-rexxref-html.zip: book1.htm
- zip rexxref-html *.htm *.jpg
+winextensions-html.zip: book1.htm
+ zip winextensions-html *.htm *.jpg
$(JADETEXFMT): $(HYPERREFCFG)
pdftex -ini \&pdflatex pdfjadetex.ini
genindex.sgml: $(HTML_STYLESHEET) $(SGML_FILES) svnrev.tmp
collateindex.pl -N -o genindex.sgml
- jade -t sgml -d ../shared/oorexx.html.dsl -V html-index rexxref.sgml
+ jade -t sgml -d ../shared/oorexx.html.dsl -V html-index winextensions.sgml
rm *.htm
collateindex.pl -p -g -o genindex.sgml HTML.index
@@ -200,9 +91,6 @@
svnversion > svnrev.tmp
-
-
clean:
- rm *.log *.aux *.out *.fmt *.pdf genindex.sgml *.htm *.zip \
- HTML.index *.tmp
+ rm -f *.log *.aux *.out *.fmt *.pdf genindex.sgml *.htm *.zip HTML.index *.tmp
Copied: docs/trunk/winextensions/docbook-1.png (from rev 4115, docs/trunk/rexxref/docbook-1.png)
===================================================================
(Binary files differ)
Copied: docs/trunk/winextensions/hyperref.cfg (from rev 4115, docs/trunk/rexxref/hyperref.cfg)
===================================================================
--- docs/trunk/winextensions/hyperref.cfg (rev 0)
+++ docs/trunk/winextensions/hyperref.cfg 2009-02-10 05:14:03 UTC (rev 4118)
@@ -0,0 +1,8 @@
+\PassOptionsToPackage{pdftitle={Open Object Rexx: Reference}}{hyperref}
+\PassOptionsToPackage{pdfauthor={Rexx Language Association}}{hyperref}
+\PassOptionsToPackage{pdfsubject={ooRexx Reference}}{hyperref}
+\PassOptionsToPackage{pdfkeywords={ooRexx, Classes, Reference, Functions}}{hyperref}
+\PassOptionsToPackage{linkcolor=blue}{hyperref}
+\PassOptionsToPackage{citecolor=blue}{hyperref}
+\PassOptionsToPackage{urlcolor=blue}{hyperref}
+\PassOptionsToPackage{anchorcolor=blue}{hyperref}
Copied: docs/trunk/winextensions/oorexx.jpg (from rev 4115, docs/trunk/rexxref/oorexx.jpg)
===================================================================
(Binary files differ)
Modified: docs/trunk/winextensions/preface.sgml
===================================================================
--- docs/trunk/winextensions/preface.sgml 2009-02-10 03:19:40 UTC (rev 4117)
+++ docs/trunk/winextensions/preface.sgml 2009-02-10 05:14:03 UTC (rev 4118)
@@ -1,8 +1,8 @@
<!--#########################################################################
#
- # Description: Open Object Rexx: Reference SGML file.
+ # Description: Open Object Rexx: Windows Extensions Reference SGML file.
#
- # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved.
+ # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved.
# Portions Copyright (c) 2004, IBM Corporation. All rights reserved.
#
# This program and the accompanying materials are made available under
@@ -42,23 +42,35 @@
#########################################################################
-->
<preface id="preface"><title>About This Book</title>
-<para>This book describes the Open Object Rexx Interpreter, called the
-<emphasis role="italic">interpreter</emphasis> or
-<emphasis role="italic">language processor</emphasis> in the
-following, and the object-oriented Rexx language.</para>
-<para>This book is intended for people who plan to develop applications using
-Rexx. Its users range from the novice, who might have experience in some
-programming language but no Rexx experience, to the experienced application
-developer, who might have had some experience with Object Rexx.</para>
-<para>This book is a reference rather than a tutorial. It assumes you are
-already familiar with object-oriented programming concepts.</para>
-<para>Descriptions include the use and syntax of the language and explain how
-the language processor "interprets" the language as a program is
-running.</para>
+<para>
+ This book describes extensions to the Open Object Rexx Interpreter that are specific to the Windows
+ operating system. The extensions described in this book are currently only available on Windows. Each
+ of the extensions is implemented as a class. Some of the classes, such as the <link
+ linkend="clsWinEventLog">WindowsEventLog</link> and the <link
+ linkend="clsWinRegistry">WindowsRegistry</link> classes, by their nature, can only be Windows specific.
+ Some of the other classes, such as the <link linkend="clsWinMenuObject">MenuObject</link> or <link
+ linkend="clsWinObject">WindowObject</link> classes could certainly be
+ enhanced to be cross-platform. However, at this time there are no plans to do
+ so.
+</para>
+<para>
+ This book is intended for people who plan to develop applications using ooRexx and one or more of the
+ Windows specific classes. In general no special knowledge of Windows programming is needed to use the
+ Windows extensions. Therefore this book is applicable for users ranging in experience from the novice
+ ooRexx programmer, to the experienced application developer.
+</para>
+<para>
+ This book is a reference rather than a tutorial. It assumes you are already familiar with
+ object-oriented programming concepts.
+</para>
+<para>
+ This book covers the use and syntax of the Windows specific classes and their methods. Many of the
+ descriptions of class methods also include example code snippets.
+</para>
<section id="relinf"><title>Related Information</title>
<para>See also:
-<citetitle pubwork="book">Open Object Rexx: Programming Guide</citetitle></para>
+<citetitle pubwork="book">Open Object Rexx: Reference</citetitle></para>
</section>
<section id="readsy"><title>How to Read the Syntax Diagrams</title>
Modified: docs/trunk/winextensions/winclasses.sgml
===================================================================
--- docs/trunk/winextensions/winclasses.sgml 2009-02-10 03:19:40 UTC (rev 4117)
+++ docs/trunk/winextensions/winclasses.sgml 2009-02-10 05:14:03 UTC (rev 4118)
@@ -41,7 +41,7 @@
#
#########################################################################
-->
-<section id="winclasses"><title>The Windows Specific Classes</title>
+<chapter id="winclasses"><title>The Windows Specific Classes</title>
<para>This section describes the Windows-specific classes supplied with
ooRexx.</para>
@@ -700,7 +700,7 @@
Instantiates a new OLEObject as a proxy for a COM / OLE object with the specified <emphasis
role="italic">classID</emphasis> (the <computeroutput>ProgID</computeroutput> or
<computeroutput>CLSID</computeroutput>). If the COM / OLE object can not be accessed or created, an
- error will be raised. See the list of <link linkend="ERR92">OLE specific errors</link>.
+ error will be raised. See the list of OLE specific errors in the Open Object Rexx Reference document.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
@@ -1499,7 +1499,7 @@
</para>
<para>
For further information on the details on how an <computeroutput>unknown</computeroutput> method works,
- see <link linkend="unkno">Defining an unknown Method</link>.
+ see <emphasis role="italic">Defining an unknown Method</emphasis> in the Open Object Rexx Reference.
</para>
<para>
The programmer can invoke the methods of the real OLE object by simply invoking the methods on the
@@ -1511,7 +1511,7 @@
<para>
This calls the method <computeroutput>"OLEMethodName"</computeroutput> of the real OLE object for any
message (method) <emphasis role="italic">that does not exist</emphasis> in the Rexx OLEObject object
- through the <link linkend="unkno">unknown</link> method mechanism. The implementation for the
+ through the <emphasis role="italic">unknown</emphasis> method mechanism. The implementation for the
<computeroutput>unknown</computeroutput>() method in the OLEObject class does this by dispatching the
method call to the real OLE object.
</para>
@@ -1522,8 +1522,8 @@
<para>
One choice is for the programmer to call the <computeroutput>unknown</computeroutput> method directly.
E.g., take an OLE object that has the method <computeroutput>copy</computeroutput> used to copy
- something from a source to a destination. Since <link linkend="mthObjectCopy">copy</link> is a method
- of the <link linkend="clsObject">Object</link> class, the copy method of the OLE object is a method
+ something from a source to a destination. Since <computeroutput>copy</computeroutput> is a method
+ of the <computeroutput>Object</computeroutput> class, the copy method of the OLE object is a method
name already defined for the OLEObject. The programmer can invoke the
<computeroutput>unknown</computeroutput> method directly, like this:
</para>
@@ -5538,5 +5538,5 @@
</section>
</section>
-</section>
+</chapter>
Modified: docs/trunk/winextensions/winextensions.sgml
===================================================================
--- docs/trunk/winextensions/winextensions.sgml 2009-02-10 03:19:40 UTC (rev 4117)
+++ docs/trunk/winextensions/winextensions.sgml 2009-02-10 05:14:03 UTC (rev 4118)
@@ -3,50 +3,19 @@
[
<!ENTITY legalstuff SYSTEM "../shared/legalstuff.sgml">
<!ENTITY preface SYSTEM "preface.sgml">
-<!ENTITY intro SYSTEM "intro.sgml">
-<!ENTITY instrc SYSTEM "instrc.sgml">
-<!ENTITY dire SYSTEM "dire.sgml">
-<!ENTITY provide SYSTEM "provide.sgml">
-<!ENTITY classes SYSTEM "classes.sgml">
-<!ENTITY fundclasses SYSTEM "fundclasses.sgml">
-<!ENTITY strmclasses SYSTEM "streamclasses.sgml">
-<!ENTITY collclasses SYSTEM "collclasses.sgml">
-<!ENTITY utilityclasses SYSTEM "utilityclasses.sgml">
<!ENTITY winclasses SYSTEM "winclasses.sgml">
-<!ENTITY xothcla SYSTEM "xothcla.sgml">
-<!ENTITY oneof SYSTEM "oneof.sgml">
-<!ENTITY funct SYSTEM "funct.sgml">
-<!ENTITY rexutil SYSTEM "rexutil.sgml">
-<!ENTITY parsingch SYSTEM "parsingch.sgml">
-<!ENTITY numarit SYSTEM "numarit.sgml">
-<!ENTITY condtra SYSTEM "condtra.sgml">
-<!ENTITY xconcur SYSTEM "xconcur.sgml">
-<!ENTITY secman SYSTEM "secman.sgml">
-<!ENTITY iostrms SYSTEM "iostrms.sgml">
-<!ENTITY xintdeb SYSTEM "xintdeb.sgml">
-<!ENTITY resvkey SYSTEM "resvkey.sgml">
-<!ENTITY spvard SYSTEM "spvard.sgml">
-<!ENTITY usepcom SYSTEM "usepcom.sgml">
<!ENTITY wsheng SYSTEM "wsheng.sgml">
-<!ENTITY dokey SYSTEM "dokey.sgml">
-<!ENTITY mig SYSTEM "mig.sgml">
-<!ENTITY errnum SYSTEM "errnum.sgml">
-<!ENTITY errnums SYSTEM "errnums.sgml">
<!ENTITY notices SYSTEM "../shared/notices.sgml">
<!ENTITY cpl SYSTEM "../shared/CPLv1.0.sgml">
<!ENTITY gethelp SYSTEM "../shared/gethelp.sgml">
<!ENTITY genindex SYSTEM "genindex.sgml">
-<!ENTITY objclsmthods SYSTEM "objectclassmethods.sgml">
-<!ENTITY collclsmthods SYSTEM "collectionclassmethods.sgml">
-<!ENTITY ocollclsmthods SYSTEM "orderedcollectionclassmethods.sgml">
-<!ENTITY mcollclsmthods SYSTEM "mapcollectionclassmethods.sgml">
<!ENTITY svnrev SYSTEM "svnrev.tmp">
]>
<!--#########################################################################
#
- # Description: Open Object Rexx: Reference SGML file.
+ # Description: Open Object Rexx: Windows Extensions SGML file.
#
- # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved.
+ # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved.
# Portions Copyright (c) 2004, IBM Corporation. All rights reserved.
#
# This program and the accompanying materials are made available under
@@ -88,41 +57,21 @@
<book>
<bookinfo>
<title>Open Object Rexx™</title>
-<subtitle>Reference</subtitle>
-<titleabbrev>ooRexx Reference</titleabbrev>
+<subtitle>Windows Extensions Reference</subtitle>
+<titleabbrev>Win Extensions Reference</titleabbrev>
&legalstuff;
</bookinfo>
-&preface; <!-- About This Book -->
+&preface; <!-- About This Book -->
<!-- start of body -->
-&intro; <!-- Rexx General Concepts -->
-&instrc; <!-- Keyword Instructions -->
-&dire; <!-- Directives -->
-&provide; <!-- Objects and Classes -->
-&classes; <!-- The Builtin Classes -->
-&oneof; <!-- Other Objects -->
-&funct; <!-- Functions -->
-&rexutil; <!-- Rexx Utilities (RexxUtil) -->
-&parsingch; <!-- Parsing -->
-&numarit; <!-- Numbers and Arithmetic -->
-&condtra; <!-- Conditions and Condition Traps -->
-&xconcur; <!-- Concurrency -->
-&secman; <!-- The Security Manager -->
-&iostrms; <!-- Input and Output Streams -->
-&xintdeb; <!-- Debugging Aids -->
-&resvkey; <!-- Reserved Keywords -->
-&spvard; <!-- Special Variables -->
-&usepcom; <!-- Useful Services -->
-&wsheng; <!-- Windows Scripting Host Engine -->
+&winclasses; <!-- Rexx General Concepts -->
+&wsheng; <!-- Windows Scripting Host Engine -->
<!-- start of appendix -->
-&dokey; <!-- Using the DO Keyword -->
-&mig; <!-- Migration -->
-&errnum; <!-- Error Numbers and Messages -->
-¬ices; <!-- Notices -->
-&cpl; <!-- CPL -->
+¬ices; <!-- Notices -->
+&cpl; <!-- CPL -->
<!-- start of index -->
-&genindex; <!-- Index -->
+&genindex; <!-- Index -->
</book>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|