Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / fpc-pascal / 2024-10

docs

9 messages · 8 people · –

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Unknown author

Apropos the new users discussion, i think the state of the docs is really important, new users can be discouraged by lack of documentation or up-to-date docs. I just recently retired so not a new young user, but relatily new to fpc. So, I’m willing to help update the docs, correct typos, etc, if someone points me in the right direction.

Regards
Pete

Reply by email

Gordon Findlay
to Unknown author

I've been programming a long time but when I first took up with Lazarus and FPC there were three issues:

- out of date documentation.
- for many topics (for example in the LCL) there is formal documentation but not tutorial material.
- distros sometimes have quite old versions in their repos. For example my opensuse machine right now is offering Lazarus 2.2.

[ fpcupdeluxe was invisible at the time. And on a single monitor machine, trunk version 3.9.9 with its greatly improved docked interface is a blessing. ]

Addressing these issues is vital to attract new users.

I'm happy to help anyone writing updated tutorial material.

On Mon, Oct 21, 2024 at 11:52 AM ppadilcdx--- via fpc-pascal <

Show quoted text 15 lines
wrote: Apropos the new users discussion, i think the state of the docs is really important, new users can be discouraged by lack of documentation or up-to-date docs. I just recently retired so not a new young user, but relatily new to fpc. So, I’m willing to help update the docs, correct typos, etc, if someone points me in the right direction. Regards Pete _______________________________________________ fpc-pascal maillist - https://lists.freepascal.org/cgi-bin/mailman/listinfo/fpc-pascal

Reply by email

Michael Van Canneyt
to Unknown author: Apropos the new users discussion, i think the state of the docs is really important, new…
ppadilcdx--- wrote
Apropos the new users discussion, i think the state of the docs is really important, new users can be discouraged by lack of documentation or up-to-date docs. I just recently retired so not a new young user, but relatily new to fpc. So, I’m willing to help update the docs, correct typos, etc, if someone points me in the right direction.

Check out:

https://gitlab.com/freepascal.org/fpc/documentation

The manuals are written in LaTeX. Subdirectory tex.

The API reference is written in fpdoc. The xml files are in subdirectory xml.

fpdoc is documented here
https://www.freepascal.org/docs-html/current/fpdoc/fpdoc.html

Michael.

Reply by email

Christo Crause
to Gordon Findlay: I've been programming a long time but when I first took up with Lazarus and FPC there…

The official FPC documentation can be accessed from here: https://www.freepascal.org/docs.html
These are obviously reference documentation, not getting started or how-to tutorials.
The documentation is hosted here:
https://gitlab.com/freepascal.org/fpc/documentation Issues reporting mistakes/omissions and merge requests with fixes can be submitted here.

Lazarus documentation is hosted on SourceForge:
https://lazarus-ccr.sourceforge.io/docs/index.html

Tutorials for FPC and Lazarus can be added to the wiki ( https://wiki.freepascal.org/Main_Page).
Perhaps for FPC tutorials take a look at the content of Basic Pascal Tutorial (https://wiki.freepascal.org/Basic_Pascal_Tutorial) and add getting started topics there.

Lazarus tutorials are a bit more scattered, but check here to see what is existing: https://wiki.freepascal.org/Category:Tutorials

On Mon, Oct 21, 2024 at 9:05 AM Gordon Findlay via fpc-pascal <

Show quoted text 34 lines
wrote: I've been programming a long time but when I first took up with Lazarus and FPC there were three issues: - out of date documentation. - for many topics (for example in the LCL) there is formal documentation but not tutorial material. - distros sometimes have quite old versions in their repos. For example my opensuse machine right now is offering Lazarus 2.2. [ fpcupdeluxe was invisible at the time. And on a single monitor machine, trunk version 3.9.9 with its greatly improved docked interface is a blessing. ] Addressing these issues is vital to attract new users. I'm happy to help anyone writing updated tutorial material. On Mon, Oct 21, 2024 at 11:52 AM ppadilcdx--- via fpc-pascal < > wrote: > Apropos the new users discussion, i think the state of the docs is really > important, new users can be discouraged by lack of documentation or > up-to-date docs. > I just recently retired so not a new young user, but relatily new to > fpc. So, I’m willing to help update the docs, correct typos, etc, if > someone points me in the right direction. > > Regards > Pete >

Reply by email

Nikolay Nikolov
to Gordon Findlay: I've been programming a long time but when I first took up with Lazarus and FPC there…
Gordon Findlay wrote
 - distros sometimes have quite old versions in their repos. For example my opensuse machine right now is offering Lazarus 2.2.

For this, we need help from FPC and Lazarus users, who actually use the given distro. Someone needs to volunteer and become a packager for the distro, so they can maintain it and keep these packages up to date. It may also be helpful to contact the previous maintainer and ask them to update the package, or maybe file a bug report for the distro (I don't know what's appropriate for openSUSE, since I've never used this distro).

Nikolay

Reply by email

geneb
to Christo Crause: The official FPC documentation can be accessed from here:…
Christo Crause wrote 21 lines
The official FPC documentation can be accessed from here: https://www.freepascal.org/docs.html These are obviously reference documentation, not getting started or how-to tutorials. The documentation is hosted here: https://gitlab.com/freepascal.org/fpc/documentation Issues reporting mistakes/omissions and merge requests with fixes can be submitted here. Lazarus documentation is hosted on SourceForge: https://lazarus-ccr.sourceforge.io/docs/index.html Tutorials for FPC and Lazarus can be added to the wiki (https://wiki.freepascal.org/Main_Page). Perhaps for FPC tutorials take a look at the content of Basic Pascal Tutorial (https://wiki.freepascal.org/Basic_Pascal_Tutorial) and add getting started topics there. Lazarus tutorials are a bit more scattered, but check here to see what is existing: https://wiki.freepascal.org/Category:Tutorials s://lists.freepascal.org/cgi-bin/mailman/listinfo/fpc-pascal

There's also this introductory book by Jeff Duntemann: https://www.contrapositivediary.com/?p=4034

g.

Reply by email

Unknown author
to Michael Van Canneyt: Check out: https://gitlab.com/freepascal.org/fpc/documentation The manuals are written in…

Thanks!

Show quoted text 23 lines
On Oct 21, 2024, at 1:35 AM, Michael Van Canneyt via fpc-pascal wrote: On Sun, 20 Oct 2024, ppadilcdx--- via fpc-pascal wrote: > Apropos the new users discussion, i think the state of the docs is really important, new users can be discouraged by lack of documentation or up-to-date docs. > I just recently retired so not a new young user, but relatily new to fpc. So, I’m willing to help update the docs, correct typos, etc, if someone points me in the right direction. Check out: https://gitlab.com/freepascal.org/fpc/documentation The manuals are written in LaTeX. Subdirectory tex. The API reference is written in fpdoc. The xml files are in subdirectory xml. fpdoc is documented here https://www.freepascal.org/docs-html/current/fpdoc/fpdoc.html Michael._______________________________________________ fpc-pascal maillist - https://lists.freepascal.org/cgi-bin/mailman/listinfo/fpc-pascal

Reply by email