Skip to content
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

Updates to Help #1259

Merged
merged 3 commits into from Dec 24, 2022
Merged

Updates to Help #1259

merged 3 commits into from Dec 24, 2022

Conversation

bonzibudd
Copy link
Member

@bonzibudd bonzibudd commented Dec 23, 2022

  • New help style
  • Grammar fixes/slight reformatting
  • Windows 8 -> 8+
  • Links now go to Github or Classic shell mirror
  • Updated Readme and EULA style to match

Fixes #524, fixes #880, and fixes #1173

@bonzibudd bonzibudd changed the title Updates to Readme Updates to Help Dec 23, 2022
@AppVeyorBot
Copy link

@AppVeyorBot
Copy link

@ge0rdi
Copy link
Member

ge0rdi commented Dec 23, 2022

I think files in Localization folder (in repo root) are not used anywhere (at least I can find any references to them).
Only files in Src/Localization seem to be used (though maybe it would be more logical to have localizations outside of source folder).

You can eventually remove them (in separate commit) to see if build and everything else goes well.
Or I can do that later if you don't want to mess with it.

@ge0rdi ge0rdi self-requested a review December 23, 2022 19:16
@ge0rdi
Copy link
Member

ge0rdi commented Dec 23, 2022

You can also rename Menu.html to StartMenu.html to fix the Can't reach this page error (see #1241 (comment)).

Though, please do that in separate commit. And don't forget to fix also references to that file in Src/Localization files.

<br>
<h1>Components</h1><br>

<h2>Components</h2>
Open-Shell has three major components:<ul>
<li><a href="Menu.html">Open-Shell Menu</a></li>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open-Shell Menu looks weird here (other components don't have Open-Shell in name).
I'd suggest to change it to Start menu.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe Classic Start Menu (as other components have Classic too).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that it looks weird, but I personally think it makes more sense to keep it consistent with the product name (as shown as the titles of the other pages, etc.) Maybe it could be a future renaming effort?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oki, lets keep it as it is for now.

@bonzibudd
Copy link
Member Author

I will look at renaming the Menu.html component. Do you know of the other references off-hand?

You can eventually remove them (in separate commit) to see if build and everything else goes well.

So I can remove the entire localization folder without issue?

@ge0rdi
Copy link
Member

ge0rdi commented Dec 23, 2022

Do you know of the other references off-hand?

I have found it in Main.html, OpenShell.hhp, OpenShellTOC.hhc (all languages).
So better just search for Menu.html in Src/Localization and replace all the ocurrences.

So I can remove the entire localization folder without issue?

I believe so. Because I don't see any references to that folder.
You should do it in separate commit so that we can easily revert/remove it if it turns out that the folder is required for something.

@AppVeyorBot
Copy link

@AppVeyorBot
Copy link

@ge0rdi
Copy link
Member

ge0rdi commented Dec 23, 2022

Hmm, not sure what's the issue with help compilation :(
You can remove > null from the hhc line in BuildInstaller.bat.
Hopefully this will show some details.

@AppVeyorBot
Copy link

@bonzibudd
Copy link
Member Author

I think I missed some references to StartMenu.html. I'll try to fix.

@bonzibudd
Copy link
Member Author

bonzibudd commented Dec 23, 2022

Ok, seems like it may be fixed now. Would you like me to revert the BuildInstaller change?

Edit: I also still need to attach one of the related issues.

@AppVeyorBot
Copy link

 - New help style
 - Grammar fixes/slight reformatting
 - Windows 8 -> 8+
 - Links now go to Github or Classic shell mirror
 - Updated Readme and EULA style to match
 Fixes #1173, #880
@bonzibudd
Copy link
Member Author

Updated the description to include #880 and #1173.

@AppVeyorBot
Copy link

@ge0rdi
Copy link
Member

ge0rdi commented Dec 24, 2022

Ok, seems like it may be fixed now.

Perfect. And the help now works nicely 👍

Would you like me to revert the BuildInstaller change?

Yes, please.
I'd modify scripts later to store the hhc output and display it in case of error.

@ge0rdi
Copy link
Member

ge0rdi commented Dec 24, 2022

Could you also fix other languages in Rename Menu.html to StartMenu.html commit?
I mean we don't build those localizations right now, but we may start to do that and it would be nice to have help fixed for them as well.

And for the Remove unnecessary Localization folder commit, please add explanation to commit message that the folder is redundant and is not used for anything (Src/Localization is used instead).

So that we will know why it was removed in the future.

This should fix the initial error message upon launching the help dialog.
Fixes #524

fix

 - Rename Menu.html in other languages
Folder is not used anywhere in build, instead Src/Localization is used.
@AppVeyorBot
Copy link

@AppVeyorBot
Copy link

Copy link
Member

@ge0rdi ge0rdi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really great.
Thank you so much.

@ge0rdi ge0rdi merged commit a784b6f into Open-Shell:master Dec 24, 2022
@ge0rdi
Copy link
Member

ge0rdi commented Dec 27, 2022

@bonzibudd
I've noticed that screenshots in help file refer to old Classic-Shell (also to old registry paths).
Maybe you can create new screenshots?

@bonzibudd
Copy link
Member Author

@ge0rdi
I'll try to work on new pictures soon. I also have a couple technical things in mind for the Help panel.

I'll also provide some new images for the Start Menu Style page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants