diff --git a/docs/images/account-activated.png b/docs/images/account-activated.png new file mode 100644 index 0000000000..921f1ddbfb Binary files /dev/null and b/docs/images/account-activated.png differ diff --git a/docs/images/account-resend-activation.png b/docs/images/account-resend-activation.png new file mode 100644 index 0000000000..02e2d515bd Binary files /dev/null and b/docs/images/account-resend-activation.png differ diff --git a/docs/images/account-settings-email.png b/docs/images/account-settings-email.png new file mode 100644 index 0000000000..f7be1ead5b Binary files /dev/null and b/docs/images/account-settings-email.png differ diff --git a/docs/images/account-settings-languages.png b/docs/images/account-settings-languages.png new file mode 100644 index 0000000000..2121e40bc2 Binary files /dev/null and b/docs/images/account-settings-languages.png differ diff --git a/docs/images/account-settings-password.png b/docs/images/account-settings-password.png new file mode 100644 index 0000000000..cb5126b4c0 Binary files /dev/null and b/docs/images/account-settings-password.png differ diff --git a/docs/images/account-signup-openid-details.png b/docs/images/account-signup-openid-details.png new file mode 100644 index 0000000000..e17a2fbf64 Binary files /dev/null and b/docs/images/account-signup-openid-details.png differ diff --git a/docs/images/admin-contact-link.png b/docs/images/admin-contact-link.png new file mode 100644 index 0000000000..a71e9c218c Binary files /dev/null and b/docs/images/admin-contact-link.png differ diff --git a/docs/images/admin-contact.png b/docs/images/admin-contact.png new file mode 100644 index 0000000000..91a0911398 Binary files /dev/null and b/docs/images/admin-contact.png differ diff --git a/docs/images/admin-menu-access.png b/docs/images/admin-menu-access.png new file mode 100644 index 0000000000..c03d4230a2 Binary files /dev/null and b/docs/images/admin-menu-access.png differ diff --git a/docs/images/admin-sections.png b/docs/images/admin-sections.png new file mode 100644 index 0000000000..688bcae463 Binary files /dev/null and b/docs/images/admin-sections.png differ diff --git a/docs/images/copy-trans-access.png b/docs/images/copy-trans-access.png new file mode 100644 index 0000000000..256650bd7c Binary files /dev/null and b/docs/images/copy-trans-access.png differ diff --git a/docs/images/copy-trans-dialog.png b/docs/images/copy-trans-dialog.png new file mode 100644 index 0000000000..4dd48a7660 Binary files /dev/null and b/docs/images/copy-trans-dialog.png differ diff --git a/docs/images/copy-trans-newversion.png b/docs/images/copy-trans-newversion.png new file mode 100644 index 0000000000..d8fde14ee8 Binary files /dev/null and b/docs/images/copy-trans-newversion.png differ diff --git a/docs/images/copy-trans-permissive.png b/docs/images/copy-trans-permissive.png new file mode 100644 index 0000000000..f745af0caf Binary files /dev/null and b/docs/images/copy-trans-permissive.png differ diff --git a/docs/images/copy-trans-strict.png b/docs/images/copy-trans-strict.png new file mode 100644 index 0000000000..38e014a37a Binary files /dev/null and b/docs/images/copy-trans-strict.png differ diff --git a/docs/images/copy-version-access.png b/docs/images/copy-version-access.png new file mode 100644 index 0000000000..46c523aaca Binary files /dev/null and b/docs/images/copy-version-access.png differ diff --git a/docs/images/copy-version-access2.png b/docs/images/copy-version-access2.png new file mode 100644 index 0000000000..b9c6d951bb Binary files /dev/null and b/docs/images/copy-version-access2.png differ diff --git a/docs/images/copy-version.png b/docs/images/copy-version.png new file mode 100644 index 0000000000..27af96eade Binary files /dev/null and b/docs/images/copy-version.png differ diff --git a/docs/images/create-group-completed.png b/docs/images/create-group-completed.png new file mode 100644 index 0000000000..43fd06fa68 Binary files /dev/null and b/docs/images/create-group-completed.png differ diff --git a/docs/images/create-group.png b/docs/images/create-group.png new file mode 100644 index 0000000000..41b4600fc3 Binary files /dev/null and b/docs/images/create-group.png differ diff --git a/docs/images/create-project-completed.png b/docs/images/create-project-completed.png index b205bb6b2f..98df2d84fa 100644 Binary files a/docs/images/create-project-completed.png and b/docs/images/create-project-completed.png differ diff --git a/docs/images/create-project.png b/docs/images/create-project.png index 228d98d5b1..4ccc02c220 100644 Binary files a/docs/images/create-project.png and b/docs/images/create-project.png differ diff --git a/docs/images/create-version-master.png b/docs/images/create-version-master.png deleted file mode 100644 index d73f9f7a04..0000000000 Binary files a/docs/images/create-version-master.png and /dev/null differ diff --git a/docs/images/create-version.png b/docs/images/create-version.png deleted file mode 100644 index 6d3e112450..0000000000 Binary files a/docs/images/create-version.png and /dev/null differ diff --git a/docs/images/editor-approve-button.png b/docs/images/editor-approve-button.png new file mode 100644 index 0000000000..50180410a3 Binary files /dev/null and b/docs/images/editor-approve-button.png differ diff --git a/docs/images/editor-approved.png b/docs/images/editor-approved.png new file mode 100644 index 0000000000..6b6ea80702 Binary files /dev/null and b/docs/images/editor-approved.png differ diff --git a/docs/images/editor-doc-list-settings.png b/docs/images/editor-doc-list-settings.png new file mode 100644 index 0000000000..0c4a99758a Binary files /dev/null and b/docs/images/editor-doc-list-settings.png differ diff --git a/docs/images/editor-doc-list-validations.png b/docs/images/editor-doc-list-validations.png new file mode 100644 index 0000000000..75703636da Binary files /dev/null and b/docs/images/editor-doc-list-validations.png differ diff --git a/docs/images/editor-doc-list.png b/docs/images/editor-doc-list.png new file mode 100644 index 0000000000..434cf0fda8 Binary files /dev/null and b/docs/images/editor-doc-list.png differ diff --git a/docs/images/editor-filter-translated.png b/docs/images/editor-filter-translated.png new file mode 100644 index 0000000000..9abca4e245 Binary files /dev/null and b/docs/images/editor-filter-translated.png differ diff --git a/docs/images/editor-history-button.png b/docs/images/editor-history-button.png new file mode 100644 index 0000000000..58dc4d06e1 Binary files /dev/null and b/docs/images/editor-history-button.png differ diff --git a/docs/images/editor-open-menu.png b/docs/images/editor-open-menu.png new file mode 100644 index 0000000000..a7562b3056 Binary files /dev/null and b/docs/images/editor-open-menu.png differ diff --git a/docs/images/editor-overview.png b/docs/images/editor-overview.png new file mode 100644 index 0000000000..6f6df8bab7 Binary files /dev/null and b/docs/images/editor-overview.png differ diff --git a/docs/images/editor-readonly-indicator.png b/docs/images/editor-readonly-indicator.png new file mode 100644 index 0000000000..d7c5dc197c Binary files /dev/null and b/docs/images/editor-readonly-indicator.png differ diff --git a/docs/images/editor-reject-dialog.png b/docs/images/editor-reject-dialog.png new file mode 100644 index 0000000000..52fefd2ae8 Binary files /dev/null and b/docs/images/editor-reject-dialog.png differ diff --git a/docs/images/editor-rejected-history.png b/docs/images/editor-rejected-history.png new file mode 100644 index 0000000000..6c213fe586 Binary files /dev/null and b/docs/images/editor-rejected-history.png differ diff --git a/docs/images/editor-rejected-with-comment.png b/docs/images/editor-rejected-with-comment.png new file mode 100644 index 0000000000..2b12de627e Binary files /dev/null and b/docs/images/editor-rejected-with-comment.png differ diff --git a/docs/images/editor-settings.png b/docs/images/editor-settings.png new file mode 100644 index 0000000000..6c02d10d2e Binary files /dev/null and b/docs/images/editor-settings.png differ diff --git a/docs/images/editor-translated-strings.png b/docs/images/editor-translated-strings.png new file mode 100644 index 0000000000..a2c4774c95 Binary files /dev/null and b/docs/images/editor-translated-strings.png differ diff --git a/docs/images/editor-validations.png b/docs/images/editor-validations.png new file mode 100644 index 0000000000..bea3ba7663 Binary files /dev/null and b/docs/images/editor-validations.png differ diff --git a/docs/images/editor-views-icon.png b/docs/images/editor-views-icon.png new file mode 100644 index 0000000000..c8f13317d2 Binary files /dev/null and b/docs/images/editor-views-icon.png differ diff --git a/docs/images/glossary-csv.png b/docs/images/glossary-csv.png new file mode 100644 index 0000000000..66f6f514e6 Binary files /dev/null and b/docs/images/glossary-csv.png differ diff --git a/docs/images/glossary-upload-windows-po.png b/docs/images/glossary-upload-windows-po.png new file mode 100644 index 0000000000..70b42a634d Binary files /dev/null and b/docs/images/glossary-upload-windows-po.png differ diff --git a/docs/images/glossary-upload-windows.png b/docs/images/glossary-upload-windows.png new file mode 100644 index 0000000000..8539ee231e Binary files /dev/null and b/docs/images/glossary-upload-windows.png differ diff --git a/docs/images/glossary-upload.png b/docs/images/glossary-upload.png new file mode 100644 index 0000000000..6e36b04c18 Binary files /dev/null and b/docs/images/glossary-upload.png differ diff --git a/docs/images/group-general-settings.png b/docs/images/group-general-settings.png new file mode 100644 index 0000000000..0c02c90eed Binary files /dev/null and b/docs/images/group-general-settings.png differ diff --git a/docs/images/group-languages-settings.png b/docs/images/group-languages-settings.png new file mode 100644 index 0000000000..cf10393987 Binary files /dev/null and b/docs/images/group-languages-settings.png differ diff --git a/docs/images/group-maintainer-settings.png b/docs/images/group-maintainer-settings.png new file mode 100644 index 0000000000..6a43302755 Binary files /dev/null and b/docs/images/group-maintainer-settings.png differ diff --git a/docs/images/group-projects-remove.png b/docs/images/group-projects-remove.png new file mode 100644 index 0000000000..3962165d23 Binary files /dev/null and b/docs/images/group-projects-remove.png differ diff --git a/docs/images/group-projects-settings.png b/docs/images/group-projects-settings.png new file mode 100644 index 0000000000..4ce727773c Binary files /dev/null and b/docs/images/group-projects-settings.png differ diff --git a/docs/images/group-request-join-dialog.png b/docs/images/group-request-join-dialog.png new file mode 100644 index 0000000000..e26eb2df7b Binary files /dev/null and b/docs/images/group-request-join-dialog.png differ diff --git a/docs/images/group-request-join.png b/docs/images/group-request-join.png new file mode 100644 index 0000000000..d5cb2166b0 Binary files /dev/null and b/docs/images/group-request-join.png differ diff --git a/docs/images/group-settings-button.png b/docs/images/group-settings-button.png new file mode 100644 index 0000000000..18df7b4d2e Binary files /dev/null and b/docs/images/group-settings-button.png differ diff --git a/docs/images/group-view-languages.png b/docs/images/group-view-languages.png new file mode 100644 index 0000000000..1798904f44 Binary files /dev/null and b/docs/images/group-view-languages.png differ diff --git a/docs/images/language-add-member.png b/docs/images/language-add-member.png new file mode 100644 index 0000000000..2ce1f485d7 Binary files /dev/null and b/docs/images/language-add-member.png differ diff --git a/docs/images/language-contact-coordinator.png b/docs/images/language-contact-coordinator.png new file mode 100644 index 0000000000..d30d66060c Binary files /dev/null and b/docs/images/language-contact-coordinator.png differ diff --git a/docs/images/language-contact-menu.png b/docs/images/language-contact-menu.png new file mode 100644 index 0000000000..6c65b8ad21 Binary files /dev/null and b/docs/images/language-contact-menu.png differ diff --git a/docs/images/language-leave-team.png b/docs/images/language-leave-team.png new file mode 100644 index 0000000000..61335cfcc2 Binary files /dev/null and b/docs/images/language-leave-team.png differ diff --git a/docs/images/language-members-tab.png b/docs/images/language-members-tab.png new file mode 100644 index 0000000000..5579c37cf1 Binary files /dev/null and b/docs/images/language-members-tab.png differ diff --git a/docs/images/language-request-join-menu.png b/docs/images/language-request-join-menu.png new file mode 100644 index 0000000000..69ec04c7b5 Binary files /dev/null and b/docs/images/language-request-join-menu.png differ diff --git a/docs/images/language-request-join.png b/docs/images/language-request-join.png new file mode 100644 index 0000000000..951933511f Binary files /dev/null and b/docs/images/language-request-join.png differ diff --git a/docs/images/merge-trans-access.png b/docs/images/merge-trans-access.png new file mode 100644 index 0000000000..72f4d645ba Binary files /dev/null and b/docs/images/merge-trans-access.png differ diff --git a/docs/images/merge-trans-dialog.png b/docs/images/merge-trans-dialog.png new file mode 100644 index 0000000000..f97b249e84 Binary files /dev/null and b/docs/images/merge-trans-dialog.png differ diff --git a/docs/images/project-about-settings.png b/docs/images/project-about-settings.png index 8d0dca0281..4ffe063ec2 100644 Binary files a/docs/images/project-about-settings.png and b/docs/images/project-about-settings.png differ diff --git a/docs/images/project-general-settings.png b/docs/images/project-general-settings.png index 68852619c7..15e00d1d0e 100644 Binary files a/docs/images/project-general-settings.png and b/docs/images/project-general-settings.png differ diff --git a/docs/images/project-languages-add.png b/docs/images/project-languages-add.png index 8652922c62..83f74cd0b8 100644 Binary files a/docs/images/project-languages-add.png and b/docs/images/project-languages-add.png differ diff --git a/docs/images/project-languages-remove.png b/docs/images/project-languages-remove.png index c522b48101..9acf0e0451 100644 Binary files a/docs/images/project-languages-remove.png and b/docs/images/project-languages-remove.png differ diff --git a/docs/images/project-languages-settings.png b/docs/images/project-languages-settings.png index 815b263e36..a9d0fee3b0 100644 Binary files a/docs/images/project-languages-settings.png and b/docs/images/project-languages-settings.png differ diff --git a/docs/images/project-permissions-settings.png b/docs/images/project-permissions-settings.png index d5cc7cacde..b67604d491 100644 Binary files a/docs/images/project-permissions-settings.png and b/docs/images/project-permissions-settings.png differ diff --git a/docs/images/project-settings-button.png b/docs/images/project-settings-button.png index 818a913842..bfc2e4e72a 100644 Binary files a/docs/images/project-settings-button.png and b/docs/images/project-settings-button.png differ diff --git a/docs/images/project-translation-settings.png b/docs/images/project-translation-settings.png index bf94223b8d..dfb2ff9924 100644 Binary files a/docs/images/project-translation-settings.png and b/docs/images/project-translation-settings.png differ diff --git a/docs/images/project-user-search.png b/docs/images/project-user-search.png new file mode 100644 index 0000000000..5446dd7ed1 Binary files /dev/null and b/docs/images/project-user-search.png differ diff --git a/docs/images/project-view-versions.png b/docs/images/project-view-versions.png index b73fad68e1..9400fdeed6 100644 Binary files a/docs/images/project-view-versions.png and b/docs/images/project-view-versions.png differ diff --git a/docs/images/project-webhooks-settings-2.png b/docs/images/project-webhooks-settings-2.png new file mode 100644 index 0000000000..ae1b1ca8da Binary files /dev/null and b/docs/images/project-webhooks-settings-2.png differ diff --git a/docs/images/project-webhooks-settings.png b/docs/images/project-webhooks-settings.png new file mode 100644 index 0000000000..47b07428e3 Binary files /dev/null and b/docs/images/project-webhooks-settings.png differ diff --git a/docs/images/upload-new-source-doc.png b/docs/images/upload-new-source-doc.png new file mode 100644 index 0000000000..80a7095a33 Binary files /dev/null and b/docs/images/upload-new-source-doc.png differ diff --git a/docs/images/upload-source-doc-dialog.png b/docs/images/upload-source-doc-dialog.png new file mode 100644 index 0000000000..1d0e8ee670 Binary files /dev/null and b/docs/images/upload-source-doc-dialog.png differ diff --git a/docs/images/upload-source-doc-from-settings.png b/docs/images/upload-source-doc-from-settings.png new file mode 100644 index 0000000000..85a6445b0e Binary files /dev/null and b/docs/images/upload-source-doc-from-settings.png differ diff --git a/docs/images/upload-source-doc.png b/docs/images/upload-source-doc.png new file mode 100644 index 0000000000..cf7298b5b8 Binary files /dev/null and b/docs/images/upload-source-doc.png differ diff --git a/docs/images/upload-translation-doc-dialog.png b/docs/images/upload-translation-doc-dialog.png new file mode 100644 index 0000000000..d4aa03a1bc Binary files /dev/null and b/docs/images/upload-translation-doc-dialog.png differ diff --git a/docs/images/upload-translation-doc.png b/docs/images/upload-translation-doc.png new file mode 100644 index 0000000000..0cdf22ba99 Binary files /dev/null and b/docs/images/upload-translation-doc.png differ diff --git a/docs/images/user-dashboard-create-version.png b/docs/images/user-dashboard-create-version.png index b3187542dd..a9f387a726 100644 Binary files a/docs/images/user-dashboard-create-version.png and b/docs/images/user-dashboard-create-version.png differ diff --git a/docs/images/user-dashboard-versions.png b/docs/images/user-dashboard-versions.png new file mode 100644 index 0000000000..0c99620843 Binary files /dev/null and b/docs/images/user-dashboard-versions.png differ diff --git a/docs/images/user-dashboard-view.png b/docs/images/user-dashboard-view.png new file mode 100644 index 0000000000..299a2008f0 Binary files /dev/null and b/docs/images/user-dashboard-view.png differ diff --git a/docs/images/user-dashboard.png b/docs/images/user-dashboard.png new file mode 100644 index 0000000000..37127289b4 Binary files /dev/null and b/docs/images/user-dashboard.png differ diff --git a/docs/images/user-profile.png b/docs/images/user-profile.png new file mode 100644 index 0000000000..79084ee76b Binary files /dev/null and b/docs/images/user-profile.png differ diff --git a/docs/images/version-create-new.png b/docs/images/version-create-new.png new file mode 100644 index 0000000000..f4b3518f05 Binary files /dev/null and b/docs/images/version-create-new.png differ diff --git a/docs/images/version-create.png b/docs/images/version-create.png new file mode 100644 index 0000000000..f215f07438 Binary files /dev/null and b/docs/images/version-create.png differ diff --git a/docs/images/version-documents-settings.png b/docs/images/version-documents-settings.png new file mode 100644 index 0000000000..fa748552c3 Binary files /dev/null and b/docs/images/version-documents-settings.png differ diff --git a/docs/images/version-download-translations-all-dialog.png b/docs/images/version-download-translations-all-dialog.png new file mode 100644 index 0000000000..b0c7814109 Binary files /dev/null and b/docs/images/version-download-translations-all-dialog.png differ diff --git a/docs/images/version-download-translations-all.png b/docs/images/version-download-translations-all.png new file mode 100644 index 0000000000..d25055fcdc Binary files /dev/null and b/docs/images/version-download-translations-all.png differ diff --git a/docs/images/version-download-translations.png b/docs/images/version-download-translations.png new file mode 100644 index 0000000000..00647d5683 Binary files /dev/null and b/docs/images/version-download-translations.png differ diff --git a/docs/images/version-general-settings.png b/docs/images/version-general-settings.png new file mode 100644 index 0000000000..f9bae749ab Binary files /dev/null and b/docs/images/version-general-settings.png differ diff --git a/docs/images/version-languages-settings.png b/docs/images/version-languages-settings.png new file mode 100644 index 0000000000..3aecb2e9e1 Binary files /dev/null and b/docs/images/version-languages-settings.png differ diff --git a/docs/images/version-merge-trans-cancel.png b/docs/images/version-merge-trans-cancel.png index 8eddac8038..1143bf0005 100644 Binary files a/docs/images/version-merge-trans-cancel.png and b/docs/images/version-merge-trans-cancel.png differ diff --git a/docs/images/version-merge-trans-dialog.png b/docs/images/version-merge-trans-dialog.png index b03ed7d790..ab12c5027b 100644 Binary files a/docs/images/version-merge-trans-dialog.png and b/docs/images/version-merge-trans-dialog.png differ diff --git a/docs/images/version-merge-trans-progress.png b/docs/images/version-merge-trans-progress.png index d2df13775e..3109da63b9 100644 Binary files a/docs/images/version-merge-trans-progress.png and b/docs/images/version-merge-trans-progress.png differ diff --git a/docs/images/version-more-action-menu.png b/docs/images/version-more-action-menu.png index 538ebd23c5..318ad8c2c4 100644 Binary files a/docs/images/version-more-action-menu.png and b/docs/images/version-more-action-menu.png differ diff --git a/docs/images/version-settings-button.png b/docs/images/version-settings-button.png new file mode 100644 index 0000000000..bfc2e4e72a Binary files /dev/null and b/docs/images/version-settings-button.png differ diff --git a/docs/images/version-translation-settings.png b/docs/images/version-translation-settings.png new file mode 100644 index 0000000000..63eef86bb6 Binary files /dev/null and b/docs/images/version-translation-settings.png differ diff --git a/docs/images/version-view-languages.png b/docs/images/version-view-languages.png index e54b3fd3cd..40f3dd3100 100644 Binary files a/docs/images/version-view-languages.png and b/docs/images/version-view-languages.png differ diff --git a/docs/images/webtrans-access.png b/docs/images/webtrans-access.png new file mode 100644 index 0000000000..a8497935ef Binary files /dev/null and b/docs/images/webtrans-access.png differ diff --git a/docs/index.md b/docs/index.md index 003e2669fc..79b0779b2e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,4 +19,32 @@ For help and support options, see [Help|Zanata](http://zanata.org/help/) License ------- -Zanata is Free software, licensed under the [LGPL](http://www.gnu.org/licenses/lgpl-2.1.html). \ No newline at end of file +Zanata is Free software, licensed under the [LGPL](http://www.gnu.org/licenses/lgpl-2.1.html). + +Release notes +------- + +[Release notes](release-notes.md) + +Contact us +------- + + \ No newline at end of file diff --git a/docs/user-guide/Opening-a-Translation-Project.md b/docs/user-guide/Opening-a-Translation-Project.md deleted file mode 100644 index 8628d421bd..0000000000 --- a/docs/user-guide/Opening-a-Translation-Project.md +++ /dev/null @@ -1,2 +0,0 @@ -_TBD_ - diff --git a/docs/user-guide/account/account-activate.md b/docs/user-guide/account/account-activate.md new file mode 100644 index 0000000000..0e84b98271 --- /dev/null +++ b/docs/user-guide/account/account-activate.md @@ -0,0 +1,14 @@ +#Activate account + +After signing up with Zanata, you will need to activate the account before being able to perform any tasks. + +To activate your account: + + 1. Check your email used for signup in Zanata. You should have received an email with subject `Zanata account activation`. + 1. If you didn't receive an email from Zanata, see [Resend activation email](user-guide/account/account-resend-activation). + 1. Click the `Account activation link` in your email or copy and paste the URL provided into your browser. + 1. You will be redirected to Zanata with your account activated. You can now log in with your details. + +Account activated + +*Note: The activation URL will expire after 24 hours.* \ No newline at end of file diff --git a/docs/user-guide/account/account-resend-activation.md b/docs/user-guide/account/account-resend-activation.md new file mode 100644 index 0000000000..5feac71063 --- /dev/null +++ b/docs/user-guide/account/account-resend-activation.md @@ -0,0 +1,10 @@ +# Resend activation email + +If you didn't receive an email after signing up, or entered wrong email address during signing up, you can always request to resend the account activation email or update your email address. + + 1. Log in to Zanata with your username and password that you used when signing up. + 1. You will be redirected to `account inactive` page. + 1. To resend activation email to the same email address, click on `Resend activation email` button. + 1. To update email address and send activation email, enter the new email address in the input field and click `Update email`. + +Resend activation or update email address \ No newline at end of file diff --git a/docs/user-guide/account/account-settings.md b/docs/user-guide/account/account-settings.md new file mode 100644 index 0000000000..54aa2610ff --- /dev/null +++ b/docs/user-guide/account/account-settings.md @@ -0,0 +1,57 @@ +# Account Settings + +To access your user settings: + + 1. Login to Zanata + 1. Click on `User menu` on top right corner, click on `Settings` on the drop down menu. + 1. Alternatively, you can click on the `Settings` tab on your dashboard page. + +## Account Settings + +### Update email + + 1. Enter the new email address in input field and click `Update email`. + + Email input field + + 1. A confirmation email will be sent to the new email address. Click on the link or the URL to confirm email address change. + +### Change password + + 1. Fill in the `Old Password` and `New Password` fields. + + Password input field + + 1. Click `Update password` to change your password. + +### Merge with other account + +Use this to merge additional Zanata accounts you may have created when signing up with a connected account. + + 1. Select and login into any connected account that you wish to merge with current logged in account. + 1. Click `Merge account` button merge from the selected connected account into current logged in account. + +## Profile + +1. To update your name, fill in updated name in input field and click `Update profile`. + +## Languages + +This page shows all the language teams you have joined in Zanata. + +Languages + +To join more language teams, + + 1. Click on `Join a language team`. + 1. See [Joining language team](user-guide/languages/language-team#joining-a-language-team). + +## Client + +API key is a unique identifier used for authentication between client and Zanata server. +Both [Zanata CLI](http://zanata-client.readthedocs.org/en/latest/installation) and [Zanata Maven plugin](http://zanata-client.readthedocs.org/en/latest/maven-plugin/installation/) uses it. + + 1. To generate an API Key, click on `Generate new API Key` button. + 1. The updated settings for your Zanata client are available in the text area below. + +For more information on setting up Zanata client, see [Zanata Client configuration](http://zanata-client.readthedocs.org/en/latest/configuration/). \ No newline at end of file diff --git a/docs/user-guide/account/account-sign-up.md b/docs/user-guide/account/account-sign-up.md new file mode 100644 index 0000000000..a23538085b --- /dev/null +++ b/docs/user-guide/account/account-sign-up.md @@ -0,0 +1,52 @@ +# Signing Up + + +You can create an account on Zanata using an OpenID login (such as Google or Fedora), or by creating a password specific to Zanata. You can set or change your password and add OpenID accounts to your Zanata account at any time. + +*Note: If you want to translate a JBoss-related project, use the translate.jboss.org site, which requires a jboss.org account. You can create a jboss.org account at the [jboss.org registration page](https://community.jboss.org/register.jspa). The following instructions are for general open source projects on [translate.zanata.org](http://translate.zanata.org).* + +## Sign up Using OpenID + +To create an account using OpenID: + + 1. Navigate to translate.zanata.org + 1. Click `Sign up` at the upper right of the page. + 1. Select your OpenID type or enter an OpenID URL. + 1. Confirm with your OpenID provider, after which you are returned to the Zanata page. + 1. Complete the `Name`, `Username`, and `Email` fields. Ensure your email address is entered correctly. + 1. Click `Save`. This sends a validation email to the address you entered in the previous step. + 1. Open the validation email and click the validation link. + +Account signup openid + +You can now sign in to Zanata using your OpenID credentials. + + +## Sign up with a New Password + +To use a separate password for Zanata, rather than registering with your OpenID credentials: + + 1. Click `Sign up` at the upper right of the page. + 1. Complete the `Name`, `Email`, and other details. + 1. Click `Register` + 1. Open the validation email and click the validation link. + +You can now sign in to Zanata with the user name and password you entered in step 2. + + +## Adding a Password + +If you registered with OpenID, you can still set up a password and sign in directly. To set a password, click `Change Password` under your profile settings and enter the desired password. + + +## Adding OpenID Accounts to Your Zanata Account + +You can add OpenID accounts to your Zanata account after it is created. You can have several different accounts linked to the same Zanata account and sign in with any of them. + +To add an OpenID account to your Zanata account: + + 1. Click the profile avatar at the upper right of the page to display the menu pane. + 1. Click `Settings` and then click `Manage Identities`. + 1. In the `Actions` menu, click `Add New Identity` and follow the procedure described earlier. + +*Note: if you want to translate a project that falls under the Fedora CLA, you must add a Fedora OpenID to your Zanata account. You can then sign in with your password or any OpenID account and be allowed to translate Fedora projects.* diff --git a/docs/user-guide/account/user-dashboard.md b/docs/user-guide/account/user-dashboard.md new file mode 100644 index 0000000000..2dc296db56 --- /dev/null +++ b/docs/user-guide/account/user-dashboard.md @@ -0,0 +1,48 @@ +The dashboard aims to help you quickly see and navigate to content that is relevant to you. With the dashboard you can: + + - quickly get back to what you were doing + - see an overview of your projects + - read about recent events related to your activity on Zanata + +## Opening the Dashboard + +If you sign in from the Zanata homepage, the first screen you see will be the user dashboard. To get to the dashboard from another page, expand the user menu on the right and click `Dashboard`. + +User dashboard menu + +## Dashboard Information + +Dashboard has + +- user information +- joined language team +- translation statistics +- an activity stream +- list of maintained projects +- [Profile settings](user-guide/account/account-settings) + +User dashboard + +### User Information + +At the top left, you will see your profile picture, name and username, as well as a link to user settings. + +### Activity Stream + +The activity stream is on the `Activity` tab on the left of the dashboard. It aims to show recent activity relevant to you. + +The activity stream shows: + + - Translations you have done. This includes links to the project, version, language and document that was translated. There is also a link to the last translation of a batch, so you can easily pick up translating where you left off the previous day or before a break. + - Reviews you have done. This will include similar information to translations. + - Documents you have uploaded recently. This includes links to the project, version and document. + +The icon to the right of each item shows the type of activity - document uploads have a document icon, translations have a globe icon and reviews have an eye icon. + +If you have more recent activity than is shown in the activity stream, you can see more by clicking `more activity` at the bottom of the stream. + +### Projects + +In the Project tab, a list of your maintained projects is shown. The down arrow to the left of the version can be clicked to show all the versions for the project. The project name, version name link directly to the project page, version page respectively. + +User dashboard diff --git a/docs/user-guide/user-profile.md b/docs/user-guide/account/user-profile.md similarity index 71% rename from docs/user-guide/user-profile.md rename to docs/user-guide/account/user-profile.md index 95a3ae03fd..6d9232aa03 100644 --- a/docs/user-guide/user-profile.md +++ b/docs/user-guide/account/user-profile.md @@ -1,6 +1,8 @@ -# User Profile Page - You can view a user's profile page by typing the username in the top search field and click on the search result. +Project user search + On the user profile page, you can view this user's recent contribution statistics according to the selected date range option. By default it will show this week's contribution categorized by language and project. + +User profile diff --git a/docs/user-guide/admin/admin-overview.md b/docs/user-guide/admin/admin-overview.md new file mode 100644 index 0000000000..b77444d8a2 --- /dev/null +++ b/docs/user-guide/admin/admin-overview.md @@ -0,0 +1,55 @@ +Zanata admin has full access to all functionality in Zanata. + +To access to admin menu, login to Zanata with admin role user, select `Administrator`. +
+admin menu access +
+
+ +## Admin sections + +
+admin sections +
+
+ +## Server configuration + +Configuration and settings for Zanata server. + +## Manage users + +- Edit user information such as password, roles. +- Delete users in Zanata. + + +## Manage Roles + +- Create new roles to Zanata. +- Edit/Remove roles in Zanata. + +## Manage Search + +- Reindexing Zanata database used for searching. + +## Role assignment rules + +Role Assignment Rules assist with the automatic assignment of user roles to certain users when they sign in. If the user's identity (e.g. user name) matches a certain pattern and they are authenticated in a certain way (e.g. via Open Id where available), Zanata will be able to automatically add the user to a specified user Role. + +## Translation memory + +- Import/Export external TMX file for translation memory in editor. + +## Process manager + +- See all background asynchronous tasks running in Zanata. + +## Overall statistic + +Overall general statistics of Zanata. + +- Number of users, projects, documents and translations. + +## Server monitoring + +- Server performance and statistics. \ No newline at end of file diff --git a/docs/user-guide/admin/contact-admin.md b/docs/user-guide/admin/contact-admin.md new file mode 100644 index 0000000000..3a90eb87e1 --- /dev/null +++ b/docs/user-guide/admin/contact-admin.md @@ -0,0 +1,11 @@ +1. Login to Zanata. +1. At the bottom of the page, click on `Contact admin`. +
+Contact admin link +
+
+1. In the dialog, fill in the message in the input file and click `Send`. +
+Contact admin +
+
\ No newline at end of file diff --git a/docs/user-guide/api/api.md b/docs/user-guide/api/api.md new file mode 100644 index 0000000000..029c776317 --- /dev/null +++ b/docs/user-guide/api/api.md @@ -0,0 +1 @@ +All Zanata API documentation is located at [Zanata API](https://zanata.ci.cloudbees.com/job/zanata-api-site/site/zanata-common-api/rest-api-docs/index.html) \ No newline at end of file diff --git a/docs/user-guide/client-command-hook.md b/docs/user-guide/client-command-hook.md deleted file mode 100644 index eaaea4650c..0000000000 --- a/docs/user-guide/client-command-hook.md +++ /dev/null @@ -1,38 +0,0 @@ -Custom commands can be specified in zanata.xml. Custom commands can be almost any command that can run on the command line, and can be configured to run before or after a Zanata client command. This feature was added in version 3.3.0 of the CLI client and the Maven Plugin, and cannot be used in earlier versions. - -To specify one or more custom commands: - - 1. Add a `` element in zanata.xml within the `` element. - 1. For each Zanata command that will have custom commands attached, add a `` element that specifies the command as an attribute. - 1. For each custom command to run before a Zanata command, add a `` element with the command as its body. - 1. For each custom command to run after a Zanata command, add an `` element with the command as its body. - -For example, the following elements within the top-level element will generate a .pot file from a man page before push, clean up the generated file after push, and will generate a translated German man page after pull then remove all downloaded .po files. - -```xml - - - -... - - - - po4a-gettextize -f man -m manpage.1 -p manpage.pot - rm -f manpage.pot - - - po4a-translate -f man -m manpage.1 -p trans/de/manpage.po -l manpage.de.1 --keep 1 - rm -rf trans - - - -... - - -``` - -Multiple commands of the same type (i.e. "before" or "after") within a hook will be run in the order that they are specified in zanata.xml. e.g. when running pull with the above config, po4a will always run before rm. If any of these commands fails, the whole operation is aborted. e.g. when running push, if po4a fails then push and rm will not be run, and if push fails then rm will not be run. - -Note that some commands (such as 'cd') do not work as custom commands. The ranges of commands that work and that do not work as custom commands have not yet been thoroughly investigated. - -The return value of each custom command is displayed after the command is run. A return value of 0 usually indicates success, and any other number usually indicates an error. Console output from custom commands is not yet displayed or logged. \ No newline at end of file diff --git a/docs/user-guide/client-configuration.md b/docs/user-guide/client-configuration.md deleted file mode 100644 index a29a5ad95d..0000000000 --- a/docs/user-guide/client-configuration.md +++ /dev/null @@ -1,85 +0,0 @@ -# Introduction - -In general, Zanata clients should get their configuration from user config, project config and command line args (or similar). - -Command line arguments should override values found in the user/project config files. Project config should override values found in the user config (if they overlap). The user config in the user's home directory are used for any values which haven't been supplied elsewhere. In other words values are taken in order from: - -1. Command line (or similar, eg maven pom) -1. Zanata project configuration (zanata.xml) -1. Zanata user configuration (zanata.ini) - -Note that some versions of Maven have a [bug](http://jira.codehaus.org/browse/MNG-1992) where pom values can't be overridden by the command line. If you want to specify a value on the command line, it may be best to leave it out of the pom. - - -## Zanata user configuration - -File location: `$HOME/.config/zanata.ini` (under a user's home directory) - -This file contains the user's general preferences and credentials for Zanata servers. - -Java/Maven/Python Example: - - [defaults] - debug = false - #errors = true - #NB: 'server' key will be removed in next release - server = local - - ### - # Server section - # Format: ServerName.Attribute=Value - # ServerName is a literature string for yourself to identify that Zanata Server - # Attributes: - # url: URL of Zanata Server - # username: Your username on that Zanata Server - # key: Your API key - # - [servers] - - # In the example below, "example", "jboss" and "localdevelinstance" - # are arbitrary identifiers for servers. - # The url value is matched with a project's zanata.xml element - # to provide the username and API key for the project - - example.url = http://translate.example.com/zanata/ - example.username = bob - example.key = 21654321651303467618640511051515 - - jboss.url = https://translate.jboss.org/ - jboss.username = robert - jboss.key = 13246817676681768761687196246543 - - localdevelinstance.url = http://localhost:8080/zanata/ - localdevelinstance.username = admin - localdevelinstance.key = 89374905823750973249502873490888 - -## Zanata project configuration - -File location: `./zanata.xml` (in a project's base directory) - -This file might be checked into a version control system along with the source files. It tells clients which Zanata server the project is linked to, and which project/version within that server. - -Example: - - - - http://localhost:8080/zanata/ - sample-project - 1.1 - - ja - zh-Hans - zh-Hant - - - -This file also specifies that the local publican PO directory "ja-JP" will be mapped to the server-side BCP47 locale "ja", and also specifies that the "zh-CN" directory will be mapped to "zh-Hanz" on the server. - - -URLs in project configuration should be matched against the [servers] defined in zanata.ini, so that the user's credentials can be used. - -(In future, it may also be used to describe the type of project, or the mapping between source filenames and Zanata document names.) - -## Command line or other mechanism (eg Maven properties) - -The client should also provide the ability to override user/project configuration values, perhaps with command line arguments or GUI options, etc. \ No newline at end of file diff --git a/docs/user-guide/client/client.md b/docs/user-guide/client/client.md new file mode 100644 index 0000000000..18cc102591 --- /dev/null +++ b/docs/user-guide/client/client.md @@ -0,0 +1 @@ +All Zanata client documentation is located at [Zanata client|readthedocs](http://zanata-client.readthedocs.org/en/latest/) \ No newline at end of file diff --git a/docs/user-guide/contributing-translations.md b/docs/user-guide/contributing-translations.md deleted file mode 100644 index 63f905459c..0000000000 --- a/docs/user-guide/contributing-translations.md +++ /dev/null @@ -1,43 +0,0 @@ -# An overview on contributing translations - -# Contributing Translations - -Any translator who has joined a Language Team can participate in the document translation process. This chapter looks at the translation process, including: - -- Opening a translation project -- Using the translation interface -- Keyboard shortcuts -- Using translation memory -- Dealing with conflicts - -# Opening a Translation Project - -## Projects - -The Projects page of your translation site will list all projects available for translation. All translators who have joined a Language Team can open these projects and translate them in the language of each respective team. - -To open a project: - -1. Click on the Projects menu option on the top menu -1. Click the title of a project you wish to translate - -## Project Information - -A project information page will appear after selecting a translation project. This includes: - -- The name of the project -- A description of the project -- The active iteration for the project -- Past iterations - -## Iterations - -An iteration is an instance or version of the project. Zanata allows for the translation of current and past versions of each project. - -Each iteration contains a number of project translations dependent upon how many Language Teams you have joined. For example, a member of the English, Chinese and French Language Teams will see project translations for English, Chinese and French under each iteration. - -Each iteration also has a progress bar for each language. Each progress bar shows the percentage of translation complete for each iteration. - -## Open an Iteration for Translation - -A translator wishing to contribute to a project translation needs to click the "Translate" link for the desired iteration and language. This takes the translator to the web-based Translation Workspace (WebTrans), which is covered in the next section. diff --git a/docs/user-guide/drupal/drupal.md b/docs/user-guide/drupal/drupal.md new file mode 100644 index 0000000000..3ff634496f --- /dev/null +++ b/docs/user-guide/drupal/drupal.md @@ -0,0 +1,11 @@ +If you wish to translate the content of a Drupal website, you can install the Drupal module TMGMT Zanata to help send text and translations between Drupal and Zanata. + +## Features +* Send text from one or more nodes in Drupal to your project in Zanata. +* Download translations from Zanata directly to the translation job in Drupal. +* Option to automatically segment text into sentences or paragraphs before it is sent to Zanata. +* Takes advantage of TMGMT's translation job management system. + +## Details + +For full installation, setup and usage instructions, visit [TMGMT Zanata | Drupal.org](https://www.drupal.org/project/tmgmt_zanata) \ No newline at end of file diff --git a/docs/user-guide/editor/documents-view.md b/docs/user-guide/editor/documents-view.md new file mode 100644 index 0000000000..ae0c5fe8dd --- /dev/null +++ b/docs/user-guide/editor/documents-view.md @@ -0,0 +1,45 @@ +
+Documents view +
+
+ +1. **Breadcrumbs** - Links to Project -> Version +2. **Statistic** - Statistic and remaining hours for the selected project version in selected language. +3. [**Views**](user-guide/editor/overview#views-in-webtrans) +4. **Search** - Allow translators to by document name. +5. **Change statistic view** - Change statistic measurement in `Words`(total words in the all documents) or `Messages` (total translation entry in all documents). +6. **Settings** - From top to bottom: Notification, Chat room, Settings, Validations. +7. **Paging** - Page navigation for document list. + +## Settings + +
+Documents view settings +
+
+ +* **Page size** - Allow user to customise documents to show per page. + +* **Layout** - Customise the view of document list with `Compact`, `Default` and `Loose`. + +* **Show System Errors** - Shows detailed messages in new windows when errors occurs. + + +## Validations + +
+Documents view settings +
+
+ +* **Run validation** - Allows user to run validations against all documents. + +------ + +1. This will run validation for the documents that are currently visible in the list (if the document list is multiple pages, validation must be run separately for each page). +2. When validation is complete, an icon is shown next to each document name on the page. A check-mark icon means the document did not have any validation warnings. A cross icon and red document name mean one or more translations in the document caused a warning. +3. Click a red document name to see all the translations that caused warnings. + +**Note:** validation icons will not change until the next time validation is run on the document, even if the translations are updated. Make sure to re-run validation after making any changes so that the results are accurate. + +See [validations](user-guide/projects/validations) for more details. \ No newline at end of file diff --git a/docs/user-guide/editor/editor-view.md b/docs/user-guide/editor/editor-view.md new file mode 100644 index 0000000000..1a322f13a7 --- /dev/null +++ b/docs/user-guide/editor/editor-view.md @@ -0,0 +1,115 @@ +
+Editor view +
+
+ +### 1. Breadcrumbs + +Links to Project -> Version -> [Documents view](user-guide/editor/documents-view) -> Document name. Each link will redirect to the respective page. + + +### 2. Statistic + +Statistic and remaining hours of the current document translation document. + +### 3. Views + +See [Views](user-guide/editor/overview#views-in-webtrans) for more information. + +### 4. Search and filter + +Allow translators to search text, and filter by translation status. +Translations can be in one of several states that indicate where they are in the translation workflow. The states are: + +Empty: no translation has been entered. +Fuzzy: a translation has been entered, but is not considered ready for use. +Translated: a translation has been entered and the translator considers it ready for use. +and only in projects that have review turned on: + +Approved: a translation has been entered and a reviewer considers it ready for use. +Rejected: a translation has been entered, but a reviewer does not consider it ready for use. +You can show or hide translations with any of these states using the filter settings above the editor table. Just check the 'Incomplete' or 'Complete' category, or check individual states within each category to show translations of interest (e.g. showing only Rejected translations to change them after review). + +In addition to filtering by states, you can check the 'Invalid' checkbox to only show translations that match one of the selected states and have one or more validation warnings. + +### 5. Source string + +Source strings show the original text for which a translation is needed. The text itself is displayed within a text box, and cannot be changed. In addition to the source text, some other useful information is shown. + +Line numbers are shown to the left of the source and translation text boxes. Long lines will be displayed over several lines in the text box, but will only have a single line number. + +Whitespace characters are shown in source and translation text to allow accurate translation. Spaces are displayed with a faint grey underline, newlines are shown with a faint grey pilcrow character (¶) and tabs are shown with a faint grey right-arrow-to-bar character (⇥). + +The string number within the document is shown below the source string for the currently selected line, along with the source comment if one exists. Clicking the string number causes some extra information about the string to be displayed. + +To the left of the string number is a bookmark icon. Clicking the bookmark icon updates the URL so that you can create a link directly to this particular string. + +### 6. Translation validation + +As you type, validations will run on the text you have entered. If any validations fail, warnings will be displayed here. Warnings are cleared when the text no longer fails the validation. + +### 7. Translation actions + +From left to right: Save as translated, Save as fuzzy, Cancel changes, Translation history, undo translation. + +### 8. Editor settings + +From top to bottom: Notification, Chat room, Settings, Validation options. + +### 9. Paging + +Page navigation of the document. + +### 10. Translation memory + +The Translation Memory (TM) searches for translations of strings the same as or similar to the currently selected source string. The search looks across all projects in Zanata for the most similar strings that have a Translated or Approved translation in the correct language. + +Matches can be copied to the translation text box and used as-is or modified before saving. To copy TM matches to the selected text box, click the `Copy` button next to the match, or use `Ctrl+Alt+1` to `Ctrl+Alt+4` keyboard shortcuts to copy the first to fourth match in the list. + +You can also search the TM for other phrases by entering them in the TM text box and clicking `Search`. + +### 11. Glossary + +If a glossary has been uploaded for your language, each word in the currently selected row will be searched for a glossary entry. + + +## Readonly editor + +If you're not part of that language team, the editor will open as readonly mode. +You will be restricted to only viewing source and translations in the editor. + +
+Readonly editor +
+
+ +## Settings + +
+Editor settings +
+
+ +* **Editor Buttons** - Show/Hide editor buttons. +* **Enter key saves immediately** - Save translation when user hit `Enter` key. +* **Use syntax highlighting Editor** - Enable syntax highlighting in editor. (Warning: no spell check, long lines may have some wrapping issues) +* **Show `Save as Approved` warning** - Show warning when Save as Approved triggered via keyboard shortcut +* **Page size** - Allow user to customise documents to show per page. +* **Show Translation Suggestion** - Show/hide Translation memory panel +* **Show Glossary Suggestion** - Show/hide glossary panel +* **Layout** - Customise the view of document list with `Compact`, `Default` and `Loose`. +* **Show System Errors** - Shows detailed messages in new windows when errors occurs. + + +## Validations + +
+Editor validation settings +
+
+ +Translators can enable or disable validation check on their translations except for those which is enforced by project maintainers. +See [Project settings](user-guide/project/project-settings#validations) for more information. + +See [validations](user-guide/projects/validations) all available check. + \ No newline at end of file diff --git a/docs/user-guide/editor/keyboard-shortcuts.md b/docs/user-guide/editor/keyboard-shortcuts.md new file mode 100644 index 0000000000..7d4f3f0917 --- /dev/null +++ b/docs/user-guide/editor/keyboard-shortcuts.md @@ -0,0 +1,82 @@ +# Global + + + + + + + + + + + + + + + + + + + + + + + + + + +
**Shortcut****Action**
`Alt+Y`Show all available keyboard shortcuts
`Esc`Close keyboard shortcuts list
`Alt+X`Activate attention mode
`Alt+L`Show document list
`Alt+O`Show Editor view
`Alt+P`Show project wide search and replace
+ + +# Editor + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
**Shortcut****Action**
`Alt+PageUp`Move to previous Fuzzy/Rejected/Untranslated
`Alt+PageDown`Move to next Fuzzy/Rejected/Untranslated
`Alt+Up` and `Alt+J`Move to previous row
`Alt+Down` and `Alt+K`Move to next row
`Alt+G` and `Alt+X,G`Copy text from source string
`Ctrl+Enter`Save as translated
`Ctrl+S`Save as fuzzy
`Ctrl+Alt+1` and `Ctrl+Alt+Num 1`Copy from translation memory match result no.1
`Ctrl+Alt+2` and `Ctrl+Alt+Num 2`Copy from translation memory match result no.2
`Ctrl+Alt+3` and `Ctrl+Alt+Num 3`Copy from translation memory match result no.3
`Ctrl+Alt+4` and `Ctrl+Alt+Num 4`Copy from translation memory match result no.4
`Ctrl+Alt+H` and `Alt+X,H`Turn syntax highlighting on or off. Spellcheck will not work when syntax highlighting is active.
\ No newline at end of file diff --git a/docs/user-guide/editor/overview.md b/docs/user-guide/editor/overview.md new file mode 100644 index 0000000000..828c4b68a9 --- /dev/null +++ b/docs/user-guide/editor/overview.md @@ -0,0 +1,18 @@ +## Navigating to editor + +See [Translator guide](user-guide/translator-guide) for more information. + + +## Views in webtrans + +
+View icons +
+
+ +From left to right + +1. [Editor view (default view)](user-guide/editor/editor-view) +2. [Documents view](user-guide/editor/documents-view) +3. [Project search and replace](user-guide/editor/project-search-replace-view) +4. [Keyboard shortcut](user-guide/editor/keyboard-shortcut) diff --git a/docs/user-guide/editor/translation-history.md b/docs/user-guide/editor/translation-history.md new file mode 100644 index 0000000000..2bc54a678c --- /dev/null +++ b/docs/user-guide/editor/translation-history.md @@ -0,0 +1,20 @@ +User will be able to see translation history of each messages. It will display for each translation, the version number, contents and status, modified user and modified date. + +### How to show translation history +In editor click on the "timer" like icon below cancel will bring up the initial view: + +
+Translation history +
+
+ +### Comparison of two entries +If selecting exactly two entries, user will be able to compare them in a diff view: + +
+Translation history comparison +
+
+ +### Other hints and tips +If you have unsaved contents in your editor while firing up translation history, your unsaved contents will also be included in the history table with version showing as "Unsaved". You will then be able to compare it with one saved translation. \ No newline at end of file diff --git a/docs/user-guide/glossary/delete-glossaries.md b/docs/user-guide/glossary/delete-glossaries.md new file mode 100644 index 0000000000..2d0877feeb --- /dev/null +++ b/docs/user-guide/glossary/delete-glossaries.md @@ -0,0 +1,33 @@ +--- +title: "Deleting Glossaries" +last-updated: 2014-10-30 +redirect_from: "/help/glossary/glossary-delete/" +--- + +### Prerequisite +Requires **Glossary-admin** role. See [glossary roles and permission]({{ site.url }}/help/glossary/glossary-roles-permissions) for permission setup. + +### Delete via Web UI +1. Login into Zanata +1. Click `Glossary` on menu. +1. Click on `Glossary options` on the glossary language you wish to delete and click `Delete glossary`. +
+ Glossary options +
+1. Click `OK` to confirm delete all glossary entries in selected locale. + + +### Delete via Zanata Maven client +The following instructions assume that you have installed and configured the Zanata Maven Plugin. Instructions for installation and configuration are available at [Installing the Maven Plugin]({{ site.url }}/help/maven-plugin/maven-plugin-install) and [Configuring the Maven Plugin]({{ site.url }}/help/maven-plugin/maven-plugin-config) + +**Delete glossary entries by locale** + +``` +mvn zanata:glossary-delete -Dzanata.lang={locale of glossary to delete} +``` + +**Delete all glossary entries in Zanata** + +``` +mvn zanata:glossary-delete -Dzanata.allGlossary=true +``` diff --git a/docs/user-guide/glossary/edit-glossaries.md b/docs/user-guide/glossary/edit-glossaries.md new file mode 100644 index 0000000000..a670b275f0 --- /dev/null +++ b/docs/user-guide/glossary/edit-glossaries.md @@ -0,0 +1,27 @@ +--- +title: "Editing Glossaries" +last-updated: 2014-10-30 +redirect_from: "/help/glossary/glossary-edit/" +--- + +### Prerequisite +See [glossary roles and permission]({{ site.url }}/help/glossary/glossary-roles-permissions) for permission setup. + +1. Go to editor in Zanata and select a string. Instructions for opening the + translation editor can be found at [Preparing for Translation]({{ site.url }}/help/translation/preparing-for-translation). +1. In Glossary panel (bottom right corner), click on icon on the glossary entry you wish to edit. +
+ glossary panel +
Glossary panel
+
+ +
+ glossary entry window +
Glossary entry windows
+
+ +1. In the popup window, user can: + 1. edit glossary target term + 1. add/remove comments to target term - use `+` sign to add new comment, use `-` sign to remove comment from list + +1. Click `Save` to save changes made in the glossary entry. diff --git a/docs/user-guide/glossary/glossary-roles-permissions.md b/docs/user-guide/glossary/glossary-roles-permissions.md new file mode 100644 index 0000000000..a7447f5669 --- /dev/null +++ b/docs/user-guide/glossary/glossary-roles-permissions.md @@ -0,0 +1,33 @@ +

+ Glossary is used globally in all projects within Zanata. User assigned with these roles should understand the + responsibility and effect when performing any of these actions. +

+ + +There are 2 roles that manage glossaries in Zanata, **glossarist** and **glossary-admin**. + +User can request those roles by [contacting Zanata admin](user-guide/admin/contact-admin). + +Below are the summary of these 2 roles with their permission. + + + + + + + + + + + + + + + + + + + + +
+
**Roles**[Upload glossary](user-guide/glossary/upload-glossaries)[Edit glossary](user-guide/glossary/edit-glossary)[Delete glossary](user-guide/glossary/delete-glossary)
glossarist✔✔✖
glossary-admin✔✔✔
diff --git a/docs/user-guide/glossary/upload-glossaries.md b/docs/user-guide/glossary/upload-glossaries.md new file mode 100644 index 0000000000..f563be59fd --- /dev/null +++ b/docs/user-guide/glossary/upload-glossaries.md @@ -0,0 +1,58 @@ +### Prerequisite + +See [glossary roles and permission](user-guide/glossary/glossary-roles-permissions) for permission setup. + +### Supported file format +#### PO + +1. GNU Gettext-based PO file + +#### CSV (comma-separated value), UTF-8 format +##### header row + +1. locale columns: The locale header column must contain a valid locale code. At least one locale code is required for the glossary. First locale column will be used as source. +1. part-of-speech column (optional): The part-of-speech header column, when included, should contain only one value: pos. +1. description column (optional): The description header column, when included, should contain only one value: description. + + +##### data rows + +1. terminology columns: Terminology in each row should correspond to the locale in the header. At least one term is required for a row to be valid. +1. part-of-speech column: The part-of-speech is an informational field that indicates the sense in which the terms in the row should be used. Sample parts-of-speech include adjective, adverb, noun, and verb. +1. description column: The description should provide any notes for the translator, including the meaning of the terms in the row. +
+ sample glossary csv file +
Valid glossary csv file
+
+ +### Upload via Web UI + +1. Login into Zanata +1. Click `Glossary` menu. +1. Click on `More Actions` on top right corner of the table, follow by `Upload glossary` from the list. +
+ More action in glossary page +
More actions in glossary table
+
+ +1. A window will popup, click on `choose file` to select your glossary file. +
+ Glossary upload window +
+ +1. For PO file format, you will need to select **Source and Target languages** of the selected po file. +
+ Glossary upload window, PO file +
+ +1. Click `Upload` button to start uploading selected glossary file. + +### Upload via Zanata client + +The following instructions assume that you have installed and configured the Zanata Client. Instructions for installation and configuration are available at [Zanata Client Installation](http://zanata-client.readthedocs.org/en/latest/installation/). + +Command + +``` +mvn zanata:glossary-push -Dzanata.glossaryFile={filename} -Dzanata.sourceLang={source locale} -Dzanata.transLang={translation locale} +``` diff --git a/docs/user-guide/groups/create-group.md b/docs/user-guide/groups/create-group.md new file mode 100644 index 0000000000..6d9b98acf8 --- /dev/null +++ b/docs/user-guide/groups/create-group.md @@ -0,0 +1,30 @@ +Currently, only admin can create a group: + + 1. Login as user with admin role. + 1. Click on `Groups` section on the top menu. + 1. Click on 'New Group' button on right panel. +
+ New group menu +
+ + The following screenshot shows the group creation page. + +
+Group create form +
Example filled in group creation form
+
+ +------------ + +### Group name + +Name is the display name for your group. This should be a name that allows users to easily recognize your group. + +### Group ID + +Group ID is a unique identifier for your group that will be used in the group's URL. It accepts only letters, numbers, periods, hyphens and underscores, and cannot contain any spaces. + +### Description + +A short description to provide a little more information for users to identify your group. + diff --git a/docs/user-guide/groups/group-settings.md b/docs/user-guide/groups/group-settings.md new file mode 100644 index 0000000000..a8658b725b --- /dev/null +++ b/docs/user-guide/groups/group-settings.md @@ -0,0 +1,84 @@ +Once a group has been created, the maintainer can add further details and group behaviour via the Settings tab. +See the [Group Creation Help](user-guide/groups/create-group) for details on creating groups. +
+Groups General Settings tab +
Groups Settings tab link.
+
+ +------------ +## General Settings + +The General tab contains fields that manage appearance your group which already covered in the [Group Creation Help](user-guide/groups/create-group). + +
+Group General Settings tab +
Group General Settings tab
+
+
+ + +### Make this group read only + +This button is used to set a group to read-only, which prevents the group being visible to users. This can be toggled using the same button, as desired. + +------------ + +## Languages Settings + +
+Groups Languages Settings tab +
Groups Languages Settings tab
+
+
+ +------------ +### Add a Language + +To search for available languages, enter text into the field under "Add a language". Available languages matching the entered text will display in a dropdown. +To add a language to your project, select the desired language from the dropdown. + +------------ +### Remove a Language + +To remove a language from the list of available locales, first move the cursor over the language, then click the "X" that appears. + +------------ + +## Projects Settings + +
+Groups Projects Settings tab +
Groups Projects Settings tab
+
+
+ +------------ +### Add a project version + +To search for available project version, enter text into the field under "Add a Project". Matching project versions will be displayed in a dropdown. +To add a version to your group, select the desired project version from the dropdown. + +------------ +### Remove a project version + +To remove a project version from the list, first move the cursor over the project version, then click the "X" that appears. +Groups projects remove + +------------ + +## Maintainers Settings + +
+Groups Maintainer Settings tab +
Group Maintainer Settings tab
+
+
+ +### Add a Maintainer + +To search for users, enter at least three characters of a username into the field under "Add a Maintainer". Available users matching the entered text will display in a dropdown. +To add a user as a maintainer for the project, select their username from the dropdown. + +### Remove a Maintainer + +To remove a maintainer from the maintainers list, first move the cursor over the maintainer, then click the "X" that appears. diff --git a/docs/user-guide/groups/group-view.md b/docs/user-guide/groups/group-view.md new file mode 100644 index 0000000000..15c3b0ceb9 --- /dev/null +++ b/docs/user-guide/groups/group-view.md @@ -0,0 +1,17 @@ +When a group is selected, you will be taken to an overall view of the group. This will show a list of the available versions as well as an indication of their translation progress. + +
+Group view language tab +
Group View
+
+
+ + +1. Group Information +2. Switches between the different views available for the group. + +The different views for a group offer more information about it. + +- **Languages** shows the languages enabled for the group. +- **Projects** shows project version that is part of the group. +- **Settings** _(This is only available to Group Maintainers)_ allows the user to change group settings. \ No newline at end of file diff --git a/docs/user-guide/joining-a-language-team.md b/docs/user-guide/joining-a-language-team.md deleted file mode 100644 index 0152676f24..0000000000 --- a/docs/user-guide/joining-a-language-team.md +++ /dev/null @@ -1,24 +0,0 @@ -# Joining a Language Team. - -# What is Language Team? - -A Language Team groups translators together through a common language. Language Teams can work simultaneously on translating a single document into their respective languages. All translations and all revisions are kept with each respective Language Team without affecting any other Team. - -Translators can also join more than one Language Team. - -## Join a Language Team - -While signed-in, translators can join a Language Team by completing the following: - -1. Click "Language" tab -1. Click the language team you want to join -1. Click "Join Language Team" (if available) or "Request to Join Team" - - -## Leaving a Language Team - -While signed-in, translators can leave a Language Team by completing the following: - -1. Click "Language" or "My Profile" tab -1. Click the language team you want to leave -1. Click "Leave Language Team" \ No newline at end of file diff --git a/docs/user-guide/keyboard-shortcuts.md b/docs/user-guide/keyboard-shortcuts.md deleted file mode 100644 index 79956f25f7..0000000000 --- a/docs/user-guide/keyboard-shortcuts.md +++ /dev/null @@ -1,45 +0,0 @@ -# List of keyboard shortcuts. - - - -# Global - - - -
**Shortcut****Action****Context****Comment**
`Alt+Y`Show all available keyboard shortcutsGlobalThe list changes depending on the available shortcuts for the current view.
- - -# Translation Table - - - - - - -
**Shortcut****Action****Context****Comment**
`Home`Move to the First pageTranslation Table
`End`Move to the Last pageTranslation Table
`PageDown`Move to next pageTranslation Table
`PageUp`Move to previous pageTranslation Table
- -# Translation Editor - - - - - - - - - - - - -
**Shortcut****Action****Context****Comment**
`Ctrl+Enter`Save and move to next entryTranslation Editor
`Ctrl+S`Save as draft (fuzzy)Translation Editorv1.4+
`Esc`Escape from Editor (cancelling changes)Translation Editorremoved in v1.4 (too easy to press by accident when using input methods)
`Alt+Down`Move to next entryTranslation Editor
`Alt+Up`Move to previous entryTranslation Editor
`Alt+PageDown`Move to next new entryTranslation Editor
`Alt+PageUp`Move to previous new entryTranslation Editor
`Ctrl+Shift+PageDown`Move to next fuzzy entryTranslation Editor
`Ctrl+Shift+PageUp`Move to previous fuzzy entryTranslation Editor
`Alt+G`Clone content from current source to target.Translation Editorv1.4+
\ No newline at end of file diff --git a/docs/user-guide/languages/add-team-member.md b/docs/user-guide/languages/add-team-member.md new file mode 100644 index 0000000000..bd222c3430 --- /dev/null +++ b/docs/user-guide/languages/add-team-member.md @@ -0,0 +1,13 @@ +This is only available to language coordinator. To add team member: + +While signed-in as language coordinator + +1. Click `Languages` tab. +1. Click the language team. +1. Click on `+` sign on the top left panel. +
+Add new member +
+
+1. Enter username and click `Search`. +1. Select the appropriate role for the user and click `Add Selected`. \ No newline at end of file diff --git a/docs/user-guide/languages/language-team.md b/docs/user-guide/languages/language-team.md new file mode 100644 index 0000000000..be7e9dedf7 --- /dev/null +++ b/docs/user-guide/languages/language-team.md @@ -0,0 +1,49 @@ +A Language Team groups translators together through a common language. Language Teams can work simultaneously on translating a single document into their respective languages. All translations and all revisions are kept with each respective Language Team without affecting any other Team. + +Translators can also join more than one Language Team. + +------------ + +## Join a Language Team + +While signed-in, translators can join a Language Team by completing the following: + +1. Click `Languages` tab. +1. Click the language team you want to join. +1. Click on `More Action` menu on top right panel, select `Request to Join Team`. +
+Request to join menu +
+
+1. In the dialog, select roles you wish to be added as, fill in some information for language team coordinator and click `Send`. +
+Request to join menu +
+
+ +------------ + +## Leaving a Language Team + +While signed-in, translators can leave a Language Team by completing the following: + +1. Click `Language` tab. +1. Click the language team you want to leave. +1. Click on `More Action` menu on top right panel, select `Leave Language Team`. +Request to leave + +## Contact Language Coordinator + +Any user in Zanata can contact language coordinator by: + +1. Click `Language` tab. +1. Click on a language team. +1. Click on `More Action` menu on top right panel, select `Contact Coordinators`. +
+Contact coordinator menu +
+
+1. In the dialog, fill in the message in the input file and click `Send`. +
+Contact coordinator +
\ No newline at end of file diff --git a/docs/user-guide/languages/modify-role.md b/docs/user-guide/languages/modify-role.md new file mode 100644 index 0000000000..d53cf7eddc --- /dev/null +++ b/docs/user-guide/languages/modify-role.md @@ -0,0 +1,10 @@ +To modify role for existing user + +1. Click `Languages` tab. +1. Click the language team. +1. In members tab, locate the user in the list, and check on the relevant role you wish to add. + +
+Language members tab +
+
\ No newline at end of file diff --git a/docs/user-guide/project-maintainer-guide.md b/docs/user-guide/project-maintainer-guide.md new file mode 100644 index 0000000000..a55f8dfa3c --- /dev/null +++ b/docs/user-guide/project-maintainer-guide.md @@ -0,0 +1,14 @@ +Any user who has joined Zanata can upload their project to be translated. + +See [signup account](user-guide/account/sign-up) and [activate account](user-guide/account/account-activate) for more information. + +## New project + +1. Create a [project](user-guide/projects/create-project) and [version](user-guide/versions/create-version). +1. [Install](http://zanata-client.readthedocs.org/en/latest/installation) and [configure](http://zanata-client.readthedocs.org/en/latest/configuration) Zanata client. +1. [Upload your project documents](user-guide/versions/upload-strings). +1. [Download translated documents](user-guide/versions/download-translations) when translations is completed. + +## Migrating to Zanata + +See [migrating to Zanata guide](user-guide/projects/import-projects) for migrating guide. \ No newline at end of file diff --git a/docs/user-guide/projects/create-project.md b/docs/user-guide/projects/create-project.md index b7ad79032c..f580b3b542 100644 --- a/docs/user-guide/projects/create-project.md +++ b/docs/user-guide/projects/create-project.md @@ -1,7 +1,7 @@ Anyone with an account can upload source strings to Zanata. The first step is to create a project: 1. **Create a project.** - 1. [Create a version](user-guide/projects/create-version) under the project. + 1. [Create a version](user-guide/versions/create-version) under the project. 1. Upload documents to the version: - Using the website - Using the [command-line client push](http://zanata-client.readthedocs.org/en/latest/commands/push/) command @@ -14,6 +14,7 @@ To start creating a project on the Zanata website, click the `New Project` butto Project creation button on Projects page
Project creation button on `Projects` page.
+
The following screenshot shows the project creation page. In the screenshot, all fields have been filled in to illustrate the process. This example would create a project with a URL ending in '/zanata-server', that will be displayed in the project list as 'Zanata Server'. Details for each of the fields are shown below. @@ -24,7 +25,6 @@ The following screenshot shows the project creation page. In the screenshot, all ------------ - ### Project ID Project ID is a unique identifier for your project that will be used in the project's URL and in client configuration files. It accepts only letters, numbers, periods, hyphens and underscores, and cannot contain any spaces. @@ -41,7 +41,7 @@ A short description to provide a little more information for translators to iden Project Type defines the type of files that your project uses to store source and translation strings. This setting ensures that files for your project will be downloaded in the correct format. -There is a brief description for each project type next to each project type option. If the description is insufficient, more information on each project type is available at the [Project Types guide](user-guide/project-types). +There is a brief description for each project type next to each project type option. If the description is insufficient, more information on each project type is available at the [Project Types](user-guide/projects/project-types). ## Project Settings diff --git a/docs/user-guide/projects/create-version.md b/docs/user-guide/projects/create-version.md deleted file mode 100644 index c463ce7142..0000000000 --- a/docs/user-guide/projects/create-version.md +++ /dev/null @@ -1,67 +0,0 @@ -Documents for a project are grouped into versions, rather than being added directly to the project. - -For simple projects, it is typical to create a single version named 'master'. Other projects use workflows in which there is a version under active development, and one or more versions that are being maintained in a stable state with only some minor changes. Grouping these related versions under the same project allows for easier reuse of translations between versions. - - - 1. [Create a project](user-guide/projects/create-project). - 1. **Create a version under the project.** - 1. Upload documents to the version: - - Using the website - - Using the [command-line client push command](http://zanata-client.readthedocs.org/en/latest/commands/push/) - - -## Version creation through the website - -To add a version to your project, navigate to the project using the menu or user dashboard and click the `Create Version` button. If your project has no versions yet, there will be a link under the project on the user dashboard to jump straight to version creation. - -![Version creation button on a project homepage](images/create-version.png) - -Version creation button on a project homepage. - -![Shortcut version creation link on user dashboard](images/user-dashboard-create-version.png) - -Shortcut version creation link on user dashboard. - - -The following screenshot shows the version creation page. The settings in this screenshot will create a version under the 'zanata-server' project with ID 'master', that does not require a review phase for translations and will use the locales and validations from the project. See below for details on each option. - - -![Example version creation form with completed name and other settings](images/create-version-master.png) - - -### Version ID - -This is the identifier used to refer to the version on the Zanata website and when using one of the Zanata clients. Versions do not use a separate display name. - -### Project Type - -Project Type defines the type of files that your project uses to store source and translation strings. For more information see the [Project Types wiki page](user-guide/project-types). - -### Require translation review - -Translation review is an optional stage in the translation process in which an experienced translator can check that translations are of sufficient quality. - -Without translation review, translators will save translations in the 'translated' state, making them immediately available to download and use for your project. - -If you check the `Require translation review` option, translations in the 'translated' state are not considered ready for download. Instead, a reviewer must look at the translations and change them to 'approved' or 'rejected' state. Only translations in 'approved' state are considered ready for download. - -Translation review adds extra time and effort to the translation process, so is not recommended for all projects. Translation review can be activated at a later time if it becomes necessary. - -### Status - -Status is used to set a version to read-only, which prevents translations being entered. Status should usually be left as active for a new version. Status can be set to read-only later, such as when work is finished on an old version and all translation effort should be put into the newer versions. - -### Customized locales - -By default, your project will be available for translation to a set of locales defined for your project, or on the Zanata server if your project does not have customized locales. If your version requires a different set of locales from your project, check the 'Would you like to add a customized list of locales?' checkbox to see and modify a list of locales available for your version. - -### Customized list of validations - -If your version requires a different set of validations than the parent project, they can be selected here. If customized validations are not specified, the validations specified for your project will be used. An advantage of inheriting validations from the poject is that new validations can be added to the project without having to add them to each different version. - -For more information, see `Customized list of validations` under [Create a project][]. - - -## Version creation through the command line - -Versions can also be created using the command-line client. See the help output of the client for a list of available options. diff --git a/docs/user-guide/projects/gettext-example.md b/docs/user-guide/projects/gettext-example.md new file mode 100644 index 0000000000..de5fc75c48 --- /dev/null +++ b/docs/user-guide/projects/gettext-example.md @@ -0,0 +1,35 @@ +This document presents an example of a Zanata project with type `gettext`. It assumes that you have already created a project and a version (See [Project Creation](user-guide/projects/create-project) ). + +Gettext projects consist of a single source file (.pot), and several translation files (.po) named after their corresponding locale. Below is a typical directory structure for a Gettext project: + +```bash +project-name +|-- zanata.xml +|-- singlesourcefile.pot +|-- es_ES.po +|-- fr.po +|-- zh_TW.po +... +``` + +Notice the presence of the `zanata.xml` file already there. This file will be generated for you by the Zanata client `init` command, or you can download it from the Zanata server. For more information see [Configuring the Client](http://zanata-client.readthedocs.org/en/latest/configuration/). This file will look something like this: + +```xml + + + http://yourinstance.zanata.org/ + project-slug + version-slug + gettext + + es-ES + fr + zh-Hant + ... + + +``` + +This example is also using the locale mapping feature. The `map-from` attributes on the `locale` elements are telling the client that although it will find the files using locales `es_ES` and `zh_TW`, those translated documents should be stored in the server under locales `es-ES` and `zh-Hant`. + +See [Upload documents](user-guide/versions/upload-strings) and [Download translation](user-guide/versions/download-translations) for more information. diff --git a/docs/user-guide/projects/import-projects.md b/docs/user-guide/projects/import-projects.md new file mode 100644 index 0000000000..c682edfe7e --- /dev/null +++ b/docs/user-guide/projects/import-projects.md @@ -0,0 +1,42 @@ +This document will provide help when importing or migrating projects into Zanata from other translation platforms. +You need a user account on the Zanata instance you will migrate to. + +See [signup account](user-guide/account/sign-up) and [activate account](user-guide/account/account-activate) for more information. + +## Create a project in Zanata + +The first thing to do is to create a project and version to host your content in Zanata. You can do this using the command line clients (See [Initialising a Project](http://zanata-client.readthedocs.org/en/latest/commands/init/) ), or Zanata's web interface (See [Project Creation](user-guide/projects/create-project) ). + +Please note that the `init` command might not be available on older platforms (like Fedora 19). Alternatively, you can use the Zanata Ivy client. For more information see [Installing the Client](http://zanata-client.readthedocs.org/en/latest/installation/) and [Configuring the Client](http://zanata-client.readthedocs.org/en/latest/configuration/). + +## Configure your Project + +If you used the client's `init` command, you should already have a `zanata.xml` in your local project directory. If not, then you can download one from the Zanata web interface. See [Configuring the Client](http://zanata-client.readthedocs.org/en/latest/configuration/) for more information. + +## Extract your content + +Extract the project's content from the other platform. Below are some examples on how to extract your content from several other translation platforms. This list will be updated with more examples in the future. + ++ Transifex: `tx pull -s -a`. This command will pull all translation and source files from the server. More information available [Here](http://docs.transifex.com/developer/client/pull). + +## Prepare your content + +Depending on your project type, you might need to modify your Zanata configuration or your project's directory structure. Here are some examples on how to set up a project locally to be pushed to Zanata. + ++ [Gettext project](user-guide/projects/gettext-example) + +Gettext projects consist of a single source file (.pot), and several translation files (.po) named after their corresponding locale. + ++ [Podir project](user-guide/projects/podir-example) + +Podir projects consist of multiple source files (.pot) in a common source directory, and several translation files (.po) located in their corresponding locale's directory. + +## Push your content to Zanata + +Move your content over to the Zanata project's directory created previously, and run the following client command from the same directory: + +```bash +zanata-cli push -s . -t . --push-type both +``` + +This will push your content into the Zanata project that you previously created. For more information on pushing your content using the zanata client see [Document Upload with Client](http://zanata-client.readthedocs.org/en/latest/commands/push/). diff --git a/docs/user-guide/projects/podir-example.md b/docs/user-guide/projects/podir-example.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/user-guide/projects/project-settings.md b/docs/user-guide/projects/project-settings.md index 59e521f566..b151e20566 100644 --- a/docs/user-guide/projects/project-settings.md +++ b/docs/user-guide/projects/project-settings.md @@ -21,7 +21,7 @@ The Settings tab contains fields that manage appearance and workflow of your pro Project Type defines the type of files that your project uses to store source and translation strings. This setting ensures that files for your project will be downloaded in the correct format. -There is a brief description for each project type next to each project type option. If the description is insufficient, more information on each project type is available at [Project Types wiki page](user-guide/project-types). +There is a brief description for each project type next to each project type option. If the description is insufficient, more information on each project type is available at [Project Types](user-guide/projects/project-types). ### Home Page @@ -96,7 +96,11 @@ To remove a language from the list of available locales, first move the cursor o Validations run in the translation editor and help translators to provide translations that are valid for your project. Validations set to `Warning` or `Error` in this list will be displayed in the translation editor when an invalid translation has been entered. Validations not enabled here can be toggled by translators to suit their individual workflow. +* Off - turn off validation check by default. +* Warning - display warning to translator when validation failed. Translator can save the translation as `Translated`. +* Error - display error to translator when validation failed. Translator cannot save translation as `Translated` until error has been fixed. +See [validation](user-guide/projects/validations) all available check. ### Copy Translations settings @@ -129,6 +133,27 @@ The access restriction feature is intended for use with special roles that can b ------------ +## Webhooks + +
+Project Webhooks Settings tab +
Project Webhooks Settings tab
+
+ +The Webhooks feature is HTTP callbacks which are triggered when a document in a language has reached a certain milestone. Currently, webhooks events will be triggered when + +- A document has reached 100% Translated +- A document has reached 100% Approved (by reviewer) + +When an event occurs, Zanata will make a HTTP POST to the URI configured in the project. + +### Adding a Webhook URI + +Project Webhooks Settings tab +Enter a valid URI into the provided text input. Hit the 'enter' key or click on 'Add webhook' button to add the URI. + +------------ + ## About
diff --git a/docs/user-guide/project-types.md b/docs/user-guide/projects/project-types.md similarity index 100% rename from docs/user-guide/project-types.md rename to docs/user-guide/projects/project-types.md diff --git a/docs/user-guide/projects/project-view.md b/docs/user-guide/projects/project-view.md index 605479e1a0..da4740faf6 100644 --- a/docs/user-guide/projects/project-view.md +++ b/docs/user-guide/projects/project-view.md @@ -1,7 +1,7 @@ When a project is selected, you will be taken to an overall view of the project. This will show a list of the available versions as well as an indication of their translation progress.
-Project Languages Settings tab +Project view version tab
Project View

diff --git a/docs/user-guide/projects/upload-strings.md b/docs/user-guide/projects/upload-strings.md deleted file mode 100644 index 2e3e35a124..0000000000 --- a/docs/user-guide/projects/upload-strings.md +++ /dev/null @@ -1,9 +0,0 @@ -# Upload Strings - -Anyone with an account on Zanata can create a translation project for their strings. The basic steps are: - - 1. [Create a project](projects/create-project). - 1. [Create a version](projects/create-version) under the project. - 1. Upload documents to the version: - - Using the website - - Using the [command-line client push command](http://zanata-client.readthedocs.org/en/latest/commands/push/) diff --git a/docs/user-guide/projects/validations.md b/docs/user-guide/projects/validations.md new file mode 100644 index 0000000000..ab0debbbba --- /dev/null +++ b/docs/user-guide/projects/validations.md @@ -0,0 +1,39 @@ +## HTML/XML tags + +Check html/xml tags are consistence between source and translation text. + +----------- + +## Java variables + +Check that java style ({x}) variables are consistent. + +----------- + +## Leading/trailing newline (\n) + +Check for consistent leading and trailing newline (\n). + +----------- + +## Positional printf (XSI extension) + +Check that positional printf style (%n$x) variables are consistent. + +----------- + +## Printf variables + +Check that printf style (%x) variables are consistent. + +----------- + +## Tab chracters (\t) + +Check whether source and target have the same number of tabs. + +----------- + +## XML entity reference + +Check that XML entity are complete. \ No newline at end of file diff --git a/docs/user-guide/review/add-reviewer.md b/docs/user-guide/review/add-reviewer.md new file mode 100644 index 0000000000..5f9935a60a --- /dev/null +++ b/docs/user-guide/review/add-reviewer.md @@ -0,0 +1,19 @@ +Translation review can only be performed for a language by users who are reviewers for that language. The language team coordinators for the language decide which users will be reviewers for the language. + +## Requesting Review Privileges + +You can request to be a reviewer using the [Contact Coordinators](user-guide/languages/language-team#contact-language-coordinator). + +This lets you send a message to the coordinators for the language team, in which you can write a message asking to become a reviewer. + +## Adding Reviewers (for language team coordinators) + +### New team member + +See [Add new member](user-guide/languages/add-team-member) for more information. + +### Existing team member + +To add reviewer role for existing user + +* See [Modify role](user-guide/languages/modify-role) and check `Reviewer` on the user. \ No newline at end of file diff --git a/docs/user-guide/review/overview.md b/docs/user-guide/review/overview.md new file mode 100644 index 0000000000..664a22db1b --- /dev/null +++ b/docs/user-guide/review/overview.md @@ -0,0 +1,9 @@ +Translation review is an optional stage in the translation process in which an experienced translator can check that translations are of sufficient quality. + +Without translation review, translators will save translations in the 'translated' state, making them immediately available to download and use for your project. + +If it's turn on, translations in the 'translated' state are not considered ready for download. Instead, a reviewer must look at the translations and change them to 'approved' or 'rejected' state. Only translations in 'approved' state are considered ready for download. + +Translation review adds extra time and effort to the translation process, so is not recommended for all projects. Translation review can be activated at a later time if it becomes necessary. + +Turning review off and on will not cause approved translations to lose their approved status. Approved translations will remain approved unless they are replaced with another translation. When review is turned off, approved translations will be treated the same as translations in the 'translated' state. \ No newline at end of file diff --git a/docs/user-guide/review/review-enable.md b/docs/user-guide/review/review-enable.md new file mode 100644 index 0000000000..273d6533bd --- /dev/null +++ b/docs/user-guide/review/review-enable.md @@ -0,0 +1,3 @@ +Translation review can be enable/disable by project maintainer in settings page. + +See [Version settings|Review](user-guide/versions/version-settings#require-translation-review) for more information. \ No newline at end of file diff --git a/docs/user-guide/review/translation-review.md b/docs/user-guide/review/translation-review.md new file mode 100644 index 0000000000..8ccca40556 --- /dev/null +++ b/docs/user-guide/review/translation-review.md @@ -0,0 +1,88 @@ +Some project-versions require translations to be reviewed before they are considered ready to use. +Instructions for changing this setting can be found at [Enable review](user-guide/review/review-enable) + +Review can only be performed by reviewers. To become a reviewer, see [Adding Reviewers](user-guide/review/add-reviewer) + +The review process is about reading translations in the 'translated' state and determining whether they are technically correct translations of sufficient quality. These instructions show how to use the user interface for accepting or rejecting translations, but does not aim to teach how to decide whether a translation should be accepted. + +## Ready for review + +Translations are considered ready for review when they have 'translated' state, which is shown as green bars on either side of the translation string. + +
+Translated strings +
+
+ + +## Filtering the view + +If only some of the translations are in 'translated' state, such as if the document is only partially translated or has already been through an initial review, it may be helpful to filter the view so that only 'translated' strings are shown. This is done by checking `Translated` state in the `Complete` category near the top of the editor. + +
+Filter translated strings +
+
+ + +*Note:* When showing only `Translated` strings, any strings that you accept or reject will stop being shown when you move to the next page of the document. If this does not suit your workflow, you can can also show `Rejected` and `Approved` strings to make sure reviewed strings remain visible. + +## Accept and Reject buttons + +If you have review permission for a document, you will see an extra pair of buttons next to each editor cell to accept or reject the translation. You will have review permission if you are a reviewer for the language, or if you are a maintainer for the project. Maintainers may wish to review strings to make sure they are correctly formatted for the environment, particularly for software translations. + +
+Editor approved button +
+
+ +## Accepting Translations + +If you decide a translation is acceptable and does not need any change, it can be approved simply by pressing the `Accept translation` button next to the editor window. This will change the state to `Approved`. + +
+Editor approved string +
+
+ +Approved state is is shown as blue bars on either side of the translation string. + + +## Rejecting Translations + +If a translation is not yet acceptable, it can be rejected so that translators know that it needs to be changed. + +To reject a translation click the `Reject translation` button next to the editor window. This will open a dialog where you can enter the reason for the rejection. + +
+Editor approved string +
+
+ +You must enter a reason for rejecting the translation - the `Confirm rejection` will not work until a reason has been entered. This is to make sure that translators can make the right changes so that the translation is acceptable, rather than trying to guess why it was rejected. + +Rejected state is shown as orange bars on either side of the translation string. You will also notice an indicator on the top right of the text area showing that there is a comment. Clicking the comment indicator will open the history view where the comment is shown. + +
+Editor rejected string +
+
+ +You can also open the history view by clicking the `History` button on the right. + +
+Editor rejected string +
+
+ +When a translation is rejected, the reason for the rejection is shown as a comment in history view, with the `Rejected` state shown above it. + +There is also a space where additional comments can be added. This may be useful for discussing a rejected translation, but keep in mind that at the time of writing, reviewers do not yet receive any notification when there is a new comment on a rejected translation. + +
+Editor rejected history +
+
+ + + diff --git a/docs/user-guide/translation-reuse/copy-trans.md b/docs/user-guide/translation-reuse/copy-trans.md new file mode 100644 index 0000000000..07d76bd91b --- /dev/null +++ b/docs/user-guide/translation-reuse/copy-trans.md @@ -0,0 +1,78 @@ +# Overview + +Copy Trans is a service that finds valid translations for documents by finding matching strings in other documents that are already translated. + +Copy Trans can save a lot of translation effort when adding a new version of a project that has been translated in Zanata. Because many of the strings will usually be the same between versions, many translations can be safely copied from the previous version. + +Copy Trans usually runs automatically when a document is uploaded using the cli-client. The Copy Trans Options for the project are used in this case. You can also run Copy Trans manually against a project version. + +# Rules + +Copy Trans works by trying to find a good match for every string in a document in every language. + +For each string that does not yet have a translation in either a "Translated" or "Approved" state, Copy Trans searches for strings with exactly the same content that have a translation, and checks every string in every project in Zanata that has a translation in either a "Translated" or "Approved" state. When Copy Trans finds a matching string, it checks a set of conditions to determine the next step. This is repeated for each language. + +*Note:* Copy Trans only considers strings that have exactly the same source content. If you want to use strings that are not exactly the same, use the Translation Memory Merge feature in the editor. + +If any "Translated" or "Approved" strings have the same source content and satisfy all the conditions, one of these strings will be used. If there is only one such string, it will be used. If there are multiple strings, the closest match is selected by: + + 1. If any strings satisfy all conditions without matching a `Don't Copy` or `Continue as Fuzzy` condition, the latest translation is used. + 1. Otherwise, if any strings reach rule 5 without matching a `Don't Copy` rule, but match a `Continue as Fuzzy` rule, a "Fuzzy" string is used. If there is more than one such string, the strings that match later `Copy as Fuzzy` conditions take higher priority. The highest priority string is used, or if multiple strings share the highest priority, the string with the latest translation is used. + 1. If all strings match one or more `Don't Copy` rules, no translation is copied for the text flow. + +This process is repeated for each text flow in the uploaded document, or, if Copy Trans is run against a project version, for each text flow in each document in the project version. + +*Note:* If a "Fuzzy" translation already exists for a text flow, it may be overwritten by a "Translated" or "Approved" translation. Consequently, Copy Trans is best used before translation and review work is initiated on a project, because overwriting partly-completed translations and rejected strings could interfere with translator and reviewer work flows and cause confusion. + +## Examples of Copy Trans Options + +#### Permissive Options + +If `Continue` is selected for all conditions, only the required "On content mismatch" rule is checked. This means that if a string has matching content it bypasses all other conditions and is reused in a "Translated" state (or "Approved" if your project requires review and the translation being copied is already in "Approved" state). When there are multiple matches, the latest translation is used. + +
+Copy trans permissive options +
+
+ +#### Strict Options + +If `Don't Copy` is selected for all conditions, a string must have matching content, a matching ID, be from the same project, and be from a document with the same name and path, otherwise it will not be reused. If all of the conditions are passed, the content is reused in a "Translated" state (or "Approved" if your project requires review and the translation being copied is already in "Approved" state). + +
+Copy trans strict options +
+
+ +#### Options for a New Version + +For this example, consider that you have a new version of your project in Zanata. The previous version is completely translated and you want to reuse the translations, but the new version uses a different directory structure. This means that the document paths have all changed. The ID for most strings is the same, but some new strings have been added. You should set up the options as follows: + +1. To ensure that Copy Trans uses strings from the other version in your project only, set "On project mismatch" to `Don't Copy`. +1. To ensure that the changed document paths do not affect the reuse process, set "On document mismatch" to `Continue`. +1. Because most string IDs have not changed, set "On Context mismatch" to `Continue as Fuzzy`. + +
+Copy trans new version +
+
+ + +## Running Copy Trans + +You can run Copy Trans manually against a project version. + +1. On the project version page, click on `More actions` menu on the top right. +
+Copy trans access +
+
+1. Select `Copy Translations`. +1. Select the appropriate action for each condition, and then click `Copy Translations` button. + +
+Copy trans dialog +
+
+ +A progress bar on the version page displays the progress of the operation. Depending on the size of the project and the number of available translations, this process can take some time to complete. diff --git a/docs/user-guide/translation-reuse/copy-version.md b/docs/user-guide/translation-reuse/copy-version.md new file mode 100644 index 0000000000..db2c10654d --- /dev/null +++ b/docs/user-guide/translation-reuse/copy-version.md @@ -0,0 +1,40 @@ +Copy version is a service that allow project maintainers to create new project version by branching off existing version in the same project. + +This saves project maintainer from uploading the same source and translation documents every time a new version is required. + +When [creating new version](user-guide/versions/create-version), project maintainer can select if it will be copying from an existing version in the same project. + +## Run copy version + +### From create new version page + +1. [Create a new version](user-guide/versions/create-version). +1. Select option `Copy from previous version`. +1. Select the version you wish to copy from. + +In the screen shot below, this will create a new version **0.3** and copying all information and history from version **0.2**. + +
+Copy version +
+
+ +A progress bar on the version page will displays the progress of the operation. + +### From existing version + +1. Go to `Version` tab in your project page. +1. Locate the version you wish to branch off, click on the menu in front of the version and select `Copy to new version`. +
+Copy version access +
+
+1. The same menu can access by going to the version page, and click on `More action` menu on the top right. Select `Copy to new version`. +
+Copy version access +
+
+1. This will redirect you to [Create a new version](user-guide/versions/create-version) with pre-selected version. +1. Fill in new version id and click `Create Version` to start. + +A progress bar on the version page will displays the progress of the operation. \ No newline at end of file diff --git a/docs/user-guide/translation-reuse/merge-trans.md b/docs/user-guide/translation-reuse/merge-trans.md new file mode 100644 index 0000000000..45228d0714 --- /dev/null +++ b/docs/user-guide/translation-reuse/merge-trans.md @@ -0,0 +1,23 @@ +Merge translation allows project maintainer to merge translations between 2 project versions. + +Only matching translate/approved translations from source version will be copied to the target version. + +If there is an existing translate/approved translations, the newer translation will be used. + +## Run merge translation + +1. Navigate to the project version page you wish to merge translations to. +1. Click on `More action` menu on the top right. Select `Merge translations`. +
+Merge translation access +
+
+1. In popup windows, select your project and version that you want to copy translation from. +
+Merge translation +
+
+1. `Keep existing translated/approved translations` - select if you do not want to merge translation to replace existing translated/approved translations with newer translations from this source. +1. Click `Merge Translations` to start. + +A progress bar on the version page will displays the progress of the operation. \ No newline at end of file diff --git a/docs/user-guide/translator-guide.md b/docs/user-guide/translator-guide.md new file mode 100644 index 0000000000..2fb6d03adc --- /dev/null +++ b/docs/user-guide/translator-guide.md @@ -0,0 +1,29 @@ +# Contributing Translations + +Any translator who has joined a language team can participate in the document translation process. + +# Start translate a project version + +1. Login as user. Make sure you have [joined at least 1 language team](user-guide/languages/language-team#join-a-language-team). +1. Click on the `Projects` menu option on the top menu. +1. Click on project you wish to translation from the list. +1. In project page, locate the version you wish to translate. +1. Click on `Options` and select `Translate in {your language}`. +
+Start translate +
+
+ +# Start translating a specific document in a project version + +1. Login as user. Make sure you have [joined at least 1 language team](user-guide/languages/language-team#join-a-language-team). +1. Click on the `Projects` menu option on the top menu. +1. Click on project you wish to translation from the list. +1. In project page, click on the version you wish to translate. +3. In version page, open up the language page (default page) and select a language. +4. Click on the document name to open up the [editor](user-guide/editor/editor-view). + +
+Select document +
+
\ No newline at end of file diff --git a/docs/user-guide/translators-new-account.md b/docs/user-guide/translators-new-account.md deleted file mode 100644 index 8fd548a12f..0000000000 --- a/docs/user-guide/translators-new-account.md +++ /dev/null @@ -1,28 +0,0 @@ -# Creating a New Account and Signing In - -Users looking to become translators must first create a new account and sign in. - -## Creating a New Account - -To create a new account: - -1. Navigate to your translation site -1. Click the "Register" link in the top-right menu of the site -1. Follow the instructions to create your new account - -## Signing In to Your Account - -To Sign In to your account: - -1. Navigate to your translation site -1. Click the "Sign In" link located in the top-right menu of the site -1. Enter your username and password in the respective fields -1. You also have the option of a persistent login by clicking "Remember Me" -1. Click "Sign-In" to complete your Sign In - -## Signing Out of Your Account - -To Sign Out of your account: - -1. Navigate to your translation site -1. Click the "Sign Out" link located in the top-right menu of the site \ No newline at end of file diff --git a/docs/user-guide/versions/create-version.md b/docs/user-guide/versions/create-version.md new file mode 100644 index 0000000000..c1d4345922 --- /dev/null +++ b/docs/user-guide/versions/create-version.md @@ -0,0 +1,47 @@ +Documents for a project are grouped into versions, rather than being added directly to the project. + +For simple projects, it is typical to create a single version named 'master'. Other projects use workflows in which there is a version under active development, and one or more versions that are being maintained in a stable state with only some minor changes. Grouping these related versions under the same project allows for easier reuse of translations between versions. + + + 1. [Create a project](user-guide/projects/create-project). + 1. **Create a version under the project.** + 1. Upload documents to the version: + - Using the website + - Using the [command-line client push command](http://zanata-client.readthedocs.org/en/latest/commands/push/) + + +## Version creation through the website + +To add a version to your project, navigate to the project using the menu or user dashboard, go to `Version` tab, click on `More action` and select `New Version`. If your project has no versions yet, there will be a link under the project on the user dashboard to jump straight to version creation. + +![Version creation button on a project homepage](images/version-create.png) + +Version creation button on a project homepage. + +![Shortcut version creation link on user dashboard](images/user-dashboard-create-version.png) + +Shortcut version creation link on user dashboard. + + +The following screenshot shows the version creation page. The settings in this screenshot will create a version under the 'zanata-server' project with ID 'master', that does not require a review phase for translations and will use the locales and validations from the project. See below for details on each option. + + +![Example version creation form with completed name and other settings](images/version-create-new.png) + + +### Version ID + +This is the identifier used to refer to the version on the Zanata website and when using one of the Zanata clients. Versions do not use a separate display name. + +### Project Type + +Project Type defines the type of files that your project uses to store source and translation strings. For more information see the [Project Types](user-guide/projects/project-types). + +### Copy from previous version + +If selected, this new version is will based off the selected version. +See [Copy version](user-guide/translation-reuse/copy-version) for more information. + +## Version creation through the command line + +Versions can also be created using the command-line client. See the help output of the client for a list of available options. diff --git a/docs/user-guide/versions/download-translations.md b/docs/user-guide/versions/download-translations.md new file mode 100644 index 0000000000..2469ba25fb --- /dev/null +++ b/docs/user-guide/versions/download-translations.md @@ -0,0 +1,34 @@ +# Download translations + +Zanata allow anyone to download translations from a project version. + +### From website + +1. Go to project version page +1. In Language tab, select a translation language that you wish to download. + +#### Download all translation documents + +1. On right panel, click on the drop down menu, select `Download All(zip)`. +
+Download all translation files +
+
+ +1. Click on `Download` button to start downloading. +
+Download all translation files dialog +
+
+ +#### Download individual translation document + +1. Click on drop down menu located in front of a document. +1. Select `Download translated [supported file format]`. +
+Download translation file +
+ +### From client + +See [Zanata-Client pull command](http://zanata-client.readthedocs.org/en/latest/commands/pull/) for more information. diff --git a/docs/user-guide/merge-translations.md b/docs/user-guide/versions/merge-translations.md similarity index 100% rename from docs/user-guide/merge-translations.md rename to docs/user-guide/versions/merge-translations.md diff --git a/docs/user-guide/versions/request-to-join-group.md b/docs/user-guide/versions/request-to-join-group.md new file mode 100644 index 0000000000..7588a9fd0c --- /dev/null +++ b/docs/user-guide/versions/request-to-join-group.md @@ -0,0 +1,13 @@ +Project maintainer can request for their project version to be part of certain Group in Zanata. To request to join a group, + +1. Navigate to the group page you wish to join. +2. On the right panel, click on the drop down menu, and select "Request to add a project version to {{Group name}}". +
+ Request to join group +
+
+3. In the dialog, search and click from the drop down for your maintained project, and check the version you wish to join into the group. +4. Fill in `Additional information` for group maintainer and click `Send`. +
+ Request to join group +
\ No newline at end of file diff --git a/docs/user-guide/versions/upload-strings.md b/docs/user-guide/versions/upload-strings.md new file mode 100644 index 0000000000..04dc848cdc --- /dev/null +++ b/docs/user-guide/versions/upload-strings.md @@ -0,0 +1,59 @@ +# Upload Strings + +Anyone with an account on Zanata can create a translation project for their strings. + +You will need to [Create a project](projects/create-project) and [Create a version](versions/create-version) to upload strings. + +------------ + +### From website + +* Go to project version page + +#### Uploading new source documents + +1. Go to `Documents` tab, click on down arrow on top of Document panel. +Upload source document +1. Select `Upload new source document`. +1. Browse or Drag your documents into the dialog and click `Upload Documents`. +1. You can access the same dialog in by go to `Settings` tab -> `Documents` section. Click `+` sign on top left panel. +Upload source document dialog +
+ +#### Updating existing source documents + +1. Go to `Documents` tab, click on down arrow on left side of document and select `Update this document`. +1. Select your file and choose the source language for this file. +1. Click `Upload` to proceed. + +Upload source document + +*Alternatively* + +1. Go to `Settings` tab -> `Documents` section. Click `+` sign on top left panel. +1. Click on `Update this document` icon on right side of a document. +1. Select your file and choose the source language for this file. +1. Click `Upload` to proceed. + +Upload source document from settings + + +#### Uploading translation documents + +1. Click on `Languages` tab in version page, select the language of translation document you wish to upload. +1. On right panel, click on the down arrow(Translation option) on left side of document and select `Upload translation`. + +Upload translation document + + +Upload translation document dialog + +1. On the dialog, select your translation file. + - `Merge` option - If unchecked, uploaded translations overrides current translation, otherwise, it will merge with current translation in system. + - `My translations` option - Indicates if all uploaded translations were translated by you. + +------------ + +### From client + +See [Zanata-Client push command](http://zanata-client.readthedocs.org/en/latest/commands/push/) for more information. diff --git a/docs/user-guide/versions/version-settings.md b/docs/user-guide/versions/version-settings.md new file mode 100644 index 0000000000..b49b090871 --- /dev/null +++ b/docs/user-guide/versions/version-settings.md @@ -0,0 +1,76 @@ +Once a version has been created, the maintainer can add further details and version behaviour via the Settings tab. +See the [Version Creation Help](user-guide/versions/create-version) for details on creating version. +
+Version General Settings tab +
Versions Settings tab link.
+
+ +------------ + +## General Settings + +
+Version General Settings tab +
Version General Settings tab
+
+
+ +### Project Type + +Project Type settings by default inherits from project's settings but maintainers are able to select a different project type for the version. See [Project Types](user-guide/projects/project-types) and [Project Settings](user-guide/projects/project-settings/#project-type) for more information. + +### Make this version read only + +This button is used to set a version to read-only, which prevents translations being entered. This may be useful in some cases, but should be used sparingly so that translators are able to work on your project. + +This can be toggled using the same button, as desired. + +------------ + +## Documents Settings + +
+Version Documents Settings tab +
Version Documents Settings tab
+
+ +------------ + +### Adding source document + +Click `+` sign on top left in Documents tab under Settings. Browse or Drag your documents into the dialog and click `Upload Documents`. + +------------ + +## Languages Settings + +
+Version Languages Settings tab +
Version Languages Settings tab
+
+ +------------ + +### Customized locales + +By default, your project will be available for translation to a set of locales defined for your project, or on the Zanata server if your project does not have customized locales. If your version requires a different set of locales from your project, click `Enable` or `Disable` button on right side of the locale. + +------------ + +## Translation Settings + +
+Version Translation Settings tab +
Version Translation Settings tab
+
+ +------------ +### Require translation review + +See [Review overview](user-guide/review/overview) for more information. + +### Customized list of validations + +If your version requires a different set of validations than the parent project, they can be selected here. If customized validations are not specified, the validations specified for your project will be used. An advantage of inheriting validations from the poject is that new validations can be added to the project without having to add them to each different version. + +For more information, see [Project settings](user-guide/projects/project-settings#validations). diff --git a/mkdocs.yml b/mkdocs.yml index eb6e6537ac..0744f10284 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,8 +7,74 @@ theme: readthedocs pages: - ['index.md', 'Home'] +# Getting started +- ['user-guide/translator-guide.md', 'Getting Started', 'Translator Guide'] +- ['user-guide/project-maintainer-guide.md', 'Getting Started', 'Project Maintainer Guide'] +## Accounts +- ['user-guide/account/account-sign-up.md', 'Accounts', 'Create new account'] +- ['user-guide/account/account-activate.md', 'Accounts', 'Activate account'] +- ['user-guide/account/account-resend-activation.md', 'Accounts', 'Resend activation email'] +- ['user-guide/account/account-settings.md', 'Accounts', 'Account settings'] +- ['user-guide/account/user-profile.md', 'Accounts', 'User profile'] +- ['user-guide/account/user-dashboard.md', 'Accounts', 'User dashboard'] +## Projects +- ['user-guide/projects/project-view.md', 'Projects', 'Project view'] +- ['user-guide/projects/create-project.md', 'Projects', 'Creating a project'] +- ['user-guide/projects/project-settings.md', 'Projects', 'Project settings'] +- ['user-guide/projects/project-types.md', 'Projects', 'Project types'] +- ['user-guide/projects/validations.md', 'Projects', 'Validations'] +- ['user-guide/projects/import-projects.md', 'Projects', 'Import Projects'] +- ['user-guide/projects/gettext-example.md', 'Projects', 'Gettext Project example'] +- ['user-guide/projects/podir-example.md', 'Projects', 'Podir Project example'] +## Versions +- ['user-guide/versions/version-view.md', 'Versions', 'Version view'] +- ['user-guide/versions/create-version.md', 'Versions', 'Creating a version'] +- ['user-guide/versions/version-settings.md', 'Versions', 'Version settings'] +- ['user-guide/versions/request-to-join-group.md', 'Versions', 'Join a group'] +- ['user-guide/versions/merge-translations.md', 'Versions', 'Merge translations'] +- ['user-guide/versions/upload-strings.md', 'Versions', 'Upload documents'] +- ['user-guide/versions/download-translations.md', 'Versions', 'Download translations'] +## Languages +- ['user-guide/languages/language-team.md', 'Languages', 'Language team'] +- ['user-guide/languages/add-team-member.md', 'Languages', 'Add members'] +- ['user-guide/languages/modify-role.md', 'Languages', 'Modify role'] +## Review +- ['user-guide/review/overview.md', 'Translation Review', 'Overview'] +- ['user-guide/review/review-enable.md', 'Translation Review', 'Enabling review in version'] +- ['user-guide/review/add-reviewer.md', 'Translation Review', 'Add reviewer'] +- ['user-guide/review/translation-review.md', 'Translation Review', 'Start reviewing'] +## Translation reuse +- ['user-guide/translation-reuse/copy-trans.md', 'Translation Reuse', 'Copy Trans'] +- ['user-guide/translation-reuse/copy-version.md', 'Translation Reuse', 'Copy version'] +- ['user-guide/translation-reuse/merge-trans.md', 'Translation Reuse', 'Merge translations'] +### merge translation from existing version -# Configuration Guide +## Groups +- ['user-guide/groups/group-view.md', 'Groups', 'Group view'] +- ['user-guide/groups/create-group.md', 'Groups', 'Creating a group'] +- ['user-guide/groups/group-settings.md', 'Groups', 'Group settings'] +## Editor +- ['user-guide/editor/overview.md', 'Editor', 'Overview'] +- ['user-guide/editor/editor-view.md', 'Editor', 'Editor view'] +- ['user-guide/editor/documents-view.md', 'Editor', 'Document view'] +- ['user-guide/editor/keyboard-shortcuts.md', 'Editor', 'Keyboard shortcuts'] +- ['user-guide/editor/translation-history.md', 'Editor', 'Translation history'] +## Glossary +- ['user-guide/glossary/glossary-roles-permissions.md', 'Glossary', 'Roles and Permissions'] +- ['user-guide/glossary/upload-glossaries.md', 'Glossary', 'Upload glossaries'] +- ['user-guide/glossary/edit-glossaries.md', 'Glossary', 'Edit glossaries'] +- ['user-guide/glossary/delete-glossaries.md', 'Glossary', 'Delete glossaries'] +## API +- ['user-guide/api/api.md', 'API', 'Zanata API'] +## Client +- ['user-guide/client/client.md', 'Zanata Client', 'Zanata client'] +## Drupal +- ['user-guide/drupal/drupal.md', 'Drupal plugin', 'Drupal plugin'] +## Admin +- ['user-guide/admin/admin-overview.md', 'Admin', 'Overview'] +- ['user-guide/admin/contact-admin.md', 'Admin', 'Contact Admin'] +## need tmx section +# Configuration - ['configuration/installation.md', 'Configuration', 'Installation'] - ['configuration/authentication.md', 'Configuration', 'Authentication'] - ['configuration/document-storage-directory.md', 'Configuration', 'Document Storage Directory'] @@ -17,26 +83,6 @@ pages: - ['configuration/infinispan.md', 'Configuration', 'Caches'] - ['configuration/jms-messaging.md', 'Configuration', 'JMS Messaging'] -# Release notes -- ['release-notes.md', 'Release Notes', 'Release Notes'] - -# User Guide -- ['user-guide/translators-new-account.md', 'User Guide', 'Creating a new account'] -- ['user-guide/joining-a-language-team.md', 'User Guide', 'Joining a Language team'] -- ['user-guide/contributing-translations.md', 'User Guide', 'Contributing Translations'] -- ['user-guide/keyboard-shortcuts.md', 'User Guide', 'Keyboard Shortcuts'] -- ['user-guide/project-types.md', 'User Guide', 'Project Types'] -- ['user-guide/client-configuration.md', 'User Guide', 'Client Configuration'] -- ['user-guide/client-command-hook.md', 'User Guide', 'Client Command Hook'] -- ['user-guide/user-profile.md', 'User Guide', 'User Profile Page'] -- ['user-guide/merge-translations.md', 'User Guide', 'Merge translations'] -## Project -- ['user-guide/projects/create-project.md', 'User Guide', 'Creating a Project'] -- ['user-guide/projects/project-settings.md', 'User Guide', 'Project settings'] -- ['user-guide/projects/create-version.md', 'User Guide', 'Creating a Version'] -- ['user-guide/projects/upload-strings.md', 'User Guide', 'Upload Strings'] -- ['user-guide/projects/project-view.md', 'User Guide', 'The Project View'] -## Version -- ['user-guide/versions/version-view.md', 'User Guide', 'The Version View'] +- ['release-notes.md'] copyright: Copyright © 2015, Red Hat.