Recent

Author Topic: Lazarus documentation preview has been updated  (Read 11582 times)

dsiders

  • Hero Member
  • *****
  • Posts: 1151
Re: Lazarus documentation preview has been updated
« Reply #15 on: February 27, 2023, 10:38:50 pm »
Is it possible to have a link in the footer (or header) to come back to the mainpage (https://dsiders.gitlab.io/lazdocsnext/ here) to change the doc area (eg. LCL to RTL) ?

Andreas:

I regenerated the HTML for LCL and LazUtils using your suggestion. At the moment, only those packages have the link in the footer area. The others (DateTimeCtrls and LazControls) will have to wait until this weekend.

I do not (cannot) generate the output for RTL and FCL -  they are a mirror of the existing output. So they will not receive the Link to the landing page.

Hope this helps.

---
Don

Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

af0815

  • Hero Member
  • *****
  • Posts: 1318
Re: Lazarus documentation preview has been updated
« Reply #16 on: February 28, 2023, 06:26:47 am »
THX, in the new generated HTML it works perefect.

Now you can go back to the root and change back to the landing page. It is easier, if you search anything in the docs and get lost. If this happens you can restart for a new try.

Perfect, and thank you for the fast insert of this feature.
   
regards
Andreas

dsiders

  • Hero Member
  • *****
  • Posts: 1151
Re: Lazarus documentation preview has been updated
« Reply #17 on: February 28, 2023, 07:59:58 am »
THX, in the new generated HTML it works perefect.

Now you can go back to the root and change back to the landing page. It is easier, if you search anything in the docs and get lost. If this happens you can restart for a new try.

Perfect, and thank you for the fast insert of this feature.

You're welcome. Please feel free to offer feedback or submit bug reports on the gitlab issue tracker. Patches for the content are always welcome too.
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

af0815

  • Hero Member
  • *****
  • Posts: 1318
Re: Lazarus documentation preview has been updated
« Reply #18 on: February 28, 2023, 08:43:23 am »
There are more 'interesting features' in the documentation, like not working samples. You have to copy some code from the documentation tree on gitlab to get the sample working. Diskussion here https://forum.lazarus.freepascal.org/index.php/topic,62017.msg468472.html#msg468472

But i got a comment from PascalDragon
Quote
The samples contained in the documentation are not necessarily meant to be completely usable or even compileable. They simply illustrate the principles of what is documented.
So its by design, but i say, better no example instead of a useless defect exsample, because this sample are more confusing for the user. The real interesting parts not in the sample and the shown code is more or less useless (for me). I got the sample working and found the interesting parts is in the missing code. It is a political decision, to create not working samples, ok i can live with this. But, so i am not willing to spend my time for this.
regards
Andreas

dsiders

  • Hero Member
  • *****
  • Posts: 1151
Re: Lazarus documentation preview has been updated
« Reply #19 on: February 28, 2023, 10:35:49 am »
There are more 'interesting features' in the documentation, like not working samples. You have to copy some code from the documentation tree on gitlab to get the sample working. Diskussion here https://forum.lazarus.freepascal.org/index.php/topic,62017.msg468472.html#msg468472

But i got a comment from PascalDragon
Quote
The samples contained in the documentation are not necessarily meant to be completely usable or even compileable. They simply illustrate the principles of what is documented.
So its by design, but i say, better no example instead of a useless defect exsample, because this sample are more confusing for the user. The real interesting parts not in the sample and the shown code is more or less useless (for me). I got the sample working and found the interesting parts is in the missing code. It is a political decision, to create not working samples, ok i can live with this. But, so i am not willing to spend my time for this.

That specific discussion is about FPC docs. Sorry I can't help you with that. But maintaining sample code (when it changes) is always a chore.
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

dbannon

  • Hero Member
  • *****
  • Posts: 2861
    • tomboy-ng, a rewrite of the classic Tomboy
Re: Lazarus documentation preview has been updated
« Reply #20 on: February 28, 2023, 11:22:46 am »
I tried to regenerate FPC/fixes + lazarus trunks docs at

https://www.stack.nl/~marcov/doc-chmbeta.zip

They might be a bit rough, it has been a while since I last tried, but a quick check seems to indicate that inter chm links work.

Yep, seems to work for me, thanks marcov.

Davo
Lazarus 3, Linux (and reluctantly Win10/11, OSX Monterey)
My Project - https://github.com/tomboy-notes/tomboy-ng and my github - https://github.com/davidbannon

af0815

  • Hero Member
  • *****
  • Posts: 1318
Re: Lazarus documentation preview has been updated
« Reply #21 on: February 28, 2023, 11:57:18 am »
That specific discussion is about FPC docs. Sorry I can't help you with that. But maintaining sample code (when it changes) is always a chore.
This was not the problem, the sample itself was definitly designed not to run if you copy it out of the documentation. This my point, such a sample should be avoided, because it make more chaos. (There will be a link to a running sample the better choice) 

I have said to my friend -> RTFM -> and he answered, this is shit, because the sample is not running. I have spend a lot of time to find the answer and i think now, my friend is right.
regards
Andreas

dsiders

  • Hero Member
  • *****
  • Posts: 1151
Re: Lazarus documentation preview has been updated
« Reply #22 on: February 28, 2023, 05:57:54 pm »
That specific discussion is about FPC docs. Sorry I can't help you with that. But maintaining sample code (when it changes) is always a chore.
This was not the problem, the sample itself was definitly designed not to run if you copy it out of the documentation. This my point, such a sample should be avoided, because it make more chaos. (There will be a link to a running sample the better choice) 

I have said to my friend -> RTFM -> and he answered, this is shit, because the sample is not running. I have spend a lot of time to find the answer and i think now, my friend is right.

Well this soured quickly. I see your point. I agree with your point. Hammering me about it will not get it resolved. I don't maintain FPC docs. Sorry.
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

dsiders

  • Hero Member
  • *****
  • Posts: 1151
Re: Lazarus documentation preview has been updated
« Reply #23 on: March 05, 2023, 07:46:49 am »
Another update has been posted to the documentation preview at https://dsiders.gitlab.io/lazdocsnext/. It updates the content for all of the Lazarus packages to version 2.3.0-57c8af94ae (2023-03-04). In addition, there are two new packages included in the release: RTTIControls and FreeType. Their initial release has skeletons for all of the topics in both packages. They do not, however, have complete coverage. This situation will improve over time.

RTL and FCL documentation are a mirror of the content at https://www.freepascal.org/docs-html/current/.

Please feel free to offer suggestions or comments about the content in the update. Bug reports can be submitted to the Lazarus issue tracker (https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues) or the FPC Documentation issue tracker (https://gitlab.com/freepascal.org/fpc/documentation/-/issues).
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

dsiders

  • Hero Member
  • *****
  • Posts: 1151
Re: Lazarus documentation preview has been updated
« Reply #24 on: March 28, 2023, 12:19:39 am »
An update has been posted to the documentation preview at https://dsiders.gitlab.io/lazdocsnext/. It updates the content for each of the Lazarus packages to version 2.3.0-f479581489 (2023-03-27), and includes the following:

Code: Text  [Select][+][-]
  1. 96a18b331f Docs: LazControls/treefilteredit. Updates TTreeFilterBranch.Move topic for changes in de07d13b.
  2. 455d0e29d1 Docs: RttiControls/rttictrls. Fixes invalid links to inherited topics.
  3. e00f5fc24e LazUtils, docs: TXmlWriter, document xwfAllowNullCharsInAttributeValue
  4. 0aca3728a6 LazUtils, docs: TXmlWriter, document changes in xwfSpecialCharsInAttributeValue
  5. 050ce1d3ed Docs: LCL/shellctrls. Adds topic for TCustomShellTreeView.ExpandCollapseMode added in efd6c16934.
  6. c8bf7b0a6a Docs: LCL/grids. Fixes missing word.
  7. a7647ebcc8 Docs: LCL/graphics. Fixes XML tagging issue.
  8. 90fb0f9e0c Docs: LCL/comctrls. Updates content and See Also links for topics, including:
  9. 332acd4b8f Docs: RttiControls/rttictrls. Removes a work-in-progress marker.
  10. 10f276e266 Docs: RttiControls/rttictrls. Adds links to inherited topics including those in external packages.
  11. 42fd1bf230 Docs: DateTimeCtrls/dbdatetimepicker. Updates content in topics including:
  12. f0ae6049c6 Docs: LCL/shellctrls. Fixes invalid See Also links.
  13. 1248f728ee Docs: LCL/shellctrls. Adds version information for changes in 499f0150.
  14. 433ce4fb28 Docs: LCL/shellctrls. Deletes commented content in TCustomShellListView.Resize which was removed in 06701d05a7.
  15. 499f015011 Docs: LCL/shellctrls. Adds and updates topics for changes in 6a85abf6.
  16. 0178542dc1 Docs: LCL/stdctrls. Adds content to replace the inherited description.
  17. 9095837756 Docs: LCL/grids. Updates topics including:
  18. 6795a6dae5 Docs: LCL/graphics. Updates content for the TCanvas.TextExtent topic.
  19. 2498b3596a Docs: LCL/grids. Fixes wording in TCustomStringGrid.Clean topic.
  20. 9208f17734 Docs: LCL/groupededit. Adds or updates content for TCustomAbstractGroupedEdit topics. Minor corrections to grammar and spelling.
  21. 1bdd39f428 Docs: LCL/stdctrls. Clarifies / corrects topic content, including:
  22. b693b70363 Docs: LazControls/treefilteredit. Updates content in topics, including:
  23. 310465e8bd Docs: Lazcontrols/treefilteredit. Adds content to TTreeFilterBranch.Move for changes in c8419bca. Issue #40135.

RTL and FCL documentation are a mirror of the content at https://www.freepascal.org/docs-html/current/.

Please feel free to offer suggestions or comments about the content in the update. Bug reports can be submitted to the Lazarus issue tracker (https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues) or the FPC Documentation issue tracker (https://gitlab.com/freepascal.org/fpc/documentation/-/issues).
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

dsiders

  • Hero Member
  • *****
  • Posts: 1151
Re: Lazarus documentation preview has been updated
« Reply #25 on: March 22, 2024, 05:14:52 am »
An update has been posted to the documentation preview at https://dsiders.gitlab.io/lazdocsnext/. It updates the content for LCL and LazUtils packages to Version 3.99-1d79f9e4df (2024-03-21).

RTL and FCL documentation are a mirror of the content at https://www.freepascal.org/docs-html/current/.

Bug reports can be submitted to the Lazarus issue tracker (https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues) or the FPC Documentation issue tracker (https://gitlab.com/freepascal.org/fpc/documentation/-/issues).
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

Handoko

  • Hero Member
  • *****
  • Posts: 5217
  • My goal: build my own game engine using Lazarus
Re: Lazarus documentation preview has been updated
« Reply #26 on: March 22, 2024, 07:06:51 pm »
Nice and thank you.

 

TinyPortal © 2005-2018