Skip to content

Commit 2383e26

Browse files
committed
fbdoc: wiki snapshot 2019-07-11
1 parent ac031c4 commit 2383e26

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+345
-105
lines changed

doc/manual/cache/CatPgConsole.wakka

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ Procedures that work with the console.
3232
Gets the character or color attribute at a given location.
3333
<<>>{{anchor name="WRITING"}}{{fbdoc item="section" value="Writing Text to the Console"}}
3434
=={{fbdoc item="keyword" value="KeyPgPrint|PRINT"}}==
35-
=={{fbdoc item="keyword" value="KeyPgPrint|?"}}==
35+
=={{fbdoc item="keyword" value="KeyPgPrint|? (Shortcut for 'PRINT')"}}==
3636
Writes text to the console.
3737
=={{fbdoc item="keyword" value="KeyPgPrintusing|PRINT USING"}}==
38-
=={{fbdoc item="keyword" value="KeyPgPrintusing|? USING"}}==
38+
=={{fbdoc item="keyword" value="KeyPgPrintusing|? USING (Shortcut for 'PRINT USING')"}}==
3939
Writes formatted text to the console.
4040
=={{fbdoc item="keyword" value="KeyPgWrite|WRITE"}}==
4141
Writes a list of items to the console.

doc/manual/cache/CatPgFile.wakka

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Statements and procedures for working with files and devices.
7070
=={{fbdoc item="keyword" value="KeyPgLineinputPp|LINE INPUT #"}}==
7171
Reads a line of text from a file or device.
7272
=={{fbdoc item="keyword" value="KeyPgPrintPp|PRINT #"}}==
73-
=={{fbdoc item="keyword" value="KeyPgPrintPp|? #"}}==
73+
=={{fbdoc item="keyword" value="KeyPgPrintPp|? # (Shortcut for 'PRINT #')"}}==
7474
Writes text data to a file or device.
7575
=={{fbdoc item="keyword" value="KeyPgPutfileio|PUT #"}}==
7676
Writes arbitrary data to a file or device.

doc/manual/cache/CatPgFullIndex.wakka

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{{fbdoc item="title" value="Alphabetical Keywords List"}}----
22
Alphabetical listing of keywords, macros and procedures.
33

4-
[[CatPgOpIndex|Operators]] ##{{anchor name="dot|."}} {{anchor name="underscore|_"}} {{anchor name="hash|#"}} {{anchor name="dollar|$"}} {{anchor name="a|A"}} {{anchor name="b|B"}} {{anchor name="c|C"}} {{anchor name="d|D"}} {{anchor name="e|E"}} {{anchor name="f|F"}} {{anchor name="g|G"}} {{anchor name="h|H"}} {{anchor name="i|I"}} {{anchor name="k|K"}} {{anchor name="l|L"}} {{anchor name="m|M"}} {{anchor name="n|N"}} {{anchor name="o|O"}} {{anchor name="p|P"}} {{anchor name="r|R"}} {{anchor name="s|S"}} {{anchor name="t|T"}} {{anchor name="u|U"}} {{anchor name="v|V"}} {{anchor name="w|W"}} {{anchor name="x|X"}} {{anchor name="y|Y"}} {{anchor name="z|Z"}}##
4+
##{{anchor name="op|Operators"}} {{anchor name="dot|."}} {{anchor name="underscore|_"}} {{anchor name="hash|#"}} {{anchor name="dollar|$"}} {{anchor name="query|?"}} {{anchor name="a|A"}} {{anchor name="b|B"}} {{anchor name="c|C"}} {{anchor name="d|D"}} {{anchor name="e|E"}} {{anchor name="f|F"}} {{anchor name="g|G"}} {{anchor name="h|H"}} {{anchor name="i|I"}} {{anchor name="k|K"}} {{anchor name="l|L"}} {{anchor name="m|M"}} {{anchor name="n|N"}} {{anchor name="o|O"}} {{anchor name="p|P"}} {{anchor name="r|R"}} {{anchor name="s|S"}} {{anchor name="t|T"}} {{anchor name="u|U"}} {{anchor name="v|V"}} {{anchor name="w|W"}} {{anchor name="x|X"}} {{anchor name="y|Y"}} {{anchor name="z|Z"}}##
55

