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

Document how to update translations #37

Open
tordans opened this issue Mar 21, 2024 · 2 comments
Open

Document how to update translations #37

tordans opened this issue Mar 21, 2024 · 2 comments

Comments

@tordans
Copy link

tordans commented Mar 21, 2024

Do we have to update the strings like

"CreatingCooperativeChallanges.content1": "Cooperative Challenges allow in-progress (uncommitted) mapping work to be packaged with tasks so that mappers don't have to do all the work themselves from scratch. When a mapper chooses to edit the task in MapRoulette, the in-progress work will automatically be loaded into the mapper's editor so that they can verify and complete the work as needed.\n\n> Note: JOSM is currently the only supported editor for Cooperative Challenges, but integration with additional editors is under way\n\nAside from the initial editing work being automatically loaded into the mapper's editor, the mapping workflow for Cooperative tasks is otherwise identical to normal tasks: the mapper still chooses to Edit the task, they still perform the editing work in their editor, they still upload and commit their work to OSM through their editor, and they still mark the task as Finished or another appropriate status in MapRoulette when complete.\n\n### Creating Cooperative Challenges\n\n#### With the `mr-cli` utility (recommended)\n\nThe simplest way to create cooperative challenges is with the [mr-cli](https://www.npmjs.com/package/@maproulette/mr-cli) command-line utility, which can generate challenges from saved JOSM (.osm) or OSM Change (.osc) files. See the tool's documentation for details and examples of use.\n\n#### With GeoJSON\n\nCooperative challenges can also be created by including additional data with each task in the GeoJSON, including an [OSMChange (.osc)](https://wiki.openstreetmap.org/wiki/OsmChange) file that represents the in-progress work that is to be loaded into the mapper's editor for the task. The additional data should be included in a `cooperativeWork` object associated with each task's `FeatureCollection` in the challenge's [line-by-line GeoJSON](/documentation/line-by-line-geojson/) file.\n\n> :warning: Only [line-by-line GeoJSON](/documentation/line-by-line-geojson/) is supported for cooperative challenges. If you use a traditional GeoJSON format, your cooperativeWork section will simply be ignored and you will end up with normal tasks instead of cooperative tasks\n\nThe structure of the `cooperativeWork` object is designed to be flexible to support various options, formats, and encodings in the future, but at the moment only a very specific combination of values is supported.\n\nThe following example demonstrates the structure, shown here over multiple lines for readability.",
manually inline or is there some UI?

Please add some docs that explain how to update the files.

@tordans
Copy link
Author

tordans commented Mar 21, 2024

Depending on the way those strings are created, it would be great if this could be refactored to use JS template literals, which would make the whole thing easier to read, get rid of the \n and improve the diff view. Diffs like 506de33 are not really usefull…

@jschwarz2030
Copy link
Contributor

I agree, updating the English translations does not have an ideal method. For now I am using a JSON.parse web tool and converting it back to a string. This is all for making the translation files compatible with transifex

For other languages, use transifex to update the translations.

Depending on the way those strings are created, it would be great if this could be refactored to use JS template literals, which would make the whole thing easier to read, get rid of the \n and improve the diff view. Diffs like 506de33 are not really usefull…

Do you have a suggested approach for this that also allows it to work with transifex?

Thanks.

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

No branches or pull requests

2 participants