From: <mie...@us...> - 2012-07-17 04:41:26
|
Revision: 8094 http://oorexx.svn.sourceforge.net/oorexx/?rev=8094&view=rev Author: miesfeld Date: 2012-07-17 04:41:19 +0000 (Tue, 17 Jul 2012) Log Message: ----------- Clarify DlgUtil::version in the ooDialog fixes doc Modified Paths: -------------- docs/branches/4.1/trunk/oodialog/Makefile docs/branches/4.1/trunk/oodialog/oodialog.xml docs/branches/4.1/trunk/oodialog/utilityclasses.xml Added Paths: ----------- docs/branches/4.1/trunk/oodialog/legalstuff.xml Modified: docs/branches/4.1/trunk/oodialog/Makefile =================================================================== --- docs/branches/4.1/trunk/oodialog/Makefile 2012-07-17 04:39:58 UTC (rev 8093) +++ docs/branches/4.1/trunk/oodialog/Makefile 2012-07-17 04:41:19 UTC (rev 8094) @@ -2,7 +2,7 @@ # # Description: Makefile for the Object Rexx OODialog Reference PDF # -# Copyright (c) 2005-2010, Rexx Language Association. All rights reserved. +# Copyright (c) 2005-2012 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 @@ -76,7 +76,7 @@ treecontrolc.xml \ userdialog.xml \ ../shared/notices.xml \ - ../shared/legalstuff.xml \ + legalstuff.xml \ ../shared/gethelp.xml \ ../shared/CPLv1.0.xml # the following files are not used & are here only for historical reasons @@ -132,7 +132,10 @@ svnrev.tmp: svnversion > svnrev.tmp +datepub.tmp: + date "+%A, %B %d %Y" > datepub.tmp + clean: rm -f *.log *.aux *.out *.fmt oodialog.pdf genindex.xml *.htm *.zip HTML.index *.tmp Added: docs/branches/4.1/trunk/oodialog/legalstuff.xml =================================================================== --- docs/branches/4.1/trunk/oodialog/legalstuff.xml (rev 0) +++ docs/branches/4.1/trunk/oodialog/legalstuff.xml 2012-07-17 04:41:19 UTC (rev 8094) @@ -0,0 +1,120 @@ +<!--######################################################################### + # + # Description: Common SGML file for all Open Object Rexx Documentation, + # modified slightly for ooDialog. + # + # Copyright (c) 2005-2012 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 + # the terms of the Common Public License v1.0 which accompanies this + # distribution. A copy is also available at the following address: + # http://www.oorexx.org/license.html + # + # Redistribution and use in source and binary forms, with or + # without modification, are permitted provided that the following + # conditions are met: + # + # Redistributions of source code must retain the above copyright + # notice, this list of conditions and the following disclaimer. + # 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. + # + # Neither the name of Rexx Language Association nor the names + # of its contributors may be used to endorse or promote products + # derived from this software without specific prior written permission. + # + # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + # OWNER OR 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. + # + # Author(s): + # W. David Ashley <da...@us...> + # + ######################################################################### +--> +<orgname>Rexx Language Association</orgname> +<copyright> + <year>1995</year> + <year>2004</year> + <holder>IBM Corporation and others. All rights reserved.</holder> +</copyright> +<copyright> + <year>2005</year> + <year>2006</year> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <year>2011</year> + <year>2012</year> + <holder>Rexx Language Association. All rights reserved.</holder> +</copyright> +<authorgroup> + <collab><collabname>W. David Ashley</collabname></collab> + <collab><collabname>Rony G. Flatscher</collabname></collab> + <collab><collabname>Mark Hessling</collabname></collab> + <collab><collabname>Rick McGuire</collabname></collab> + <collab><collabname>Mark Miesfeld</collabname></collab> + <collab><collabname>Lee Peedin</collabname></collab> + <collab><collabname>Oliver Sims</collabname></collab> + <collab><collabname>Jon Wolfers</collabname></collab> +</authorgroup> + +<!--####################################################################### + # The following need to be modified for each release! + #######################################################################--> +<edition>Version 4.1.0</edition> +<pubdate>May 15, 2012</pubdate> +<!--####################################################################### + # The releaseinfo tag is used to show the release status of a document. + # + # Use the following for production releases. + # + # <releaseinfo>Revision 1</releaseinfo> + # or + # <releaseinfo></releaseinfo> + # + # Use the following for draft releases of a document. + # + # <releaseinfo>Draft - SVN Rev &svnrev;</releaseinfo> + # Draft - SVN Rev &svnrev; + # + #########################################################################--> +<releaseinfo>Revision 1</releaseinfo> +<!--####################################################################### + # End of modification area. + #######################################################################--> + +<mediaobject> +<imageobject> +<!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> +<imagedata fileref="oorexx.jpg" align="center"> +</imageobject> +</mediaobject> +<legalnotice> +<para> + This program and the accompanying materials are made available under the terms of the <link linkend="cplv10" + endterm="cplv10.title"></link>. +</para> +<para> + Before using this information and the product it supports, be sure to read the general information under <link + linkend="notices" endterm="notices.title"></link>. +</para> +<para> + This document was originally owned and copyrighted by IBM Corporation 1995, 2004. It was donated as open source under + the <link linkend="cplv10" endterm="cplv10.title"></link> to the Rexx Language Association in 2004. +</para> +<para> + Thanks to Julian Choy for the ooRexx logo design. +</para> +</legalnotice> Property changes on: docs/branches/4.1/trunk/oodialog/legalstuff.xml ___________________________________________________________________ Added: svn:eol-style + native Modified: docs/branches/4.1/trunk/oodialog/oodialog.xml =================================================================== --- docs/branches/4.1/trunk/oodialog/oodialog.xml 2012-07-17 04:39:58 UTC (rev 8093) +++ docs/branches/4.1/trunk/oodialog/oodialog.xml 2012-07-17 04:41:19 UTC (rev 8094) @@ -1,7 +1,7 @@ <?xml version="1.0" standalone="no"> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ -<!ENTITY legalstuff SYSTEM "../shared/legalstuff.xml"> +<!ENTITY legalstuff SYSTEM "legalstuff.xml"> <!ENTITY preface SYSTEM "preface.xml"> <!ENTITY overview SYSTEM "overview.xml"> <!ENTITY termdef SYSTEM "termdef.xml"> @@ -35,12 +35,13 @@ <!ENTITY gethelp SYSTEM "../shared/gethelp.xml"> <!ENTITY genindex SYSTEM "genindex.xml"> <!ENTITY svnrev SYSTEM "svnrev.tmp"> +<!ENTITY datepub SYSTEM "datepub.tmp"> ]> <!--######################################################################### # - # Description: Open Object Rexx: OODialog Reference SGML file. + # Description: Open Object Rexx: ooDialog Reference SGML file. # - # Copyright (c) 2005-2010, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2012 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 @@ -81,9 +82,9 @@ --> <book> <bookinfo> -<title>Open Object Rexx™</title> -<subtitle>Windows OODialog Reference</subtitle> -<titleabbrev>ooRexx OODialog Reference</titleabbrev> +<title>ooDialog Reference Manual</title> +<subtitle>ooDialog an ooRexx™ Extension</subtitle> +<titleabbrev>ooDialog Reference</titleabbrev> &legalstuff; Modified: docs/branches/4.1/trunk/oodialog/utilityclasses.xml =================================================================== --- docs/branches/4.1/trunk/oodialog/utilityclasses.xml 2012-07-17 04:39:58 UTC (rev 8093) +++ docs/branches/4.1/trunk/oodialog/utilityclasses.xml 2012-07-17 04:41:19 UTC (rev 8094) @@ -237,48 +237,55 @@ <indexterm><primary>version</primary></indexterm> <programlisting> <![CDATA[ - +-Full----+ ->>-.DlgUtil~version(--------------)------------------------>< - +-Short---+ +>>-.DlgUtil~version(--+----------+--)---------------------->< + +-format---+ ]]> </programlisting> <para>Returns the ooDialog version string.</para> <variablelist> -<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> -<listitem><para>There are no arguments for this method. -<variablelist> -<varlistentry><term>format</term> -<listitem> -<para> - A keyword indicating the format of the returned version string. Only the first letter is - needed and case is not significant. Any unrecognized keyword is ignored and the default - format is used. The format for each keyword is as follows: -</para> -<variablelist> -<varlistentry><term>Full</term> -<listitem> -<para> - A string specifying the version of ooDialog. This is the default. The string has the format: - <computeroutput>ooDialog Version x.x.x.SS (an ooRexx Windows Extension) </computeroutput> where - x.x.x is the ooRexx interpreter version and SS is the Subversion revision number of the build. - The actual version string might look like: <computeroutput>ooDialog Version 4.0.0.3734 (an ooRexx - Windows Extension)</computeroutput> -</para></listitem></varlistentry> -<varlistentry><term>Short</term> -<listitem><para>Only the x.x.x.SS part of the full version string is returned. -</para></listitem></varlistentry> -</variablelist> -</listitem></varlistentry> -</variablelist> -</para></listitem></varlistentry> -<varlistentry><term><emphasis role="bold">Return value:</emphasis></term> -<listitem> -<para> - A string in one of the formats specified above. -</para></listitem></varlistentry> -<varlistentry><term><emphasis role="bold">Example:</emphasis></term> -<listitem><para> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The single argument is: + <variablelist> + <varlistentry><term>format [optional]</term> + <listitem> + <para> + A keyword indicating the format of the returned version string. Only the first letter is + needed and case is not significant. Any unrecognized keyword is ignored and the default + format is used. The format for each keyword is as follows: + </para> + <variablelist> + <varlistentry><term>Full</term> + <listitem> + <para> + A string specifying the version of ooDialog. This is the default. The string has the format: + <computeroutput>ooDialog Version x.x.x.SS (an ooRexx Windows Extension) </computeroutput> where + x.x.x is the ooDialog version and SS is the Subversion revision number of the build. The actual version string might + look like: <computeroutput>ooDialog Version 4.1.0.8038 (an ooRexx Windows Extension)</computeroutput> + </para> + </listitem></varlistentry> + <varlistentry><term>Short</term> + <listitem> + <para> + Only the x.x.x.SS part of the full version string is returned. + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + </variablelist> + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + A string in one of the formats specified above. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> <programlisting> <![CDATA[ v = .DlgUtil~version @@ -286,10 +293,10 @@ say if .DlgUtil~version("SHORT") < 4.1.0.0000 then do - say 'Too bad, you are still running ooRexx 4.0.0' + say 'Too bad, you are using ooDialog 4.0.0' end else do - say 'Great you have upgraded past ooRexx 4.1.0' + say 'Great you have upgraded past ooDialog 4.0.0' end ::requires 'oodPlain.cls' @@ -298,12 +305,13 @@ ooDialog Version 4.0.0.3768 (an ooRexx Windows Extension) -Too bad, you are still running ooRexx 4.0.0 +Too bad, you are still using ooDialog 4.0.0 */ ]]> </programlisting> -</para></listitem></varlistentry> + </para> + </listitem></varlistentry> </variablelist> </section> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |