diff --git a/internal/help/$DYNAMIC.txt b/internal/help/$DYNAMIC.txt index 8123ef20e..db5a69682 100644 --- a/internal/help/$DYNAMIC.txt +++ b/internal/help/$DYNAMIC.txt @@ -2,7 +2,7 @@ The [[$DYNAMIC]] [[Metacommand|metacommand]] allows the creation of dynamic (res {{PageSyntax}} -:{[[REM]] | ' } [[$DYNAMIC]] +:{[[REM]] | [[apostrophe|']] } [[$DYNAMIC]] {{PageDescription}} diff --git a/internal/help/$EXEICON.txt b/internal/help/$EXEICON.txt index 4128f82b7..d9447d7cc 100644 --- a/internal/help/$EXEICON.txt +++ b/internal/help/$EXEICON.txt @@ -5,7 +5,7 @@ : [[$EXEICON]]:'{{Parameter|iconfile.ico}}' -{{Parameters}} +{{PageParameters}} * '{{Parameter|iconfile.ico}}' is a valid [https://en.wikipedia.org/wiki/ICO_(file_format) ICO file] diff --git a/internal/help/$IF.txt b/internal/help/$IF.txt index 96d97fca8..28687b64f 100644 --- a/internal/help/$IF.txt +++ b/internal/help/$IF.txt @@ -23,6 +23,7 @@ ** '''32BIT''' if the user is running a 32-bit version of QB64. ** '''64BIT''' if the user is running a 64-bit version of QB64. ** '''VERSION''', which is set to the version of the QB64 compiler. This is a number and can be ordered, see example below. +* Special values '''DEFINED''' and '''UNDEFINED''' can be used to check whether a precompiler variable has already been assigned a value. Useful for code in libraries which may be repeated. * [[$END IF]] denotes the end of a valid precompiler $IF block. * [[$ELSEIF]] must follow a valid $IF or $ELSEIF statement. * If [[$ELSE]] is used, it must be used as the last conditional check before $END IF. $ELSEIF cannot come after $ELSE. diff --git a/internal/help/$INCLUDE.txt b/internal/help/$INCLUDE.txt index c499a8a8a..5acff5f59 100644 --- a/internal/help/$INCLUDE.txt +++ b/internal/help/$INCLUDE.txt @@ -2,7 +2,7 @@ {{PageSyntax}} -: {[[REM]] | [[REM|']] } $INCLUDE: '{{Parameter|sourceFile}}' +: {[[REM]] | [[apostrophe|']] } [[$INCLUDE]]: '{{Parameter|sourceFile}}' {{PageDescription}} diff --git a/internal/help/$LET.txt b/internal/help/$LET.txt index 29d478783..467b909ff 100644 --- a/internal/help/$LET.txt +++ b/internal/help/$LET.txt @@ -10,6 +10,7 @@ * $LET a = 12 sets a precompiler variable "a" to the value of 12. This variable is only valid for the precompiler itself and does nothing to affect the values of any variable/constant which might also be called "a" in the program. * Variable names can contain numbers, letters, and periods in any order. [[$LET]] '''3.2 = TRUE''' is a perfectly valid variable and expression. * Expressions can contain one set of leading and/or trailing quotes; and any number of numbers, letters, and periods, in any order. [[$LET]] '''3.2 = "TRUE"''' is also perfectly valid, but [[$LET]] '''3.2 = ""TRUE""''' will error because of the double quotes. +* You can check a precompiler variable against special values '''DEFINED''' and '''UNDEFINED''', in order to assess whether the variable has already been assigned a value. Useful for code in libraries which may be repeated. {{PageExamples}} diff --git a/internal/help/$STATIC.txt b/internal/help/$STATIC.txt index ebf694805..52f629c09 100644 --- a/internal/help/$STATIC.txt +++ b/internal/help/$STATIC.txt @@ -1,8 +1,8 @@ -The '''$STATIC''' [[Metacommand|metacommand]] allows the creation of static (unresizable) arrays. +The [[$STATIC]] [[Metacommand|metacommand]] allows the creation of static (unresizable) arrays. {{PageSyntax}} -:{[[REM]] | ' } '''$STATIC''' +:{[[REM]] | [[apostrophe|']] } [[$STATIC]] {{PageDescription}} diff --git a/internal/help/$VERSIONINFO.txt b/internal/help/$VERSIONINFO.txt index cb79d7d1e..b7552a370 100644 --- a/internal/help/$VERSIONINFO.txt +++ b/internal/help/$VERSIONINFO.txt @@ -6,7 +6,7 @@ The [[$VERSIONINFO]] [[Metacommand|metacommand]] adds text metadata to the resul : [[$VERSIONINFO]]:{{Parameter|key}}={{Parameter|value}} -{{Parameters}} +{{PageParameters}} * Text ''keys'' can be: '''CompanyName, FileDescription, InternalName, LegalCopyright, LegalTrademarks, OriginalFilename, ProductName, Web, Comments''' * Numeric {{Parameter|keys}} can be:'''FILEVERSION#''' and '''PRODUCTVERSION#''' diff --git a/internal/help/ALIAS.txt b/internal/help/ALIAS.txt index 90b18f00b..8dede9d4e 100644 --- a/internal/help/ALIAS.txt +++ b/internal/help/ALIAS.txt @@ -7,7 +7,7 @@ The [[ALIAS]] clause in a [[DECLARE LIBRARY]] statement block tells the program : SUB ''pseudoname'' [[ALIAS]] ''actualname'' [(''parameters'')] -{{Parameters}} +{{PageParameters}} * The ''pseudo name'' is the name of the [[SUB]] or [[FUNCTION]] the QB64 program will use. * The ''actual name'' is the same procedure name as it is inside of the DLL library. * QB64 must use all parameters of imported procedures including optional ones. diff --git a/internal/help/ATN.txt b/internal/help/ATN.txt index 546a17289..b4421e0fd 100644 --- a/internal/help/ATN.txt +++ b/internal/help/ATN.txt @@ -5,7 +5,7 @@ The [[ATN]] or arctangent function returns the angle in radians of a numerical [ : {{Parameter|radianAngle}} = [[ATN]]({{Parameter|tangent!}}) -{{Parameters}} +{{PageParameters}} * The return is the {{Parameter|tangent!}}'s angle in '''radians'''. * {{Parameter|tangent!}} [[SINGLE]] or [[DOUBLE]] values are used by the function. EX:'''{{text|Pi <nowiki>=</nowiki> 4 * ATN(1)|green}}''' diff --git a/internal/help/Apostrophe.txt b/internal/help/Apostrophe.txt index 4b1abb696..af328db0d 100644 --- a/internal/help/Apostrophe.txt +++ b/internal/help/Apostrophe.txt @@ -1,16 +1,15 @@ -The '''apostrophe''' is used to tell the compiler to ignore a statement or programmer comment. - +The '''apostrophe''' allows explanatory comments, or remarks, to be inserted in a program. These may be included anywhere in the source code and extend to the end of the line. Comments are ignored when the program is run. {{PageSyntax}} - -:: <b>'</b> a program comment +:: [[apostrophe|']] this is a comment +:: [[REM]] this is also a comment {{PageDescription}} -* Allows programmer comments or temporary code removal. -* [[REM]] can also be used to "comment out" a line. -* QBasic [[Metacommand|metacommand]]s must be commented either with an apostrophe or [[REM]]. -* [[$INCLUDE]] requires an apostrophe before and after the included file name. +* [[REM]] can also be used to insert comments but may only be used as the last, or only, statement on a line. +* QBasic [[metacommand]]s like [[$INCLUDE]] must be included in a comment using either [[REM]] or [[apostrophe|']]. +* [[Apostrophe]] comments, unavailable in earlier dialects of the BASIC language, are now generally favored over [[REM]] statements for their greater flexibility. +* Comments are also useful for disabling code for program testing and debugging purposes. {{PageExamples}} @@ -25,6 +24,7 @@ COLOR 11: PRINT "Print this...." ' PRINT "Don't print this program comment!" {{PageSeeAlso}} * [[REM]] +* [[$DYNAMIC]], [[$STATIC]], [[$INCLUDE]] {{PageNavigation}} diff --git a/internal/help/BLOAD.txt b/internal/help/BLOAD.txt index 2d95484a0..dd6949260 100644 --- a/internal/help/BLOAD.txt +++ b/internal/help/BLOAD.txt @@ -8,7 +8,7 @@ : [[BLOAD]] {{Parameter|fileName$}}, [[VARPTR]]({{Parameter|imageArray%({{Parameter|index}})}}) -{{Parameters}} +{{PageParameters}} * {{Parameter|fileName$}} is the name of the file that the image should be [[BSAVE]]d to. * {{Parameter|imageArray%(index)}} is the [[INTEGER]] [[arrays|array]] start index to store the image loaded. diff --git a/internal/help/BSAVE.txt b/internal/help/BSAVE.txt index 41288e2f8..f54775e43 100644 --- a/internal/help/BSAVE.txt +++ b/internal/help/BSAVE.txt @@ -9,7 +9,7 @@ : [[BSAVE]] {{Parameter|saveFile$}}, [[VARPTR]]({{Parameter|array(index)}}), {{Parameter|fileSize&}} -{{Parameters}} +{{PageParameters}} * {{Parameter|saveFile$}} is the STRING file name of the file designated to be created. * {{Parameter|array(index)}} is the image [[arrays|array]] that already holds the [[GET (graphics statement)|GET]] image data. * {{Parameter|fileSize&}} must be a bit over twice the size of the elements used in an [[INTEGER]] [[Arrays|array]]. diff --git a/internal/help/CDBL.txt b/internal/help/CDBL.txt index 2d99c19d1..4ec49388d 100644 --- a/internal/help/CDBL.txt +++ b/internal/help/CDBL.txt @@ -6,7 +6,7 @@ : {{Parameter|doubleValue#}} = [[CDBL]]({{Parameter|expression}}) -{{Parameters}} +{{PageParameters}} * {{Parameter|expression}} is any [[TYPE]] of literal or variable numerical value or mathematical calculation. diff --git a/internal/help/CHAIN.txt b/internal/help/CHAIN.txt index a605e1dbc..c054e5fb3 100644 --- a/internal/help/CHAIN.txt +++ b/internal/help/CHAIN.txt @@ -8,7 +8,7 @@ {{PageSyntax}} : [[CHAIN]] {{Parameter|moduleName$}} -{{Parameters}} +{{PageParameters}} * {{Parameter|moduleName$}} is a variable or a literal [[STRING]] value in quotation marks with the optional EXE or BAS file name extension. diff --git a/internal/help/CINT.txt b/internal/help/CINT.txt index 21f96cc1b..18805aa6d 100644 --- a/internal/help/CINT.txt +++ b/internal/help/CINT.txt @@ -5,7 +5,7 @@ The [[CINT]] function rounds decimal point numbers up or down to the nearest [[I : {{Parameter|value%}} = [[CINT]]({{Parameter|expression}}) -{{Parameters}} +{{PageParameters}} * {{Parameter|expression}} is any [[TYPE]] of literal or variable numerical value or mathematical calculation. diff --git a/internal/help/CIRCLE.txt b/internal/help/CIRCLE.txt index 39fd17e93..8f2bb55c8 100644 --- a/internal/help/CIRCLE.txt +++ b/internal/help/CIRCLE.txt @@ -5,7 +5,7 @@ The [[CIRCLE]] statement is used in graphic [[SCREEN (statement)|SCREEN]] modes : [[CIRCLE]] [{{KW|STEP}}]'''('''{{Parameter|column}}''',''' {{Parameter|row}}'''),''' {{Parameter|radius%}}''',''' [{{Parameter|drawColor%}}][, {{Parameter|startRadian!}}, {{Parameter|stopRadian!}}] [, {{Parameter|aspect!}}] -{{Parameters}} +{{PageParameters}} * Can use [[STEP]] for relative coordinate moves from the previous graphic coordinates. * Coordinates designate the center position of the circle. Can be partially drawn offscreen. * {{Parameter|radius%}} is an [[INTEGER]] value for half of the total circle diameter. diff --git a/internal/help/CLNG.txt b/internal/help/CLNG.txt index c282943bd..5e04617c2 100644 --- a/internal/help/CLNG.txt +++ b/internal/help/CLNG.txt @@ -5,7 +5,7 @@ The [[CLNG]] function rounds decimal point numbers up or down to the nearest [[L : {{Parameter|value&}} = [[CLNG]]({{Parameter|expression}}) -{{Parameters}} +{{PageParameters}} * {{Parameter|expression}} is any [[TYPE]] of literal or variable numerical value or mathematical calculation. diff --git a/internal/help/CLOSE.txt b/internal/help/CLOSE.txt index 88fbaf3d5..f536f4ae0 100644 --- a/internal/help/CLOSE.txt +++ b/internal/help/CLOSE.txt @@ -5,7 +5,7 @@ : [[CLOSE]] [{{Parameter|fileNumber}}[, ...]] -{{Parameters}} +{{PageParameters}} * {{Parameter|fileNumber}} indicates the file or list of file numbers to close. When not specified, all open files are closed. diff --git a/internal/help/CLS.txt b/internal/help/CLS.txt index d50c23fa7..c72989040 100644 --- a/internal/help/CLS.txt +++ b/internal/help/CLS.txt @@ -5,7 +5,7 @@ The [[CLS]] statement clears the [[_DEST|current write page]]. : [[CLS]] [{{Parameter|method%}}] [, {{Parameter|bgColor&}}] -{{Parameters}} +{{PageParameters}} * {{Parameter|method%}} specifies which parts of the page to clear, and can have one of the following values: ** CLS    - clears the active graphics or text viewport or the entire text screen and refreshes bottom function [[KEY LIST|KEY ON]] line. ** CLS 0 - Clears the entire page of text and graphics. Print cursor is moved to row 1 at column 1. diff --git a/internal/help/CONST.txt b/internal/help/CONST.txt index c7b1bad97..ca6c76703 100644 --- a/internal/help/CONST.txt +++ b/internal/help/CONST.txt @@ -5,7 +5,7 @@ The [[CONST]] statement globally defines one or more named numeric or string val : [[CONST]] {{Parameter|constantName}} = {{Parameter|value}}[, ...] -{{Parameters}} +{{PageParameters}} * {{Parameter|constantName}} is the constant name or list of names assigned by the programmer. * {{Parameter|value}} is the value to initialize the global constant which cannot change once defined. ** If {{Parameter|constantName}} specifies a numeric type, {{Parameter|value}} must be a numeric expression containing literals and other constants. diff --git a/internal/help/COS.txt b/internal/help/COS.txt index c8100aec8..38b2de221 100644 --- a/internal/help/COS.txt +++ b/internal/help/COS.txt @@ -5,7 +5,7 @@ The [[COS]] function returns the horizontal component or the cosine of an angle : {{Parameter|value!}} = [[COS]]({{Parameter|radianAngle!}}) -{{Parameters}} +{{PageParameters}} * The {{Parameter|radianAngle!}} must be measured in radians. diff --git a/internal/help/CSNG.txt b/internal/help/CSNG.txt index 213be0db8..bfeba50fb 100644 --- a/internal/help/CSNG.txt +++ b/internal/help/CSNG.txt @@ -5,7 +5,7 @@ : {{Parameter|singleValue!}} = [[CSNG]]({{Parameter|expression}}) -{{Parameters}} +{{PageParameters}} * {{Parameter|expression}} is any [[TYPE]] of literal or variable numerical value or mathematical calculation. diff --git a/internal/help/DECLARE_LIBRARY.txt b/internal/help/DECLARE_LIBRARY.txt index 2f083fd92..04f36e943 100644 --- a/internal/help/DECLARE_LIBRARY.txt +++ b/internal/help/DECLARE_LIBRARY.txt @@ -10,7 +10,7 @@ The '''DECLARE LIBRARY''' declaration allows the use of external library [[SUB]] : '''END DECLARE''' -{{Parameters}} +{{PageParameters}} * The {{Parameter|Library_filename}} is needed if a Library is not already loaded by QB64. Do not include the ''.DLL'', ''LIB'' or ''.H'' file extension. ** It's always a good idea to try declaring Windows API libraries without a {{Parameter|Library_filename}} first, as most Windows headers are already included in QB64 source. * Begin the {{Parameter|Library_filename}} with '''./''' or '''.\''' to make it relative to the path where your source file is saved, so you can keep all your project files together. @@ -33,28 +33,28 @@ The '''DECLARE LIBRARY''' declaration allows the use of external library [[SUB]] * The [[_OFFSET]] in memory can be used in '''CUSTOMTYPE''', '''STATIC''' and '''DYNAMIC LIBRARY''' declarations. * Declarations can be made inside of [[SUB]] or [[FUNCTION]] procedures. Declarations do not need to be at program start. -* '''NOTE: It is up to the user to document and determine the suitability of all Libraries and procedures they choose to use! QB64 cannot guarantee that any procedure will work and cannot quarantee any troubleshooting help.''' +* '''NOTE: It is up to the user to document and determine the suitability of all Libraries and procedures they choose to use! QB64 cannot guarantee that any procedure will work and cannot guarantee any troubleshooting help.''' {{PageExamples}} ''Example 1:'' Using an '''SDL''' library procedure as a program SUB procedure to move the mouse pointer to a coordinate (works in versions prior to 1.000): {{CodeStart}} '' '' {{Cl|DECLARE LIBRARY}} - {{Cl|SUB}} SDL_WarpMouse ({{Cl|BYVAL}} column {{Cl|AS}} {{Cl|LONG}}, {{Cl|BYVAL}} row {{Cl|AS}} {{Cl|LONG}}) 'SDL procedure name + {{Cl|SUB}} SDL_WarpMouse ({{Cl|BYVAL}} column {{Cl|AS}} {{Cl|LONG}}, {{Cl|BYVAL}} row {{Cl|AS}} {{Cl|LONG}}) 'SDL procedure name {{Cl|DECLARE LIBRARY|END DECLARE}} {{Cl|SCREEN (statement)|SCREEN}} {{Cl|_NEWIMAGE}}(640, 480, 256) 'simulate screen 12 with 256 colors {{Cl|RANDOMIZE}} {{Cl|TIMER}} -DO - {{Cl|_DELAY}} 1 - x = {{Cl|RND}} * 640: y = {{Cl|RND}} * 480 - {{Cl|LINE}} (x, y)-{{Cl|STEP}}(10, 10), {{Cl|RND}} * 100 + 32, BF - MouseMove x + 5, y + 5 +{{Cl|DO}} + {{Cl|_DELAY}} 1 + x = {{Cl|RND}} * 640: y = {{Cl|RND}} * 480 + {{Cl|LINE}} (x, y)-{{Cl|STEP}}(10, 10), {{Cl|RND}} * 100 + 32, BF + MouseMove x + 5, y + 5 {{Cl|LOOP}} {{Cl|UNTIL}} {{Cl|LEN}}({{Cl|INKEY$}}) 'any keypress quits {{Cl|END}} {{Cl|SUB}} MouseMove (x {{Cl|AS}} {{Cl|LONG}}, y {{Cl|AS}} {{Cl|LONG}}) -SDL_WarpMouse x, y 'call SDL library procedure + SDL_WarpMouse x, y 'call SDL library procedure {{Cl|END SUB}} '' '' {{CodeEnd}} {{small|Code by Galleon}} @@ -64,7 +64,7 @@ SDL_WarpMouse x, y 'call SDL library procedure {{CodeStart}} '' '' {{Cl|SCREEN}} 12 {{Cl|DECLARE LIBRARY}} - {{Cl|SUB}} MouseMove {{Cl|ALIAS}} SDL_WarpMouse ({{Cl|BYVAL}} column&, {{Cl|BYVAL}} row&) + {{Cl|SUB}} MouseMove {{Cl|ALIAS}} SDL_WarpMouse ({{Cl|BYVAL}} column&, {{Cl|BYVAL}} row&) {{Cl|DECLARE LIBRARY|END DECLARE}} {{Cl|_DELAY}} 2 @@ -79,11 +79,11 @@ MouseMove 200, 200 '' '' {{CodeStart}} '' '' {{Cl|DECLARE LIBRARY}} "" {{Cl|FUNCTION}} addone& ({{Cl|BYVAL}} value&) -{{Cl|END}} DECLARE '' '' +{{Cl|END DECLARE}} '' '' {{CodeEnd}} :''Explanation:'' The C function 'addone' exists in a library QB64 already links to, but it hasn't been defined as a C function or a QB64 function. By using "" we are telling QB64 the function exists in a library which is already linked to and that it must define the C function before calling it, as well as allowing QB64 code to call it. Trying the above code without the "" will fail. -: '''Note: What libraries are or aren't automatically used in the linking process is not formally defined, nor is it guaranteed to stay that way in future versions of QB64.''' +: '''Note: Which libraries are or aren't automatically used in the linking process is not formally defined, nor is it guaranteed to stay that way in future versions of QB64.''' <center>'''QB64 version 1.000 and up produce standalone executables. External DLL files must be distributed with your program.'''</center> diff --git a/internal/help/DIR$.txt b/internal/help/DIR$.txt index edc2f217d..8714c53c1 100644 --- a/internal/help/DIR$.txt +++ b/internal/help/DIR$.txt @@ -6,7 +6,7 @@ The [[_DIR$]] function returns common paths in '''Windows''' only such as My Doc : {{Parameter|d$}} = [[_DIR$]]("{{Parameter|folderspecification}}") -{{Parameters}} +{{PageParameters}} * ''folderspecification'' may be "desktop", "download", "documents", "music", "video", "pictures", "appdata", "program data", "local data". * Some variation is accepted for the folder specification: :: MY DOCUMENTS, TEXT, DOCUMENT, DOCUMENTS, DOWNLOAD, DOWNLOADS diff --git a/internal/help/FIX.txt b/internal/help/FIX.txt index 4818940ad..9b34f40bb 100644 --- a/internal/help/FIX.txt +++ b/internal/help/FIX.txt @@ -5,7 +5,7 @@ The [[FIX]] function rounds a numerical value to the next whole number closest t : {{Parameter|result}} = [[FIX]]({{Parameter|expression}}) -{{Parameters}} +{{PageParameters}} * {{Parameter|expression}} is any [[Data types|type]] of literal or variable numerical value or mathematical calculation. diff --git a/internal/help/FOR...NEXT.txt b/internal/help/FOR...NEXT.txt index 2eb97f3eb..f7e58b809 100644 --- a/internal/help/FOR...NEXT.txt +++ b/internal/help/FOR...NEXT.txt @@ -8,7 +8,7 @@ The [[FOR]] statement creates a counter loop using specified start and stop nume : [[NEXT]] [{{Parameter|counterVariable}}] -{{Parameters}} +{{PageParameters}} * The [[FOR]] {{Parameter|counterVariable}} name is required to define the counter span and may also be used after the NEXT keyword. * The {{Parameter|startValue}} [[TO]] {{Parameter|stopValue}} can be any literal or variable numerical type. Both values are required. * [[STEP]] can be used for a loop {{Parameter|increment}} other than the default ''plus 1 and can be any positive or negative literal or variable numerical value as long as the STEP value corresponds to the loop's {{Parameter|startValue}} and {{Parameter|stopValue}}. diff --git a/internal/help/GET_(graphics_statement).txt b/internal/help/GET_(graphics_statement).txt index d76ad1d4a..20b9b499e 100644 --- a/internal/help/GET_(graphics_statement).txt +++ b/internal/help/GET_(graphics_statement).txt @@ -8,7 +8,7 @@ The [[GET (graphics statement)|GET]] statement is used in graphics to store a bo : [[GET]] [STEP] ({{Parameter|column1}}, {{Parameter|row1}})-[STEP]({{Parameter|column2}}, {{Parameter|row2}}), {{Parameter|array}}([{{Parameter|index}}])[, {{Parameter|offscreenColor}}] -{{Parameters}} +{{PageParameters}} * ''column'' and ''row'' [[INTEGER]] coordinates for the box area must be on the screen except when using an ''offscreenColor''. * [[INTEGER]] array sizes must be large enough (use width * height of the box area + 4) to hold the data or an error will occur. * The [[arrays|array]] ''index'' offset is optional. If the offset is zero the brackets may be empty. diff --git a/internal/help/INPUT.txt b/internal/help/INPUT.txt index 81fb7abc9..01a564372 100644 --- a/internal/help/INPUT.txt +++ b/internal/help/INPUT.txt @@ -6,7 +6,7 @@ The [[INPUT]] statement requests a [[STRING]] or numerical keyboard entry from t : [[INPUT]] ; {{Parameter|variable}}[, ...] -{{Parameters}} +{{PageParameters}} * A [[semicolon]] after the [[INPUT]] keyword keeps the entry on the same row after enter is pressed and prevents the screen contents from rolling up. * The optional prompt "Question or statement text" must be a literal predefined [[STRING|string]]. '''The prompt cannot use a variable.''' * [[Quotation mark]]s are required except when a semicolon follows [[INPUT]]. A question mark will appear before the cursor. diff --git a/internal/help/INPUT_(file_statement).txt b/internal/help/INPUT_(file_statement).txt index e85fda66a..ef98203e1 100644 --- a/internal/help/INPUT_(file_statement).txt +++ b/internal/help/INPUT_(file_statement).txt @@ -5,7 +5,7 @@ The [[INPUT #]] file or port statement reads sequential data using one variable : [[INPUT #]]{{Parameter|fileNumber&}}, {{Parameter|variable1}}[, {{Parameter|variable2}}, ..., {{Parameter|variableN}}] -{{Parameters}} +{{PageParameters}} * {{Parameter|fileNumber&}} is a positive [[LONG]] integer value used to [[OPEN]] the file FOR [[INPUT (file mode)|INPUT]] mode. * The [[Variable Types|type]] of the ''variable'' used defines the value or list of values to be returned from the file. Numeric types must match the values returned. * As reflected in the syntax you can list a number of variables with different types seperated by a comma and they will hold the values in the file (keep in mind that the information in the file should match the variable types used). diff --git a/internal/help/INSTR.txt b/internal/help/INSTR.txt index 9bd3c8e6e..7157546ec 100644 --- a/internal/help/INSTR.txt +++ b/internal/help/INSTR.txt @@ -5,7 +5,7 @@ The [[INSTR]] function searches for the first occurence of a search [[STRING]] w : {{Parameter|position%}} = [[INSTR]]([{{Parameter|start%}},] {{Parameter|baseString$}}, {{Parameter|searchString$}}) -{{Parameters}} +{{PageParameters}} * The optional literal or variable [[INTEGER]] {{Parameter|start%}} indicates where in the {{Parameter|baseString$}} the search must start. * The {{Parameter|baseString$}} is a literal or variable [[STRING]] value to be searched for an exact match including [[UCASE$|letter cases]]. * The {{Parameter|searchString$}} is a literal or variable [[STRING]] value being searched. diff --git a/internal/help/INT.txt b/internal/help/INT.txt index 22922e96d..98c9802c0 100644 --- a/internal/help/INT.txt +++ b/internal/help/INT.txt @@ -5,7 +5,7 @@ The [[INT]] function rounds a numeric value down to the next whole number. : {{Parameter|result}} = [[INT]]({{Parameter|expression}}) -{{Parameters}} +{{PageParameters}} * {{Parameter|expression}} is any [[Data types|type]] of literal or variable numerical value or mathematical calculation. diff --git a/internal/help/INTERRUPT.txt b/internal/help/INTERRUPT.txt index a5397a349..2cc7097a8 100644 --- a/internal/help/INTERRUPT.txt +++ b/internal/help/INTERRUPT.txt @@ -9,7 +9,7 @@ The [[INTERRUPT]] statement is an assembly routine for accessing computer inform : [[CALL]] [[INTERRUPT]]({{Parameter|intNum}}, {{Parameter|inRegs}}, {{Parameter|outRegs}}) -{{Parameters}} +{{PageParameters}} * Registers are emulated in QB64 and there is no support for {{Parameter|intNum}} 33h mouse functions above 3 or {{Parameter|intNum}} requests other than 33. * {{Parameter|inRegs}} are the values placed into the call and {{Parameter|outRegs}} are the register return values. diff --git a/internal/help/INTERRUPTX.txt b/internal/help/INTERRUPTX.txt index 81b0cdb24..5f9142387 100644 --- a/internal/help/INTERRUPTX.txt +++ b/internal/help/INTERRUPTX.txt @@ -9,7 +9,7 @@ The [[INTERRUPTX]] statement is an assembly routine for accessing computer infor : [[CALL]] [[INTERRUPTX]]({{Parameter|intNum}}, {{Parameter|inRegs}}, {{Parameter|outRegs}}) -{{Parameters}} +{{PageParameters}} * Registers are emulated in QB64 and there is no support for {{Parameter|intNum}} 33h mouse functions above 3 or {{Parameter|intNum}} requests other than 33. * {{Parameter|inRegs}} are the values placed into the call and {{Parameter|outRegs}} are the register return values. diff --git a/internal/help/LEFT$.txt b/internal/help/LEFT$.txt index cdd1aa920..5e1996508 100644 --- a/internal/help/LEFT$.txt +++ b/internal/help/LEFT$.txt @@ -5,7 +5,7 @@ The [[LEFT$]] string function returns a number of characters from the left of a : [[LEFT$]]({{Parameter|stringValue$}}, {{Parameter|numberOfCharacters%}}) -{{Parameters}} +{{PageParameters}} * {{Parameter|stringValue$}} can be any [[STRING]] literal or variable. * {{Parameter|numberOfCharacters%}} [[INTEGER]] determines the number of characters to return from left of string. diff --git a/internal/help/LINE.txt b/internal/help/LINE.txt index 3036b6961..845047b79 100644 --- a/internal/help/LINE.txt +++ b/internal/help/LINE.txt @@ -5,7 +5,7 @@ The [[LINE]] statement is used in graphic [[SCREEN (statement)|SCREEN]] modes to : [[LINE]] [STEP] ['''('''''column1''''',''' ''row1''''')''']'''-'''[STEP] '''('''''column2'', ''row2'''''),''' ''color''[, [{B|BF}], {{Parameter|style%}}] -{{Parameters}} +{{PageParameters}} * The [[STEP]] keyword make ''column'' and ''row'' coordinates relative to the previously coordinates set by any graphic statement. * The optional parameters (''column1'', ''row1'') set the line's starting point. * The dash and second coordinate parameters (''column2'', ''row2'') must be designated to complete the line or box. diff --git a/internal/help/LINE_INPUT.txt b/internal/help/LINE_INPUT.txt index bca1fdc60..cf27ca588 100644 --- a/internal/help/LINE_INPUT.txt +++ b/internal/help/LINE_INPUT.txt @@ -6,7 +6,7 @@ The [[LINE INPUT]] statement requests a [[STRING]] keyboard entry from a program : [[LINE INPUT]] ; {{Parameter|stringVariable$}} -{{Parameters}} +{{PageParameters}} * A [[semicolon]] immediately after LINE INPUT stops the cursor after the entry and prevents screen roll on the lowest two screen rows. * ''text prompt or question'' is optional, but quotes are necessary unless just a semicolon is used before the {{Parameter|stringVariable$}}. * Requires only one [[STRING|string]] variable to hold the entire text entry. diff --git a/internal/help/LINE_INPUT_(file_statement).txt b/internal/help/LINE_INPUT_(file_statement).txt index c77568505..a62e9400f 100644 --- a/internal/help/LINE_INPUT_(file_statement).txt +++ b/internal/help/LINE_INPUT_(file_statement).txt @@ -5,7 +5,7 @@ The '''LINE INPUT #''' file statement reads an entire line from a text file into : '''LINE INPUT''' '''#'''{{Parameter|fileNumber&}}''',''' ''stringVariable$'' -{{Parameters}} +{{PageParameters}} * {{Parameter|fileNumber&}} is the [[INTEGER]] number of the file previously opened with the [[OPEN]] statement. * {{Parameter|stringVariable$}} holds the text line read from the file. diff --git a/internal/help/LOCATE.txt b/internal/help/LOCATE.txt index 0d8a9160c..49022c6ec 100644 --- a/internal/help/LOCATE.txt +++ b/internal/help/LOCATE.txt @@ -5,7 +5,7 @@ The [[LOCATE]] statement locates the screen text row and column positions for a : [[LOCATE]] [{{Parameter|row%}}][, {{Parameter|column%}}] [, {{Parameter|cursor%}}][, {{Parameter|cursorStart%}}, {{Parameter|cursorStop%}}] -{{Parameters}} +{{PageParameters}} * optional text {{Parameter|row%}} [[INTEGER]] values are from 1 to 25, 43 or 50 in [[SCREEN]] 0 and 25 in most other legacy graphic screen modes, except screens 11 and 12 which can have 30 or 60 rows. * optional {{Parameter|column%}} [[INTEGER]] values are from 1 to 40 or 80 in [[SCREEN]] 0 and 80 in all other legacy screen modes. * optional {{Parameter|cursor%}} value can be 0 to turn displaying the cursor off or 1 to turn it on. diff --git a/internal/help/LPRINT_USING.txt b/internal/help/LPRINT_USING.txt index 02f684de6..421275f34 100644 --- a/internal/help/LPRINT_USING.txt +++ b/internal/help/LPRINT_USING.txt @@ -5,7 +5,7 @@ The [[LPRINT USING]] statement sends formatted data to LPT1, the parallel port p : '''LPRINT''' [''text$''{;|,}] '''USING''' {{Parameter|template$}}; {{Parameter|variable}}[; ...][{;|,}] -{{Parameters}} +{{PageParameters}} * Literal or variable [[STRING]] ''text$'' can be placed between [[LPRINT]] and USING or it can be included in the {{Parameter|template$}}. * A [[semicolon]] or [[comma]] may follow the {{Parameter|text$}} to stop or tab the print cursor before the {{Parameter|template$}} [[LPRINT]]. * The literal or variable [[STRING]] {{Parameter|template$}} should use the template symbols to display each variable [[Variable Types|type]] in the list following it. diff --git a/internal/help/MID$.txt b/internal/help/MID$.txt index 5fbda61b5..017e5b1a7 100644 --- a/internal/help/MID$.txt +++ b/internal/help/MID$.txt @@ -5,7 +5,7 @@ The [[MID$]] function returns a portion of a [[STRING|string]]. : {{Parameter|portion$}} = [[MID$]]({{Parameter|stringValue$}}, {{Parameter|startPosition%}}[, {{Parameter|bytes%}}]) -{{Parameters}} +{{PageParameters}} * {{Parameter|stringValue$}} can be any literal or variable non-empty [[STRING]] value. Use [[LEN]] to check the length of a string. * {{Parameter|startPosition%}} designates the non-zero position of the first character to be returned by the function. * {{Parameter|bytes%}} (optional) tells the function how many characters to return including the first character at {{Parameter|startPosition%}}. diff --git a/internal/help/MOD.txt b/internal/help/MOD.txt index 796d06b77..075582b84 100644 --- a/internal/help/MOD.txt +++ b/internal/help/MOD.txt @@ -5,7 +5,7 @@ The [[MOD]] operator gives the remainder after division of one number by another : {{Parameter|remainder}} = {{Parameter|numerator}} [[MOD]] {{Parameter|divisor}} -{{Parameters}} +{{PageParameters}} * Returns the integer division remainder as a whole [[INTEGER]], [[LONG]] or [[_INTEGER64]] value. * {{Parameter|numerator}} is the [[INTEGER]] value to divide. * {{Parameter|divisor}} is the [[INTEGER]] value to divide by. diff --git a/internal/help/OPEN.txt b/internal/help/OPEN.txt index 2cdb1da0a..5c31b8395 100644 --- a/internal/help/OPEN.txt +++ b/internal/help/OPEN.txt @@ -9,7 +9,7 @@ The [[OPEN]] statement is used to open a file or [[OPEN_COM|COM]] serial communi : [[OPEN]] {{Parameter|modeLetter$}}, [#]{{Parameter|fileNumber&}}, {{Parameter|fileName$}}[, {{Parameter|recordLength}}] -{{Parameters}} +{{PageParameters}} * The {{Parameter|fileName$}} is a [[STRING]] variable or literal file name (path optional) in quotes. * FOR mode can be: [[APPEND]] (write to end), [[BINARY]] (read/write), [[INPUT (file mode)|INPUT]] (read), [[OUTPUT]] (write new) or [[RANDOM]] (read/write). * GW-BASIC's {{Parameter|modeLetter$}} is a [[STRING]] variable or the letter "A", "B", "I", "O" or "R" designating the OPEN modes above. @@ -72,7 +72,7 @@ file$ = "Hello,~1.mp3" 'example call below {{Cl|LOCATE}} 20, 30: errors% = CheckName%(file$): {{Cl|COLOR}} 14: {{Cl|PRINT}} " Total Errors ="; errors% {{Cl|FUNCTION}} CheckName% (Filename$) - '{{Cl|NOT}}E: Function also displays filename errors so {{Cl|LOCATE}} on screen before call! + 'NOTE: Function also displays filename errors so {{Cl|LOCATE}} on screen before call! {{Cl|DIM}} L {{Cl|AS}} {{Cl|INTEGER}}, DP {{Cl|AS}} {{Cl|INTEGER}}, XL {{Cl|AS}} {{Cl|INTEGER}} L = {{Cl|LEN}}(Filename$): DP = {{Cl|INSTR}}(Filename$, "."): {{Cl|IF...THEN|IF}} DP {{Cl|THEN}} XL = L - DP 'extension {{Cl|IF...THEN|IF}} L = 0 {{Cl|OR (boolean)|OR}} L > 12 {{Cl|OR (boolean)|OR}} DP > 9 {{Cl|OR (boolean)|OR}} XL > 3 {{Cl|THEN}} diff --git a/internal/help/OPEN_COM.txt b/internal/help/OPEN_COM.txt index c96dae349..35436b576 100644 --- a/internal/help/OPEN_COM.txt +++ b/internal/help/OPEN_COM.txt @@ -5,7 +5,7 @@ The [[OPEN COM]] statement is used to access a computer's serial port COM. : '''OPEN''' "COMn: ''Speed'', ''Parity'', ''Bits'', ''Stopbit'', [''Options'']" [FOR {[[RANDOM]]|[[BINARY]]|[[OUTPUT]]|[[INPUT (file mode)|INPUT]]}] AS #''P'' [LEN = {{Parameter|byteSize}}] -{{Parameters}} +{{PageParameters}} * ''Speed'' (baud rate): 50, 150, 300, 600, 1200, 1800, 2400, '''9600''' (QBasic's maximum), 19200 or '''115200''' ('''QB64''''s maximum). * ''Parity'': '''N''' (none), E (even), O (odd), S (space) or M (mark). Note: If 8 bits, use parity N for numerical data. * ''Bits'' = number of bits/byte: Valid numbers: 5, 6, 7 or '''8''' diff --git a/internal/help/OUT.txt b/internal/help/OUT.txt index bb322e180..b34e7ec70 100644 --- a/internal/help/OUT.txt +++ b/internal/help/OUT.txt @@ -5,7 +5,7 @@ : [[OUT]] {{Parameter|registerAddress%}}, {{Parameter|value%}} -{{Parameters}} +{{PageParameters}} * {{Parameter|registerAddress%}} is a value expressed as a decimal [[INTEGER]] or [[&H|hexadecimal]]. * The [[INTEGER]] {{Parameter|value%}} sent is normally only 0 to 255 per byte register (8 bit) address. diff --git a/internal/help/PAINT.txt b/internal/help/PAINT.txt index 4e85fd01f..54ffe58c0 100644 --- a/internal/help/PAINT.txt +++ b/internal/help/PAINT.txt @@ -5,7 +5,7 @@ The [[PAINT]] statement is used to fill a delimited area in a graphic screen mod : [[PAINT]] ['''STEP'''] ({{Parameter|column%}}, {{Parameter|row%}}), {{Parameter|fillColor}}[, {{Parameter|borderColor%}}] -{{Parameters}} +{{PageParameters}} * Can use the [[STEP]] keyword for relative coordinate placements. See example 1 below. * {{Parameter|fillColor}} is an [[INTEGER]] or [[LONG]] 32-bit value to paint the inside of an object. Colors are limited to the [[SCREEN]] mode used. * Optional [[INTEGER]] or [[LONG]] 32-bit {{Parameter|borderColor%}} is the color of the border of the shape to be filled when this is different from the fill color. diff --git a/internal/help/PLAY.txt b/internal/help/PLAY.txt index 31bb9ac1d..d4e957ba7 100644 --- a/internal/help/PLAY.txt +++ b/internal/help/PLAY.txt @@ -5,7 +5,7 @@ ::: '''PLAY ''commandstring$''''' -{{Parameters}} +{{PageParameters}} * The ''commandstring'' can be any literal or variable [[STRING]] consisting of the following uppercase or lowercase commands: :*'''O'''n - Sets the current octave (from 0 to 6). Example: '''{{text|PLAY "O3"|green}}''' :*'''<''' - Down one octave (cannot be below zero). Example: '''{{text|PLAY "<<"|green}}''' 'goes down two octaves. diff --git a/internal/help/POINT.txt b/internal/help/POINT.txt index 43bd8fb4d..85870814c 100644 --- a/internal/help/POINT.txt +++ b/internal/help/POINT.txt @@ -9,7 +9,7 @@ The '''POINT''' function returns the pixel [[COLOR]] attribute at a specified gr ::::pointer_coordinate% = '''POINT('''{0|1|2|3}''')''' -{{Parameters}} +{{PageParameters}} Graphic Color syntax: * The [[INTEGER]] ''column'' and ''row'' coordinates designate the pixel position color on the screen to read. diff --git a/internal/help/PRINT.txt b/internal/help/PRINT.txt index dc09a15b5..f613cc0a1 100644 --- a/internal/help/PRINT.txt +++ b/internal/help/PRINT.txt @@ -5,7 +5,7 @@ The {{KW|PRINT}} statement prints numeric or string expressions to the program s ::: '''PRINT''' [{{Parameter|expression}}] [{;|,] [''expression''...] -{{Parameters}} +{{PageParameters}} * {{Parameter|expression}} is a numeric or string expression or list of expressions to be written to the screen. End quotes will not be displayed in strings. * The print statement can be followed by a [[semicolon]] to stop the print cursor or a [[comma]] to tab space the next print. diff --git a/internal/help/PRINT_(file_statement).txt b/internal/help/PRINT_(file_statement).txt index 67428e90f..04cd16fbd 100644 --- a/internal/help/PRINT_(file_statement).txt +++ b/internal/help/PRINT_(file_statement).txt @@ -5,7 +5,7 @@ The [[PRINT (file statement)|PRINT #]] statement prints numeric or string expres ::: '''PRINT #''fileNumber&''''', [ [{{Parameter|expression}}] [{;|,] ... ] -{{Parameters}} +{{PageParameters}} * {{Parameter|fileNumber&}} is the file number of a file or device opened for writing. See {{KW|OPEN}}. * {{Parameter|expression}} is a numeric or string expression to be written to the file. Quotes will be removed from strings. * The print statement can be followed by a [[semicolon]] to stop the print cursor or a [[comma]] to tab the next print. diff --git a/internal/help/PRINT_USING.txt b/internal/help/PRINT_USING.txt index c321eaac5..30cf02d71 100644 --- a/internal/help/PRINT_USING.txt +++ b/internal/help/PRINT_USING.txt @@ -5,7 +5,7 @@ The '''PRINT USING''' statement is used to [[PRINT]] formatted data to the Scree :: '''PRINT''' [''text$''{;|,}] '''USING''' ''template$''; ''variable''[; ...][{;|,}] -{{Parameters}} +{{PageParameters}} * Literal or variable [[STRING]] ''text$'' can be placed between PRINT and USING or it can be included in the ''template''. * A [[semicolon]] or [[comma]] may follow the ''text'' to stop or tab the print cursor before the ''template'' [[PRINT]]. * The literal or variable [[STRING]] ''template'' should use the template symbols to display each variable [[Variable Types|type]] in the list following it. diff --git a/internal/help/PRINT_USING_(file_statement).txt b/internal/help/PRINT_USING_(file_statement).txt index 1469777c1..7db512a27 100644 --- a/internal/help/PRINT_USING_(file_statement).txt +++ b/internal/help/PRINT_USING_(file_statement).txt @@ -6,7 +6,7 @@ The '''PRINT #, USING''' statement is used to [[PRINT]] formatted text data to a :: '''PRINT ''filenumber%,''''' [''text$''{;|,}] '''USING ''template$''; ''variable'''''[; ...][{;|,}] -{{Parameters}} +{{PageParameters}} * [[INTEGER]] ''filenumber'' refers to the file number [[OPEN]]ed previously followed by a [[comma]]. * Literal or variable [[STRING]] ''text$'' can be placed between PRINT and USING or it can be included in the ''template''. * A [[semicolon]] or [[comma]] may follow the ''text'' to stop or tab the print cursor before the ''template'' [[PRINT]]. diff --git a/internal/help/PSET.txt b/internal/help/PSET.txt index a6f4696bd..27680e492 100644 --- a/internal/help/PSET.txt +++ b/internal/help/PSET.txt @@ -1,4 +1,4 @@ -The '''PSET''' grahics [[SCREEN (statement)|SCREEN]] statement sets a pixel to a coordinate with a default or designated color attribute. +The '''PSET''' graphics [[SCREEN (statement)|SCREEN]] statement sets a pixel to a coordinate with a default or designated color attribute. {{PageSyntax}} diff --git a/internal/help/PUT_(TCP%2FIP_statement).txt b/internal/help/PUT_(TCP%2FIP_statement).txt index 28868c402..93367ada5 100644 --- a/internal/help/PUT_(TCP%2FIP_statement).txt +++ b/internal/help/PUT_(TCP%2FIP_statement).txt @@ -5,7 +5,7 @@ The '''PUT #''' TCP/IP statement sends unformatted(raw) data to an open connect :: '''PUT ''#handle'', , ''data'' ''' -{{Parameters}} +{{PageParameters}} * The ''handle'' value is returned by the [[_OPENCLIENT]], [[_OPENHOST]] or [[_OPENCONNECTION]] '''QB64''' functions. * The ''data'' can be any variable type value. Literal values are not allowed. diff --git a/internal/help/REM.txt b/internal/help/REM.txt index 1335db7f8..6e3376abe 100644 --- a/internal/help/REM.txt +++ b/internal/help/REM.txt @@ -1,30 +1,33 @@ -'''REM''' or an apostrophe is used for programmer remarks, comments or to stop the execution of program code. +[[REM]] allows explanatory comments, or remarks, to be inserted in a program. [[REM]] statements extend to the end of the line and the text is ignored when the program is run. {{PageSyntax}} -:: REM program comment or ignore code +:: [[REM]] this is a comment +:: [[apostrophe|']] this is also a comment {{PageDescription}} -* Comments cannot be read by QBasic correctly and may cause syntax and other errors without REM! -* Instead of REM you can use the {{KW|REM|'}} symbol which can be put anywhere. -* Code can also be commented out for program testing purposes. -* QBasic Metacommands such as {{KW|$DYNAMIC}} and {{KW|$INCLUDE}} require the use of REM or the apostrophe. +* [[REM]] may only be used where statements are allowed unlike [[apostrophe]] comments which may be included anywhere. +* [[REM]] must appear as the last, or only, statement on a line. Any following statements are included in the comment text and ignored. +* QBasic [[metacommand]]s like [[$INCLUDE]] must be included in a comment using either [[REM]] or [[apostrophe|']]. +* [[Apostrophe]] comments, unavailable in earlier dialects of the BASIC language, are now generally favored over [[REM]] statements for their greater flexibility. +* Comments are also useful for disabling code for program testing and debugging purposes. -''Example:'' Avoiding an END IF error. +{{PageExamples}} +''Example:'' Avoiding an [[END IF]] error. {{CodeStart}} '' '' {{Cl|REM}} This is a remark... ' This is also a remark... -{{Cl|IF...THEN|IF}} a = 0 {{Cl|THEN}} {{Cl|REM}} (REM follows syntax rules) -{{Cl|IF...THEN|IF}} a = 0 {{Cl|THEN}} '(apostrophe doesn't follow syntax rules, so use END IF after this) +{{Cl|IF...THEN|IF}} a = 0 {{Cl|THEN}} {{Cl|REM}} this statement is executed so this is a single-line IF statement +{{Cl|IF...THEN|IF}} a = 0 {{Cl|THEN}} ' this comment is not executed so this is a multi-line IF statement and END IF is required {{Cl|END IF}} '' '' {{CodeEnd}} {{PageSeeAlso}} * [[Apostrophe]] -* {{KW|$DYNAMIC}}, {{KW|$STATIC}}, {{KW|$INCLUDE|$INCLUDE:}} +* [[$DYNAMIC]], [[$STATIC]], [[$INCLUDE]] {{PageNavigation}} diff --git a/internal/help/RETURN.txt b/internal/help/RETURN.txt index dfe8cd542..78b4fb172 100644 --- a/internal/help/RETURN.txt +++ b/internal/help/RETURN.txt @@ -5,7 +5,7 @@ :: '''RETURN''' [{''linelabel''|''linenumber''}] -{{Parameters}} +{{PageParameters}} * RETURN without parameters returns to the code immediately following the original [[GOSUB]] call. * ''line number'' or ''linelabel'' after the RETURN statement returns code execution to that label. diff --git a/internal/help/RIGHT$.txt b/internal/help/RIGHT$.txt index 7ed4ea7a3..80deab5ff 100644 --- a/internal/help/RIGHT$.txt +++ b/internal/help/RIGHT$.txt @@ -6,7 +6,7 @@ The '''RIGHT$''' function returns a set number of characters in a [[STRING]] var :: '''RIGHT$('''''stringvalue$, numberofcharacters%''''')''' -{{Parameters}} +{{PageParameters}} * The ''stringvalue$'' can be any string of [[ASCII]] characters as a [[STRING]] variable. * The ''numberofcharacters'' [[INTEGER]] value determines the number of characters to return from the right end of the string. diff --git a/internal/help/RND.txt b/internal/help/RND.txt index 6cc7148e4..e3ac4d6e9 100644 --- a/internal/help/RND.txt +++ b/internal/help/RND.txt @@ -5,7 +5,7 @@ The '''RND''' function returns a random number with a value between 0 (inclusive :: result! = [[RND]] [(''n'')] -{{Parameters}} +{{PageParameters}} * ''n'' is a [[SINGLE]] numeric value that defines the behavior of the RND function but is '''NOT normally required''': ::n parameter omitted: Returns next random number in the sequence. ::n = 0: Return the last value returned. diff --git a/internal/help/RUN.txt b/internal/help/RUN.txt index 6ad91fefe..ac6f57435 100644 --- a/internal/help/RUN.txt +++ b/internal/help/RUN.txt @@ -8,7 +8,7 @@ The multi-modular technique goes back to when QBasic and QuickBASIC had module s :: '''RUN''' [{''line_number'' | ''filespec$''}] [''command_parameter(s)''] -{{Parameters}} +{{PageParameters}} * ''line number'' specifies a line number in the main module code. * An optional ''filespec'' specifies a program to load into memory and run. : * BAS or EXE extensions are assumed to be the same as the calling module's extension, EXE or BAS (QBasic only). diff --git a/internal/help/SCREEN.txt b/internal/help/SCREEN.txt index abe4a9263..91538a8de 100644 --- a/internal/help/SCREEN.txt +++ b/internal/help/SCREEN.txt @@ -9,7 +9,7 @@ The [[SCREEN]] statement sets the video display mode and size of the program win ::: '''SCREEN''' {''mode%''|''imagehandle&''} [, , active_page, visual_page] -{{Parameters}} +{{PageParameters}} * The SCREEN ''mode'' [[INTEGER]] values available today are 0 to 2 and 7 to 13 listed below. * '''QB64''' can use a [[LONG]] [[_NEWIMAGE]] page or [[_LOADIMAGE]] file ''image handle'' value instead. * The empty comma disables color when any value is used. '''DO NOT USE!''' Include the comma ONLY when using page flipping. diff --git a/internal/help/SCREEN_(function).txt b/internal/help/SCREEN_(function).txt index 9f5b77785..7ee8728c8 100644 --- a/internal/help/SCREEN_(function).txt +++ b/internal/help/SCREEN_(function).txt @@ -5,7 +5,7 @@ The '''SCREEN''' function returns the [[ASCII]] code of a text character or the :: codeorcolor% = '''SCREEN (''row%'', ''column%''''' [, colorflag%]''')''' -{{Parameters}} +{{PageParameters}} * ''row'' and ''column'' are the [[INTEGER]] text coordinates of the [[SCREEN]] mode used. * Optional ''colorflag'' [[INTEGER]] value can be omitted or 0 for [[ASCII]] code values or 1 for color attributes. diff --git a/internal/help/SHELL_(function).txt b/internal/help/SHELL_(function).txt index f881a8809..159ee0dd7 100644 --- a/internal/help/SHELL_(function).txt +++ b/internal/help/SHELL_(function).txt @@ -5,7 +5,7 @@ The '''SHELL''' function displays the console and returns the [[INTEGER]] code v ::: return_code = '''SHELL(''DOScommand$'')''' -{{Parameters}} +{{PageParameters}} * The literal or variable [[STRING]] ''command'' parameter can be any valid external command or call to another program. diff --git a/internal/help/SIN.txt b/internal/help/SIN.txt index 165a2dbdb..a75fbb583 100644 --- a/internal/help/SIN.txt +++ b/internal/help/SIN.txt @@ -5,7 +5,7 @@ The {{KW|SIN}} function returns the vertical component or sine of an angle measu ::: value! = '''SIN('''''radian_angle!''''')''' -{{Parameters}} +{{PageParameters}} * The ''radian_angle'' must be measured in radians from 0 to 2 * Pi. diff --git a/internal/help/SPACE$.txt b/internal/help/SPACE$.txt index a8cd6d1c3..d12a39feb 100644 --- a/internal/help/SPACE$.txt +++ b/internal/help/SPACE$.txt @@ -5,7 +5,7 @@ The {{KW|SPACE$}} function returns a {{KW|STRING}} consisting of a number of spa :''result$'' = '''SPACE$({{Parameter|count&}})''' -{{Parameters}} +{{PageParameters}} * {{Parameter|count&}} is the number of space characters to repeat. Cannot use negative values! diff --git a/internal/help/SPC.txt b/internal/help/SPC.txt index d6ed1e944..c1fc21fa5 100644 --- a/internal/help/SPC.txt +++ b/internal/help/SPC.txt @@ -5,7 +5,7 @@ The {{KW|SPC}} function is used in [[PRINT]] and [[LPRINT]] statements to print ::: '''SPC({{Parameter|count%}})''' -{{Parameters}} +{{PageParameters}} * ''count'' designates the number of column spaces to move the cursor in a [[PRINT]] statement. diff --git a/internal/help/STR$.txt b/internal/help/STR$.txt index 6b6a368fd..a7105a78c 100644 --- a/internal/help/STR$.txt +++ b/internal/help/STR$.txt @@ -5,7 +5,7 @@ The '''STR$''' function returns the [[STRING]] representation of a numerical val :: result$ = '''STR$('''{{Parameter|number}}''')''' -{{Parameters}} +{{PageParameters}} * {{Parameter|number}} is any numerical type value to convert. diff --git a/internal/help/SUB.txt b/internal/help/SUB.txt index daa96352e..4e44e95f3 100644 --- a/internal/help/SUB.txt +++ b/internal/help/SUB.txt @@ -9,7 +9,7 @@ A '''SUB''' procedure is a procedure within a program that can calculate and ret :: '''END SUB''' -{{Parameters}} +{{PageParameters}} * Parameters passed after the procedure call must match the variable types in the SUB parameters in order. * If there are no ''parameter''s passed or they are [[SHARED]] the parameters and parenthesis are not required in the procedure. * Parameter [[Variable]] names in the procedure do not have to match the names used in the [[CALL]], just the value types. diff --git a/internal/help/SYSTEM.txt b/internal/help/SYSTEM.txt index c30819a2b..00eda754e 100644 --- a/internal/help/SYSTEM.txt +++ b/internal/help/SYSTEM.txt @@ -5,7 +5,7 @@ The [[SYSTEM]] statement immediately closes a program and returns control to the :'''SYSTEM''' [return_code%] -{{Parameters}} +{{PageParameters}} * QB64 allows a ''code'' number to be used after SYSTEM to be read in another program module by the [[SHELL]] or [[_SHELLHIDE]] functions. diff --git a/internal/help/TAN.txt b/internal/help/TAN.txt index f6f822b49..19cd0f9fa 100644 --- a/internal/help/TAN.txt +++ b/internal/help/TAN.txt @@ -5,7 +5,7 @@ The [[TAN]] function returns the ratio of [[SIN]]e to [[COS]]ine or tangent valu ::: tangent! = '''TAN('''''radian_angle!''''')''' -{{Parameters}} +{{PageParameters}} * The ''radian_angle'' must be measured in radians. diff --git a/internal/help/TIMER_(statement).txt b/internal/help/TIMER_(statement).txt index 05a7543dc..ecee908c8 100644 --- a/internal/help/TIMER_(statement).txt +++ b/internal/help/TIMER_(statement).txt @@ -9,7 +9,7 @@ QB64 :::TIMER(''number%'') {ON|STOP|OFF|FREE} -{{Parameters}} +{{PageParameters}} * ''number'' denotes a specific numbered timer event in '''QB64 only'''. QB64 can run many timer events at once including the base timer. * TIMER ON enables event trapping of an [[ON TIMER (n)]] statement. While enabled, a check is made after every code statement to see if the specified time has elapsed and the ON TIMER [[GOSUB]] (or [[SUB]] in QB64) procedure is executed. * TIMER STOP disables timer event trapping. When an event occurs while stopped, it is remembered. If timer events are turned back on later, any remembered events are immediately executed. diff --git a/internal/help/VIEW_PRINT.txt b/internal/help/VIEW_PRINT.txt index 8043b2364..40cd5e86f 100644 --- a/internal/help/VIEW_PRINT.txt +++ b/internal/help/VIEW_PRINT.txt @@ -5,7 +5,7 @@ The [[VIEW PRINT]] statement defines the boundaries of a text viewport {{KW|PRIN : '''VIEW PRINT''' [{{Parameter|topRow%}} '''TO''' {{Parameter|bottomRow%}}] -{{Parameters}} +{{PageParameters}} * {{Parameter|topRow%}} and {{Parameter|bottomRow%}} specify the upper and lower rows of the text viewport. * If {{Parameter|topRow%}} and {{Parameter|bottomRow%}} are not specified when first used, the text viewport is defined to be the entire screen. diff --git a/internal/help/WIDTH.txt b/internal/help/WIDTH.txt index 948dbb1be..f078d91e8 100644 --- a/internal/help/WIDTH.txt +++ b/internal/help/WIDTH.txt @@ -8,7 +8,7 @@ The {{KW|WIDTH}} statement changes the text dimensions of certain {{KW|SCREEN (s ::: '''WIDTH''' {'''''file_number''''' | '''''device'''''}, '''''columnwidth%''''' -{{Parameters}} +{{PageParameters}} * When parameters are not specified, columns defaults to 80 with 25 (30 in [[SCREEN]] 11 or 12) rows. diff --git a/internal/help/_ALPHA32.txt b/internal/help/_ALPHA32.txt index f5a0b7967..6576cddef 100644 --- a/internal/help/_ALPHA32.txt +++ b/internal/help/_ALPHA32.txt @@ -5,7 +5,7 @@ The [[_ALPHA32]] function returns the alpha transparency level of a 32 bit color {{PageSyntax}} :{{Parameter|alpha&}} = [[_ALPHA32]]({{Parameter|color32~&}})''' -{{Parameters}} +{{PageParameters}} * {{Parameter|color32&}} is the [[_UNSIGNED]] [[LONG]] 32 bit color value used to retrieve the alpha level. ** Color values that are set as a [[_CLEARCOLOR]] always have an alpha level of 0 (transparent). ** [[_SETALPHA]] can set any alpha level from 0 (or fully transparent) to 255 (or opaque). diff --git a/internal/help/_ATAN2.txt b/internal/help/_ATAN2.txt index 9d9e6f548..49ebd0de5 100644 --- a/internal/help/_ATAN2.txt +++ b/internal/help/_ATAN2.txt @@ -6,7 +6,7 @@ The [[_ATAN2]] function returns the radian angle between the positive x-axis of : {{Parameter|angle!}} = [[_ATAN2]]({{Parameter|y}}, {{Parameter|x}}) -{{Parameters}} +{{PageParameters}} * {{Parameter|y}} is the vertical axis position (row) as a positive, zero or negative floating point value. * {{Parameter|x}} is the horizontal axis position (column) as a positive, zero or negative floating point value. diff --git a/internal/help/_CLEARCOLOR.txt b/internal/help/_CLEARCOLOR.txt index 823fe0a8c..83e9470c4 100644 --- a/internal/help/_CLEARCOLOR.txt +++ b/internal/help/_CLEARCOLOR.txt @@ -5,7 +5,7 @@ The [[_CLEARCOLOR]] statement sets a specific color to be treated as transparent {{PageSyntax}} :[[_CLEARCOLOR]] {{{Parameter|color&}}|_NONE}[, {{Parameter|Dest_Handle&}}] -{{Parameters}} +{{PageParameters}} * In color modes using a palette, {{Parameter|color&}} is the palette index of the new transparent color value or _NONE designates no clear colors. * If {{Parameter|color&}} is not a valid palette index, an [[ERROR Codes|illegal function call]] error will occur. * In 32-bit color modes, {{Parameter|color&}} is the [[_LONG]] color value of the new transparent color. diff --git a/internal/help/_COPYIMAGE.txt b/internal/help/_COPYIMAGE.txt index 3c6da8540..47b99e6c9 100644 --- a/internal/help/_COPYIMAGE.txt +++ b/internal/help/_COPYIMAGE.txt @@ -6,7 +6,7 @@ The [[_COPYIMAGE]] function creates an identical designated image in memory with : newhandle& = [[_COPYIMAGE]][({{Parameter|imageHandle&}}[, {{Parameter|mode%}})]] -{{Parameters}} +{{PageParameters}} * The [[LONG]] ''newhandle&'' value returned will be different than the source handle value supplied. * If ''imageHandle&'' parameter is omitted or zero is designated, the current software [[_DEST|destination]] screen or image is copied. * If 1 is designated instead of an ''imageHandle&'', it designates the last OpenGL hardware surface to copy. diff --git a/internal/help/_CV.txt b/internal/help/_CV.txt index e259f9f8a..f34385653 100644 --- a/internal/help/_CV.txt +++ b/internal/help/_CV.txt @@ -6,7 +6,7 @@ The [[_CV]] function is used to convert [[_MK$]], [[ASCII]], [[STRING]] values t :{{Parameter|result}} = [[_CV]]({{Parameter|numericalType}}, {{Parameter|MKstringValue$}}) -{{Parameters}} +{{PageParameters}} * {{Parameter|numericalType}} is any number type: [[INTEGER]], [[LONG]], [[SINGLE]], [[DOUBLE]], [[_INTEGER64]], [[_FLOAT]], [[_BYTE]] or [[_BIT]]. * Integer, Long, Byte and Bit values can be signed or [[_UNSIGNED]]. * The {{Parameter|MKstringvalue$}} parameter must be a string value generated by [[_MK$]] diff --git a/internal/help/_DEFINE.txt b/internal/help/_DEFINE.txt index 414a045f7..0ac36ba54 100644 --- a/internal/help/_DEFINE.txt +++ b/internal/help/_DEFINE.txt @@ -6,7 +6,7 @@ :[[_DEFINE]] {{Parameter|letter}}[{{Parameter|-range}}, ...] [[AS]] [{{KW|_UNSIGNED}}] data[[Variable Types|type]] -{{Parameters}} +{{PageParameters}} * Variable start ''letter range'' is in the form firstletter-endingletter (like A-C) or just a single letter. * ''Data types'': [[INTEGER]], [[SINGLE]], [[DOUBLE]], [[LONG]], [[STRING]], [[_BIT]], [[_BYTE]], [[_INTEGER64]], [[_FLOAT]], [[_OFFSET]], [[_MEM]] * Can also use the [[_UNSIGNED]] definition for positive whole [[INTEGER]] type numerical values. diff --git a/internal/help/_DEVICEINPUT.txt b/internal/help/_DEVICEINPUT.txt index 3e017e00c..7f366091a 100644 --- a/internal/help/_DEVICEINPUT.txt +++ b/internal/help/_DEVICEINPUT.txt @@ -7,7 +7,7 @@ The '''_DEVICEINPUT''' function returns the device number when a controller devi : {{Parameter|device_active%}} = [[_DEVICEINPUT]]({{Parameter|device_number%}}) -{{Parameters}} +{{PageParameters}} * Use the _DEVICEINPUT {{Parameter|device%}} [[INTEGER]] returned to find the number of the controller device being used. * A literal specific {{Parameter|device_number%}} parameter can be used to return -1 if active or 0 if inactive. {{text|EX: '''WHILE _DEVICEINPUT(2)'''|green}} diff --git a/internal/help/_DIR$.txt b/internal/help/_DIR$.txt index edc2f217d..8714c53c1 100644 --- a/internal/help/_DIR$.txt +++ b/internal/help/_DIR$.txt @@ -6,7 +6,7 @@ The [[_DIR$]] function returns common paths in '''Windows''' only such as My Doc : {{Parameter|d$}} = [[_DIR$]]("{{Parameter|folderspecification}}") -{{Parameters}} +{{PageParameters}} * ''folderspecification'' may be "desktop", "download", "documents", "music", "video", "pictures", "appdata", "program data", "local data". * Some variation is accepted for the folder specification: :: MY DOCUMENTS, TEXT, DOCUMENT, DOCUMENTS, DOWNLOAD, DOWNLOADS