PureBasic Docs - Errors & needed improvements to the man

[Comtois]

Sorry if this error is already mentioned, but for DatabaseUpdate() in chm help file (databaseupdate.html) , the example doesn't mention 2 param, only one (the db handler is ommitted).

DatabaseUpdate("UPDATE employee SET checked=1 WHERE id="+GetDatabaseString(#Database, 0))

That would be corrected as :

DatabaseUpdate(#database,"UPDATE employee SET checked=1 WHERE id="+GetDatabaseString(#Database, 0))

In the french .chm help file,
- AddCipherBuffer(), StartAESCipher(), GetXMLStandalone(), FinishDatabaseQuery(), AESEncoder(), FinishCipher() and AESDecoder() description are in english.
- Same thing for "Compilation d'un programme" (ide_compiler.html), from "Enable Debugger" paragraph to "constantes" paragraph.
- Same thing for "Compilation d'un programme" (ide_compiler.html), for "Constantes personnalisées" paragraph.
- In "les outils externes" (PureBasic.chm::/Reference/ide_externaltools.html), the "Enable Tool on a per-source basis" paragraph is in english.
- In "Utiliser le debugger" page (PureBasic.chm::/Reference/ide_debugger.html), the following sentence is in english : "The code view also provides the mouse-over feature from the integrated debugger to quickly view the content of a variable.".
- One paragraph for AddMailAttachment() is in english.

These small errors are still present in 4.51.

The French community can help in the translation here

[Trond]

The page of GetFunction() refers to CallFunctionFast() and CallCFunctionFast(). It would be better if it referred to the prototypes.

[zxtunes.com]

Function AddMailAttachment() have desicriptions of mime types.
Some desicriptions written on in French:

Code: Select all

application/sla           | st�r�olithographie   stl
application/step          | de donn�es STEP  step
application/iges          | Format d'�change CAO IGES   igs,iges

ETC

[Demivec]

As part of the cipher library the function AESEncoder() and AESDecoder() are documented as:

Result$ = AESEncoder(*Input, *Output, Size, *Key, Bits, *InitializationVector [, Mode])

Result$ = AESDecoder(*Input, *Output, Size, *Key, Bits, *InitializationVector [, Mode])

The return type is incorrectly shown as being a string but it is actually the length in bytes of the string placed in the output buffer. The documentation for each of the two functions does not specify anything about what this return value actually contains or how to interpret it.

Also the return value for AESEncoder() equals zero if the input string was unable to be encoded (due to its length being less than 16 bytes).


For discussion related to this see this thread http://www.purebasic.fr/english/viewtop ... =4&t=43762

[Foz]

Pressing F1 on InputEvent3D() brings up the help with a "This program cannot display the webpage" message.

[Trond]

Linux 4.51:
On the page for FrontColor() there is a link to the color table, but nothing happen when you click it.

[Demivec]

Constants

All constants are preceded by #. They can only be declared once in the source and always keep their predefined values. (The compiler replaces all constant names with their corresponding values when compiling the executable.)

It is possible to declare constants more than once if they are declared with the same value each time.


Under this topic

Expressions

An expression is something which can be evaluated. An expression can mix any variables, constants, or functions, of the same type. When you use numbers in an expression, you can add the Keyword $ sign in front of it to mean a hexadecimal number, or a Keyword % sign sign to mean a binary number. Without either of those, the number will be treated as decimal. Strings must be enclosed by inverted commas.

Please add a remark regarding the evaluation of strings in conditional expressions:

Code: Select all

If the result of a conditional expression is a non-empty string it will evaluate as True.
a$ = "Test"
If a$
  Debug "not empty"
Else
  Debug "empty"
EndIf

If Mid(a$, 2, 1)
  Debug "not empty"
Else
  Debug "empty"
EndIf

This remark might be better place under the topic of If:Else:EndIf

[skywalk]

Please add this to the Help Section - Customizing the IDE
If you press Tab or Enter twice, it will insert the corresponding end keyword (for example "EndSelect" to "Select" or "EndIf " to "If") to the keyword you have just inserted. The end keyword will be inserted after the cursor, so you can continue typing after the first keyword that was inserted. "If" requires File - Preferences... - AutoComplete - Characters needed before opening the list = 2"

With the setting = 3 and typing "If", the style would immediately change to if, but the closing "EndIf" is not triggered with double [Enter]'s.

[nco2k]

minus on 4 and 8?

Code: Select all

  Priority Level |     Operators
  ---------------+---------------------
       8 (high)  |      ~, - <--- ?
       7         |    <<, >>, %, !
       6         |       |, &
       5         |       *, /
       4         |       +, - <--- ?
       3         | >, >=, <, <=, =, <>
       2         |       Not
       1 (low)   |  And, Or, XOr

c ya,
nco2k

[Demivec]

minus on 4 and 8?

4 is for subtraction operator, 8 is for unary sign operator

[skywalk]

http://www.purebasic.com/documentation/ ... state.html

Changes the specified MenuItem state. This functions allows you to display a 'check mark' next to the menu item text. The check is displayed when State equals 1, if State equals something else then the 'check mark' will not be displayed.

Actually, the SetMenuItemState() is set to checked(ON) with any non-zero entry, -1,+1,99,etc.

[Rings]

Texture : Loadtexture() can even
load *.DDS files,
a feature of ogre3d

[buddymatkona]

I just noticed that structure related Compiler Functions have been left out of my PB 4.51, Win64, Help Index. InitializeStructure, CopyStructure, and ClearStructure should be added to the Index.

[nco2k]

http://www.purebasic.com/documentation/ ... depth.html

Code: Select all

PB_Image_InternalDepth -> #PB_Image_InternalDepth
PB_Image_OriginalDepth -> #PB_Image_OriginalDepth

c ya,
nco2k

[MachineCode]

CreateImage() is no longer restricted to 8192x8192, but is now 32000x32000.