tads3-website/README.md at main · tads-intfic/tads3-website · GitHub Here’s the repo and guide for contributing also!
(I added a license but I am not sure if it is legal under MR’s initial license or other people’s licenses…please let me know if I need to change it)
I see from your readme that you’d like to host the adv3 documentation. Would you also like to host the adv3Lite documentation? It’s on my GitHub repo but that doesn’t render the HTML (it just shows the HTML source), so there’s currently nowhere online where the adv3Lite documentation can be read online (apart from Learning TADS 3 with Adv3Lite).
In any case you might want to link to the adv3Lite Quick Start Guide. If you host all the adv3Lite documentation you can do that in any case, but otherwise you could put a copy of the Quick Start Guide up on your site to link to.
I thought the peripluses read the library comments? The files seem to be stored in the repo (you can check Jim’s repo, I got it from there). Is that different from the documentation?
In any case, I am planning to link to the book you mentioned, and the rest of the bookshelf books in both places, even if not hosted. The site is not filled out with all resources.
Remember you can also open an issue to add stuff 
I think we’re conflating two different issues here.
Yes, the source files are in the repo, so if the periplus can be generated from the comments in the source files, then you should be able to use those. (The one caveat there is that the source files on GitHub may be slightly ahead of those in the latest release, but that probably won’t matter all that much).
As a completely separate point, I saw that you said you would like to host “the original TADS website documentation”, so I was wondering whether you would also like to host the adv3Lite documentation (so that it would be available to view on the web, which at present it is not).
If we can host that it would be nice (for a search bar’s purposes)! But you’re actively maintaining it so it’s less of a priority/doesn’t need to happen. It can just be linked to (if/when made available as html)
I was hoping to replace the adv3Lite source files with the new release to regenerate them eventually for the periplus (or make some sort of thing that references your github repo and generates it automatically without the files having to be on the website-- if that’s even possible). that’s step 3!
I’ve just taken another look at the existing adv3Lite periplus. From what I can see, it can’t have been generated from the comments in the source code. Some sections of it link to the TADS 3 Library Reference Manual (which is generated from the comments on the source code, but the periplus just uses the existing LRM). Parts of it link to the Adv3Lite Manual, parts of it to the TADS 3 Technical Manual, and maybe some parts elsewhere, so it’s already pulling in stuff from a mutiplicity of sources. It’s linking to versions of adv3Lite documentation under the url adv3Lite Library Manual and Adv3Lite Library Reference Manual. which I guess is where Jim Nelson must have copied some of the (v 1.5) adv3Lite documentation to.
That being the case, then I don’t think you need to regenerate the periplus. I think you need to replace the v 1.5 version of the documentation it links to with the latest version. There’s a good chance that the existing periplus index would still work. but would be then be linking to the updated versions of the same files.
For what it’s worth, our dear @fos1 has been hosting a copy of the Adv3Lite docs here. I’m not sure if they match the most recent version, but that’s what I link to when I’m sharing documentation online.
Good to know, but it looks like that’s the Adv3Lite docs for version 1.5, so rather out of date now.
I think I get what you’re saying, though maybe @jnelson can clarify about the generating stuff? I probably misunderstood what’s actually happening there re: the PHP script (don’t know it very well).
However, I think that the periplus links to the Library Reference, which then links to the source files. Those would need to be not just re-linked to, but replaced with the new 2.1 versions and hosted, right…? This is still primarily for the purposes of the search functionality.
The periplus links to a variety of sources. One of these is the Library Reference Manual that links to the Library Reference, but it links to other documentation as well, including the Library Manual and the Technical Manual. I don’t know how the periplus links to the Reference Manual; if it’s just linking to particular pages (as I think it may do) then it should be possible must to replace the 1.5 version with the 2.1.1 version, as one would also have to do for the Library Manual (a separate set of HTML files).
Alright, so if I’m understanding correctly: I’ll host all the 2.1.1 versions of various files, documentation, etc and link to the hosted versions in the periplus. When you update adv3Lite and its files, I’ll replace them, and the links should still hold as long as they have the same names.
Worth saying that part of the reason I need to regenerate the periplus is cuz it’s got HTML 4 and lower tags also, which need to be updated to HTML 5 to play nice with Jekyll.
Also LOL…
Yes, I think that’s how it should work. If you have adv3Lite version 2.1.1 (or download it from GitHub) that’ll give you all the adv3Lite documentation you can host. I’m not expecting to do another update now until March.
Yes, my repo / periplus was hosting the entire adv3Lite class library docs (v. 1.5) as-is. Those were not generated by my PHP scripts, but simply copied in from the adv3Lite ZIP (as I recall).
The PHP script generates the link pages that are hosted by the frames. Basically, the two frames on the left hand side. Those pages link to the existing class library docs, plus other docs (such as articles and tutorials).
Eric Eve is right, if you replace the 1.5 class library docs in the repo with the 2.1.1 docs, it should mostly work. The only problem would be if a class was renamed or removed. And, obviously, the index pages on the left won’t point to new classes added in later versions.
On the periplus, I think that adv3Lite’s changelog allows a quick updating of the periplus.
but I think everyone will like an offline version in their HD (coders often work at night, and also providers’s engineers work at night (go figure, the first thing I check when net connection drops in middle of night is the time… often is indeed x:00 or x:30 for X= 00 to 05… that is, scheduled server or line maintenance.), so whatever format has the consolidated resources, the index.html should be capable of working offline (often using relative addressing in lieu of absolute addressing suffice; for example, the adv3Lite bookshelf’s index.html has simple and clear instruction for changing the link to the TADS3 sytem manual from tads . org offline copy of TADS3/adv3 bookshelf)
Best regards from Italy,
dott. Piergiorgio.
The site is currently in the process of building incREDIBLY slowly, but I was able to add a (very slow) search function to the website, and new CSS for the pages (written by Alexis from our old project). With the new formatting a LOT of the site looks wonky, so I may just give up and use the original jank HTML eventually. Who knows?!
It’s not updated yet due to the slow building, but will update this post when it is.
Thanks for working on this, I think it’s a great idea. I just tried the search and it’s returning a 404 (the page URL was https://tads.dev/search/?query=Event)
Yep, I had an error with the search page, try again with a new search 
I also fixed the build to regenerate faster (apparently the github pages gem SUCKS yall, it takes SO LONG to build jekyll with it! don’t use it!) so it takes 5 minutes to update instead of an hour and a half
The adv3lite bookshelf at https://faroutscience.com/adv3lite_docs/index.htm just went 404 when it was working earlier today. Did activity on this thread have something to do with it?
Why would it?? My site has nothing to do with that site.
@fos1 ?
These are two entirely different computers, so no, the activity on this thread has nothing to do with the 404 you encountered.