66
{{fbdoc item="back" value="DocToc|Table of Contents"}}
7-
<<{{fbdoc item="section" value="Operators"}}
7+
<<{{fbdoc item="section" value="Operators"}}{{anchor name="op"}}
88
- [[CatPgOpIndex|See Operator List]]
99

1010
{{fbdoc item="section" value="."}}{{anchor name="dot"}}
@@ -94,6 +94,11 @@ Alphabetical listing of keywords, macros and procedures.
9494
- {{fbdoc item="keyword" value="KeyPgMetaLang|$LANG"}}
9595
- {{fbdoc item="keyword" value="KeyPgMetaStatic|$STATIC"}}
9696

97+
{{fbdoc item="section" value="?"}}{{anchor name="query"}}
98+
- {{fbdoc item="keyword" value="KeyPgPrint|? (Shortcut for 'PRINT')"}}
99+
- {{fbdoc item="keyword" value="KeyPgPrintPp|? # (Shortcut for 'PRINT #')"}}
100+
- {{fbdoc item="keyword" value="KeyPgPrintusing|? USING (Shortcut for 'PRINT USING')"}}
101+
97102
{{fbdoc item="section" value="A"}}{{anchor name="a"}}
98103
- {{fbdoc item="keyword" value="KeyPgAbs|ABS"}}
99104
- {{fbdoc item="keyword" value="KeyPgAbstract|ABSTRACT (member)"}}
@@ -259,6 +264,8 @@ Alphabetical listing of keywords, macros and procedures.
259264
- {{fbdoc item="keyword" value="KeyPgExp|EXP"}}
260265
- {{fbdoc item="keyword" value="KeyPgExport|EXPORT"}}
261266
- {{fbdoc item="keyword" value="KeyPgExtends|EXTENDS"}}
267+
- {{fbdoc item="keyword" value="KeyPgExtendsWstring|EXTENDS WSTRING"}}
268+
- {{fbdoc item="keyword" value="KeyPgExtendsZstring|EXTENDS ZSTRING"}}
262269
- {{fbdoc item="keyword" value="KeyPgExtern|EXTERN"}}
263270
- {{fbdoc item="keyword" value="KeyPgExternBlock|EXTERN...END EXTERN"}}
264271

@@ -297,7 +304,7 @@ Alphabetical listing of keywords, macros and procedures.
297304
- {{fbdoc item="keyword" value="KeyPgHiword|HIWORD"}}
298305
- {{fbdoc item="keyword" value="KeyPgHour|HOUR"}}
299306

300-
{{fbdoc item="section" value="I"}}{{anchor name="i"}}
307+
<<>>{{fbdoc item="section" value="I"}}{{anchor name="i"}}
301308
- {{fbdoc item="keyword" value="KeyPgIfthen|IF...THEN"}}
302309
- {{fbdoc item="keyword" value="KeyPgIif|IIF"}}
303310
- {{fbdoc item="keyword" value="KeyPgImageConvertRow|IMAGECONVERTROW"}}
@@ -322,7 +329,7 @@ Alphabetical listing of keywords, macros and procedures.
322329
- {{fbdoc item="keyword" value="KeyPgIsDate|ISDATE"}}
323330
- {{fbdoc item="keyword" value="KeyPgIsredirected|ISREDIRECTED"}}
324331

325-
<<>>{{fbdoc item="section" value="K"}}{{anchor name="k"}}
332+
{{fbdoc item="section" value="K"}}{{anchor name="k"}}
326333
- {{fbdoc item="keyword" value="KeyPgKill|KILL"}}
327334

