I think at the moment you use many [l i s t][/l i s t] tags in your post looks good :-)fxm wrote:What do you think?
Wiki improvements
-
- Posts: 8586
- Joined: May 28, 2005 3:28
- Contact:
Re: Wiki improvements
Re: Wiki improvements
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)
(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)
Re: Wiki improvements
I could also add 2 more pages: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"
- "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
- Overview
Pointer Arithmetic
- From Pointers to References
Using References
- Overview
.....
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
..... - Constants and Enumerations
But here, a lot of work of synthesis and writing!
Re: Wiki improvements
LOL, yes, I shamelessly have not volunteered. I appreciate your initiative.fxm wrote:But here, a lot of work of synthesis and writing!
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.
Re: Wiki improvements
I anticipated the article formatting for the 2 Programmer's Guide pages.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.
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"]
Re: Wiki improvements
@Jeff,
Can you fully delete the empty page "ProPgCompoAgregInherit", because replaced by the page "ProPgCompoAggregInherit".
Thank you in advance.
Can you fully delete the empty page "ProPgCompoAgregInherit", because replaced by the page "ProPgCompoAggregInherit".
Thank you in advance.
Re: Wiki improvements
No problem, done.
Re: Wiki improvements
'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]
- 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]
Re: Wiki improvements
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?
Maybe in the "Other Topics" section, after "Internal Graphics Formats" page?
Re: Wiki improvements
Perhaps, you could create a new sub-section called "Graphics"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?
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.
Re: Wiki improvements
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]
'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]
Re: Wiki improvements
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.
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.
Re: Wiki improvements
'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):
- 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)
.....
Re: Wiki improvements
Even so, I just started this longer and more difficult task: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!
I think the different sub-sections are in an increasing order of difficulty for the user and myself!Programmer's Guide
.....
.....
Multi-Threading.....
- Overview
Threads
Mutual Exclusion
Conditional Variables
Critical Sections
.....
But I intend to go to the end of this challenge.
Re: Wiki improvements
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.
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.