Forum > Beginners

My contribution to the community for beginners

(1/5) > >>

kveroneau:
Now that I have been using FreePascal for a bit, I am now starting to jot down lots of useful notes, and believe these notes could be very useful to someone who is starting out with FreePascal.  When I first started learning FreePascal, documentation was at times difficult to find for some very specific units, and I had to read the source files of those units to better understand what was going on and how to use those units.  While the Wiki is great, it can be at times difficult to locate exactly what you are looking for, and at times there are multiple pages about a similar topic, but with different solutions.  While I am very thankful that there is more than one way to do something in FreePascal, it does lead to some confusion when picking the right solution.

I now present you with what I am calling kDocs for ObjectPascal.  http://tech406.com/kdocs/

What's more, is that this website is built entirely in XML!  If you do not believe me, right-click and view source.  I choose of doing it this way, as it makes copying and pasting examples and documentation super easy, also adding new documentation is very easy as all it is, is a static website.  Anyways...

I choose not to write new Wiki pages, as firstly I was originally writing this as a personal set of documentation which I can have locally and easily reference.  However, I felt that sharing it with the community will be beneficial to all in the end, no need to hoard documentation.

With that said, it is in the very early stages, but does include some interesting topics, such as the project and module templates available in Lazarus, along with full source of what each template looks like, so you can easily review each template before choosing it in the IDE.  The IDE should have a project review button so we can preview the source code templates before committing to using it.  Other interesting topics for newcomers are basic Networking using just fcl-net and fcl-web, along with examples for a TCP client/server, and how to use the fphttpclient class in it's simplest form to get you started.  There's also a short document on Encryption and uses Blowfish as an example along with how to set-up a TStream to use it correctly.  Then there's the ever so popular documentation on Threads.  With a fully working command-line program example, as simple examples are the best way to educate.  Future examples will include how to enable a TCP server to use a thread for each incoming connection.

This is an ongoing effort I am putting together mainly for keeping personal notes, so these documents will expand as I keep thinking of new and interesting things I'd love to try out with ObjectPascal.  This is by no means meant as a tutorial, but more so for general notes on some more complicated functionality in ObjectPascal which can otherwise be difficult to grasp at first without a simple example to guide you.  Enjoy!

Oh, and the landing page has a nice introduction to me, and why I personally chose to go with ObjectPascal.  Might be useful to show others why ObjectPascal is a good choice.

Handoko:
Thank you for sharing your knowledge.

I've just checked the website. Great, it has networking tutorials, which is the topic I currently want to learn. I bookmarked it and hope to see more various topics  in kDocs in the future.

GAN:
Nice and clean site.
Thank you.

PascalDragon:

--- Quote from: kveroneau on June 04, 2019, 03:50:40 am ---Now that I have been using FreePascal for a bit, I am now starting to jot down lots of useful notes, and believe these notes could be very useful to someone who is starting out with FreePascal.  When I first started learning FreePascal, documentation was at times difficult to find for some very specific units, and I had to read the source files of those units to better understand what was going on and how to use those units.  While the Wiki is great, it can be at times difficult to locate exactly what you are looking for, and at times there are multiple pages about a similar topic, but with different solutions.  While I am very thankful that there is more than one way to do something in FreePascal, it does lead to some confusion when picking the right solution.
--- End quote ---
Just for the sake of correctness: It's Free Pascal, not FreePascal. ;) (same for ObjectPascal by the way)

HuntingKashket:
Good job!
My advice is to add ability to contribute to it, or maybe to export its content to the freepascal wiki, which will be a useful update for.
Also, i think description for the examples is a good practice, which will be a cherry on this cake :)

P.s Lazarus needs to introduce wiki for some platform-specific differences between GUI routines

Navigation

[0] Message Index

[#] Next page

Go to full version