Recent

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

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Lazarus documentation preview has been updated
« on: August 13, 2022, 05:20:35 am »
An updated preview for Lazarus documentation has been posted to https://dsiders.gitlab.io/lazdocsnext/.

HTML help content for the LCL and LazUtils packages has been updated to version 2.3.0-c303bd45d2 (2022-08-12).
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Re: Lazarus documentation preview has been updated
« Reply #1 on: November 18, 2022, 01:16:15 am »
An updated preview for Lazarus documentation has been posted to https://dsiders.gitlab.io/lazdocsnext/.

HTML help content for the LCL and LazUtils packages has been updated to version 2.3.0-df5754c7f4 (2022-11-17).
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

cappe

  • Full Member
  • ***
  • Posts: 191
Re: Lazarus documentation preview has been updated
« Reply #2 on: November 18, 2022, 09:36:51 am »
sometimes i watch it

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Re: Lazarus documentation preview has been updated
« Reply #3 on: January 18, 2023, 08:18:02 pm »
An updated preview for Lazarus documentation has been posted to https://dsiders.gitlab.io/lazdocsnext/.

HTML help content for the LCL and LazUtils packages has been updated to version 2.3.0-4c53c90895 (2023-01-18). It includes the following updates:

Code: Text  [Select][+][-]
  1. 112a42d2d3 Docs: LCL/comctrls. Adds content for Heigh, Left, Top, and Width topics in TTabSheet.
  2. 21761a63c4 Docs: LazUtils/masks. Removes invalid See Also link.
  3. 809f3a702f Docs: LazUtils/masks. Reduces cuteness factor.
  4. 4dea7ea47a Docs: LazUtils/masks. Updates content in the TMasklist.Matches and TMasklist.MatchesWindowsMask topics.
  5. f172b78cdc Docs: LCL/comctrls. Adds missing content in the TCustomListView.SortWithParams topic.
  6. 884efa6315 Docs: LazUtils/masks. Removes TWindowsMaskList.MatchesWindowsMask topic after changes in 7b815990.
  7. dc18060660 Docs: LCL/menus. Updates TPopupMenu topic for changes in 45e80c9d. Issue #40092.
  8. cc2704a497 Docs: LazUtils/masks. Adds or updates topics for changes in 408f319004.
  9. d35defa41c Docs: LCL/dialogs. Updates topics for changes in 70688d5a1f..3a944f112d.
  10.  
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Re: Lazarus documentation preview has been updated
« Reply #4 on: February 04, 2023, 04:54:02 am »
An updated preview for Lazarus documentation has been posted to https://dsiders.gitlab.io/lazdocsnext/.

HTML help content for the LCL and LazUtils packages has been updated. It includes the initial documentation preview for the DateTimeCtrls package.
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Re: Lazarus documentation preview has been updated
« Reply #5 on: February 27, 2023, 05:36:39 am »
An updated preview for Lazarus documentation has been posted to https://dsiders.gitlab.io/lazdocsnext/.

HTML help content for the LCL and LazUtils packages has been updated to version 2.3.0-1b9d3d4cbf (2023-02-26), and includes the following:

Code: Bash  [Select][+][-]
  1. 1b9d3d4cbf Docs: LCL/extctrls. Updates content in TCustomFlowPanel.CalculatePreferredSize for changes in 6cc8ef74.
  2. e00d028b0e Docs: LazUtils/lazutf8. Removes deprecated ReplaceSubstring topic after changes in ce9b92c9.
  3. b61d4e63a1 Docs: LCL/comctrls. Updates content in TCustomUpDown topics.
  4. f79a5d6718 Docs: LCL/comctrls. Updates content in topics including:
  5. 4143748675 Docs: LCL/comctrls. Updates topics for changes in d42c3fe9.
  6. 17b66f88c4 Docs: DateTimeCtrls. Adds text for See Also links in other units or packages. Fixes awkward wording in sentences.
  7. 658d14c8a7 Docs: LCL/various. Corrects spelling for 'check box' when not referring to a property name.
  8. aa4b71e15e Docs: DateTimeCtrls. Corrects spelling for 'check box' when not referring to a property name.
  9. c58ada4acf Docs: DateTimeCtrls/dbdatetimepicker. Adds a topic for TDBDateTimePicker.Options.
  10. 33ffadbc89 Docs: LCL/controls,ldocktree. Updates topics for changes in 3d86c02c.
  11. 251585aef1 Docs: LCL/controls. Fixes invalid See Also links in topics.


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

dbannon

  • Hero Member
  • *****
  • Posts: 2786
    • tomboy-ng, a rewrite of the classic Tomboy
Re: Lazarus documentation preview has been updated
« Reply #6 on: February 27, 2023, 06:20:49 am »
Thanks Don, thats really valuable work.

It would be heaps more useful if it could be turned into chm help format and we could point our "main" Lazarus IDE to a local copy. Or, perhaps, harder, somewhere where in the IDE that remembers your URL. 

