loot / loot.github.io

The website and meta issue tracker.
https://loot.github.io
GNU General Public License v3.0
12 stars 9 forks source link

Simplify quickClean message #78

Closed pStyl3 closed 2 years ago

pStyl3 commented 4 years ago

&quickClean

Due to Improvements made to the cleaning process with the official release of xEdit 4.0.x+, any mods which were verified as clean with older versions of xEdit may now require additional cleaning. A guide for running xEdit 4.0.x+ in Quick Auto Clean mode can be found here.

A lot of time has passed since @ElminsterAU introduced the new QAC process to clean plugins. I think that the message could be changed to something more generic and that it may no longer be important to indicate that QAC may find more than the old process of cleaning plugins. QAC is the de facto standard now. So the question is, what should we change it to?

For reference, the old &dirtyPlugin message, which was used before QAC was introduced (and still is used in the Skyrim & Oblivion masterlists):

An explanation of Dirty Edits is available here.

First of all, the url in &quickClean should be changed to this one (notice that the number 6 changed to 7): https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods

Here is a possible new message:

The cleaning process Quick Auto Clean of xEdit has found, that this plugin may require cleaning. A guide for running xEdit 4.0.x+ in Quick Auto Clean mode can be found here.

Or a more direct variant:

The cleaning process Quick Auto Clean of xEdit has found, that this plugin requires cleaning. A guide for running xEdit 4.0.x+ in Quick Auto Clean mode can be found here.

I'd like to hear other opinions on this, before deciding the final version of this message. Maybe something entirely different than the two examples above is suited better?

The new &quickClean message that needs to be translated:

A guide to cleaning plugins using xEdit can be found [here](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods).

As always, we need as many translations for this message as possible, especially in this important case:

Under #77

Ortham commented 4 years ago

The &quickClean message is appended to the generated message ("X found Y", where Y can be "dirty edits" or a breakdown of the different counts of dirty edits found), so I don't think it's beneficial to repeat that dirty edits have been found. I suggest

A guide to cleaning plugins using xEdit can be found here.

I'm not sure if it's more or less useful to mention Quick Auto Clean in the message, or leave that to the xEdit guide.

pStyl3 commented 4 years ago

The &quickClean message is appended to the generated message ("X found Y", where Y can be "dirty edits" or a breakdown of the different counts of dirty edits found), so I don't think it's beneficial to repeat that dirty edits have been found. I suggest

I agree, it would be redundant. Your suggestion is fine for me, it's even more compact and does what it needs to do, it links the user to a cleaning guide.

I'm not sure if it's more or less useful to mention Quick Auto Clean in the message, or leave that to the xEdit guide.

After thinking about it once more, I would also say, that we don't necessarily need to mention QAC in that message. After all, the process of using QAC is pretty straight forward and it is clearly described in the linked guide. Even more so, if we think of QAC as the new standard to clean plugins, it no longer needs to be mentioned seperately or to be explained in a special way on our side. It is, what it is, the way to clean plugins.

pStyl3 commented 4 years ago

Okay, let's settle on @Ortham's suggestion: A guide to cleaning plugins using xEdit can be found [here](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods).

German: Eine Anleitung zum Säubern von Plugins mit xEdit finden Sie [hier](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods).

Would the following people be able to help with translating that sentence? Posting the translated sentence in this issue would be sufficient.

@tktk11 Japanese (ja) @sean-kang Korean (ko) @Yoosk Polish (pl) @ironmagician Portuguese (pt) @TokcDK Russian (ru) @simoneddeland Swedish (sv)

Thanks a lot to everyone who finds the time to help!

ironmagician commented 4 years ago

Hello, here's the translated sentence:

Portuguese (pt): Um guia para limpar plugins utilizando xEdit pode ser encontrado [aqui](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods)

Feel free to use it as 'pt-br' translation also, if no 'pt-br' appears.

gnunesm commented 4 years ago

I was going to contribute a 'pt-br' version, but in this case it really is the same as @ironmagician 's translation.

pStyl3 commented 4 years ago

Alright, thank you both @ironmagician and @gnunesm.

tktk11 commented 4 years ago

Hi, I translate it. Japanese (ja): xEditを使ったプラグインのクリーニングのガイドは[こちら](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods)にあります。

TokcDK commented 4 years ago

Here is Russian (ru): Гид по очистке с помощью xEdit можно найти [здесь](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods).

pStyl3 commented 4 years ago

Thanks a lot @tktk11 and @TokcDK.

simoneddeland commented 4 years ago

Swedish (sv): En guide till att rensa plugins med xEdit finns [här](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods).

pStyl3 commented 3 years ago

@3ventic Would you mind translating this one sentence into Finnish as well? So: A guide to cleaning plugins using xEdit can be found [here](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods).

pStyl3 commented 3 years ago

@RacerBG Since you added the Bulgarian translation for the LOOT application itself (will be added with the next official release), would you mind also translating some general messages for our masterlists? That way, once the next version will be released, those messages will be displayed in Bulgarian, too.

For one, there is this one sentence that you can see here in the post above or in the original post at the start of this topic. On the other hand there is issue number 646 which holds additional messages. PRs are welcome, but not strictly necessary, you could just post the translations in that issue, if you want.

3ventic commented 3 years ago

@3ventic Would you mind translating this one sentence into Finnish as well? So: A guide to cleaning plugins using xEdit can be found [here](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods).

Ohjeet liitännäisten puhdistamiseen xEditillä löytyvät [tästä linkistä](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods).

LMK if you prefer a PR.

pStyl3 commented 3 years ago

@3ventic Thanks for that. No need for a PR really, I will handle the rest!

sibir-ine commented 3 years ago

@pStyl3 A friend who'd like to remain anonymous has provided a Simplified Chinese translation. I'll add it to the masterlists shortly, but how should we credit him? Something like "anonymous translator"? He & possibly a few others will provide more translations after we refactor the messages a bit more.

pStyl3 commented 3 years ago

@sibir-ine If he or she prefers to stay anonymous, we should handle it just like that and not add a mentioning of any sort. Be sure to let him/her know our gratitude though.

RacerBG commented 3 years ago

@RacerBG Since you added the Bulgarian translation for the LOOT application itself (will be added with the next official release), would you mind also translating some general messages for our masterlists? That way, once the next version will be released, those messages will be displayed in Bulgarian, too.

For one, there is this one sentence that you can see here in the post above or in the original post at the start of this topic. On the other hand there is issue number 646 which holds additional messages. PRs are welcome, but not strictly necessary, you could just post the translations in that issue, if you want.

@pStyl3 Here you go (Bulgarian translation):

Информация за почистване на приставките в xEdit може да намерите [тук](https://tes5edit.github.io/docs/7-mod-cleaning-and-error-checking.html#ThreeEasyStepstocleanMods).

pStyl3 commented 2 years ago

At this point in time we probably can close this issue. Even though we currently still need 3 more translations so that &quickClean is fully translated into all languages LOOT supports, &quickClean is simply one of many Message Anchors and probably shouldn't stand out above the others anylonger.