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
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
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) ?
If you're using 2.3.X, you can build both documentation formats locally. See:
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?
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 ?
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) ?
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.
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.
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 PascalDragonQuoteThe 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.
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.
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)
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.