328335
{{fbdoc item="section" value="L"}}{{anchor name="l"}}
@@ -426,25 +433,22 @@ Alphabetical listing of keywords, macros and procedures.
426433
- {{fbdoc item="keyword" value="KeyPgPmap|PMAP"}}
427434
- {{fbdoc item="keyword" value="KeyPgPoint|POINT"}}
428435
- {{fbdoc item="keyword" value="KeyPgPointCoord|POINTCOORD"}}
429-
- {{fbdoc item="keyword" value="KeyPgPointer|POINTER"}}
436+
- {{fbdoc item="keyword" value="KeyPgPtr|POINTER"}}
430437
- {{fbdoc item="keyword" value="KeyPgPoke|POKE"}}
431438
- {{fbdoc item="keyword" value="KeyPgPos|POS"}}
432439
- {{fbdoc item="keyword" value="KeyPgPreserve|PRESERVE"}}
433440
- {{fbdoc item="keyword" value="KeyPgPreset|PRESET"}}
434441
- {{fbdoc item="keyword" value="KeyPgPrint|PRINT"}}
435-
- {{fbdoc item="keyword" value="KeyPgPrint|?"}}
436442
- {{fbdoc item="keyword" value="KeyPgPrintPp|PRINT #"}}
437-
- {{fbdoc item="keyword" value="KeyPgPrintPp|? #"}}
438443
- {{fbdoc item="keyword" value="KeyPgPrintusing|PRINT USING"}}
439-
- {{fbdoc item="keyword" value="KeyPgPrintusing|? USING"}}
440444
- {{fbdoc item="keyword" value="KeyPgPrivate|PRIVATE"}}
441445
- {{fbdoc item="keyword" value="KeyPgVisPrivate|PRIVATE: (Access Control)"}}
442446
- {{fbdoc item="keyword" value="KeyPgOpProcptr|PROCPTR"}}
443447
- {{fbdoc item="keyword" value="KeyPgProperty|PROPERTY"}}
444448
- {{fbdoc item="keyword" value="KeyPgVisProtected|PROTECTED: (Access Control)"}}
445449
- {{fbdoc item="keyword" value="KeyPgPset|PSET (Statement)"}}
446450
- {{fbdoc item="keyword" value="KeyPgPsetGfx|PSET (Graphics PUT)"}}
447-
- {{fbdoc item="keyword" value="KeyPgPtr|PTR"}}
451+
- {{fbdoc item="keyword" value="KeyPgPtr|PTR (Shortcut for 'POINTER')"}}
448452
- {{fbdoc item="keyword" value="KeyPgPublic|PUBLIC"}}
449453
- {{fbdoc item="keyword" value="KeyPgVisPublic|PUBLIC: (Access Control)"}}
450454
- {{fbdoc item="keyword" value="KeyPgPutgraphics|PUT (Graphics)"}}

doc/manual/cache/CatPgFunctIndex.wakka

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ List of ""FreeBASIC"" keywords sorted by the function they perform.
4242
- {{fbdoc item="keyword" value="KeyPgOptionstatic|OPTION STATIC"}}
4343

4444
{{fbdoc item="section" value="Console"}}
45+
- {{fbdoc item="keyword" value="KeyPgPrint|? (Shortcut for 'PRINT')"}}
46+
- {{fbdoc item="keyword" value="KeyPgPrintusing|? USING (Shortcut for 'PRINT USING')"}}
4547
- {{fbdoc item="keyword" value="KeyPgBeep|BEEP"}}
4648
- {{fbdoc item="keyword" value="KeyPgCls|CLS"}}
4749
- {{fbdoc item="keyword" value="KeyPgColor|COLOR"}}
@@ -53,9 +55,7 @@ List of ""FreeBASIC"" keywords sorted by the function they perform.
5355
- {{fbdoc item="keyword" value="KeyPgOpenScrn|OPEN SCRN"}}
5456
- {{fbdoc item="keyword" value="KeyPgPos|POS"}}
5557
- {{fbdoc item="keyword" value="KeyPgPrint|PRINT"}}
56-
- {{fbdoc item="keyword" value="KeyPgPrint|?"}}
5758
- {{fbdoc item="keyword" value="KeyPgPrintusing|PRINT USING"}}
58-
- {{fbdoc item="keyword" value="KeyPgPrintusing|? USING"}}
5959
- {{fbdoc item="keyword" value="KeyPgScreenCons|SCREEN (Console)"}}
6060
- {{fbdoc item="keyword" value="KeyPgSpc|SPC"}}
6161
- {{fbdoc item="keyword" value="KeyPgTab|TAB"}}
@@ -75,6 +75,8 @@ List of ""FreeBASIC"" keywords sorted by the function they perform.
7575
- {{fbdoc item="keyword" value="KeyPgDouble|DOUBLE"}}
7676
- {{fbdoc item="keyword" value="KeyPgEnum|ENUM"}}
7777
- {{fbdoc item="keyword" value="KeyPgExtends|EXTENDS"}}
78+
- {{fbdoc item="keyword" value="KeyPgExtendsWstring|EXTENDS WSTRING"}}
79+
- {{fbdoc item="keyword" value="KeyPgExtendsZstring|EXTENDS ZSTRING"}}
7880
- {{fbdoc item="keyword" value="KeyPgFunctionPtr|FUNCTION (Pointer)"}}
7981
- {{fbdoc item="keyword" value="KeyPgImplements|IMPLEMENTS"}}
8082
- {{fbdoc item="keyword" value="KeyPgInteger|INTEGER"}}
@@ -145,6 +147,7 @@ List of ""FreeBASIC"" keywords sorted by the function they perform.
145147
- {{fbdoc item="keyword" value="KeyPgResumenext|RESUME NEXT"}}
146148

