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

Witness: Add French and German Setup Documentation #2527

Open
wants to merge 24 commits into
base: main
Choose a base branch
from

Conversation

ReverM
Copy link
Contributor

@ReverM ReverM commented Nov 28, 2023

What is this fixing or adding?

Adding french and german documentation for the witness
Removing a paragraph in the english doc

How was this tested?

Reading

If this makes graphical changes, please attach screenshots.

@NewSoupVi NewSoupVi added the is: documentation Improvements or additions to documentation. label Nov 28, 2023
@ThePhar ThePhar changed the title [Documentation] Witness FR + DE docs Witness: Add French and German Setup Documentation Nov 28, 2023
@BootsinSoots
Copy link
Contributor

Any reason for removing the paragraph about the text client?

@ReverM
Copy link
Contributor Author

ReverM commented Nov 29, 2023

B

Any reason for removing the paragraph about the text client?

The information in the paragraph was no longer relevant. I have asked Violet about the change before doing it. (it was refering to the fact messages weren't supported in game which is no longer true)

@BootsinSoots
Copy link
Contributor

B

Any reason for removing the paragraph about the text client?

The information in the paragraph was no longer relevant. I have asked Violet about the change before doing it. (it was refering to the fact messages weren't supported in game which is no longer true)

Actually, that got changed in #2294

Copy link
Member

@NewSoupVi NewSoupVi left a comment

Choose a reason for hiding this comment

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

I wrote the German part, so I approve of it.

Can't comment on French, I don't speak it.

@ReverM
Copy link
Contributor Author

ReverM commented Nov 29, 2023

B

Any reason for removing the paragraph about the text client?

The information in the paragraph was no longer relevant. I have asked Violet about the change before doing it. (it was refering to the fact messages weren't supported in game which is no longer true)

Actually, that got changed in #2294

Thank you for the catch, I talked back with Violet and it seemed that some confusion crept in

@black-sliver
Copy link
Member

Can we get a second set of eyes on the French translation so we can merge this?

@PoryGone PoryGone added the waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. label Feb 11, 2024
The Witness a un tracker fonctionnel qui supporte l'auto-tracking.

1. T�l�chargez [The Witness Map- and Auto-Tracker](https://github.com/NewSoupVi/witness_archipelago_tracker/releases) et [PopTracker](https://github.com/black-sliver/PopTracker/releases).
2. Ouvrez Poptracker, puis chargez le pack Witness.
Copy link
Contributor

@benny-dreamly benny-dreamly Feb 19, 2024

Choose a reason for hiding this comment

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

est-ce-que Poptracker devrait être en guillemets ou en gras?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, je ne crois pas.

Co-authored-by: Lolo <lowgau@gmail.com>
Copy link
Contributor

@neocerber neocerber left a comment

Choose a reason for hiding this comment

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

I am a native French speaker but my mastery of French is on the weak side. Except for the suggestions attached to this review, the French part of the documentation seems good for me and Antidote. In terms of content, it seems to corresponds perfectly to the English version. Also, I only know how to say "Thank you" in German, so I can't judge that part.

I validated, via local web hosting, that both the French and Deustch version of the setup page work as intended: the pages and their respective content are there and the links seems to correct.

Three global changes to apply:

  • Re-encode the files in utf-8? In my Ubuntu, the rendering of some characters are bugged and I had to change the "ç" in the init.py to host the pages.
  • style guide says to enforce 120 caracters limit for markdown file.
  • All English word in the French document should be put in " or translated to French. (e.g., item, auto-tracker, tracker, pack). This is partially the case right now.

Unsure suggestions:

  • Some of the links redirect to the latest release will other redirect to releases. Not sure if it is voluntary and/or a problem.

5. Cliquez sur "Connect"
6. Jouez!

Pour continuer un jeu multimonde précedemment commencé:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion:
Replace with "Pour continuer une partie déjà commencé:"
If not accepted, at least change
précedemment for précédemment

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I like this, will change when I have the time

Copy link

Choose a reason for hiding this comment

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

Small correction un jeu commencé -> une partie commencée.

1. Lancez The Witness
2. Chargez la sauvegarde sur laquelle vous avez dernièrement joué ce monde, si ce n'est pas celle qui a été chargée automatiquement
3. Lancez [The Witness Archipelago Randomizer](https://github.com/NewSoupVi/The-Witness-Randomizer-for-Archipelago/releases/latest)
4. Cliquez sur "Load Credentials" (ou tapez les manuellement)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion:
Change for "4. Cliquez sur "Load Credentials" (ou saisissez-les manuellement)"
Just for style uniformity. Not important.

Copy link

Choose a reason for hiding this comment

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

I'd use "ou inscrivez-les manuellement" to reflect #4 step for a new game.

4. Cliquez sur "Load Credentials" (ou tapez les manuellement)
5. Cliquez sur "Connect"

## Archipelago Text Client
Copy link
Contributor

Choose a reason for hiding this comment

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

Since it is a English term, put in ""? (Not critical)

Comment on lines +33 to +35
<br/>The Witness affiche également ces informations en jeu, mais seulement pour une courte période et donc il est facile de manquer ces messages.

<br/><br/>Bien sûr, vous pouvez également utiliser l'auto-tracker!
Copy link
Contributor

Choose a reason for hiding this comment

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

Google's markdown style discourage "'
". Changing line does the job, so should be removed. (Do the same with English and Deustch)

Comment on lines 46 to 47
Le reste devrait être pris en charge par Poptracker - les items que vous recevrez et les puzzles que vous résolverez seront automatiquement indiqués. De plus, Poptracker est en mesure de détecter
vos param�tres de jeu - les puzzles accessibles seront alors masqu�s ou affich�s en fonction de vos param�tres de randomization et de logique. Veuillez noter que le tracker peut �tre obsol�te.
Copy link
Contributor

Choose a reason for hiding this comment

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

"puzzle" -> "énigme" If not done, put " around the word puzzle.
"résolverez" -> "résoudrez"
Either put " around the word randomization or use the french spelling i.e. 'randomisation'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looking with the Larousse, it seems puzzle is an accepted word in french. I personally use the word puzzle quite a lot in french discussion but I'll be happy to change it to énigme instead.

I'll adress the rest asap

Copy link
Contributor

Choose a reason for hiding this comment

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

From looking at Larousse, it would seems that the word is accepted when talking about "casse-tête". However, most people would understand what is meant, so I leave the decision to you!

1. Lancez The Witness
2. Commencez une nouvelle partie
3. Lancez [The Witness Archipelago Randomizer](https://github.com/NewSoupVi/The-Witness-Randomizer-for-Archipelago/releases/latest)
4. Inscrivez l'adresse Archipelago, votre nom de joueur et le mot de passe du jeu multimonde
Copy link
Contributor

Choose a reason for hiding this comment

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

Indicate that password are only needed if they are needed.

@ScipioWright ScipioWright added the waiting-on: author Issue/PR is waiting for feedback or changes from its author. label Jun 3, 2024
@Exempt-Medic
Copy link
Collaborator

@ReverM

@NewSoupVi
Copy link
Member

NewSoupVi commented Aug 17, 2024

Anything left to do here?

Edit: Wait, oh no, did I fuck everything up lol

@NewSoupVi
Copy link
Member

NewSoupVi commented Aug 17, 2024

Ok yeah I think this is not my fault, something is wrong with the encoding of the french docs too

Edit: Nvm, it was the ç in __init__.py

Idk what's going on with the encoding overall, the french doc looks very strange on github but displays ok in PyCharm

@NewSoupVi
Copy link
Member

Can one of the french ppl tell me if the last edit was correct? DO NO EDIT THROUGH GITHUB IT BREAKS EVERYTHING

@neocerber
Copy link
Contributor

As one of the french people, I confirm that the last edit, e199982, is correct.

@NewSoupVi
Copy link
Member

NewSoupVi commented Aug 17, 2024

Thanks! Gonna wait for Rever to comment and then I'll merge

Copy link
Contributor

@benny-dreamly benny-dreamly left a comment

Choose a reason for hiding this comment

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

forgot about this but the French segment looks good

The Witness a un tracker fonctionnel qui supporte l'auto-tracking.

1. Téléchargez [The Witness Map- and Auto-Tracker](https://github.com/NewSoupVi/witness_archipelago_tracker/releases) et [PopTracker](https://github.com/black-sliver/PopTracker/releases).
2. Ouvrez Poptracker, puis chargez le pack Witness.
Copy link

Choose a reason for hiding this comment

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

J'utiliserais "L'ancez Poptracker", pour se coller aux autres instructions.

3. Cliquez sur l'icone "AP" qui se situe au dessus de la carte.
4. Inscrivez l'adresse Archipelago, votre nom de joueur et le mot de passe du jeu multimonde.

Le reste devrait être pris en charge par Poptracker - les items que vous recevrez et les puzzles que vous résolverez seront automatiquement indiqués. De plus, Poptracker est en mesure de détecter
Copy link

Choose a reason for hiding this comment

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

résolverez -> résoudrez

4. Inscrivez l'adresse Archipelago, votre nom de joueur et le mot de passe du jeu multimonde.

Le reste devrait être pris en charge par Poptracker - les items que vous recevrez et les puzzles que vous résolverez seront automatiquement indiqués. De plus, Poptracker est en mesure de détecter
vos paramètres de jeu - les puzzles accessibles seront alors masqués ou affichés en fonction de vos paramètres de randomization et de logique. Veuillez noter que le tracker peut être obsolète.
Copy link

Choose a reason for hiding this comment

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

I think the note about the poptracker being out of date can probably be removed? It doesn't seem to appear to be in the english version (anymore?)

Otherwise, I'd probably word it more along the lines of "Veuillez noter que le pack peut demander une mise à jour". Obsolete sounds a too final.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation. waiting-on: author Issue/PR is waiting for feedback or changes from its author. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet.
Projects
None yet
Development

Successfully merging this pull request may close these issues.