From d3cde544e159aea3745e4f66bc9a49c1e818f36f Mon Sep 17 00:00:00 2001 From: peartown Date: Jan 31 2022 18:05:47 +0000 Subject: New weblate.adoc - transfer from wiki Rework of weblate.adoc, based on https://fedoraproject.org/wiki/L10N/Translate_on_Weblate. Also screenshots reused. --- diff --git a/modules/ROOT/assets/images/Add_to_watchlist.png b/modules/ROOT/assets/images/Add_to_watchlist.png new file mode 100644 index 0000000..c13b856 Binary files /dev/null and b/modules/ROOT/assets/images/Add_to_watchlist.png differ diff --git a/modules/ROOT/assets/images/Login_redirect_fas.png b/modules/ROOT/assets/images/Login_redirect_fas.png new file mode 100644 index 0000000..6e78ff7 Binary files /dev/null and b/modules/ROOT/assets/images/Login_redirect_fas.png differ diff --git a/modules/ROOT/assets/images/Project_search.png b/modules/ROOT/assets/images/Project_search.png new file mode 100644 index 0000000..3f79935 Binary files /dev/null and b/modules/ROOT/assets/images/Project_search.png differ diff --git a/modules/ROOT/assets/images/Single_string_mode.png b/modules/ROOT/assets/images/Single_string_mode.png new file mode 100644 index 0000000..065657a Binary files /dev/null and b/modules/ROOT/assets/images/Single_string_mode.png differ diff --git a/modules/ROOT/assets/images/Weblate_Login-Register.png b/modules/ROOT/assets/images/Weblate_Login-Register.png new file mode 100644 index 0000000..9b8fde1 Binary files /dev/null and b/modules/ROOT/assets/images/Weblate_Login-Register.png differ diff --git a/modules/ROOT/assets/images/Weblate_editor_zen_mode.png b/modules/ROOT/assets/images/Weblate_editor_zen_mode.png new file mode 100644 index 0000000..96d359b Binary files /dev/null and b/modules/ROOT/assets/images/Weblate_editor_zen_mode.png differ diff --git a/modules/ROOT/pages/weblate.adoc b/modules/ROOT/pages/weblate.adoc index 9315d32..26c2716 100644 --- a/modules/ROOT/pages/weblate.adoc +++ b/modules/ROOT/pages/weblate.adoc @@ -1,2 +1,62 @@ +include::{partialsdir}/attributes.adoc[] + += How to use Weblate +:experimental: + +This page describes in basic (ie. non-exhaustive) manner how to use and translate on the contemporary translation platform used by the Fedora Localization team. +The platform is a specific Weblate's instance, which is located on https://translate.fedoraproject.org. + +== Intoduction to Weblate + +Weblate is a web based translation tool with tight version control integration. +It features a simple and clean user interface, propagation of translations across components, quality checks and automatic linking to source files. + +More information about Weblate can be found on https://weblate.org. + +NOTE: Fedora's translation platform is an instance of an upstream Weblate project's software run on translate.fedoraproject.org. +The instance is tailored to some specific needs of the Fedora Project. +To distinguish the instance from the upstream project further down this document, the notion _Weblate_ means the Fedora's {WEBLATE}[Weblate] instance, whereas _Weblate software_ denotes the upstream project. + +== Login to Weblate + +A user must be logged in to Weblate in order to translate. +Weblate access is tightly coupled with https://docs.fedoraproject.org/en-US/fedora-accounts[Fedora Accounts], as a consequence, it cannot be accessed without a Fedora Account ID (your username). +How to create such account please see xref:join.adoc#Create a FAS account[Create a Fedora Account]. + +Once you have FAS ID, you can click the btn:[Login] to access Weblate and begin your contribution. + +image:Weblate_Login-Register.png[] + +image:Login_redirect_fas.png[] + +== Weblate User Interface + +After you've logged in successfully, you can find the project you want to translate by clicking btn:[Projects] link on top of the page. +There is a btn:[Watching] button on right side of the page of each project. You can simply click that button to add the project to your watching list. +When you login again next time, it will appear in your _Dashboard/Watched Translations_. So you can click the btn:[Translate] button next to the project to begin your translation without having to navigate the project first. + +image:Add_to_watchlist.png[] + +=== Online Translation === + +There are two available modes for translators when they translate using the Weblate online editor: _Zen_ mode and _Full Editor_ mode (single string mode). +Single string mode contains only one string in the page, but provides very detailed information about the string. +On the other hand, in Zen mode, detailed information is hidden, multiple of strings are shown in the page instead, which helps the translator to move to the next string very quickly. +Switching between two modes is quite easy, just click btn:[Exit Zen] or btn:[Zen] on the top right of the page, it's located to the left of the preference icon. + +* Zen Mode: + +image:Weblate_editor_zen_mode.png[] + +* Single String Mode: + +image:Single_string_mode.png[] + +Weblate features an advanced search function, which makes the string filtering easier. +The btn:[Search] button is located at the top left of the editor, below the project navigation. +Furthermore, a search can also be done through the project overview page. + +image:Project_search.png[] + +For further information about using Weblate software, please visit the official https://docs.weblate.org[Weblate Documentation]. -TBD