Wiki improvements

Forum for discussion about the documentation project.
D.J.Peters
Posts: 7824
Joined: May 28, 2005 3:28

Re: Wiki improvements

Postby D.J.Peters » Aug 31, 2019 0:20

fxm wrote:What do you think?
I think at the moment you use many [l i s t][/l i s t] tags in your post looks good :-)
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Aug 31, 2019 5:19

But I think my question was more about substance than about form :-(

(I think the substance is more important than the form, but a good form can encourage more readers to discover the substance and vice versa)
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Aug 31, 2019 11:47

fxm wrote:Starting from the content of my article on references, I propose to add two pages:
- "From Pointers to References"
- and "Using References"
- in a new section "References"
of the "Programmer's Guide / Variables and Datatypes"

I could also add 2 more pages:
- "Composition, Aggregation, Inheritance"
- and "Inheritance Polymorphism"
in the "Programmer's Guide / User Defined Types", as follows:
    Programmer's Guide

    .....
    .....

    Variables and Datatypes
      Constants and Enumerations
      Numeric Types
      Strings (string, zstring, and wstring)
      Coercion and Conversion
      Constants
      Variables

      Arrays
        Overview
        Fixed-length Arrays
        Variable-length Arrays
        Array Indexing
        Passing Arrays to Procedures
      Pointers
        Overview
        Pointer Arithmetic
      References
        From Pointers to References
        Using References
    .....
    .....

    User Defined Types
      Overview
      Type Aliases
      Temporary Types
      Constructors and Destructors
      Member Procedures
      Properties
      Member Access Rights
      Operator Overloading
      Iterators
      New and Delete
      Types as Objects
      Composition, Aggregation, Inheritance
      Inheritance Polymorphism

    .....
    .....

It is missing too, but a complete section on the Multi-Threading (with several pages, for example: "Overview", "Threads", "Mutual Exclusion", "Conditional Variables", "Critical Sections", ...) .
But here, a lot of work of synthesis and writing!
coderJeff
Site Admin
Posts: 3065
Joined: Nov 04, 2005 14:23
Location: Ontario, Canada
Contact:

Re: Wiki improvements

Postby coderJeff » Aug 31, 2019 13:31

fxm wrote:But here, a lot of work of synthesis and writing!


LOL, yes, I shamelessly have not volunteered. I appreciate your initiative.

I always thought your articles in this forum would make great additions to the programmers guide. I read through your article on references again just now, and other than the formatting work needed to adapt to wiki, it looks like it would fit in very well. I did not read again your other articles yet, but I suspect the same, that they will also fit in with the programmer's guide, well.

fxm, thank you very much your tireless efforts on the documentation.
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Aug 31, 2019 14:19

coderJeff wrote:I read through your article on references again just now, and other than the formatting work needed to adapt to wiki, it looks like it would fit in very well.

I anticipated the article formatting for the 2 Programmer's Guide pages.
See here the result:
- ProPgFromPtrToRef → fxm [new page created]
- ProPgReferences → fxm [new page created]
- CatPgProgrammer → fxm [added links to the 2 new pages: "From Pointers to References" and "Using References"]
- PrintToc → fxm [added links to the 2 new pages: "From Pointers to References" and "Using References"]
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Aug 31, 2019 22:00

@Jeff,

Can you fully delete the empty page "ProPgCompoAgregInherit", because replaced by the page "ProPgCompoAggregInherit".

Thank you in advance.
coderJeff
Site Admin
Posts: 3065
Joined: Nov 04, 2005 14:23
Location: Ontario, Canada
Contact:

Re: Wiki improvements

Postby coderJeff » Aug 31, 2019 23:19

fxm wrote:@Jeff,

Can you fully delete the empty page "ProPgCompoAgregInherit".


No problem, done.
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 01, 2019 12:03

'Composition, Aggregation, Inheritance' and 'Inheritance Polymorphism' pages filled in the Programmer's Guide / User Defined Types:
- CatPgProgrammer → fxm [predisposed links to "Composition, Aggregation, Inheritance" and "Inheritance Polymorphism" pages]
- PrintToc → fxm [predisposed links to "Composition, Aggregation, Inheritance" and "Inheritance Polymorphism" pages]
- ProPgCompoAggregInherit → fxm [new page created]
- ProPgPolymorphism → fxm [new page created]
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 01, 2019 12:47

About my article about implementing an anti-flickering process when refreshing a graphics window (viewtopic.php?f=9&t=26692), I think it deserves a page in the Programmer's Guide, but I do not know where.

Maybe in the "Other Topics" section, after "Internal Graphics Formats" page?
coderJeff
Site Admin
Posts: 3065
Joined: Nov 04, 2005 14:23
Location: Ontario, Canada
Contact:

Re: Wiki improvements

Postby coderJeff » Sep 01, 2019 12:56

fxm wrote:About my article about implementing an anti-flickering process when refreshing a graphics window (viewtopic.php?f=9&t=26692), I think it deserves a page in the Programmer's Guide, but I do not know where.

Maybe in the "Other Topics" section, after "Internal Graphics Formats" page?


Perhaps, you could create a new sub-section called "Graphics"

Graphics
- FreeBASIC GfxLib overview
- Graphics Mode Refresh and Anti-Flickering
- Internal Graphics Formats
- External Graphics Formats

... or whatever titles you choose. Anything in "Other Topics" section should be moved to a better named section if it exists, in my opinion.
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 01, 2019 13:59

OK for me.

'Graphics Mode Refresh and Anti-Flickering' page filled in the Programmer's Guide / Graphics:
- CatPgProgrammer → fxm [predisposed link to "Graphics Mode Refresh and Anti-Flickering" page]
- PrintToc → fxm [predisposed links to "Graphics Mode Refresh and Anti-Flickering" page]
- ProPgAntiFlickering → fxm [new page created]
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 02, 2019 11:09

I think the page 'Constructors and Destructor' (for UDT) a little (too much) "light" (for a Programmer's Guide)!

I propose to keep it as it is, by just renaming it 'Constructors and Destructors (basics)', and complete that with a new page 'Constructors, Assignment-Operators, and Destructors (advanced)' which would be synthesized from my two articles (9 and 15) on this subject.
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 04, 2019 7:17

'Constructors, Assignment-Operators, and Destructors (advanced, part #1 & #2)' pages filled in the Programmer's Guide / User Defined Types:
- CatPgProgrammer → fxm [predisposed links to "Constructors, Assignment-Operators, and Destructors (advanced, part #1 & #2)]
- PrintToc → fxm [predisposed links to "Constructors, Assignment-Operators, and Destructors (advanced, part #1 & #2)]
- ProPgCtorsAssignDtors → fxm [new page created]
- ProPgCtorsAssignDtors2 → fxm [new page created]

Contents of the Programmer's Guide (at this time):
Programmer's Guide

.....
.....

User Defined Types
    Overview
    Type Aliases
    Temporary Types
    Constructors and Destructors (basics)
    Member Procedures
    Properties
    Member Access Rights
    Operator Overloading
    Iterators
    New and Delete
    Types as Objects
    Composition, Aggregation, Inheritance
    Inheritance Polymorphism
    Constructors, Assignment-Operators, and Destructors (advanced, part #1)
    Constructors, Assignment-Operators, and Destructors (advanced, part #2)

.....
.....
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 07, 2019 15:19

fxm wrote:It is missing too, but a complete section on the Multi-Threading (with several pages, for example: "Overview", "Threads", "Mutual Exclusion", "Conditional Variables", "Critical Sections", ...) .
But here, a lot of work of synthesis and writing!

Even so, I just started this longer and more difficult task:
Programmer's Guide

.....
.....

Multi-Threading
    Overview
    Threads
    Mutual Exclusion
    Conditional Variables
    Critical Sections
.....
.....


I think the different sub-sections are in an increasing order of difficulty for the user and myself!
But I intend to go to the end of this challenge.
fxm
Posts: 9178
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 10, 2019 15:13

This is progressing well in my opinion (started since September 2, 2019).
Go see it if the above subject interests you !

For the only remaining page "Critical Sections", I already have "material" thanks to my article on the subject.

Return to “Documentation”

Who is online

Users browsing this forum: No registered users and 17 guests