Wiki improvements

Forum for discussion about the documentation project.
Imortis
Moderator
Posts: 1729
Joined: Jun 02, 2005 15:10
Location: USA
Contact:

Re: Wiki improvements

Postby Imortis » Jul 11, 2020 16:03

fxm wrote:
fxm wrote:I wrote a beginning of the page 'Programmer's Guide / Making Binaries / Executables'.
A volunteer to improve / complete ?
Imortis wrote:I can take a look at the Executables page. I am not sure when I will get to it, but I am pretty sure I can fill out the needed info.

Maybe a little free time during the summer?

I work for the government. I don't really get free time... I will try to put what I have toward this though. Sorry I have not gotten to it sooner.
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 11, 2020 18:30

Added paragraphs in some pages of the Programmer's Guide:
- ProPgErrorHandling → fxm [added paragraph ('On [Local] Error Goto' statement use)]
- ProPgStringsTypes → fxm [added paragraph (Implicit conversion from Zstring to Ubyte)]
- ProPgCtorsAssignDtors → fxm [added paragraph (Processing variable-length arrays as members of Type)]
- ProPgDynamicMemory → fxm [added very tiny paragraph about Imagecreate / Imagedestroy]
- ProPgOperatorOverloading → fxm [added paragraph (Special Cases of Operators: '.' (Member access), '@' (Address of), '->' (Pointer to member access), and '*' (Value of))]
- ProPgArrays → fxm [added paragraph (Detailed use of LBound and UBound)]
Last edited by fxm on Jul 12, 2020 8:18, edited 1 time in total.
Reason: A 6th paragraph has been added.
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 12, 2020 16:07

If someone else could fill in (even in free text without formatting) the last remaining blank page "Graphics / External Graphics File Formats", it would be nice to finally have a complete Programmer's Guide.
(this subject is outside of my skills)

coderJeff's advice to fill in this page:
coderJeff wrote:For external graphics file formats topic: what is supported by BLOAD & BSAVE. To be cross platform, the QB/BMP formats that can be loaded/saved are hard coded in the rtlib. So, this is will be a description of what is specifically supported by the rtlib.
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 13, 2020 5:23

Maybe counting_pine (for "Graphics / External Graphics File Formats") ?
Help would be welcome to fill in this Programmer's Guide page.
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 17, 2020 14:51

Programmer's Guide
versus
Index page of tutorial / teaching / pedagogical topics (draft articles for documentation)

I think I have finished integrating into this guide all the suitable parts (in my opinion) of these draft articles of the documentation forum, which roughly corresponds to 80% of the total of the articles.

Would it be interesting that I detail here the remaining 20% not integrated in the guide (articles or parts of articles) so that users can give their opinion on the interest of also adding such or such other part in the guide (or elsewhere) ?
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 18, 2020 6:01

fxm wrote:Would it be interesting that I detail here the remaining 20% not integrated in the guide (articles or parts of articles) so that users can give their opinion on the interest of also adding such or such other part in the guide (or elsewhere) ?

Nevertheless here are two lists anyway.
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 25, 2020 17:50

I intend to add in the Programmer's Guide:
  1. A new short paragraph 'Declaration with initializer' (with or without ellipsis) into the existing 'Programmer's Guide / Variables and Datatypes / Arrays / Fixed-length Arrays' page.
  2. A new paragraph 'Variadic macros' into the existing 'Programmer's Guide / Preprocessor / Macros' page.
  3. A new page 'Variadic arguments' in the 'Programmer's Guide / Procedures' section, instead of the 'Programmer's Guide / Procedures / Variable Arguments' page which links only to the simple list (catalog) of the dedicated keywords.
What do you think about this?


[Edit]
Addition of a first small task to do.
srvaldez
Posts: 2511
Joined: Sep 25, 2005 21:54

Re: Wiki improvements

Postby srvaldez » Jul 26, 2020 3:02

Hi fxm
I am all for it :-)
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 26, 2020 8:39

fxm wrote:I intend to add in the Programmer's Guide:
    a. A new short paragraph 'Declaration with initializer' (with or waithout ellipsis) into the existing 'Programmer's Guide / Variables and Datatypes / Arrays / Fixed-length Arrays' page.

Done:
ProPgFixLenArrays → fxm [added paragraph 'Declaration with initializer']
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 26, 2020 16:01

fxm wrote:I intend to add in the Programmer's Guide:
    b. A new paragraph 'Variadic macros' into the existing 'Programmer's Guide / Preprocessor / Macros' page.

Done:
ProPgMacros → fxm [added paragraph 'Variadic macro']
badidea
Posts: 2148
Joined: May 24, 2007 22:10
Location: The Netherlands

Re: Wiki improvements

Postby badidea » Jul 26, 2020 22:45

fxm wrote:Done: ProPgFixLenArrays → fxm [added paragraph 'Declaration with initializer']

Counting is not easy :-)
Dim c(5 To 10) As Integer '' 1-dimensional, 5 elements (5, 6, 7, 8, 9 and 10)
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 27, 2020 5:14

Thanks from my predecessor (LaananFisher) on this page!
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 28, 2020 15:59

fxm wrote:I intend to add in the Programmer's Guide:
    c. A new page 'Variadic arguments' in the 'Programmer's Guide / Procedures' section, instead of the 'Programmer's Guide / Procedures / Variable Arguments' page which links only to the simple list (catalog) of the dedicated keywords.

Done:
ProPgVariadicArguments → fxm [new page created]
fxm
Posts: 9927
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Jul 31, 2020 14:03

I can no longer login to fb.wiki. No error message but the login request has no effect.
counting_pine
Site Admin
Posts: 6225
Joined: Jul 05, 2005 17:32
Location: Manchester, Lancs

Re: Wiki improvements

Postby counting_pine » Jul 31, 2020 15:05

Sorry, I was trying something with the .htaccess. Logins should work again now.

Return to “Documentation”

Who is online

Users browsing this forum: No registered users and 1 guest