From: George H. <geo...@us...> - 2006-08-30 08:30:25
|
Update of /cvsroot/win32forth/win32forth/doc In directory sc8-pr-cvs9.sourceforge.net:/tmp/cvs-serv20916/win32forth/doc Modified Files: p-index.htm Added Files: p-W32fdexh.htm p-dexh-createdocs.htm p-interpif.htm Log Message: gah:Updated docs Index: p-index.htm =================================================================== RCS file: /cvsroot/win32forth/win32forth/doc/p-index.htm,v retrieving revision 1.15 retrieving revision 1.16 diff -C2 -d -r1.15 -r1.16 *** p-index.htm 19 Aug 2006 14:45:36 -0000 1.15 --- p-index.htm 30 Aug 2006 08:30:22 -0000 1.16 *************** *** 91,94 **** --- 91,95 ---- <li><a href="ProMgr/ProjectManager.htm">ForthProject</a> (Win32Forth Project Manager)</li> <li><a href="p-dexh.htm">Dex</a> Document Extractor</li> + <li><a href="p-w32fdexh.htm">W32FDex</a> Win32Forth extensions for the Document Extractor</li> </ul> *************** *** 140,143 **** --- 141,145 ---- <li><a href="p-float.htm">Floating point words in Win32Forth</a></li> <li><a href="p-module.htm">Using the Module Wordset</a></li> + <li><a href="p-interpif.htm">Interpretive conditionals in Win32Forth</a></li> <li><a href="p-task.htm">Using the Task Wordset</a></li> <li><a href="p-random.htm">The Random Number Generator</a></li> --- NEW FILE: p-dexh-createdocs.htm --- <?xml version="1.0"?> <!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> <meta name="GENERATOR" content="dexh v03"> <meta name="ProgId" content="FrontPage.Editor.Document"> <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> <title> Docs W32F )</title><style><!-- h1 { font-family: Tahoma; font-size: 24pt; font-weight: bold } h2 { font-family: Tahoma; font-size: 18pt; font-weight: bold } --> </style> </head> <body><h1 align="center"> <a href="mailto:win...@ya...?subject=DOC:Doc error in $Id: p-dexh-createdocs.htm,v 1.1 2006/08/30 08:30:22 georgeahubert Exp $"> <img border="0" src="TELLUS.gif" align="left" width="32" height="32"></a> <img border="0" src="FORTHPRO.gif" width="32" height="32"> Win32Forth</h1> <hr /><h1>Documenting Win32Forth </h1><hr /><pre><b><a name="0">: create-docs ( -- ) \ W32F tool </a></b></pre><p>Create the documentation for Win32Forth from the source files. </p><p>Not all files have been marked up yet. If you feel like doing some then drop us a line at </p><a href="http://groups.yahoo.com/group/win32forth">win32forth at Yahoo</a> <p>VOLUNTEERS are always welcome. </p><hr><p>Document $Id: p-dexh-createdocs.htm,v 1.1 2006/08/30 08:30:22 georgeahubert Exp $</p> </body></html> --- NEW FILE: p-W32fdexh.htm --- <html> <head> <meta http-equiv="Content-Language" content="en-gb"> <meta name="GENERATOR" content="dexh00"> <meta name="ProgId" content="FrontPage.Editor.Document"> <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> <title> </title><style><!-- h1 { font-family: Tahoma; font-size: 24pt; font-weight: bold } h2 { font-family: Tahoma; font-size: 18pt; font-weight: bold } --> </style> </head> <body><h1 align="center"> <a href="mailto:win...@ya...?subject=DOC:Doc error in $Id: p-W32fdexh.htm,v 1.1 2006/08/30 08:30:22 georgeahubert Exp $"> <img border="0" src="TELLUS.gif" align="left" width="32" height="32"></a> <img border="0" src="FORTHPRO.gif" width="32" height="32"> Win32Forth</h1> <hr /><h1>Extensions to DexH for producing Win32Forth Documents </h1><hr /><p>DexH is a versatile system for producing documentation and these extensions are designed to customise it for producing the Win32Forth documentation itself (including this file). </p><h2>Glossary </h2><pre><b><a name="0">: W32FDocs ( -- ) </a></b></pre><p>Set output for Win32Forth documents in the doc folder. </p><pre><b><a name="1">: W32FClassDocs ( -- ) </a></b></pre><p>Set output for Win32Forth documents in the doc\classes folder. </p><pre><b><a name="2">: DexDocs ( -- ) </a></b></pre><p>Set normal DexH output style. </p><pre><b><a name="3">: -tr ( -- ) </a></b></pre><p>Stop output of the HTML trailer. </p><pre><b><a name="4">: +tr ( -- ) </a></b></pre><p>Restart output of the HTML trailer. </p><pre><b><a name="5">: create-doc ( addr len -- ) </a></b></pre><p>Create the document for a file. To find the file the forth search path is used. </p><pre><b><a name="6">: DEXF ( -- ) </a></b></pre><p>Choose a file and convert it to HTML. Output filenames are included in the source file. </p><hr><p>Document $Id: p-W32fdexh.htm,v 1.1 2006/08/30 08:30:22 georgeahubert Exp $</p> </body></html> --- NEW FILE: p-interpif.htm --- <?xml version="1.0"?> <!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> <meta name="GENERATOR" content="dexh v03"> <meta name="ProgId" content="FrontPage.Editor.Document"> <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> <title> W32F interpretive conditionals</title><style><!-- h1 { font-family: Tahoma; font-size: 24pt; font-weight: bold } h2 { font-family: Tahoma; font-size: 18pt; font-weight: bold } --> </style> </head> <body><h1 align="center"> <a href="mailto:win...@ya...?subject=DOC:Doc error in $Id: p-interpif.htm,v 1.1 2006/08/30 08:30:22 georgeahubert Exp $"> <img border="0" src="TELLUS.gif" align="left" width="32" height="32"></a> <img border="0" src="FORTHPRO.gif" width="32" height="32"> Win32Forth</h1> <hr /><h1>Interpretive conditionals in Win32Forth </h1><hr /><p>Win32Forth supports the ANSI interpretive from the tools extension wordset, with some W32F specific extensions as well as an alternative set based on the 'C' style words #if #else #then etc. </p><h2>Glossary </h2><pre><b><a name="0">: [else] ( -- ) \ ANSI TOOLS EXT </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: ( "<spaces>name" ... -- ) Skipping leading spaces, parse and discard space-delimited words from the parse area, including nested occurrences of [IF] ... [THEN] and [IF] ... [ELSE] ... [THEN], until the word [THEN] has been parsed and discarded. If the parse area becomes exhausted, it is refilled as with REFILL. [ELSE] is an immediate word. </p><pre><b><a name="1">: [if] ( flag -- ) \ ANSI TOOLS EXT </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: ( flag | flag "<spaces>name" ... -- ) If flag is true, do nothing. Otherwise, skipping leading spaces, parse and discard space-delimited words from the parse area, including nested occurrences of [IF] ... [THEN], [IF] ... [ELSE] ... [THEN], [IF] ... [ENDIF] and [IF] ... [ELSE] ... [ENDIF], until either the word [ELSE], the word [THEN] or the word [ENDIF] has been parsed and discarded. If the parse area becomes exhausted, it is refilled as with REFILL. [IF] is an immediate word. An ambiguous condition exists if [IF] is POSTPONEd. If the end of the input buffer is reached and cannot be refilled before the terminating [ELSE], [THEN] or [ENDIF] is parsed then error -58 is thrown. </p><pre><b><a name="2">: [then] ( -- ) \ ANSI TOOLS EXT </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: ( -- ) Does nothing. [THEN] is an immediate word. </p><pre><b><a name="3">: [endif] ( -- ) \ W32F TOOLS EXTRA </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: ( -- ) Does nothing. [ENDIF] is an immediate word. </p><pre><b><a name="4">: #else ( -- ) \ W32F TOOLS EXTRA </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: ( "<spaces>name" ... -- ) Skipping leading spaces, parse and discard space-delimited words from the parse area, including nested occurrences of #IF ... #THEN and #IF ... #ELSE ... #THEN, until the word #THEN has been parsed and discarded. If the parse area becomes exhausted, it is refilled as with REFILL. #ELSE is an immediate word. </p><pre><b><a name="5">: #if ( flag -- ) \ W32F TOOLS EXTRA </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: ( flag | flag "<spaces>name" ... -- ) If flag is true, do nothing. Otherwise, skipping leading spaces, parse and discard space-delimited words from the parse area, including nested occurrences of #IF ... #THEN, #IF ... #ELSE ... #THEN, #IF ... #ENDIF and #IF ... #ELSE ... #ENDIF, until either the word #ELSE, the word #THEN or the word #ENDIF has been parsed and discarded. If the parse area becomes exhausted, it is refilled as with REFILL. #IF is an immediate word. An ambiguous condition exists if #IF is POSTPONEd. If the end of the input buffer is reached and cannot be refilled before the terminating #ELSE, #THEN or #ENDIF is parsed then error -58 is thrown. </p><pre><b><a name="6">: #then ( -- ) \ W32F TOOLS EXTRA </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: ( -- ) Does nothing. #THEN is an immediate word. </p><pre><b><a name="7">: #endif ( -- ) \ W32F TOOLS EXTRA </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: ( -- ) Does nothing. #ENDIF is an immediate word. </p><pre><b><a name="8">: #ifdef ( "aword" -- ) \ W32F TOOLS EXTRA </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: ( "aword" | "aword<spaces>name" ... -- ) If "aword" is found in the search order, do nothing. Otherwise, skipping leading spaces, parse and discard space-delimited words from the parse area, including nested occurrences of #IF ... #THEN, #IF ... #ELSE ... #THEN, #IF ... #ENDIF and #IF ... #ELSE ... #ENDIF, until either the word #ELSE, the word #THEN or the word #ENDIF has been parsed and discarded. If the parse area becomes exhausted, it is refilled as with REFILL. #IF is an immediate word. An ambiguous condition exists if #IF is POSTPONEd. If the end of the input buffer is reached and cannot be refilled before the terminating #ELSE, #THEN or #ENDIF is parsed then error -58 is thrown. This word is designed to ignore object.ivar type words. </p><pre><b><a name="9">: #ifndef ( "aword" -- ) \ W32F TOOLS EXTRA </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: ( "aword" | "aword<spaces>name" ... -- ) If "aword" is not found in the search order, do nothing. Otherwise, skipping leading spaces, parse and discard space-delimited words from the parse area, including nested occurrences of #IF ... #THEN, #IF ... #ELSE ... #THEN, #IF ... #ENDIF and #IF ... #ELSE ... #ENDIF, until either the word #ELSE, the word #THEN or the word #ENDIF has been parsed and discarded. If the parse area becomes exhausted, it is refilled as with REFILL. #IF is an immediate word. An ambiguous condition exists if #IF is POSTPONEd. If the end of the input buffer is reached and cannot be refilled before the terminating #ELSE, #THEN or #ENDIF is parsed then error -58 is thrown. This word is designed to ignore object.ivar type words. </p><pre><b><a name="10">: [DEFINED] ( "aword" -- f1 ) \ W32F TOOLS EXTRA </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: Return true if "aword" is found in a search of the search order. This word is designed to ignore object.ivar type words. </p><pre><b><a name="11">: [UNDEFINED] ( "aword" -- f1 ) \ W32F TOOLS EXTRA </a></b></pre><p>Compilation: Perform the execution semantics given below. <br /> Execution: Return false if "aword" is found in a search of the search order. This word is designed to ignore object.ivar type words. </p><hr><p>Document $Id: p-interpif.htm,v 1.1 2006/08/30 08:30:22 georgeahubert Exp $</p> </body></html> |