====== Translation suggestions ======
Pootle has the ability to optionally allow users to provide suggestions that need to be reviewed before they are accepted into the real translation files. Who is allowed to do what, is determined by the configuration of [[permissions]] for the project or the server.

===== Viewing and making suggestions =====
When translating, suggestions are shown inline so they're always visible.
If a user wants to view all the suggestions within a project scope, it just needs to go to the "Review" tab and click on the "View Suggestions" link. Users with rights to translate will be shown a "Review Suggestions" link and will be able to accept and reject suggestions.

Users with rights for making suggestions will see a "Suggest" button next to "Submit". Making a suggestions is as easy as clicking the button -- hey, did you expect more steps involved?

===== Reviewing suggestions =====
In order to review suggestions, users must have privileges to translate. There are two ways for reviewing suggestions: going through all of them, or reviewing while translating.

To go through all of them, the reviewer must click on "Review Suggestions" within the "Review" tab of the project. This would guide her/him through all the suggestions available for the current view.

The second method is straightforward, since suggestions are shown throughout the translation process. Additionally, buttons for accepting and rejecting the suggestions are displayed.

While reviewing a suggestion, a coloured difference between the current translation and the suggestion is displayed. If available, the username is provided of the user that gave the suggestion.

A click on the green tick icon approves the selected suggestion while the red cross rejects the selected suggestion. A suggestion approval doesn't imply the rejection of the remaining suggestions.
No page reload is needed since all the requests are done using AJAX methods.

===== PO projects =====

The PO format does not specify a way for storing suggestions in the files. In PO based projects, we therefore store suggestions in .pending files next to the real PO files. Location comments (#: comments) are used to match suggestions with the translations. If your PO file does not have #: comments, or if these comments are not unique for each translation unit, the matching won't work. This can be addressed by adding any unique #: comments to the POT file and updating translations to the new POT file.

Note that this way of matching might also affect a team after upgrading to new templates if the location comments changed in the POT file. Therefore suggestions should ideally be reviewed before upgrading to newer templates.

===== XLIFF projects =====
In XLIFF based projects, suggestions are stored in alt-trans tags. Note that if files are uploaded with the "overwrite" choice, these suggestions in the version on the server will be lost, or replaced with whatever existed in the uploaded file.