-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhancement: improve the look and feel of the constructed HTML files #2006
Comments
:-) About that entry .. didn't you say I needed to fix something there in the README.md and maybe other markdown files? What did you have in mind (well besides the markdown file references on GitHub should be removed which I'll get to)? Thanks.
Good call on linking there.
As above. Of course I think I've done much of this work but it'll be helpful to see how the index.html files come out to know what has to change further.
I can see how that would be less desirable yes.
This is an example of disabling warnings i.e. the less desirable way, right?
Perhaps it'll be helpful to have all the html files generated so we can see what they look like here so I can know what to fix? And do feel free to assign this to me!
I guess in general complex ways should be weighed against the easier ways and what is gained/lost. Of course in some cases more complex is the right way to go but not always. I can see how a widespread problem would be better fixed at the source of course.
Speaking of such. What will the other html files (from other markdown files I mean) be using?
Agreed it would be good if this can be avoided!
True. That seems even worse than modifying the CSS file. I guess you agree there. Anyway feel free to assign this (and every other one .. I'll mention that in 5) to me. I'll be asking for a priority list too. |
Probably it is: that is untested and likely not needed. It was just a fake example. |
Just making sure. Thanks for assigning it to me. I presume you'll get back to me on the other things later on. |
We just needed a fake example to use. |
They ARE generated OK, as mentioned the higher level HTML files and the winner HTML files that are not It was a milestone that we had been working on for months. It was why we asked to hold off on edits being made to the manifest numbers spreadsheet until now. It was the reason for the creation of all those new issues, etc. start side noteWe are actively working on generating the rest of the HTML files (see the TODO list of issue #4): racing to try and finish issue #4 before the other ((top primary)) issues are completed. For a number of people, work on issue #2 and issue #3 might seem nice, but as they might not take the time to try all of the IOCCC winners of the past, they might not understand the full benefit .. that it until they are looking at past winners for ideas and discover that they actually have a reasonable change to download the core, compile it and run it today. Sadly it will be the look and feel that will catch the attention of most people. The winner If we were make a new accouchement now about the work done so far, and people see a bunch of broken links, missing HTML files, etc. it will be hard for some people to perceive the tremendous progress that was made by issue #2 and issue #3. Thus we have be working very hard to race to try and get the look and feel ready so that your important efforts may present themselves in a good light for others to see. end side noteAnd as the top comment suggests, much of the work will likely involve editing the |
For this issue, only the winner When other HTML files are generated, there will be other issues to review them: likely 2 more issues that will be created, one for the winner non-index.html files and one more for all of the top level HTML files, one those HTML files are generated in the first place. |
Sure .. but I was thinking of in general. But I'll worry about that later on. Thanks. Still what problem existed in I think you said 2020/ferguson1/README.md ? That way I can correct it. |
Right but I thought you said some days back that that file needed some fixes? |
No .. you did indeed mention it. I was thinking of something specific but I'm afraid I don't know what it is now. Maybe it's already fine as it is. That's possible - it might just be I have to look at the rendered files to find errors.
Of course.
I remember you saying that yes. And I wish I had thought of the fact that I know of some errors in one of my entries. Wrong file name. Well I won't do that today. The manifest task is taking too much for me today. I really don't know why I am so exhausted today but I am.
Hmm yes I can imagine that. I don't think nearly as many people understand how many entries no longer worked and how almost all of them now do. And the ones that don't I think work in some platforms. In one case I'm pretty sure it has to do with the version of perl in macOS, as to why it crashes. I think this based on the author's remarks. Even those that do they might not care as much as the look and feel as you say. Presentation etc. seems to get to people in ways that sometimes goes to quite some extremes. The flashy websites being something that so many people like (even if the content is not quality) is a classic example.
Thank you very much! I needed to hear that! When I'm done with that other issue, 3, I will look at the rendered files and then go from there. It is probably better that order anyway since that way I can be sure the html files are up to date. As noted in another issue some are not now (though they're being updated). Then if a file name changes or a file is added or removed or that also means the index.html is out of date. So better to finish that first. Though I have to say today the manifest one is getting to me. But that's because I'm extremely tired - more than usual - and also probably because it's my first time with the very long process.
That's true and it's also true that there will be broken links. Let me say that differently: there ARE broken links. That includes from typos on my part (normal typos that I haven't gone back to 'zoom in on' yet and also it's possible I had the wrong link to type .. and then there are other things too).
Yes. I'm still doing that of course. I think manifest issue is about done, what I'm working on, so I'll post this and hopefully be making a pull request shortly. |
Added an "UPDATE 0" to the top level comment. |
I did like the 2020 version of the entries' index.html files and the year's index.html too but I also liked the way you had the index.html files here. Speaking of such I thought you had linked to an example index.html that was rendered as html. I can't find it now though. Can you post it again please? Thanks. That'll help I think. |
Then are rendering on the GitHub pages for the web site such as: https://ioccc-src.github.io/temp-test-ioccc/2020/ferguson1/index.html Better still one can view them locally on macOS using the built in Apache server as needed. |
The GitHub version is better for me actually. Thanks. Would you mind adding a link to it in the todo list so I am sure to not lose it again? Thanks. |
Speaking of such I see a problem with the index.html files ... They should list more than just name and location. In particular they should list URLs and also award title. Where should this be fixed? And if it's later in the file I think that's a mistake. A lesser matter is I'm not sure if the 'Author' heading level is right. But I'm not sure if it's wrong either. Seems smaller though and maybe it shouldn't be? But I don't know and the more We could have the author information at the top level 1 (as in |
As mentioned in the top comment: HINT: We recommend using the method outlined in comment 1893176110 on a macOS machine to examine HTML files before pushing changes to the repo. This allows you to first check and test HTML files on your local machine before pushing out a commit for a pull request. |
I meant to see what they look like now. I was too tired to think of more details but that's what I was getting at. |
Addressing any such missing information is probably premature given the ongoing actions are mentioned in comment 1928224505. |
Just wanted to bring it up. No rush on my behalf. I'm afraid I won't do more than the manifest that I did today .. too tired and too much on my mind. I'll do more tomorrow. |
FYI @xexyl , the mention of the IOCCC award for a winning entry has been addressed in |
Thanks for the update. |
Also FYI: @xexyl , the questions about formatting such as 'Author' heading level has been addressed in |
Thanks! I am going to get myself to bed now. I don't know what I will be able to do tomorrow but hopefully I can do a bit. If nothing else I should be able to start back at doing more in the days after my birthday - though as I said there are a few days after it that will be slower. Enjoy the rest of your day! |
We believe we have addressed all of the current questions that still need answering at this time. If we've missed something or something else needs to be clarified, please ask again. |
See commit cc73503 As a result, from the top level make quick_www and try: make www among other things. :-) |
Nice. Thanks! That'll be helpful. I guess I can update the manifest tool I wrote to do that too but we'll see. Will hopefully do some things tomorrow morning. Just spending a couple more hours and then probably will get sleep: very tired. |
The inc and bin items should NOT be in the menu. They are useful for those who maintain the web site: not for the general. We've been off-line since yesterday, so if you put those into the web make menus (either or both the JavaScript and the no-JavaScript versions), please remove them. UPDATE 0When we get online and rebuild the website based upon all of your wonderful changes, we will comment on the above in more detail. |
I wish you had not merged them then. I figured it might be good for the bin/ because what's the point of the index.html file? What I mean by that is that is there a point in building the index.html? Certainly there is a need for the README.md but is there really a need for index.html if it's not going to be linked? I agree that UPDATE 0Actually I am glad you merged it. As there are other fixes too. But you know what I mean. |
... anyway, I'll be gone for the rest of the day now. Tomorrow based on what you have done I can either do something here or not. Hope you have a good night. |
Reminder set. And looking at it again I am inclined to agree. The original rationale, so you can understand what I was getting at: it makes it easier to access. But it's not that important either I guess. Will fix tomorrow morning. Now I really am leaving for the day. |
I had an idea that should speed it up. Depends on how fast this goes whether I'll do it today or tomorrow though. My guess is it won't be done until tomorrow morning as I'm quite tired and even using UPDATE 0I must have missed some files to touch so I'll just do the Sorry about the mess! It seemed like a good idea at the time and it looked okay too but after time away from it and looking at it again I think it's better to not have it, like you think too. Good night. |
I have some ideas for some last minute improvements. Shouldn't take much work or time beyond the fact I have to rebuild every html file (but I have to do that anyway). I will be working on them soon. |
Okay I have a nice menu in order so now doing I made a pull request already but expect another one later on when Hope you had a great night! |
Now running I reworded some of the section names and I also reorganised the menus. After this I think I'm good. Well I might want to add jump to top of the rules at each rule but that's something that can be easily done. |
The sections have been modified a fair amount. The Entries menu has been extended to have: Fixing entries, Updating author info, Thanks for the help. The first two were moved from FAQ and the last one from About. The rationale for these, in order: entries and authors have to do with entries and most of the help involves entries. It also has to do with website but in 'about' it does not seem the right place, unless maybe it is renamed to 'Credits' or something (I am not suggesting this one way or the other). This one is debatable but that was the rationale. The Status menu has been extended to have: Markdown guidelines and Security policy. The rationale is that the markdown guidelines are part of contest guidelines and the security policy is about the status of the entries and how if there are any security problems they will not be addressed (instead of about the IOCCC). The FAQ was extended to have: Compiling entries, Running entries, How to help. The reason to not have compiling and running entries under Entries is because this is 'how to' and also the menu was too long. How to help seems like a good idea under FAQ too (was in About). About was extended to have the new 'about.html' page (from about.md). This is a rare case where a new file is useful as it fits under 'About'. The menu now is: Home page, About the IOCCC, The Judges, Contact us. I was pondering the 'About [the IOCCC]' at the top and also naming it 'About us' but it seemed like a link to index.html was necessary and as for 'about us' it seemed less clear as to whether it was about the judges or the contest itself. The FAQ has been updated slightly for this. After further inspection the bin/index.html and the inc/index.html links were removed from the about section. With these changes, renaming an item or slight reordering notwithstanding, I believe that ioccc-src#2006 is probably in good shape.
See commit af54828. Unless you wish to rename a section or two or if you want to move an item I think that this issue #2006 is in good shape. I will be doing other things for the rest of the day anyway. Feel free to put in a soft freeze though if you do please let me know. Assuming that is the case I'll take some time off this weekend and maybe next week too. Well time off from here that is. |
Okay I believe I have made my last edit until the final review. Unless I see something or you request something. I had to make a minor fix (well addition and then it required a fix and a fix on that fix) but now I'm off to do other things. Hopefully things look good to you too and we can go from there. Anyway doing other things now. Good day! Let me know if you need anything changed. |
How does this issue look? If all good then tomorrow I will just do something else entirely, perhaps watch a film. Or maybe I will look at jparse. Otherwise if something needs to be done I will do it. Just taking it easy for a little bit and then going to sleep. Good night! |
With commit a2e351d we believe we have competed the work on this issue. We plan, the day after we meet with our python helper on the submit server (2024 Oct 26), to go over the repo one last time before we close this issue. |
Okay let me know when you want me to see if I can do some final checks as well. I guess that's early next month? |
As for: We move the "Thanks for the help" out from under the "Entries" menu and under the "About" menu to better balance the menus. Besides, "Thanks for the help" is more about the IOCCC itself. ... I was on the fence with that one so I'm glad you had a better idea. Also I agree it does balance it out more (the menus) and that was a concern of mine. |
NOTICEWe are about 15 hours (plus or minus a few hours) to the time that this issue will be closed and the repo will go into a code freeze where only changes related to TODO items in issue #2239 that related to completing the Great Fork Merge will be "happily entertained" as the expression goes. Beyond that (post Great Fork Merge an in the official IOCCC winner repo), prior to announcing the winners of IOCCC28, only those changes that relate to the running of the IOCCC28 (such as draft rules and guidelines, official rules and guidelines, IOCCC28 news related announcements, updates to FAQ that relate to the registration process or the submission process, etc.) will be "happily entertained" as the expression goes. Anything else will be deferred until well after IOCCC28 closes and the IOCCC judges take a well deserved vacation. |
Thanks for the notice! I think I'm probably all good. I can look at things when you're gone. I can't catch everything but nobody could and I think most things are in good shape. I reworded things slightly in the thanks file but that's all I can think of at this time. In a short bit (minutes from now) I'll be afk a while but beyond that today I'll be focusing on other things I think. Have a great day! |
We now have the honour of closing this very significant issue. Many people may not realize how much work you put into this issue, @xexyl even with the documentation that is available in Thank you 🙏! UPDATE 0During the FINAL REVIEW section of the TODO items for issue #2239 (please see/review the top comment of #2239 (comment)), there will be be a period of time where we can correct any issues / typos / poor working / issues that were introduced into this repo as a result of completing the TODO items that some after the "[x] Complete issue #2006" ). So please do not fret if we do things that are not quite up to the excellent level that you have achieved with this issue. |
Lovely ❤️
WOW! As a wordsmith I am not usually speechless but I'm mostly speechless (for a moment at least :-) )! THANK YOU!! That means VERY MUCH, more than you can possibly know! I am happy I did it. Not because of this but because I love the IOCCC and just like with winning it this and the mkiocccentry repo are a win in another way. This comment of yours, this thank you, it's hugely significant and precious to me! Make that sibilant: Preciouss! I am SO VERY HAPPY I could help in the ways I could but as much as all that is special to me, it is the friendship that REALLY matters! Not just friendship but great friendship and also learning so much from you, some programming but also the history of Unix/C and other things. And we must not forget that we're both Tolkienists and that is also wonderful! It's not many people that I can share jokes and all the references to Tolkien's Legendarium who would both appreciate it (as below) and also laugh at it (plus all the other jokes/memes)! It's not everyone who would appreciate:
Doing this and having this honour, it is like winning the contest many more times than I already have! Obviously I hope to win it again but that's another thing. Working on jparse with you and writing txzchk and other tools for you/the Judges (and other tools with you even besides jparse): that's also a huge honour! Not many people can say they have done that, only one before, Anthony Howe. Being in the guidelines is really special to me too! You also have a shared interest in volcanoes. You're an astronomer and although I am no expert in space I have always loved it, just like volcanoes. Your stories about your childhood and also adulthood are all really special to me too. I have thought of even more than these things but the point is it is the friendship that really matter. The rest is also very special to me too, of course, but I didn't do it for that; I did it because I'm passionate about the IOCCC and I like to help others where I can. It's been an absolute honour!
You're very welcome my good friend. But: THANK YOU TOO!
I won't fret of course but thanks. When would you like me to review these things? I think that until later this week I probably can't do much but I am putting a reminder out for Thursday to check this issue so I can know what to do next! |
'It is my own. I found it. It came to me.' 'Yes, yes,' said Landon. 'But there is no need to get happy.'
Speaking of such ... I had two in mind but only one now comes to mind, above, but I'm sure you'll appreciate it! |
An amusing exercise is to ask ChatGPT to identify the quote:
Then correct it and see where that goes and then try and correct it again and again! I've done it a number of times as it amuses me so much. |
BTW: @xexyl the meeting with Leo went well. And as we suspected, Leo might want to add a few mods of his own. So even though we are in a "soft freeze state", please help Leo with mods and make actions in order to accommodate his mods. |
I am glad it went well! I am happy to help Leo if he lets me know how I can help. Tomorrow morning I will at least look at this issue and take care of what is clear. If you have more information or you want to clarify anything please do so. |
Leo doesn't know the bin tools nor make actions. So, for example, when he added that image and the inventory broke, he didn't realize it. Thus you may have to step in and complete actions until he becomes familiar with the situation. |
Ah. Thanks for clarifying! I wondered about those files. I didn't think they were there. Thanks! So tomorrow morning I can do this stuff. Safe travels and holiday! |
All generated HTML web pages are covered by this issue.
This issue covered all generated HTML files, including generated entry
index.html
files, top level web pages (both constructed form data such asauthors.html
andyears.html
as well as top level HTML files generated from markdown such asjudges.html
andnews.html
) and year level 'index.htmlweb pages,
bin/index.htmland
archive/historic/index.html`, etc. If the web page is generated or updated by a bin tool, then that page a candidate for this include the "look and feel" issue.This issue focuses on these web pages "look and feel".
This is NOT about fixing content errors. (Well if you see something glaring, go ahead and fix it). This is about how the generated HTML pages look in a web browser.
Here are the types of questions ask about a generated HTML web page as viewed in a browser:
We are NOT focusing on the accuracy of the generated web page per se (although if you see something glaring, feel free to fix it under the guide of something that slipped passed the issue #3 effort). We are focusing on HOW it LOOKS with an emphasis on correcting dysfunctional presentations.
In many cases, corrections can be addressed by editing some markdown file such as the entry's
README.md
file. Please modify the entry'sREADME.md
file and re-build the entry'sindex.html
in a pull request.If, however, you see an issue that may be more a matter of changing
ioccc.css
or the related bin tool, please raise the matter as a comment in this issue #2239 so we can discuss the matter before editing the CSS and/or bin tool. Again, this is less likely to happen, but if it does, we recommend a comment related discussion first. Modification to the entry'sREADME.md
file can be done directly via pull requests.We also want to address any fix all REASONABLE "validation errors and warnings" as reported by the "Nu HTML check this web page". We emphasize REASONABLE because in the past, we have found some of those "validation errors and warnings" to be on the pedantic side of things. Moreover, when it comes to the HTML generated by
pandoc(1)
we may not have much room to fix things.See also comment-2101733908 regarding links to markdown files, links to GitHub, relative links, and links with %%TOKEN%% symbols.
Please note that the top index page of this repo, as rendered by GitHub, is https://ioccc-src.github.io/temp-test-ioccc/index.html.
A review of commit 4d6009b, and commit 3aec80f, and commit 85c9916, and commit 5dd3311 should be done to consider changes impacted by the move away from "spoiler" language and towards language such as "deobfuscation".
The text was updated successfully, but these errors were encountered: