Wiki improvements

Forum for discussion about the documentation project.
Post Reply
badidea
Posts: 2636
Joined: May 24, 2007 22:10
Location: The Netherlands

Re: Wiki improvements

Post by badidea »

@fxm:
Is this statement on https://www.freebasic.net/wiki/TutIntroArrays correct?
"Static arrays, the arrays described above, are kept on the heap, but dynamic arrays are allocated from the computer's pool of memory. The compiler dynamically allocates memory for the array based on the requested dimensions of the array."

I thought incorrect, but I may have misunderstood the 'heap'.
fxm
Moderator
Posts: 12577
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Post by fxm »

In the context of this sentence, I think that 'static arrays' means 'fixed-length arrays' and therefore that this beginning of the sentence is wrong.
I simply propose to delete the beginning of the sentence:
Dynamic arrays are allocated from the computer's pool of memory. The compiler dynamically allocates memory for the array based on the requested dimensions of the array.
or correct it:
Static (fixed-length) arrays, the arrays described above, are kept either in static storage or on the program stack, but dynamic arrays are allocated from the computer's pool of memory. The compiler dynamically allocates memory for the array based on the requested dimensions of the array.
Last edited by fxm on Jan 24, 2025 6:08, edited 1 time in total.
Reason: Complemented post.
badidea
Posts: 2636
Joined: May 24, 2007 22:10
Location: The Netherlands

Re: Wiki improvements

Post by badidea »

The first (with less information) seems better to me.
In both suggestions the reference to heap is gone, but in the second 'static storage or program stack' is now mentioned which is confusing if we don't explain the difference between these 2 concepts.
Maybe add a link to https://www.freebasic.net/wiki/ProPgDynamicMemory where this is better explained?
fxm
Moderator
Posts: 12577
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Post by fxm »

Retained sentence:
Dynamic arrays are allocated from the computer's pool of memory called heap. The compiler dynamically allocates memory for the array based on the requested dimensions of the array.

Documentation updated:
TutIntroArrays → fxm [rewording]
Quin
Posts: 13
Joined: Feb 14, 2025 22:11
Location: Colorado, United States
Contact:

Re: Wiki improvements

Post by Quin »

Hello,
I'm a completely blind FreeBASIC programmer, and I prefer reading the documentation in the compiled CHM format. However, when I do this, there are no spaces between keywords, so something like Dim Test As String is read as DimTestAsString by my screen reader, and when I go character-by-character there are no spaces like there would be in the compiled code. Is it possible for this to be fixed?
You can notice this behavior yourself by selecting the text with shift+arrow keys and copying it into notepad.
Thanks!
fxm
Moderator
Posts: 12577
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Post by fxm »

Maybe a problem with just Linux?
RetardedAndProud
Posts: 35
Joined: Jun 09, 2024 18:26

Re: Wiki improvements

Post by RetardedAndProud »

Quin wrote: Mar 12, 2025 22:04 Hello,
I'm a completely blind FreeBASIC programmer, and I prefer reading the documentation in the compiled CHM format. However, when I do this, there are no spaces between keywords, so something like Dim Test As String is read as DimTestAsString by my screen reader, and when I go character-by-character there are no spaces like there would be in the compiled code. Is it possible for this to be fixed?
You can notice this behavior yourself by selecting the text with shift+arrow keys and copying it into notepad.
Thanks!
Maybe you could provide more information in your post.
OS?
Version?
Architecture?
How you are currently viewing it i.e. OS built-in or third party software?
and maybe a reference to the page you are referring to.
fxm wrote: Mar 13, 2025 9:44 Maybe a problem with just Linux?
Using Debian 11 (Bullseye):
I can view the CHM manual perfectly using either xChm (Debian repo package) or via wine hh.exe <.chm file>
Quin
Posts: 13
Joined: Feb 14, 2025 22:11
Location: Colorado, United States
Contact:

Re: Wiki improvements

Post by Quin »

Sorry, I should've been more specific. I'm on Windows, using the free NVDA screen reader from nvaccess.org, reading the provided CHM file in Microsoft's built-in CHM viewer. I imagine it looks fine visually, my assumption is it's either some weird unicode character or some odd CSS styling inside code blocks.
Thanks!
RetardedAndProud
Posts: 35
Joined: Jun 09, 2024 18:26

Re: Wiki improvements

Post by RetardedAndProud »

Quin wrote: Mar 13, 2025 13:17 Sorry, I should've been more specific. I'm on Windows, using the free NVDA screen reader from nvaccess.org, reading the provided CHM file in Microsoft's built-in CHM viewer. I imagine it looks fine visually, my assumption is it's either some weird unicode character or some odd CSS styling inside code blocks.
Thanks!
No problem.

As I'm not a Windows user (not since XP) I'm really not able to assist further, maybe a Windows guru will be along soon?

Good luck.
Quin
Posts: 13
Joined: Feb 14, 2025 22:11
Location: Colorado, United States
Contact:

Re: Wiki improvements

Post by Quin »

Hi,
The wiki currently says:
FreeBASIC is a high-level programming language supporting procedural, object-orientated and meta-programming paradigms,
however, I think the correct wording is:
FreeBASIC is a high-level programming language supporting procedural, object-oriented and meta-programming paradigms,
:)
fxm
Moderator
Posts: 12577
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Post by fxm »

Thanks:
CompilerAbout → fxm [typo]
Quin
Posts: 13
Joined: Feb 14, 2025 22:11
Location: Colorado, United States
Contact:

Re: Wiki improvements

Post by Quin »

fxm wrote: May 04, 2025 4:33 Thanks:
CompilerAbout → fxm [typo]
Wow, that was fast. Thanks!
Quin
Posts: 13
Joined: Feb 14, 2025 22:11
Location: Colorado, United States
Contact:

Re: Wiki improvements

Post by Quin »

Found another typo, normally I compile these all into a list and wait until I have at least 3 to post, but I'm about to go away for a couple days so this should be all from me for a little while.
In the source files (.bas) section of the wiki, "named" is typoed as "names".
The main module can be explicitly names by passing -m filename on the command line...
should be
The main module can be explicitly named by passing -m filename on the command line...
Thanks!
fxm
Moderator
Posts: 12577
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Post by fxm »

Done:
ProPgSourceFiles → fxm [typo]
paul doe
Posts: 1878
Joined: Jul 25, 2017 17:22
Location: Argentina
Contact:

Re: Wiki improvements

Post by paul doe »

Any chance that a link to the Shared Libraries section of the Wiki be added to both the #inclib and the #libpath pages? I think this is super relevant information to have it buried on the 'Programmer's Guide'.

A link to it on those pages would help, as this issue (along with search paths) are some of the most asked questions here and on the Discord server. A bit more visibility won't hurt.
Post Reply