Either way, having people looking at it directly, from the Lazarus IDE would be a good thing for for users and perhaps for the quality control of your project.

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

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Re: Lazarus documentation preview has been updated
« Reply #7 on: February 27, 2023, 06:39:37 am »
Thanks Don, thats really valuable work.

It would be heaps more useful if it could be turned into chm help format and we could point our "main" Lazarus IDE to a local copy. Or, perhaps, harder, somewhere where in the IDE that remembers your URL. 

Either way, having people looking at it directly, from the Lazarus IDE would be a good thing for for users and perhaps for the quality control of your project.

Davo

Hello Davo.

Thanks for the kind words. I wanted to make the content available so people could use it or offer suggestions. I do not put downloads on the site because its not an official documentation source. Its just a way to see updates that cannot be included in the fixes branch because they are deferred to the next major release.

If you're using 2.3.X, you can build both documentation formats locally. See:

docs/html/README.txt
docs/html/build_chm.sh
docs/html/build_chm.bat
docs/html/build_html.sh
docs/html/build_html.bat

Hope that helps.

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

af0815

  • Hero Member
  • *****
  • Posts: 1289
Re: Lazarus documentation preview has been updated
« Reply #8 on: February 27, 2023, 10:57:18 am »
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) ?
regards
Andreas

dbannon

  • Hero Member
  • *****
  • Posts: 2786
    • tomboy-ng, a rewrite of the classic Tomboy
Re: Lazarus documentation preview has been updated
« Reply #9 on: February 27, 2023, 12:18:56 pm »
If you're using 2.3.X, you can build both documentation formats locally. See:

docs/html/README.txt
docs/html/build_chm.sh
docs/html/build_chm.bat
docs/html/build_html.sh
docs/html/build_html.bat

Ah, I will have a read !
Thanks.
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

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Re: Lazarus documentation preview has been updated
« Reply #10 on: February 27, 2023, 08:38:33 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) ?

Short answer: No.

Longer answer:

The HTML files on the site (except for the landing page) are the standard output from FPDoc. Just like those on Source Forge host at https://lazarus-ccr.sourceforge.io/docs/. Unfortunately, the current build process for HTML does not use a site map with any links outside of a given package.

A link could be added in the footer area of each page pretty easily.

Would that be helpful?
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

marcov

  • Administrator
  • Hero Member
  • *
  • Posts: 11383
  • FPC developer.
Re: Lazarus documentation preview has been updated
« Reply #11 on: February 27, 2023, 09:38:52 pm »
If you're using 2.3.X, you can build both documentation formats locally. See:

Any question about CHM generation can be asked here.  It can be useful to read the readmechm.txt in the FPC documentation git repo too

marcov

  • Administrator
  • Hero Member
  • *
  • Posts: 11383
  • FPC developer.
Re: Lazarus documentation preview has been updated
« Reply #12 on: February 27, 2023, 10:05:13 pm »
The HTML files on the site (except for the landing page) are the standard output from FPDoc. Just like those on Source Forge host at https://lazarus-ccr.sourceforge.io/docs/. Unfortunately, the current build process for HTML does not use a site map with any links outside of a given package.

A link could be added in the footer area of each page pretty easily.

Would that be helpful?

While html is not my core knowledge, afaik fpdoc for plain html uses as convention (given the propre .xct) that all packages are in ../<packagename>/<relative url>.  Maybe a small webservicy (.js?) like thingy there to mutate the link to redirect to a different remote target (e.g. the FPC website docs) could be a way to have some interlinking ?

marcov

  • Administrator
  • Hero Member
  • *
  • Posts: 11383
  • FPC developer.
Re: Lazarus documentation preview has been updated
« Reply #13 on: February 27, 2023, 10:08:54 pm »
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.

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Re: Lazarus documentation preview has been updated
« Reply #14 on: February 27, 2023, 10:12:08 pm »
The HTML files on the site (except for the landing page) are the standard output from FPDoc. Just like those on Source Forge host at https://lazarus-ccr.sourceforge.io/docs/. Unfortunately, the current build process for HTML does not use a site map with any links outside of a given package.

A link could be added in the footer area of each page pretty easily.

Would that be helpful?

While html is not my core knowledge, afaik fpdoc for plain html uses as convention (given the propre .xct) that all packages are in ../<packagename>/<relative url>.  Maybe a small webservicy (.js?) like thingy there to mutate the link to redirect to a different remote target (e.g. the FPC website docs) could be a way to have some interlinking ?

My answer was not worded very well.

FPDoc does generate links to other packages . It does not generate anything related to a home page or landing page though. It has an option for an index page (like a TOC if you will) but it is not used in the current build process (for HTML).

« Last Edit: February 27, 2023, 10:14:03 pm by dsiders »
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

 

TinyPortal © 2005-2018