147149
{{fbdoc item="section" value="Files"}}
150+
- {{fbdoc item="keyword" value="KeyPgPrintPp|? # (Shortcut for 'Print #')"}}
148151
- {{fbdoc item="keyword" value="KeyPgAccess|ACCESS"}}
149152
- {{fbdoc item="keyword" value="KeyPgAppend|APPEND"}}
150153
- {{fbdoc item="keyword" value="KeyPgBinary|BINARY"}}
@@ -164,7 +167,6 @@ List of ""FreeBASIC"" keywords sorted by the function they perform.
164167
- {{fbdoc item="keyword" value="KeyPgOpen|OPEN"}}
165168
- {{fbdoc item="keyword" value="KeyPgOutput|OUTPUT"}}
166169
- {{fbdoc item="keyword" value="KeyPgPrintPp|PRINT #"}}
167-
- {{fbdoc item="keyword" value="KeyPgPrintPp|? #"}}
168170
- {{fbdoc item="keyword" value="KeyPgPutfileio|PUT # (File I/O)"}}
169171
- {{fbdoc item="keyword" value="KeyPgRandom|RANDOM"}}
170172
- {{fbdoc item="keyword" value="KeyPgReadFile|READ (File Access)"}}
@@ -385,9 +387,9 @@ List of ""FreeBASIC"" keywords sorted by the function they perform.
385387
- {{fbdoc item="keyword" value="KeyPgWindowtitle|WINDOWTITLE"}}
386388

387389
{{fbdoc item="section" value="Pointers"}}
388-
- {{fbdoc item="keyword" value="KeyPgPointer|POINTER"}}
390+
- {{fbdoc item="keyword" value="KeyPgPtr|POINTER"}}
389391
- {{fbdoc item="keyword" value="KeyPgOpProcptr|PROCPTR"}}
390-
- {{fbdoc item="keyword" value="KeyPgPtr|PTR"}}
392+
- {{fbdoc item="keyword" value="KeyPgPtr|PTR (Shortcut for 'POINTER')"}}
391393
- {{fbdoc item="keyword" value="KeyPgSadd|SADD"}}
392394
- {{fbdoc item="keyword" value="KeyPgOpStrptr|STRPTR"}}
393395
- {{fbdoc item="keyword" value="KeyPgOpVarptr|VARPTR"}}

doc/manual/cache/CatPgStdDataTypes.wakka

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Built-in data types
4646
<<>>{{anchor name="MODIFIERS"}}{{fbdoc item="section" value="Data Type Modifiers"}}
4747
=={{fbdoc item="keyword" value="KeyPgConstQualifier|CONST"}}==
4848
Specifies a read only type.
49-
=={{fbdoc item="keyword" value="KeyPgPointer|POINTER"}} and {{fbdoc item="keyword" value="KeyPgPtr|PTR"}}==
49+
=={{fbdoc item="keyword" value="KeyPgPtr|POINTER"}} and {{fbdoc item="keyword" value="KeyPgPtr|PTR (Shortcut for 'POINTER')"}}==
5050
Modifies types to be pointer types.
5151
=={{fbdoc item="keyword" value="KeyPgUnsigned|UNSIGNED"}}==
5252
Specifies an unsigned integer type.

doc/manual/cache/CatPgUserDefTypes.wakka

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@
2020
User defined structure of overlapping data
2121
=={{fbdoc item="keyword" value="KeyPgExtends|EXTENDS"}}==
2222
Extends an user defined type to derive another
23+
=={{fbdoc item="keyword" value="KeyPgExtendsWstring|EXTENDS WSTRING"}}==
24+
Extends an user defined type to inherits Wstring behavior
25+
=={{fbdoc item="keyword" value="KeyPgExtendsZstring|EXTENDS ZSTRING"}}==
26+
Extends an user defined type to inherits Zstring behavior
2327
=={{fbdoc item="keyword" value="KeyPgImplements|IMPLEMENTS"}}==
2428
Not implemented. Keyword reserved.
2529
=={{fbdoc item="keyword" value="KeyPgField|FIELD"}}==

doc/manual/cache/FBWikiFormatting.wakka

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,10 @@ In all of the examples following, the markup line with the formatting codes is f
111111
Then link to that anchor with:
112112
##""{{anchor name="item1|Jump to Item #1"}}""##
113113
{{anchor name="item1|Jump to Item #1"}}
114+
115+
**Note about adding a new anchor:**
116+
- Don't pretest the new anchor link through the "Preview" mode, otherwise that cancels all changes in progress done with "Edit" (check only the added text associated with the new anchor).
117+
- But execute "Store" to first save the adding in progress and quit the "Edit" mode, and only then, we can test in "operational" the functioning of the new link.
114118

115119
{{fbdoc item="section" value="Tables"}}
116120
The ""{{table}}"" action is recognized by the document generators, using the following format.

doc/manual/cache/GlossaryIndex.wakka

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,8 @@ Brief definitions and explanations for words and phrases used in the ""FreeBASIC
434434

435435
**static variable/object/array**
436436
A variable, object or array with **static storage**.
437+
**Note:** Some times, we talk about 'static array/string' (as opposed to 'dynamic array/string'), but here, the 'static' term applies on the size of the array/string (fixed length as opposed to 'dynamic' term for a variable length) .
438+
Thus this 'static/dynamic' term does not apply on the storage type for data.
437439

438440
**sub**
439441
A procedure defined using ##[[KeyPgSub|Sub]]##, optionally taking parameters and not returning a value.

doc/manual/cache/KeyPgAbstract.wakka

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ end sub
8080
- ##[[KeyPgVirtual|Virtual]]##
8181
- ##[[KeyPgType|Type]]##
8282
- ##[[KeyPgExtends|Extends]]##
83+
- ##[[KeyPgExtendsZstring|Extends Zstring]]##
84+
- ##[[KeyPgExtendsWstring|Extends Wstring]]##
8385
- ##[[KeyPgObject|Object]]##
8486
- ##[[KeyPgOverride|Override]]##
8587

doc/manual/cache/KeyPgAllocate.wakka

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Allocates a block of memory from the free store
1818
Attempts to allocate, or reserve, ##//count//## number of bytes from the free store (heap). The newly allocated memory is not initialized.
1919

2020
As the initial value of newly allocated memory is unspecified, **Allocate** must not be directly used with ##[[KeyPgString|String]]## or ##[[KeyPgType|UDT]]## containing string, because the string descriptor being not cleared (containing random data), that may induce corrupted string or more (trying to write to a random place in memory or trying to deallocate a random pointer). It is mandatory in that case (with string or UDT containing string) to use ##[[KeyPgCallocate|Callocate]]## (clearing memory), or ##[[KeyPgOpNew|New Expression]]## (calling constructor) in case of **UDT**, or at worst after **Allocate** to explicitly clear the descriptor (setting to 0) before the first string use.
21+
For allocating memory for a ##[[KeyPgZstring|Zstring]]## or a ##[[KeyPgWstring|Wstring]]##, see the corresponding page.
2122

2223
The pointer that is returned is an [[KeyPgAny|any]] [[KeyPgPtr|ptr]] and points to the start of the allocated memory. This pointer is guaranteed to be unique, even if ##//count//## is zero.
2324

0 commit comments

Comments
 (0)