Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/community/l10n_community_roles.html b/community/l10n_community_roles.html
new file mode 100644
index 00000000..d62fba01
--- /dev/null
+++ b/community/l10n_community_roles.html
@@ -0,0 +1,338 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Localization community in Mozilla
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/community/l10n_feedback.html b/community/l10n_feedback.html
new file mode 100644
index 00000000..c7acc0a2
--- /dev/null
+++ b/community/l10n_feedback.html
@@ -0,0 +1,270 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Roles and guidelines in the localization community
+Volunteer communities are the backbone of the localization (l10n) efforts at Mozilla. They are designed to be self-regulating and self-managing with minimal intervention from staff. For example, the responsibility of reviewing suggestions falls on the Translators and Managers within the community; they not only ensure quality and consistency but also keep an eye out for potential new volunteers to promote. And when Managers plan to step down, it’s crucial they develop succession plans to maintain continuity.
+The role of staff is to intervene only when necessary. The main reasons for staff to be involved is when self-regulation fails or there are violations of the Community Participation Guidelines (CPG). The goal is to empower the communities to thrive independently while maintaining the high standards that Mozilla is known for.
+The localization team can occasionally take a more hands-on approach, proactively engaging with locales that are facing challenges. For example, it can happen when a member (or members) of a locale reaches out directly to localization staff to express concerns about their community. Other times, the team may receive product requests for specific locales, which prompts initiatives to ensure that these communities are capable of supporting the product expansion.
+In the following sections, we’ll review the current roles and expectations and suggest guidelines for when role criteria are not met — and how the localization staff can get involved and help in these different scenarios.
+Roles: responsibilities and expectations
+Managers
+Responsibilities
+On top of the responsibilities associated with the Translator role:
+-
+
- Establish mentorship practices for new localizers that foster growth and lead to impactful participation. +
- Identify and train community mentors in their role. +
- Coordinate translation and l10n testing of projects within the l10n community. +
- Provide input and consultation with localizers, evaluate candidates for advanced roles within the community. +
- Coordinate and facilitate internal community discussions. +
- Create and maintain language resources for the community (e.g., terminology, style guides, etc.). +
Expectations
+-
+
- Open and frequent communication (liaison between l10n-drivers and l10n community) concerning new projects, new deadlines, and community issues. +
- Create and secure a safe space for people to participate in l10n in an impactful way. +
- Recruit and mentor new localizers. +
- Give timely feedback to community mentors and translators. +
Translators
+Responsibilities
+-
+
- Submit translations for new content. +
- Review pending translation suggestions from contributors and provide them with timely feedback that focuses on developing skills. +
- Testing of all submitted translations in product. +
- Work with Managers to create and maintain language resources for the community. +
- Report issues concerning source language content issues. +
Expectations
+-
+
- Ensure consistent quality of the project they’re localizing. +
- Give detailed feedback to contributors in a timely manner. +
- Translate new content regularly. +
- Ensure that community style guidelines are being followed in translations that make it to the repositories. +
- Keep pending translation suggestion queue to a low number. +
- Gracefully accept feedback on their translations from other Translators and Managers. +
Contributors
+Responsibilities
+-
+
- Submit translation suggestions to Pontoon projects for the target language. +
- Request and accept feedback from Translators and Managers in the community. +
- In-context review (l10n testing) of translation suggestions that have been approved by Translators and Managers. +
Expectations
+-
+
- Gracefully accept feedback on their translations from Translators and Managers. +
- Avoid relying exclusively on machine translation, especially when unsure about the source string or the language. +
- Proactively request feedback from Translators and Managers. +
- Network and form relationships with others in the community. +
Guidelines
+Promotions
+Promotions apply to Translators and Contributors. Managers and localization staff can directly promote/demote users to Translator or Manager roles.
+Efforts to revive an inactive community
+A community is considered inactive when there are no other active Translators or Managers, which can make it difficult for Contributors to participate effectively. If a Contributor has attempted to reach out to the Managers or Translators but has not received a satisfactory response (or any response) within a few weeks, it’s advisable to contact the localization staff for assistance. Each situation is unique, and staff can help investigate further, for example reviewing a localizer’s contribution history across external localization projects outside of Mozilla. The localization team will also reach out to former Managers and Translators for their input. If there is still no response, the localization team will consider promoting active localizers who have expressed interest in taking on an active role.
+Community engagement
+Localizers who actively participate in community discussions, provide feedback and reviews, mentor new members, and engage in localization events and workshops should be recognized and promoted for their dedication and leadership within the community. They often transition from direct translation work to more managerial roles, focusing on building and enabling the locale community.
+How do you recognize and promote them? Existing locale Managers are typically in charge of updating the permissions on Pontoon. Staff will step in if there are reasons preventing a person from reaching the next role (for example, if there are no active Managers, or if there is gatekeeping).
+In the case there is no existing community, a localizer requesting a new locale will be appointed to the Manager role.
+High-quality contributions
+A localizer who consistently provides high-quality translations that meet the community’s standards should be considered for promotion. This includes accuracy, adherence to style guides, and timely contributions and reviews. Contribution data on Pontoon can be used to help guide these decisions.
+Demotions
+Demotions should come as a last resort when a localizer’s actions significantly impact the project’s quality, collaboration, or community. In practice demotions are extremely rare and historically have occurred when a Manager or Translator voluntarily expresses a desire to step back from their roles and expectations.
+Here are some examples of reasons for demotion.
+A localizer wants to take a step back
+As explained, a request for demotion can come from localizers themselves, when they want to delegate certain responsibilities. This is a straightforward scenario, in which a localizer typically will reach out to the manager — or localization staff — to express their desire to step down. Managers have the permissions to do so themselves, but localization staff can also assist.
+A localizer is failing to meet role expectations
+A localizer might notice that a Manager or Translator is abusing their role, especially in ways that may be considered gatekeeping. After the community has tried to get in touch with the Managers or Translators, but has not received a satisfactory response (or any response) after a few weeks, reaching out to the localization staff is a good first step for the team to help investigate and find solutions, as each situation is unique. Note that the localization team rarely demotes anyone unless it’s a grave situation, but they can help promote or unblock users.
+Prolonged inactivity
+Typically there isn’t a need to demote a Manager or Translator due to inactivity, unless gatekeeping or retaliation disrupt the work of others.
+Community guidelines enforcement
+CPG violation
+A CPG violation is taken very seriously and will be addressed immediately. The process for reporting a violation is detailed under the “Reporting” section of the CPG.
+Gatekeeping
+Gatekeeping can show up in different ways in localization communities/localizers:
+-
+
- Not reviewing new Contributors’ work, which prevents them from joining and contributing. +
- Self-reviewing their own work and ignoring the work done by others — or constantly rejecting others’ contributions as not good enough to maintain control over the locale. +
- Creating unnecessary barriers to participation, like setting very strict standards without offering guidance or feedback, holding onto knowledge or resources instead of sharing with the community, and resisting changes or improvements suggested by others without explanation. +
- Being inactive for a long period of time, but nonetheless never wanting to give permissions to others actively participating. +These actions limit the growth and diversity of the community, making it less welcoming and inclusive. +
How does the localization team know someone is gatekeeping? This can happen through direct feedback, or through the localization team’s own investigations.
+If a localizer has attempted to reach out to Managers or Translators but has not received a satisfactory response (or any response) within 2 weeks, it’s advisable to contact the localization staff for assistance.
+Common issues and references
+How can I contact the localization staff?
+If you have contacted members of your team and received no responses, have questions about these guidelines or want to suggest improvements, don’t hesitate to get in touch with the localization staff:
+-
+
- You can use email and Matrix to reach out to the entire team. +
- You can also find the member of staff in charge of each project directly in Pontoon. +
I am a Translator and want to become a Manager, what do I do?
+Try to get in touch with the current Managers and Translators from your locale, to surface your request (you can find them under the Contributor view in your team page on Pontoon). Check also the Promotions section. You can also reach out to the localization team directly.
+No one is reviewing my suggestions, what do I do?
+Try to get in touch with the current Managers and Translators from your locale, to surface your request (you can find them under the Contributor view in your team page on Pontoon). You can also reach out to the localization team directly.
+I’m a new Contributor and am interested in becoming a Translator for only one project.
+Get in touch with the locale Managers first, to ask them to appoint you to only one project. If there is no response within a few weeks, reach out to the localization team.
+How can I delete my Pontoon account?
+Currently users cannot remove their account directly from Pontoon. Reach out to the localization team.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/css/chrome.css b/css/chrome.css
new file mode 100644
index 00000000..83b7969b
--- /dev/null
+++ b/css/chrome.css
@@ -0,0 +1,604 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+
+/*
+ body-container is necessary because mobile browsers don't seem to like
+ overflow-x on the body tag when there is a tag.
+*/
+#body-container {
+ /*
+ This is used when the sidebar pushes the body content off the side of
+ the screen on small screens. Without it, dragging on mobile Safari
+ will want to reposition the viewport in a weird way.
+ */
+ overflow-x: clip;
+}
+
+/* Menu Bar */
+
+#menu-bar,
+#menu-bar-hover-placeholder {
+ z-index: 101;
+ margin: auto calc(0px - var(--page-padding));
+}
+#menu-bar {
+ position: relative;
+ display: flex;
+ flex-wrap: wrap;
+ background-color: var(--bg);
+ border-block-end-color: var(--bg);
+ border-block-end-width: 1px;
+ border-block-end-style: solid;
+}
+#menu-bar.sticky,
+.js #menu-bar-hover-placeholder:hover + #menu-bar,
+.js #menu-bar:hover,
+.js.sidebar-visible #menu-bar {
+ position: -webkit-sticky;
+ position: sticky;
+ top: 0 !important;
+}
+#menu-bar-hover-placeholder {
+ position: sticky;
+ position: -webkit-sticky;
+ top: 0;
+ height: var(--menu-bar-height);
+}
+#menu-bar.bordered {
+ border-block-end-color: var(--table-border-color);
+}
+#menu-bar i, #menu-bar .icon-button {
+ position: relative;
+ padding: 0 8px;
+ z-index: 10;
+ line-height: var(--menu-bar-height);
+ cursor: pointer;
+ transition: color 0.5s;
+}
+@media only screen and (max-width: 420px) {
+ #menu-bar i, #menu-bar .icon-button {
+ padding: 0 5px;
+ }
+}
+
+.icon-button {
+ border: none;
+ background: none;
+ padding: 0;
+ color: inherit;
+}
+.icon-button i {
+ margin: 0;
+}
+
+.right-buttons {
+ margin: 0 15px;
+}
+.right-buttons a {
+ text-decoration: none;
+}
+
+.left-buttons {
+ display: flex;
+ margin: 0 5px;
+}
+.no-js .left-buttons button {
+ display: none;
+}
+
+.menu-title {
+ display: inline-block;
+ font-weight: 200;
+ font-size: 2.4rem;
+ line-height: var(--menu-bar-height);
+ text-align: center;
+ margin: 0;
+ flex: 1;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+.js .menu-title {
+ cursor: pointer;
+}
+
+.menu-bar,
+.menu-bar:visited,
+.nav-chapters,
+.nav-chapters:visited,
+.mobile-nav-chapters,
+.mobile-nav-chapters:visited,
+.menu-bar .icon-button,
+.menu-bar a i {
+ color: var(--icons);
+}
+
+.menu-bar i:hover,
+.menu-bar .icon-button:hover,
+.nav-chapters:hover,
+.mobile-nav-chapters i:hover {
+ color: var(--icons-hover);
+}
+
+/* Nav Icons */
+
+.nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+
+ position: fixed;
+ top: 0;
+ bottom: 0;
+ margin: 0;
+ max-width: 150px;
+ min-width: 90px;
+
+ display: flex;
+ justify-content: center;
+ align-content: center;
+ flex-direction: column;
+
+ transition: color 0.5s, background-color 0.5s;
+}
+
+.nav-chapters:hover {
+ text-decoration: none;
+ background-color: var(--theme-hover);
+ transition: background-color 0.15s, color 0.15s;
+}
+
+.nav-wrapper {
+ margin-block-start: 50px;
+ display: none;
+}
+
+.mobile-nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+ width: 90px;
+ border-radius: 5px;
+ background-color: var(--sidebar-bg);
+}
+
+/* Only Firefox supports flow-relative values */
+.previous { float: left; }
+[dir=rtl] .previous { float: right; }
+
+/* Only Firefox supports flow-relative values */
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+[dir=rtl] .next {
+ float: left;
+ right: unset;
+ left: var(--page-padding);
+}
+
+/* Use the correct buttons for RTL layouts*/
+[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
+[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+/* sidebar-visible */
+@media only screen and (max-width: 1380px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a) > .hljs {
+ color: var(--inline-code-color);
+ overflow-x: initial;
+}
+
+a:hover > .hljs {
+ text-decoration: underline;
+}
+
+pre {
+ position: relative;
+}
+pre > .buttons {
+ position: absolute;
+ z-index: 100;
+ right: 0px;
+ top: 2px;
+ margin: 0px;
+ padding: 2px 0px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+ visibility: hidden;
+ opacity: 0;
+ transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+pre:hover > .buttons {
+ visibility: visible;
+ opacity: 1
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+ border-color: var(--icons-hover);
+ background-color: var(--theme-hover);
+}
+pre > .buttons i {
+ margin-inline-start: 8px;
+}
+pre > .buttons button {
+ cursor: inherit;
+ margin: 0px 5px;
+ padding: 3px 5px;
+ font-size: 14px;
+
+ border-style: solid;
+ border-width: 1px;
+ border-radius: 4px;
+ border-color: var(--icons);
+ background-color: var(--theme-popup-bg);
+ transition: 100ms;
+ transition-property: color,border-color,background-color;
+ color: var(--icons);
+}
+@media (pointer: coarse) {
+ pre > .buttons button {
+ /* On mobile, make it easier to tap buttons. */
+ padding: 0.3rem 1rem;
+ }
+
+ .sidebar-resize-indicator {
+ /* Hide resize indicator on devices with limited accuracy */
+ display: none;
+ }
+}
+pre > code {
+ display: block;
+ padding: 1rem;
+}
+
+/* FIXME: ACE editors overlap their buttons because ACE does absolute
+ positioning within the code block which breaks padding. The only solution I
+ can think of is to move the padding to the outer pre tag (or insert a div
+ wrapper), but that would require fixing a whole bunch of CSS rules.
+*/
+.hljs.ace_editor {
+ padding: 0rem 0rem;
+}
+
+pre > .result {
+ margin-block-start: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding-block-start: 0;
+ padding-block-end: 1px;
+ padding-inline-start: 3px;
+ padding-inline-end: 3px;
+ margin-block-start: 0;
+ margin-block-end: -1px;
+ margin-inline-start: -3px;
+ margin-inline-end: -3px;
+ background-color: var(--search-mark-bg);
+ transition: background-color 300ms linear;
+ cursor: pointer;
+}
+
+mark.fade-out {
+ background-color: rgba(0,0,0,0) !important;
+ cursor: auto;
+}
+
+.searchbar-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ padding: 10px 16px;
+ transition: box-shadow 300ms ease-in-out;
+ border: 1px solid var(--searchbar-border-color);
+ border-radius: 3px;
+ background-color: var(--searchbar-bg);
+ color: var(--searchbar-fg);
+}
+#searchbar:focus,
+#searchbar.active {
+ box-shadow: 0 0 3px var(--searchbar-shadow-color);
+}
+
+.searchresults-header {
+ font-weight: bold;
+ font-size: 1em;
+ padding-block-start: 18px;
+ padding-block-end: 0;
+ padding-inline-start: 5px;
+ padding-inline-end: 0;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+ border-block-end: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-inline-start: 20px;
+}
+ul#searchresults li {
+ margin: 10px 0px;
+ padding: 2px;
+ border-radius: 2px;
+}
+ul#searchresults li.focus {
+ background-color: var(--searchresults-li-bg);
+}
+ul#searchresults span.teaser {
+ display: block;
+ clear: both;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: 20px;
+ margin-inline-end: 0;
+ font-size: 0.8em;
+}
+ul#searchresults span.teaser em {
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Sidebar */
+
+.sidebar {
+ position: fixed;
+ left: 0;
+ top: 0;
+ bottom: 0;
+ width: var(--sidebar-width);
+ font-size: 0.875em;
+ box-sizing: border-box;
+ -webkit-overflow-scrolling: touch;
+ overscroll-behavior-y: contain;
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+}
+[dir=rtl] .sidebar { left: unset; right: 0; }
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.no-js .sidebar,
+.js:not(.sidebar-resizing) .sidebar {
+ transition: transform 0.3s; /* Animation: slide away */
+}
+.sidebar code {
+ line-height: 2em;
+}
+.sidebar .sidebar-scrollbox {
+ overflow-y: auto;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ padding: 10px 10px;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: calc(var(--sidebar-resize-indicator-width) * -1);
+ top: 0;
+ bottom: 0;
+ display: flex;
+ align-items: center;
+}
+
+.sidebar-resize-handle .sidebar-resize-indicator {
+ width: 100%;
+ height: 12px;
+ background-color: var(--icons);
+ margin-inline-start: var(--sidebar-resize-indicator-space);
+}
+
+[dir=rtl] .sidebar .sidebar-resize-handle {
+ left: calc(var(--sidebar-resize-indicator-width) * -1);
+ right: unset;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
+}
+/* sidebar-hidden */
+#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+ z-index: -1;
+}
+[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+/* sidebar-visible */
+#sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+}
+@media only screen and (min-width: 620px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
+ }
+ [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-inline-start: 0;
+ line-height: 2.2em;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ padding: 0;
+ text-decoration: none;
+ color: var(--sidebar-fg);
+}
+
+.chapter li a:hover {
+ color: var(--sidebar-active);
+}
+
+.chapter li a.active {
+ color: var(--sidebar-active);
+}
+
+.chapter li > a.toggle {
+ cursor: pointer;
+ display: block;
+ margin-inline-start: auto;
+ padding: 0 10px;
+ user-select: none;
+ opacity: 0.68;
+}
+
+.chapter li > a.toggle div {
+ transition: transform 0.5s;
+}
+
+/* collapse the section */
+.chapter li:not(.expanded) + li > ol {
+ display: none;
+}
+
+.chapter li.chapter-item {
+ line-height: 1.5em;
+ margin-block-start: 0.6em;
+}
+
+.chapter li.expanded > a.toggle div {
+ transform: rotate(90deg);
+}
+
+.spacer {
+ width: 100%;
+ height: 3px;
+ margin: 5px 0px;
+}
+.chapter .spacer {
+ background-color: var(--sidebar-spacer);
+}
+
+@media (-moz-touch-enabled: 1), (pointer: coarse) {
+ .chapter li a { padding: 5px 0; }
+ .spacer { margin: 10px 0; }
+}
+
+.section {
+ list-style: none outside none;
+ padding-inline-start: 20px;
+ line-height: 1.9em;
+}
+
+/* Theme Menu Popup */
+
+.theme-popup {
+ position: absolute;
+ left: 10px;
+ top: var(--menu-bar-height);
+ z-index: 1000;
+ border-radius: 4px;
+ font-size: 0.7em;
+ color: var(--fg);
+ background: var(--theme-popup-bg);
+ border: 1px solid var(--theme-popup-border);
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ display: none;
+ /* Don't let the children's background extend past the rounded corners. */
+ overflow: hidden;
+}
+[dir=rtl] .theme-popup { left: unset; right: 10px; }
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 20px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: start;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+
+.theme-selected::before {
+ display: inline-block;
+ content: "✓";
+ margin-inline-start: -14px;
+ width: 14px;
+}
diff --git a/css/general.css b/css/general.css
new file mode 100644
index 00000000..7670b087
--- /dev/null
+++ b/css/general.css
@@ -0,0 +1,232 @@
+/* Base styles and content styles */
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+ color-scheme: var(--color-scheme);
+}
+
+html {
+ font-family: "Open Sans", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+}
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: var(--mono-font) !important;
+ font-size: var(--code-font-size);
+ direction: ltr !important;
+}
+
+/* make long words/inline code not x overflow */
+main {
+ overflow-wrap: break-word;
+}
+
+/* make wide tables scroll if they overflow */
+.table-wrapper {
+ overflow-x: auto;
+}
+
+/* Don't change font size in headers. */
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ font-size: unset;
+}
+
+.left { float: left; }
+.right { float: right; }
+.boring { opacity: 0.6; }
+.hide-boring .boring { display: none; }
+.hidden { display: none !important; }
+
+h2, h3 { margin-block-start: 2.5em; }
+h4, h5 { margin-block-start: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-block-start: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-inline-start: -30px;
+ width: 30px;
+}
+
+/* This is broken on Safari as of version 14, but is fixed
+ in Safari Technology Preview 117 which I think will be Safari 14.2.
+ https://bugs.webkit.org/show_bug.cgi?id=218076
+*/
+:target {
+ /* Safari does not support logical properties */
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+ background-color: var(--bg);
+}
+.no-js .page-wrapper,
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 5px 50px 5px;
+}
+.content main {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+.content p { line-height: 1.45em; }
+.content ol { line-height: 1.45em; }
+.content ul { line-height: 1.45em; }
+.content a { text-decoration: none; }
+.content a:hover { text-decoration: underline; }
+.content img, .content video { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+}
+table td {
+ padding: 3px 20px;
+ border: 1px var(--table-border-color) solid;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: 3px 20px;
+}
+table thead tr {
+ border: 1px var(--table-header-bg) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ background: var(--table-alternate-bg);
+}
+
+
+blockquote {
+ margin: 20px 0;
+ padding: 0 20px;
+ color: var(--fg);
+ background-color: var(--quote-bg);
+ border-block-start: .1em solid var(--quote-border);
+ border-block-end: .1em solid var(--quote-border);
+}
+
+.warning {
+ margin: 20px;
+ padding: 0 20px;
+ border-inline-start: 2px solid var(--warning-border);
+}
+
+.warning:before {
+ position: absolute;
+ width: 3rem;
+ height: 3rem;
+ margin-inline-start: calc(-1.5rem - 21px);
+ content: "ⓘ";
+ text-align: center;
+ background-color: var(--bg);
+ color: var(--warning-border);
+ font-weight: bold;
+ font-size: 2rem;
+}
+
+blockquote .warning:before {
+ background-color: var(--quote-bg);
+}
+
+kbd {
+ background-color: var(--table-border-color);
+ border-radius: 4px;
+ border: solid 1px var(--theme-popup-border);
+ box-shadow: inset 0 -1px 0 var(--theme-hover);
+ display: inline-block;
+ font-size: var(--code-font-size);
+ font-family: var(--mono-font);
+ line-height: 10px;
+ padding: 4px 5px;
+ vertical-align: middle;
+}
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-block-start: 2em;
+}
+.footnote-definition {
+ font-size: 0.9em;
+ margin: 0.5em 0;
+}
+.footnote-definition p {
+ display: inline;
+}
+
+.tooltiptext {
+ position: absolute;
+ visibility: hidden;
+ color: #fff;
+ background-color: #333;
+ transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
+ left: -8px; /* Half of the width of the icon */
+ top: -35px;
+ font-size: 0.8em;
+ text-align: center;
+ border-radius: 6px;
+ padding: 5px 8px;
+ margin: 5px;
+ z-index: 1000;
+}
+.tooltipped .tooltiptext {
+ visibility: visible;
+}
+
+.chapter li.part-title {
+ color: var(--sidebar-fg);
+ margin: 5px 0px;
+ font-weight: bold;
+}
+
+.result-no-output {
+ font-style: italic;
+}
diff --git a/css/print.css b/css/print.css
new file mode 100644
index 00000000..80ec3a54
--- /dev/null
+++ b/css/print.css
@@ -0,0 +1,50 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none !important;
+ margin-inline-start: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ direction: ltr !important;
+}
+
+pre > .buttons {
+ z-index: 2;
+}
+
+a, a:visited, a:active, a:hover {
+ color: #4183c4;
+ text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ page-break-inside: avoid;
+ page-break-after: avoid;
+}
+
+pre, code {
+ page-break-inside: avoid;
+ white-space: pre-wrap;
+}
+
+.fa {
+ display: none !important;
+}
diff --git a/css/variables.css b/css/variables.css
new file mode 100644
index 00000000..0da55e8c
--- /dev/null
+++ b/css/variables.css
@@ -0,0 +1,279 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --sidebar-resize-indicator-width: 8px;
+ --sidebar-resize-indicator-space: 2px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+ --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+ --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* Themes */
+
+.ayu {
+ --bg: hsl(210, 25%, 8%);
+ --fg: #c5c5c5;
+
+ --sidebar-bg: #14191f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #5c6773;
+ --sidebar-active: #ffb454;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #0096cf;
+
+ --inline-code-color: #ffb454;
+
+ --theme-popup-bg: #14191f;
+ --theme-popup-border: #5c6773;
+ --theme-hover: #191f26;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(210, 25%, 13%);
+ --table-header-bg: hsl(210, 25%, 28%);
+ --table-alternate-bg: hsl(210, 25%, 11%);
+
+ --searchbar-border-color: #848484;
+ --searchbar-bg: #424242;
+ --searchbar-fg: #fff;
+ --searchbar-shadow-color: #d4c89f;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #252932;
+ --search-mark-bg: #e3b171;
+
+ --color-scheme: dark;
+}
+
+.coal {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+
+ --color-scheme: dark;
+}
+
+.light {
+ --bg: hsl(0, 0%, 100%);
+ --fg: hsl(0, 0%, 0%);
+
+ --sidebar-bg: #fafafa;
+ --sidebar-fg: hsl(0, 0%, 0%);
+ --sidebar-non-existant: #aaaaaa;
+ --sidebar-active: #1f1fff;
+ --sidebar-spacer: #f4f4f4;
+
+ --scrollbar: #8F8F8F;
+
+ --icons: #747474;
+ --icons-hover: #000000;
+
+ --links: #20609f;
+
+ --inline-code-color: #301900;
+
+ --theme-popup-bg: #fafafa;
+ --theme-popup-border: #cccccc;
+ --theme-hover: #e6e6e6;
+
+ --quote-bg: hsl(197, 37%, 96%);
+ --quote-border: hsl(197, 37%, 91%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(0, 0%, 95%);
+ --table-header-bg: hsl(0, 0%, 80%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #e4f2fe;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: light;
+}
+
+.navy {
+ --bg: hsl(226, 23%, 11%);
+ --fg: #bcbdd0;
+
+ --sidebar-bg: #282d3f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #2b79a2;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: #282e40;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(226, 23%, 16%);
+ --table-header-bg: hsl(226, 23%, 31%);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: dark;
+}
+
+.rust {
+ --bg: hsl(60, 9%, 87%);
+ --fg: #262625;
+
+ --sidebar-bg: #3b2e2a;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #e69f67;
+ --sidebar-spacer: #45373a;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #262625;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #6e6b5e;
+
+ --theme-popup-bg: #e1e1db;
+ --theme-popup-border: #b38f6b;
+ --theme-hover: #99908a;
+
+ --quote-bg: hsl(60, 5%, 75%);
+ --quote-border: hsl(60, 5%, 70%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(60, 9%, 82%);
+ --table-header-bg: #b3a497;
+ --table-alternate-bg: hsl(60, 9%, 84%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #dec2a2;
+ --search-mark-bg: #e69f67;
+
+ --color-scheme: light;
+}
+
+@media (prefers-color-scheme: dark) {
+ .light.no-js {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+ }
+}
diff --git a/elasticlunr.min.js b/elasticlunr.min.js
new file mode 100644
index 00000000..94b20dd2
--- /dev/null
+++ b/elasticlunr.min.js
@@ -0,0 +1,10 @@
+/**
+ * elasticlunr - http://weixsong.github.io
+ * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
+ *
+ * Copyright (C) 2017 Oliver Nightingale
+ * Copyright (C) 2017 Wei Song
+ * MIT Licensed
+ * @license
+ */
+!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Reviewing translations within your community
+Mozilla encourages a three-stage review process:
+-
+
- Linguistic review in Pontoon by community. +
- Technical review by l10n-drivers. +
- In-context localization testing by community and users. +
This document explains how to perform the first stage of the review process: review the work of another member of your community and provide constructive feedback.
+Attitudes around reviewing translations
+Reviewing the translation contributions of another localizer can be controversial. Many attach strong feelings to their contributions, making it very difficult for them to receive feedback and make adjustments to the way they contribute. Reviews are opportunities to ensure high quality contributions while mentoring someone to improve their translation skill set. Reviewers should approach their work with these things in mind:
+-
+
- Everyone is volunteering their time and looking to have a positive impact in their community. +
- Reviews are an opportunity to give clear, actionable feedback about another localizer’s contributions. +
- Reviews should be based on objective standards agreed upon by the community and made explicit through the community’s style guide and terminology resources rather than personal preferences. This eliminates the potential for subjective feedback or manipulation through reviews, and thus eliminates potential conflicts within the community. +
- Reviewers should avoid using vague, potentially inflammatory language in their reviews (e.g., “This translation is terrible, fix it“). +
Localizers should approach receiving feedback with these things in mind:
+-
+
- Everyone is volunteering their time and looking to have a positive impact in their community. +
- Reviews are an opportunity to develop and improve your translation skills. They should be welcomed with an open mind. +
- Reviews are a natural and required part of the localization process. +
Giving constructive feedback
+When reviewing someone else’s translations, feedback should be actionable and based on objective standards. Style guides and terminology resources developed within the community with agreement from its members contain those objective standards. Feedback should include the following elements:
+-
+
- Actionable criticism. +
- Reference to where the translation violates the objective standards. +
For example, if a translation contains a spelling error, a constructive piece of feedback would look like this: +“There’s a spelling mistake in moniter. The correct spelling can be found in either our official terminology or this section of the community style guide.“
+Tools available for giving feedback
+Pontoon currently allows reviewers to do the following:
+-
+
- Approve or reject suggestions. +
- Make edits to existing translation submissions. +
A more robust feedback loop will be implemented in Pontoon during the beginning of 2018.
+ +":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/mark.min.js b/mark.min.js
new file mode 100644
index 00000000..16362318
--- /dev/null
+++ b/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Documentation for Mozilla localizers
+Table of contents
+Community
+ +Products
+How to localize and test Mozilla products:
+-
+
- Firefox for desktop. +
- Firefox for Android. +
- Firefox for iOS. +
- Focus for Android and iOS. +
- Mozilla.org. +
Tools
+ +Web Projects
+-
+
- Web projects +
Other topics
+ +How to contribute to documentation
+Please see the README file in our GitHub repository.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/misc/l10n_resources.html b/misc/l10n_resources.html
new file mode 100644
index 00000000..bfa5ecad
--- /dev/null
+++ b/misc/l10n_resources.html
@@ -0,0 +1,258 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bugzilla for localizers
+-
+
- Triage localization bugs + + +
Bugzilla is the system used to track issues for most of Mozilla’s projects. For this reason, every localizer should have an account on Bugzilla, and check incoming emails and notifications. Since bugs need to be read and understood by several people, including developers, English is the language commonly used in Bugzilla.
+Bugs are filed in a Product, each product has multiple Components. For localization, there are two main products:
+-
+
Mozilla Localizations: this product has several components, including one for each locale.
+www.mozilla.org: there is one specific component used for localization (L10N).
+
Bugzilla components are often referenced in the form of product :: component, e.g. Mozilla Localizations :: it / Italian or www.mozilla.org :: L10N. For some components, there is also a Locale field, that allows selecting one or more languages affected.
A bug has a status, the most common ones are:
+-
+
- UNCONFIRMED: the bug was reported but it’s not confirmed yet. By default, a new user can only submit bugs as unconfirmed. +
- NEW: the bug has been confirmed, but it still requires action. +
- RESOLVED: the bug has been resolved. +
When a bug is marked as RESOLVED, there is an additional information that describes the type of resolution:
+-
+
- FIXED: the bug was fixed by a specific action. +
- INVALID: the problem described is not a bug. +
- WONTFIX: the problem described is a bug which will never be fixed. +
- DUPLICATE: the problem is a duplicate of an existing bug. +
- WORKSFORME: it wasn’t possible to reproduce the bug. +
- INCOMPLETE: the bug doesn’t contain enough information to reproduce it, or a clear description of the issue. +
When filing new bugs, the rule of thumb is:
+-
+
- If the issue can be fixed by the localization team, e.g. it’s about a typo or mistranslation, it should be filed in
Mozilla Localizations :: Languageorwww.mozilla.org :: L10N.
+ - If the issue needs work from a developer, e.g. a window is too narrow or a string is hardcoded, it’s a product bug, and should be filed accordingly. In case of doubt on which product or component to pick,
Firefox :: Untriagedis usually a good starting point for Firefox bugs. If you’re reporting a bug for a specific string, you should trace back that string to a bug, and file your report in the same product and component.
+
More information about Bugzilla are available in this guide.
+Triage localization bugs
+Each localization team should keep an eye on bugs filed for their languages. The simplest way to do it is to use the BUGS tab on their team page in Pontoon.
+Follow the Bugzilla component for your locale
+The simplest way to keep your bugs under control is to follow your locale in Mozilla Localizations:
+-
+
- Open your account preferences on Bugzilla. +
- Select Component Watching in the left sidebar. +
- In the right section, select Mozilla Localizations as product, then your locale in the Component list. +
- Click Add. +
The product will appear in the section You are currently watching: right below. From this moment, you will receive an email for all bugs filed in – or moved to – that component.
+There are a few limitations to this approach:
+-
+
- It’s not possible to follow a single locale within a component, for example for
www.mozilla.org :: L10N.
+ - By default, bugs marked as UNCONFIRMED won’t send any notification. In order to receive emails for unconfirmed bugs, you need to update the Email Preferences in your profile, removing the flag from the Component column in the line
The bug is in the UNCONFIRMED state.
+
Saved searches
+In Bugzilla, it’s possible to perform searches, and save them as templates. For example, let’s create a search for bugs reported against Italian in www.mozilla.org :: L10N.
Start from the Advanced Search page:
+-
+
- Leave the search field empty. +
- Select
www.mozilla.orgas Product.
+ - Select
L10Nas Component.
+ - Expand the Custom Search section at the bottom, and set it to Locale + contains the string + it. +
When the results appear, you can use the Remember search button and input field to save this search.
+
The list of your saved searches can be displayed by clicking in the search field at the top of the page: you simply need to click one of the items to perform the search.
+
At the bottom of the page displaying search results, there’s a link to delete the saved search just performed (Forget Search “NAME”).
+Note that you can select multiple products and multiple statuses (including UNCONFIRMED) to refine or expand the search criteria.
+Confirm and close bugs
+As already explained, each locale should address the bugs reported for their language in a timely manner. Bugs filed as UNCONFIRMED should be triaged, marked as NEW if they’re actual bugs or closed, and marked as fixed once the problem is solved.
+By default, users can’t confirm or close bugs filed by other users. In order to do that, you need a permission called editbugs, which is normally assigned to localizers only after they demonstrated a clear understanding of how Bugzilla works and its etiquette. The reason for this is that this permission is assigned across the entire Bugzilla, not on single products or components. If you need to upgrade your permissions, get in touch with l10n-drivers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/print.html b/print.html
new file mode 100644
index 00000000..857ddb66
--- /dev/null
+++ b/print.html
@@ -0,0 +1,2376 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Using l10n resources while translating
+What are l10n resources
+
+L10n resources are used to ensure consistency of translation and localization at specific levels of a document or set of documents. These levels are:
-
+
- Word or phrase level (terminology). +
- Sentence or string level (translation memory). +
- Whole document or project level (style guides). +
Terminology
+Terminology resources define specific words or phrases and their translated equivalents to be used in the translation process. These resources often go beyond providing one-to-one bilingual equivalents. They can include metadata about a particular term, including a monolingual definition, part of speech, context, images, and other relevant metadata that helps the translator understand the concept behind the term. A term belongs in the approved term base (terminology database) when it appears regularly, has a singular meaning in a particular context, or is specialized in nature.
+Term bases are useful in helping translators to maintain meaning and consistent terms across multiple projects. They’re especially useful in collaborative translation environments that involve multiple projects with similar content and audiences. Term bases also help to ensure that any new collaborators can translate effectively in a shorter period of time.
+Using term bases ensures that a user’s experience is consistent across platforms, products, and content types. For example, terminology used in the Firefox desktop UI also appears in Firefox for Android, Firefox for iOS, and SUMO documentation. If a user encounters a problem in Firefox, they will expect to find a solution by searching SUMO with the text from the Firefox desktop user interface. Consistent terminology use ensures a holistically consistent user experience for such cases.
+Translation memory
+Translation memory is a mechanism that reuses previously translated segments (i.e., strings, sentences, etc.). These segments are stored in a database as a key-value pair, with the source language segment as key and the target language segment as its value. Algorithms like the Levenshtein Distance are then used to compare an untranslated segment to the database of source language segments. If there’s a perfect match, the target language segment is returned for the translator to reuse. If there are partial matches (i.e., fuzzy match), they are returned as suggestions. Translators can then post-edit the closest matching suggestion without needing to repeat fully translating the segment.
+Translation memory is useful in helping translators to translate more in a shorter amount of time. For example, it allows source content authors to make regular updates to source content without causing translators to treat these updates as untranslated segments. As with term bases, translation memory also ensures consistency between similar projects and collaborative translation projects with rotating contributors.
+Style guides
+Style guides establish the norms for translating a full document or project. It establishes norms for many of the following topics:
+-
+
- Style. +
- Tone. +
- Grammar and spelling resources. +
- Instructions on handling cultural references. +
- Word forms (e.g., plurals, abbreviations). +
- Language and culture-specific units (e.g., dates, numerals, currency). +
- Criteria for identifying “Do-Not-Translate” content in a project. +
Style guides help translators to know to address their audience (or users) in the target language when translating. They ensure consistency between translators in all of the above-mentioned topics. In a collaborative translation environment, they serve as the standard against which peers can review and correct translations from both new and old translators.
+When are they used in the l10n process
+Term bases and translation memory are best used within the translation environment (e.g., Pontoon). These computer-assisted translation (CAT) tools are designed to make use of these resources as a translator is in the process of translating a project.
+Style guides are used primarily as a point of reference. A new translator should always begin their contributions by studying the style guide and refer back to it regularly while translating when they have questions. Reviewers use style guides to ensure that new translations meet the quality standards established in the style guide.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/firefox_android/how_to_localize.html b/products/firefox_android/how_to_localize.html
new file mode 100644
index 00000000..315c495f
--- /dev/null
+++ b/products/firefox_android/how_to_localize.html
@@ -0,0 +1,242 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email
+
+
+
+
+ Documentation for Mozilla localizers
+Table of contents
+Community
+ +Products
+How to localize and test Mozilla products:
+-
+
- Firefox for desktop. +
- Firefox for Android. +
- Firefox for iOS. +
- Focus for Android and iOS. +
- Mozilla.org. +
Tools
+ +Web Projects
+-
+
- Web projects +
Other topics
+ +How to contribute to documentation
+Please see the README file in our GitHub repository.
+Localization community in Mozilla
+ +Roles and guidelines in the localization community
+Volunteer communities are the backbone of the localization (l10n) efforts at Mozilla. They are designed to be self-regulating and self-managing with minimal intervention from staff. For example, the responsibility of reviewing suggestions falls on the Translators and Managers within the community; they not only ensure quality and consistency but also keep an eye out for potential new volunteers to promote. And when Managers plan to step down, it’s crucial they develop succession plans to maintain continuity.
+The role of staff is to intervene only when necessary. The main reasons for staff to be involved is when self-regulation fails or there are violations of the Community Participation Guidelines (CPG). The goal is to empower the communities to thrive independently while maintaining the high standards that Mozilla is known for.
+The localization team can occasionally take a more hands-on approach, proactively engaging with locales that are facing challenges. For example, it can happen when a member (or members) of a locale reaches out directly to localization staff to express concerns about their community. Other times, the team may receive product requests for specific locales, which prompts initiatives to ensure that these communities are capable of supporting the product expansion.
+In the following sections, we’ll review the current roles and expectations and suggest guidelines for when role criteria are not met — and how the localization staff can get involved and help in these different scenarios.
+Roles: responsibilities and expectations
+Managers
+Responsibilities
+On top of the responsibilities associated with the Translator role:
+-
+
- Establish mentorship practices for new localizers that foster growth and lead to impactful participation. +
- Identify and train community mentors in their role. +
- Coordinate translation and l10n testing of projects within the l10n community. +
- Provide input and consultation with localizers, evaluate candidates for advanced roles within the community. +
- Coordinate and facilitate internal community discussions. +
- Create and maintain language resources for the community (e.g., terminology, style guides, etc.). +
Expectations
+-
+
- Open and frequent communication (liaison between l10n-drivers and l10n community) concerning new projects, new deadlines, and community issues. +
- Create and secure a safe space for people to participate in l10n in an impactful way. +
- Recruit and mentor new localizers. +
- Give timely feedback to community mentors and translators. +
Translators
+Responsibilities
+-
+
- Submit translations for new content. +
- Review pending translation suggestions from contributors and provide them with timely feedback that focuses on developing skills. +
- Testing of all submitted translations in product. +
- Work with Managers to create and maintain language resources for the community. +
- Report issues concerning source language content issues. +
Expectations
+-
+
- Ensure consistent quality of the project they’re localizing. +
- Give detailed feedback to contributors in a timely manner. +
- Translate new content regularly. +
- Ensure that community style guidelines are being followed in translations that make it to the repositories. +
- Keep pending translation suggestion queue to a low number. +
- Gracefully accept feedback on their translations from other Translators and Managers. +
Contributors
+Responsibilities
+-
+
- Submit translation suggestions to Pontoon projects for the target language. +
- Request and accept feedback from Translators and Managers in the community. +
- In-context review (l10n testing) of translation suggestions that have been approved by Translators and Managers. +
Expectations
+-
+
- Gracefully accept feedback on their translations from Translators and Managers. +
- Avoid relying exclusively on machine translation, especially when unsure about the source string or the language. +
- Proactively request feedback from Translators and Managers. +
- Network and form relationships with others in the community. +
Guidelines
+Promotions
+Promotions apply to Translators and Contributors. Managers and localization staff can directly promote/demote users to Translator or Manager roles.
+Efforts to revive an inactive community
+A community is considered inactive when there are no other active Translators or Managers, which can make it difficult for Contributors to participate effectively. If a Contributor has attempted to reach out to the Managers or Translators but has not received a satisfactory response (or any response) within a few weeks, it’s advisable to contact the localization staff for assistance. Each situation is unique, and staff can help investigate further, for example reviewing a localizer’s contribution history across external localization projects outside of Mozilla. The localization team will also reach out to former Managers and Translators for their input. If there is still no response, the localization team will consider promoting active localizers who have expressed interest in taking on an active role.
+Community engagement
+Localizers who actively participate in community discussions, provide feedback and reviews, mentor new members, and engage in localization events and workshops should be recognized and promoted for their dedication and leadership within the community. They often transition from direct translation work to more managerial roles, focusing on building and enabling the locale community.
+How do you recognize and promote them? Existing locale Managers are typically in charge of updating the permissions on Pontoon. Staff will step in if there are reasons preventing a person from reaching the next role (for example, if there are no active Managers, or if there is gatekeeping).
+In the case there is no existing community, a localizer requesting a new locale will be appointed to the Manager role.
+High-quality contributions
+A localizer who consistently provides high-quality translations that meet the community’s standards should be considered for promotion. This includes accuracy, adherence to style guides, and timely contributions and reviews. Contribution data on Pontoon can be used to help guide these decisions.
+Demotions
+Demotions should come as a last resort when a localizer’s actions significantly impact the project’s quality, collaboration, or community. In practice demotions are extremely rare and historically have occurred when a Manager or Translator voluntarily expresses a desire to step back from their roles and expectations.
+Here are some examples of reasons for demotion.
+A localizer wants to take a step back
+As explained, a request for demotion can come from localizers themselves, when they want to delegate certain responsibilities. This is a straightforward scenario, in which a localizer typically will reach out to the manager — or localization staff — to express their desire to step down. Managers have the permissions to do so themselves, but localization staff can also assist.
+A localizer is failing to meet role expectations
+A localizer might notice that a Manager or Translator is abusing their role, especially in ways that may be considered gatekeeping. After the community has tried to get in touch with the Managers or Translators, but has not received a satisfactory response (or any response) after a few weeks, reaching out to the localization staff is a good first step for the team to help investigate and find solutions, as each situation is unique. Note that the localization team rarely demotes anyone unless it’s a grave situation, but they can help promote or unblock users.
+Prolonged inactivity
+Typically there isn’t a need to demote a Manager or Translator due to inactivity, unless gatekeeping or retaliation disrupt the work of others.
+Community guidelines enforcement
+CPG violation
+A CPG violation is taken very seriously and will be addressed immediately. The process for reporting a violation is detailed under the “Reporting” section of the CPG.
+Gatekeeping
+Gatekeeping can show up in different ways in localization communities/localizers:
+-
+
- Not reviewing new Contributors’ work, which prevents them from joining and contributing. +
- Self-reviewing their own work and ignoring the work done by others — or constantly rejecting others’ contributions as not good enough to maintain control over the locale. +
- Creating unnecessary barriers to participation, like setting very strict standards without offering guidance or feedback, holding onto knowledge or resources instead of sharing with the community, and resisting changes or improvements suggested by others without explanation. +
- Being inactive for a long period of time, but nonetheless never wanting to give permissions to others actively participating. +These actions limit the growth and diversity of the community, making it less welcoming and inclusive. +
How does the localization team know someone is gatekeeping? This can happen through direct feedback, or through the localization team’s own investigations.
+If a localizer has attempted to reach out to Managers or Translators but has not received a satisfactory response (or any response) within 2 weeks, it’s advisable to contact the localization staff for assistance.
+Common issues and references
+How can I contact the localization staff?
+If you have contacted members of your team and received no responses, have questions about these guidelines or want to suggest improvements, don’t hesitate to get in touch with the localization staff:
+-
+
- You can use email and Matrix to reach out to the entire team. +
- You can also find the member of staff in charge of each project directly in Pontoon. +
I am a Translator and want to become a Manager, what do I do?
+Try to get in touch with the current Managers and Translators from your locale, to surface your request (you can find them under the Contributor view in your team page on Pontoon). Check also the Promotions section. You can also reach out to the localization team directly.
+No one is reviewing my suggestions, what do I do?
+Try to get in touch with the current Managers and Translators from your locale, to surface your request (you can find them under the Contributor view in your team page on Pontoon). You can also reach out to the localization team directly.
+I’m a new Contributor and am interested in becoming a Translator for only one project.
+Get in touch with the locale Managers first, to ask them to appoint you to only one project. If there is no response within a few weeks, reach out to the localization team.
+How can I delete my Pontoon account?
+Currently users cannot remove their account directly from Pontoon. Reach out to the localization team.
+Reviewing translations within your community
+Mozilla encourages a three-stage review process:
+-
+
- Linguistic review in Pontoon by community. +
- Technical review by l10n-drivers. +
- In-context localization testing by community and users. +
This document explains how to perform the first stage of the review process: review the work of another member of your community and provide constructive feedback.
+Attitudes around reviewing translations
+Reviewing the translation contributions of another localizer can be controversial. Many attach strong feelings to their contributions, making it very difficult for them to receive feedback and make adjustments to the way they contribute. Reviews are opportunities to ensure high quality contributions while mentoring someone to improve their translation skill set. Reviewers should approach their work with these things in mind:
+-
+
- Everyone is volunteering their time and looking to have a positive impact in their community. +
- Reviews are an opportunity to give clear, actionable feedback about another localizer’s contributions. +
- Reviews should be based on objective standards agreed upon by the community and made explicit through the community’s style guide and terminology resources rather than personal preferences. This eliminates the potential for subjective feedback or manipulation through reviews, and thus eliminates potential conflicts within the community. +
- Reviewers should avoid using vague, potentially inflammatory language in their reviews (e.g., “This translation is terrible, fix it“). +
Localizers should approach receiving feedback with these things in mind:
+-
+
- Everyone is volunteering their time and looking to have a positive impact in their community. +
- Reviews are an opportunity to develop and improve your translation skills. They should be welcomed with an open mind. +
- Reviews are a natural and required part of the localization process. +
Giving constructive feedback
+When reviewing someone else’s translations, feedback should be actionable and based on objective standards. Style guides and terminology resources developed within the community with agreement from its members contain those objective standards. Feedback should include the following elements:
+-
+
- Actionable criticism. +
- Reference to where the translation violates the objective standards. +
For example, if a translation contains a spelling error, a constructive piece of feedback would look like this: +“There’s a spelling mistake in moniter. The correct spelling can be found in either our official terminology or this section of the community style guide.“
+Tools available for giving feedback
+Pontoon currently allows reviewers to do the following:
+-
+
- Approve or reject suggestions. +
- Make edits to existing translation submissions. +
A more robust feedback loop will be implemented in Pontoon during the beginning of 2018.
+Localization of Mozilla products
+Documentation regarding testing and localization of the following products:
+ +Documentation about testing localization of Mozilla projects in general.
+L10n and Firefox for desktop
+Some documentation specific for common tasks regarding Firefox desktop and l10n:
+ +Testing Firefox Desktop
+-
+
- Which build should I test? + + +
- How to test + + +
Which build should I test?
+As a localizer you will work against Nightly, which means you should be testing a localized build of Firefox Nightly provided directly by Mozilla.
+You can download the build from the pre-release download page, the download page for all systems and locales, or directly via FTP (search for your locale code and operative system).
+Why Nightly? Because it’s updated twice every day, which means that you can fix an error and verify if the correction was effective within a few hours. It’s definitely a good approach to use this version as your main browser.
+At the same time, you, or someone in your team, should be testing also Beta and Release, to make sure updates don’t introduce issues.
+Building a localized version of Firefox
+If you’re interested in building a localized version of Firefox from source code, please follow the official instructions available in Mozilla Source Tree Docs. Note that you will need to set up the build environment on your system.
+How to test
+Here are some tips on how to test Firefox once installed in your computer.
+Create a new profile
+From time to time create a new profile:
+-
+
- To test that the default searchplugins are still relevant and work as expected. +
- To check messages and pages displayed on first run. +
- To test dialogs and preferences at the default size. +
Search for untranslated strings
+-
+
- Open all the items available in the main menu and check that they’re properly localized. If you opted to keep Developer Tools in English, the language should be consistent across all the developer tools. +
- Check the “hamburger” menu, making sure to inspect subpanels for items displaying the
>symbol.
+ - Open Preferences/Options and navigate through all panels, try to open all dialogs like
Exceptions…. Make also sure to select theCustom settingsoption for History in the Privacy panel.
+ - Log in with you Firefox Account and make sure that all preferences and dialogs are properly localized. +
- Check for untranslated strings and errors in the Library (Bookmarks->View all bookmarks…). +
- Open a new Private Window and check the content of the page. +
- Type
about:supportin the address bar, press Enter, and check for errors or missing translations.
+ - Check the error pages for malware, unwanted software, deceptive website, harmful website. All strings are also visible in
about:blocked.
+ - Check permissions dialogs on this test website. +
- Visit secure and unsecure websites, and check the panel displayed when clicking the lock icon. +
- Check the Protections panel displayed when clicking the shield icon in the address bar, and the
about:protectionspage for the Protections Report.
+ - Right click on a page and verify all panels in the
View Page Infodialog.
+ - Enable login saving in Logins & Passwords, make sure that
about:loginsis correctly localized and works as expected.
+
Test the New Tab page and Contextual Feature Recommendations
+First of all, make sure that everything is correctly translated in about:newtab. That’s the default page displayed when opening a new tab in Firefox.
In order to test other features available for New Tab, it’s necessary to enable a devtools option: open about:config, search for browser.newtabpage.activity-stream.asrouter.devtoolsEnabled and set it to true. After that, in the top right corner of the New Tab page a small wrench icon will be displayed.
For example, the AS Router Admin page can be used to test contextual feature recommendations (CFR):
+-
+
- In the Messages section, select to show message for cfr. +
- Click the Show button in one of the available options. +
The suggestions is displayed at the end of the address bar (first as a bulb icon, then as a “suggestion” tag). Clicking the blue tag will display a doorhanger.
+Test webextension permissions dialog
+Create a new profile and open about:config in your browser:
-
+
- Right click on the list of available keys and create a new boolean key
extensions.webextPermissionPromptsset totrue.
+ - Search for the key
xpinstall.signatures.requiredand set it tofalse. This will allow installing unsigned add-ons.
+ - Open this link, select Download and save the file on your computer. +
- Extract the archive. +
- Drag each (one by one) of the .xpi files on your browser’s window to display the dialog (you don’t need to actually install it). +
Test accesskeys and shortcuts
+You can test accesskeys only on Windows and Linux, since they’re not available in OS X.
+If your locale uses a non Latin alphabet and opted to keep the English accesskeys, you don’t have anything to check. If you’re localizing accesskeys, you should check that:
+-
+
- Accesskeys use letters available in the associated label, and are not displayed between parenthesis at the end of the label itself. +
- There are no conflicts, which means there are no items in the same menu or preference panel using the same letter. Starting from Firefox 56, it’s not possible to avoid conflicts in preferences: the guideline in that case is to reduce to a minimum the number of times the same letter is used within a panel. +
For shortcuts, you should test at least the most common ones. You should never change a shortcut, unless that combination of keys is not available in the keyboard layout commonly used for your locale. For example, in the Italian keyboard the character [ is available pressing Alt and è. A shortcut based on Shift + [ would never work, because it would be read as Alt + Shift + è.
Transvision has a QA view to check both accesskeys and keyboard shortcuts for each locale.
+Test certificate error pages
+There are several certificate error pages in Firefox, the message displayed can vary depending on the error being bypassable or not:
+-
+
- SEC_ERROR_UNKNOWN_ISSUER: bypassable, not bypassable. +
- SSL_ERROR_BAD_CERT_DOMAIN: bypassable, not bypassable. +
- SEC_ERROR_EXPIRED_CERTIFICATE: bypassable. +
Other test pages for certificates, both valid and invalid, are available at https://badssl.com.
+Test the installer on Windows
+Download the installer version and make sure that everything is working correctly. In the FTP folder you have both the Full Installer and the Stub Installer (downloading the package from Internet). You should test both at least once.,
+L10n and Firefox for Android
+Some documentation specific for common tasks regarding Firefox for Android and l10n:
+ +Firefox for Android - How to localize
+Firefox for Android is on a four week rapid release cycle. This means that usually there is a new release going out every four weeks.
+Within this timeframe, localizers will usually have approximately four weeks to localize and test their strings for a given release: strings land continuously on Nightly during the first four weeks, and then these strings ride the train to the Beta version. The deadline in Pontoon is an indicator of when the next localization cut-off date is for the upcoming release - in other words, the last day to get localization updates into that release.
+Note that all files contained in the project should be localized in order for Firefox for Android to be complete.
+Localize Firefox for Android in Pontoon
+Localizers should go to the Firefox for Android page on Pontoon, and click "Request New Language". They will be notified by email once the locale is set up and the project is ready to be localized.
+When the locale has been set up, localizers can choose it from the list of locales on Pontoon, and start localizing the product from there.
+Once localization starts, the locale should become available in Nightly builds within the next few days, which will enable localizers to check and test their work (see this section for more information about testing).
+When the locale reaches 70% completion (and given that active testing has taken place), it can be added to the release version.
+Testing Firefox for Android
+Testing Nightly builds
+Once you have localized all the strings needed to complete the Firefox for Android project, and your language is up in Nightly builds, you should start testing! This is the moment to engage as many people as possible: have them use and check out these builds regularly. The more eyes on them, the better.
+What to look out for?
+(For more detailed explanations about testing, please refer to testing localization of Mozilla projects)
+-
+
- Language quality. +
- Truncated words (cut-off from screen) or overlaps. +
- Anything that appears broken in the UI. +
- Check out at all the main screens, UI, menus, tabs, new features, etc. Make sure these all look good, that everything is properly translated and appears as expected. +
- Font support. +
- Check that all searchplugins are working correctly. +
If you find issues such as the ones listed above, there are two possible options: fix it by yourself directly via Pontoon, or get a mobile developer to fix it. It all depends what kind of issue you find.
+In fact, language quality, truncations, overlaps and unlocalized strings can usually be fixed directly via Pontoon. You can verify that your fix has worked by checking it in the new Nightly version that usually ships the next day.
+If the issue is something else, you will probably have to get a mobile developer’s help to fix it. Please file an issue here, and CC the mobile PM in charge (@ followed by the GitHub username, which is currently “delphine”). +Once more, please refer to testing localization of Mozilla projects for more details on how to fix different kind of issues.
+Please note that it is strongly suggested to start using Nightly builds on a daily basis - and even after your locale is shipping on release version - so that you can get into as many screens as possible and check that everything looks fine.
+Also, it is important that builds are tested by people outside the localization team. Ask other people from your community to help test in order to have fresh eyes looking at your work.
+l10n-drivers send out regular reminders about merge days, updates on Android projects, schedule and important info on the Discourse Localization category. Please make sure you’re following this category closely so that you get regular updates about which part of the cycle you’re at, when you need to finish your work, and anything relevant to what you are doing.
+L10n and Firefox for iOS
+Some documentation specific for common tasks regarding Firefox for iOS and l10n:
+ +Adding a new locale to Firefox for iOS
+Prerequisites
+iOS language support
+iOS currently supports two tiers of locales, and a locale must be part of one of these two lists in order to ship on Firefox for iOS. Unlike Firefox for Android, there’s no locale switcher included in the app, so it’s possible to ship only locales that are supported by iOS.
+Note that for Tier 2 locales, some menu items in Firefox for iOS can not be translated since they are part of the OS itself. Strings will unfortunately appear in English on the final UI in these cases.
+To tell if a locale is supported or not, take a look on an actual device, under the Language Settings of the most recent iOS version available. Tier one locales are the ones listed under “iPod/iPhone/iPad Language”, and Tier 2 locales appear under “Other Language” (or “Add Language” if there are already some languages under that list). If a locale appears under none of these two lists, then it should be safe to assume the language is not supported by iOS.
+Request to add a localization
+Once it is determined if a locale is supported by the operating system and can ship on Firefox for iOS, a request can be made to work on the project through the usual localization tools.
+For Pontoon, go to the Firefox for iOS project page here, and click on the link to request to add a new language to the project.
+Shipping
+Once pending localization work is complete for a given release, l10n-drivers will work on adding the locale to the list of shipping locales.
+Remember to regularly check the Discourse Localization category for latest information and updates on the project.
+Testing on iOS for a new release
+Localizers currently mostly rely on screenshots for testing. Latest information and updates about Firefox for iOS are generally announced on the Discourse Localization category, which you should follow if you are working on l10n for any of the existing Mozilla products.
+Testing with screenshots
+Screenshots are currently provided by the iOS team, and the latest iterations can be found right here. Once you find your locale in the list, you should choose and download the .zip file that contains your locale code.
+Test builds
+The beta version used for testing can be found here. In case the registration does not work from there, localizers can also reach out to the l10n mobile PM in order to be added to these builds (currently delphine at mozilla dot com). +Please note you will need an iOS device running v13.6 or above.
+Aspects to review
+Here is a list of issues you should try to identify when testing the build:
+-
+
- Language quality. +
- Truncated words (cut-off from screen). +
- Anything that appears broken on the UI. +
- Check out at all the main screens, UI, menus, tabs, new features, etc. Make sure these all look good, that everything is properly translated and appears as expected. +
- Font support. +
- Untranslated content. +
Concerning untranslated content: please note that we currently have two tiers of support in iOS. If your locale is only in the Tier 2 support list, then it sometimes happens that menu items, which are part of the OS itself, may not be localizable - and will therefore unfortunately appear in English on the final UI. To tell if a locale is supported or not, simply take a look on an actual device, under the Language Settings of the most recent iOS version available. Tier 1 locales are the ones listed under “iPod/iPhone/iPad Language”, and Tier 2 locales appear under “Other Language” (or “Add Language” if there are already some languages under that list).
+Shipping a brand new locale
+The locale is tested and has reached 20% completion, we will add the locale to release builds.
+L10n and Focus for iOS and Android
+Some documentation specific for common tasks regarding Focus for iOS and Android:
+ +Focus - How to localize
+Focus for Android and Focus for iOS are both on a four week rapid release cycle. This means that usually there are new releases going out every four weeks.
+Within this timeframe, localizers will have approximately four weeks to localize and test their strings for a given release: strings land continuously on Nightly during the first four weeks, and then these strings ride the train to the Beta version.
+It is important to use the Nightly versions for both products, in order to test localization work regularly (see more details about testing here).
+Localizing Focus for Android and Focus for iOS in Pontoon
+Localizers should go to the Focus for Android page on Pontoon - or the Focus for iOS page on Pontoon - and click Request New Language. They will be notified by email once the locale is set up and the project is ready to be localized.
When the locale has been set up, localizers can choose it from the list of locales on Pontoon, in the same page from which they made the locale request (links above).
+Once localization starts, the locale should become available in Nightly builds within the next few days, which will enable localizers to check and test their work. For Nightly builds and testing instructions, please refer again here.
+Once the locale starts work and reaches even 1% completion in Pontoon (and assuming that active testing has taken place), it will be added to the release version either in the Google Play Store or the iOS App Store.
+Note that Focus for Android strings share common strings with android-components, just like Fenix (Firefox for Android) does. At the moment, android-components strings all live in the Firefox for Android project in Pontoon - these are all the files in your locale folder that start with mozilla-mobile/android-components/. If Firefox for Android is not yet enabled for your locale, you will be asked to complete that work first.
Localization deadlines for projects are noted as Resources in each project page in Pontoon, and the main Project Manager’s contact information can be found there as well.
+Testing Focus for iOS and Focus for Android for a new release
+Given Focus for iOS and Focus for Android have very similar test procedures, this document will cover both at once. Please note that in certain markets, the app is named “Klar”. For the sake of simplicity, we will only call out the name “Focus” in this document.
+Localizers currently mostly rely on screenshots for testing Focus for iOS. Latest information and updates about testing are provided on the l10n Discourse Channel, which you should follow if you are working on localizing any of the existing Mozilla products. +Links to iOS screenshots are also provided under the Resources section in Pontoon, at the top of the project page. +For Focus for Android and iOS, there are also links to testing builds, if they are currently available.
+Testing with screenshots (currently available for Focus for iOS only)
+Screenshots are provided by the mobile teams for iOS and appear under the Resources section in Pontoon or in the l10n Discourse channel (see above point for more details).
+Test builds
+-
+
- For Focus for Android testing of either Nightly or Beta, you will first have to join this google group. Please note that you must use the same Google account you use on your device to download apps from Google Play. +
For Beta releases: +After you have joined the group, opt-in to receive Beta builds, (again with the same Google account) here. +Then, download Firefox Focus (Beta) from Google Play here.
+For Nightly releases: +After you have joined the group opt-in, to receive Nightly builds, (again with the same Google account) here. +Then, download Firefox Focus (Nightly) from Google Play here.
+-
+
- For Focus for iOS Nightly builds, check as well under the Resources section in Pontoon, at the top of the project page - or reach out directly to the mobile project manager (currently delphine at mozilla dot com) to be added to the TestFlight system. +
For Focus for iOS, please note an iOS device running v13.6 or above is needed. For Focus for Android, an Android device running v5.0 or above is needed.
+Aspects to review
+Here is a list of issues you should try to identify when testing the build:
+-
+
- Language quality. +
- Truncated words (cut-off from screen). +
- Anything that appears broken on the UI. +
- Check out all the main screens, UI, menus, tabs, new features, etc. Make sure these all look good, that everything is properly translated and appears as expected. +
- Font support: once you start translating, you should check against the screenshots provided that the fonts used appear correctly. +
- Untranslated content. +
Concerning untranslated content on Focus for iOS: please note that we currently have two tiers of support in iOS. If your locale is only in the Tier 2 support (which corresponds to the languages under Other Languages in the iOS system settings), then it sometimes happens that menu items and dialogs, which are part of the OS itself, may not be localizable - and will therefore unfortunately appear in the primary OS language on the final UI.
+Locale sign-offs
+Unless there are visible l10n errors upon review of the locale’s screenshots (e.g., significant truncation, text overflow, encoding, etc.) - and besides what +may have already been reported to the mobile team to correct - we will ship any locale that has started to localize (this applies to both Focus products).
+Focus for Android issues can be filed here.
+Focus for iOS issues can be filed here.
Details about any major updates concerning these products are always announced on the [l10n Discourse Channel - and are reflected in this document as well.
+Working on mozilla.org
+Some documentation specific for common tasks on mozilla.org
+ +Testing Mozilla.org
+-
+
- Key links +
- What to test + + +
- How to test localized pages on the production server + + +
- Testing content in Fluent + + +
- Testing dynamic pages + + +
Mozilla.org is highly visible because the site houses the basic info of all Mozilla products, conveys Mozilla’s mission, vision, and values it stands for. Additionally, it promotes initiatives and campaigns in time of these events. The localized versions reach 60% of the Mozilla users globally. It is very important that, not only the main pages are localized, they are thoroughly tested before they are launched on production.
+It’s highly advised you to ask other community members to conduct peer review not only on Pontoon, but on staging and production. While not all the languages are required for certain projects, each community can opt in the projects at a later time.
+Key links
+-
+
- Production: https://www.mozilla.org/{locale_code}/ +
- Staging: https://www-dev.allizom.org/{locale_code}/ +
- Repository: https://github.com/mozilla-l10n/www-l10n +
- Pontoon: https://pontoon.mozilla.org/projects/mozillaorg/ +
What to test
+Pre-l10n test
+-
+
- Have your glossary available as a reference, select mozilla.org as Repository, your language as your Target Locale. +
- For terminology consistency, reference the product or site that the page is for, assuming the product or site is localized (e.g.: Firefox, Monitor). +
- Have the matching US page up as reference, though some strings may not be identical due to A/B testing. +
- Have the project you just localized available for editing in Pontoon. +
Linguistic testing
+-
+
- Translation quality in context. +
- Grammar correctness in context. +
- Truncation: button text should remain inside the button. +
- Header line break wraps at proper place. +
- Text not overlapping graphic. +
- Terminology consistent with product across web pages. +
- Brand names remain in English, with a few exceptions due to declension. Check out these detailed guidelines when working with brands and trademarks. +
- Product names comply to Mozilla guideline and adhere to what the community has agreed to. +
- No corrupted characters. +
- Click the links on the page to navigate to localized pages in the same language. If a page is not localized, you will be redirected based on your language preference settings (e.g., Fulah > French > English). If no preferences are set, the default is en-US. +
- Navigation terms consistent with the page titles they are linked to (except when the navigation term is shortened due to space limitation). +
- Footer links don’t overlap with one another. +
You can make linguistic changes directly in Pontoon.
+Functionality testing
+-
+
- Click the download link, you should be able to download the product in your language, if it is localized, such as Firefox. +
- Font support and readability. +
- Footer: verify that the translation of the link is coherent and the link is functional. +
- Language list: is your language listed as one of the options? Check https://www-dev.allizom.org/firefox/all/ to confirm. See detailed steps below to get to the language list. +
- Error page: deliberately type a broken link, such as https://www.mozilla.org/firefox/neu/, check whether 404 page is localized. +
- If your language is RTL, make sure that the page layout and text flow in the correct directions. +
Compatibility testing:
+-
+
- Test the page layout in other major browsers and on other platforms. +
- Test the page layout on the leading locally developed browser if available. +
- Test the page layout on mobile devices of major platforms. +
How to test localized pages on the production server
+Updated translations are pushed to the production server regularly throughout the day.
+-
+
- New page: When a brand new page is available for localization, it will be enabled on production when it’s 80% complete. At that point, if it doesn’t reach 100% completion level, the page will be available on production with English content mixed with translation. Before the page is activated in production, use the staging server for testing. +
- Activated page with added strings: The strings will appear in English on production right away. Localized content will be pushed to production as soon as translations are available in the repository. +
- Activated page with string updates: The switch to the updated content happens when the replacements of obsolete strings are fully localized. In some cases, there is a defined time frame to show the new strings on production, so test the updates on staging server. The obsolete string will be removed three months after the introduction of the replacement strings. +
- Activated page with template change: In some cases, a page receives a major update that requires a complete rewrite of the template. If this happens, the old template is kept online only for a defined period of time. When removed, it will cause the URL to redirect users to the English version if the intended localized version is not ready, or other user preferred localized versions are not available either. +
- Activated page missing too many updates: An activated page falling far behind with multiple updates will create poor user experience. They may be subjected to removal. +
Sync and update frequencies
+Updated translations are pushed to the production server regularly throughout the day.
+-
+
- Pontoon syncs every 10 minutes to the repository. +
- GitHub update is pushed to production every 5 minutes. +
It is safe to say that it will take less than an hour to see your changes reflected on the production server.
+When a project has a firm deadline to meet, it will be indicated at the top left corner of the project page in Pontoon and at the page level. When necessary, it will be communicated through the l10n-community room on Matrix.
+Testing content in Fluent
+Reviewing and updating brands.ftl
+This file captures all the brand and product names that appear in all the pages on mozilla.org. As a general rule, brands and product names remain unchanged. The exceptions are:
+-
+
- Account/accounts in Mozilla account/accounts: Mozilla should be treated as a brand, but
accountandaccountsshould be translated. Both the singular and plural forms are used in lower cases. Uppercase is reserved for special use cases where headline case is necessary, for example legal document names and references.
+ - Browser/Browsers in Firefox Browser/Browsers. +
If your community decides to translate any of these products or feature names, translate it once and translate it in this file. Be sure to have a consensus among active contributors what the translation should be before updating this file. This practice will ensure term use consistency across all pages.
+Please refer to the guidelines for brands and trademarks when reviewing and updating this file.
+Reporting technical issues
+Report issues that can’t be resolved in Pontoon by:
+-
+
- Filing a bug in Bugzilla and selecting your locale. +
- Adding the l10n PM in charge for NI. The l10n PM information appears at the top left corner on the project page. +
- Including the file name plus a screenshot and/or URL. +
- If an extra tag is added to a string in order for it make sense in your language, the string will generate an error report. The l10n PM for the project will consult you whether to make this an exception so it will not generate an error report in the future. +
Reporting vendor translation errors
+If the mozilla.org project is not in your Pontoon dashboard, but the site is localized into your locale, it is likely being translated by a translation vendor. Report any translation errors by:
+-
+
- Filing a bug using one of these templates and selecting your locale in the component list: + + +
Testing dynamic pages
+This section focuses on instructions for testing pages with dynamically generated content. Each page or topic is different in terms of steps or flow. These instructions could change over time to reflect product design updates. Linguistic testing is the main focus. The instructions below are detailed steps to get to the localized content so it can be reviewed in context.
+firefox/accounts.ftl
+On the landing page of the Mozilla account page, click on the links under each of the following products which take you to product specific pages:
+-
+
- Firefox Browser +
- Firefox Monitor +
- Firefox Relay +
- Mozilla VPN +
If you already have an account, click on the Manage your account link on the right side of the landing page, which will take you to the subscription page. If you do not have an account, you will be invited to create an account by providing an email address in the Sign In box.
Note: You may see different languages between mozilla.org, the login window, and the products above. If any of these products is not localized in your locale, it will fall back to other languages set as preferred for content language negotiation, assuming any of them is available for the project, or English.
+firefox/all.ftl
+On the right side of the page, there is a four-step process to go through in order to download Firefox.
+-
+
- Browsers: choose one of the options either for desktop or mobile. Click on the
?next to the Browsers category, a popup window shows the descriptions of different versions of Firefox browsers available for download. Select one browser to proceed to the next step.
+ - Platforms: Click on the
?, a popup window shows the descriptions of different versions of installers available for download.
+ - Languages: A list of languages available in the build depending on what is selected in the above two categories. Check whether your current preferred language is shown by default. Change to a different language, check whether the download summary above the Download Now button corresponds to your new selection. +
- Download: The Download Now button appears. +
On the lower left side of each page, you will see these links:
+-
+
- These two sites are in English only: Check the system requirements and Release notes. +
- Click on the Source code link, you will be directed to the Firefox Source Docs page which is not localized. +
- The Firefox Privacy Notice document is localized in limited number of languages. +
- Click on the Need Help link, you will be directed to the SUMO home page. +
firefox/new/download.ftl
+-
+
- Click the Download Firefox button to check the thank you page that triggers an automatic download. +
- The Firefox Privacy Notice document is localized in limited number of languages. +
- Click on the Download options and other languages link, you will be directed to the firefox/all page. +
- Click on the Firefox Browser support link, you will be directed to the SUMO site featuring various topics on Firefox. +
navigation_v2.ftl
+The strings in this file are shared content and are activated on production whether they are localized or not. When clicking on any of these topics on the navigation bar, Firefox Browsers, Products, Who We Are or Innovation, you will see a drop-down panel with subcategory topics. Within each of the topics, there is a description and a few links to help you dive deeper further into a topic which takes you to a different page. When reviewing the content, keep in mind the following:
+-
+
- Not all links take you to a site that’s localizable for all locales. +
- Not all products are offered in your locale. +
- Brand and product names must remain unchanged. +
Testing localization of Mozilla projects
+Mozilla encourages a three-stage review process:
+-
+
- Linguistic review in Pontoon by community. +
- Technical review by l10n-drivers. +
- In-context localization testing by community and users. +
Other documents will cover how the Mozilla approach to the first two stages of the review process. This document covers what to look for when performing in-context localization testing for a Mozilla product or Web project.
+Localization testing process
+Each Mozilla project has its own process for taking your translations and making them available for you to test. Generally speaking, the process moves like this:
+-
+
- You submit a translation through Pontoon or directly to version control (Mercurial, GitHub). +
- The translation goes through a linguistic review and a technical review. +
- Once approved, the translation is automatically pushed into the project’s repository. +
- Depending on the project, you’ll need to wait anywhere from 30 minutes to 24 hours to look for your translation in the Mozilla project. +
- Once you’ve found your translation, if you see a problem with it, you return to Pontoon to make any necessary corrections. +
Pontoon simplifies these steps for some Web projects by enabling the in-context editor (aka WYSIWYG editor). This allows you to see your translations in-context the moment you create them in Pontoon, cutting out the 30 minutes to 24 hours waiting period to test. Most projects do not have this enabled, however, so it is still important to know the typical testing process for your projects.
+You might be wondering, “what sort of problems am I supposed to be looking for when I test?” Good question :-) Here’s a list of common localization bugs with screenshots that illustrate the problems in context.
+Common localization bugs
+Encoding and fonts
+Character encoding errors occur when the browser can’t find the correct symbol to display for a character. Normally, you will recognize these errors when you see Unicode replacement characters (�), or strange glyphs, instead of letters or radicals in your language. In some cases the problem can be resolved by changing your browser’s default encoding, in other cases the problem is due to the website not serving content with the right encoding and can be fixed only by the website’s owner.
+
Fonts that do not include full support for a language’s set of glyphs can present similar issues, for example showing incorrect line spacing (leading), character spacing (kerning), or missing ligatures between characters. In the example below, the kerning of the Cherokee letters is too wide. This may be fixed by using a different font on the site.
+
Truncation
+Truncation happens when a translation is too long to fit in its corresponding space in the user interface. This error can cause problems with transmitting the right meaning to the user by hiding part of the translation from view. It can be corrected in one of two ways:
+-
+
- The developer increases the UI space to accommodate longer translations. +
- The localizer creates a shorter translation that captures the primary message but may not capture secondary or tertiary messages. +
String reuse
+String reuse occurs when the same string is used in different contexts, and it represents a poor approach to localization.
+Consider for example a string like Add to bookmarks: developers might consider a good idea to reuse the same string for both a button label and button tooltip, since it works fine for English. On the other hand, other languages might have completely different needs for these two contexts: while the button indicates an action (imperative verb), the tooltip is used to describe the action associated to the UI element and might need a sentence using a verb with the third person, and the element itself as implicit subject.
+String concatenation and empty strings
+String concatenation occurs when a developer takes one string, splits it into multiple strings, and tells the code to display these strings one after another.
+This is often used to overcome technical limitations, like including a link in the middle of a sentence without exposing HTML tags to localization and injecting unsafe HTML in the UI.
+Empty strings are also common when creating a sentence with a link. Typically 3 strings are used: before_link + link + after_link. English doesn’t need the part before or after the link, but that’s useful for other languages, so they’re kept empty in English. It’s expected for some locales to have a completely different behavior than English.
+UI layout
+Translated text often requires more space than the same text in the source language. For example, when translating between English and German, it’s common practice to expect a length increase of 30%. This can cause problems as wrapping text elements cause different parts of the user interface move around to accommodate a longer string. To fix this, the translator often needs to create a new, shorter translation that captures the primary meaning, but might lose some of the secondary or tertiary meaning.
+
Mistranslation
+Mistranslation occurs when meaning is lost between the source language and the target language. This can be caused accidentally by a lack of context for where a translation will be placed within a user interface (very common in software localization), a translator’s lack of subject matter expertise, or intentionally due to user interface text constraints (e.g., truncation).
+
Untranslated strings
+Untranslated strings appear in a user interface when developers don’t include that string in the string resource files available for localization, but instead in their code. It’s a practice called hardcoding. The best way to correct this error is to make sure that Pontoon does not contain the string for translation (or that it’s not in the string resource files) and then contact developers using Bugzilla to make the string available for localization.
+
Style bugs
+Mozilla’s official style guide serves as a primer to help communities create their own style guides. Style errors are when the tone or appearance of a translation does not match the tone or appearance described in a style guide. These can be corrected by making sure that localizers understand the style guide rules and follow them when translating.
+
Numbers, date, currency
+Every language and region displays numbers, dates, and currency differently. These errors occur when the user sees an incorrect number format, date format, or currency for the language and region of their localized Firefox. This can be fixed by filing a bug in Bugzilla.
+
XML parsing errors
+XML parsing errors (aka “the yellow screen of death”) cause Firefox to display a yellow error page. This is often due to a broken translated string in that localization of Firefox which causes the Firefox build to break. With Fluent, these errors will no longer be relevant.
+
Exposed variables and placeholders
+Variables and placeholders become exposed in the user interface when the translated string has a typo within the variable or placeholder. Because it is not exactly the variable that the software or website expected to find, the system simply displays the variable rather than its value. A very common example of this is with the variable &brandShortName. If that variable is typed correctly in the translation, it will return the variable’s value (in this case, it’s Firefox). If it contains a typo, the user will see the variable instead (e.g., &brandshortname). These are discoverable in the Mozilla localization dashboards and can be corrected in Pontoon.
Broken access keys
+Access keys are less effective when the same key is assigned to multiple functions within the same scope (menu, preference panel, etc.). Additionally, if the access key uses a letter not available in the label, it’s displayed near the label between parentheses. Multiple identical access keys in the same context (preference menu, toolbar menu) will require the user to press the letter twice to use it. Ideally, repetitions should be avoided, but that’s not possible in some places, e.g. the reorganized preferences shipping with Firefox 56 and later.
+It’s possible to see a list of access keys using letters not available in the associated label in your Firefox localization by looking at this page in Transvision for your locale.
+
Broken language preferences
+Users experience broken website language preferences in Firefox when the accept-lang preferences are left unchanged from the en-US default set of language preferences. This can lead to the user receiving web pages in a language they’re unfamiliar with by default, even when the web page is localized into their native language. It can be fixed in toolkit/chrome/global/intl.properties in the accept-lang setting.
Broken searchplugins
+Users experiencing a broken searchplugin will receive a “website unreachable” message when they attempt to perform a search from their awesome bar or search bar. If you discover that a searchplugin is broken, please file a bug with the l10n-drivers.
+Broken hyperlinks
+Broken hyperlinks occur in a couple of different ways:
+-
+
- When there are typos in the hyperlink markup, the markup is then exposed to users. +
- When the hyperlink links to a site that is not obvious by the text it’s linked to (e.g., linking to the wrong support article according to the link’s context). +These can only be discovered by using the website or software regularly and clicking each hyperlink available to ensure that they take the user to the intended website. +
What to do when you find an error while testing
+Congratulations! You’ve found a bug! No software is perfect and you’re very likely to find bugs while you test your localization. Once you’ve found a bug, you can either attempt to find the affected string in your community’s Pontoon projects or you can file a bug in Bugzilla for that language in Mozilla Localizations :: [your_locale]. Once a fix for that bug is landed, it’s important to test again to be sure that the issue has been resolved.
+For project-specific testing guides, please see these pages:
+-
+
- Addons.mozilla.org (AMO). +
- Firefox Desktop. +
- Firefox for Android. +
- Firefox for iOS. +
- Focus. +
- Mozilla.org. +
- Support.mozilla.org (SUMO). +
Documentation for Mozilla localizers
+Table of contents
+Community
+ +Products
+How to localize and test Mozilla products:
+-
+
- Firefox for desktop. +
- Firefox for Android. +
- Firefox for iOS. +
- Focus for Android and iOS. +
- Mozilla.org. +
Tools
+ +Web Projects
+-
+
- Web projects +
Other topics
+ +How to contribute to documentation
+Please see the README file in our GitHub repository.
+How to use Pontoon
+This document covers how to work with Pontoon from the user’s perspective. While most of the documentation applies to any deployment of Pontoon, the Mozilla instance is referenced frequently as an example. Some limited portions apply specifically to using Pontoon to localize Mozilla projects online.
+If you’re interested in administrating Pontoon, please read these documents.
+-
+
- How to translate. +
- Translation workspace. +
- Team and project pages. +
- User accounts and settings. +
- Notifications. +
- Profile page. +
- Glossary. +
Note: The screenshots in this documentation use the dark theme, but a light theme is also available.
+How to translate
+This document describes briefly how to translate and review strings in Pontoon and provides an example of translation workflow within a team. The documentation also includes a dedicated page about Pontoon’s translation workspace, including translation tools.
+Translating strings
+When a string is selected in the sidebar, users can input a translation using the editor available in the middle of the page. Note that, if the string already has a translation, the editor will be pre-populated with text that the user can modify.
+Depending on the current translation mode, the UI will look slightly different.
+When the user is in Suggestion Mode — manually selected, or because the user doesn’t have permissions to submit translations directly — a blue SUGGEST button will be displayed in the lower-right side of the editing space.
To suggest a translation, the user can input the text in the editor and click SUGGEST. The suggestion will then be displayed below the editing space and in the sidebar where, in the case of multiple suggestions, only the most recent one will be displayed.
Note that a suggestion exists only in the Pontoon database, and it’s not added to the translation memory. For projects using version control systems, the translation is not stored in localized files outside of Pontoon.
+When the user is in Translation Mode, a green SAVE button will be displayed instead of SUBMIT. When saving a translation:
-
+
- The translation will be displayed directly below the editing space and in the sidebar. +
- The translation will be stored in the version control system (where applicable). +
- All pending suggestions or pretranslations will be rejected. +
Manually switch to suggestion mode
+Even if the user has permissions to add translations directly, submitting suggestions to be reviewed by another person helps ensure quality. To manually switch to Suggestion Mode, click the settings icon in the lower-left side of the editing space and select Make suggestions. The SUGGEST button will be displayed in the lower-right side of the editing space, replacing the green SAVE button.
To switch back to Translation Mode, click the settings icon again and turn off Make suggestions.
Reviewing strings
+To review a suggestion or pretranslation, search for unreviewed or pretranslated strings in the sidebar.
+If the current translation is acceptable, either click on the APPROVE button in the lower-right side of the editing space, or click on the approve icon to the right of the text. This will transform the suggestion or pretranslation into an approved translation. In the case of suggestions, the approved translation will also be stored in the version control system (where applicable).
If the current translation is not acceptable, it can be rejected by clicking the reject icon to the right of the suggestion. After rejecting a suggestion or pretranslation, it’s also possible to delete it completely by clicking the trashcan icon. In the case of pretranslations, the rejected text will be also removed from version control systems (where applicable).
+Alternatively, it’s possible to provide a different suggestion: turn on Make suggestions, edit the translation as appropriate, and click SUGGEST. This will add the translation as a new suggested string.
Quality checks
+When submitting a translation or suggestion, Pontoon performs automated quality checks. They are meant to help localizers identify issues with punctuation, capitalization, variables, etc. before translations are saved. Failures for these checks are stored in the database, and it’s possible to filter strings with issues from the search bar.
+There are two types of quality check failures: errors and warnings.
+Errors
+Errors cover critical issues that would cause the string to be removed from products. For this reason, errors cannot be bypassed by localizers - the button to submit a translation is removed and the error needs to be fixed before the translation can be saved.
+Examples include exceeding the maximum string length, incorrect syntax, etc. Errors are denoted with a circled X with red background.
+
Warnings
+Warnings are displayed when potential issues are detected in the string, but it’s not certain that they will create problems in products (unlike errors). For that reason, warnings can be bypassed by localizers, allowing them to save a translation anyway.
+Examples include missing punctuation, differences in number of sentences and capitalization, etc. Warnings are denoted with a circled X with gray background.
+
Certain types of checks reported by the Translate Toolkit library may result in many false positives. For this reason, they can be completely disabled.
+Performing batch actions on strings
+Mass actions can be performed on multiple strings at once by clicking on the square to the left of any string in the sidebar. When clicked, the square will show a checkmark and the editing space will show the mass action panel. Note that mass actions are only available to users with translator permissions.
+
To select a range of strings, select the first one and hold SHIFT, then select the last one. To select all strings, click SELECT ALL on the top-right of the mass action panel. The number of selected strings will appear on the top-left, next to the Exit icon.
To return back to the default editing space, click the Exit icon on the top-right of the mass action panel.
+In the REVIEW TRANSLATIONS section, the user can approve or reject suggestions for all selected strings. Upon clicking APPROVE ALL or REJECT ALL SUGGESTIONS, the label of the button will be replaced with the number of affected translations.
+Note that APPROVE ALL accepts the latest suggestion, but doesn’t reject other suggestions if available.
In the FIND & REPLACE IN TRANSLATIONS section, the user can input the text to search for, and the text to replace it with. This is a basic find and replace feature that will work only on the selected strings.
Downloading and uploading translations
+Pontoon provides the ability to download and upload translations, including terminology and translation memories. To access these features, click on the profile icon in the top-right corner of any page. Note that the user must be in the translation workspace for the download/upload options to be displayed in the dropdown menu.
+
Anyone can download terminology (.tbx), translation memory (.tmx) and translations, while only users with translator permissions can upload translations. When downloading translations:
-
+
- The resource currently selected is downloaded in its original format, it’s not converted in any way. +
- If the project contains multiple files, a ZIP of all files is downloaded. If the project contains more than 10 files, only the file currently translated will be downloaded. +
When uploading translations to Pontoon:
+-
+
- Translations different from the ones in Pontoon will be imported and attributed to the user uploading the file. +
- Translations matching the ones in Pontoon will be ignored. +
Downloading .tbx and .tmx files via command line
+Terminology (.tbx) and translation memory (.tmx) files can grow big in size over time. To download files via command line it is advised to use curl command with the --compressed flag, to reduce download times and avoid request timeouts.
Here’s an example command to download German (de) .tmx file across all projects from pontoon.mozilla.org:
curl -o de.all-projects.tmx --compressed https://pontoon.mozilla.org/translation-memory/de.all-projects.tmx
+Note that Terminology files can be downloaded in the TBX 2008 (v2) format in addition to the default TBX v3 format available via the profile menu.
Here’s an example command to download German (de) .tbx file in the TBX 2008 (v2) format from pontoon.mozilla.org:
curl -o de.v2.tbx --compressed https://pontoon.mozilla.org/terminology/de.v2.tbx
+Workflow example
+This workflow utilizes the full power of Pontoon’s online translation features. It assumes that at least two translators are available for the project (AB workflow); however, this workflow can be completed by a single translator performing each phase (AA workflow), or by multiple translators in an ABCn workflow repeating Phase 3.
+Phase 1: translation
+Translator A
+-
+
- Log in to Pontoon. +
- Browse to the project. +
- Using filters select
Missingto display only the strings currently missing a translation, marked as fuzzy or containing errors.
+ - Access personal settings by clicking on the gear icon below the editing field and turn on
Make suggestions.
Note that new contributors who have not yet been granted Translator permissions will only have the ability toMake suggestions, which will be enabled by default.
+ - For each string, type a translation and save it with the blue
SUGGESTbutton. The string will be stored and displayed under the editor. Each translation submitted shows the name of the author and when it was saved. +-
+
- If something is unclear or there is a question about the source string, use the REQUEST CONTEXT or REPORT ISSUE feature to ask the Project manager. +
+
General notes:
+-
+
- Rely on Pontoon’s translation tools to ensure consistency and make the translation process faster. +
- When using Firefox, make sure to have a dictionary installed for the translation language, and that spell checking is enabled in the translation text area. +
Phase 2: review suggestions
+Translator B
+-
+
- Log in to Pontoon. +
- Browse to the project. +
- In filters select
Unreviewed, to isolate the strings previously suggested by another translator.
+ - Review the suggested strings.
+
-
+
- If a suggestion is acceptable:
+
-
+
- Confirm it as an approved translation by clicking the green
SAVEbutton or the checkmark icon near the string in the list below the editor (it turns green when hovered).
+
+ - Confirm it as an approved translation by clicking the green
- If a suggestion is not acceptable:
+
-
+
- Switch to Suggest mode. Edit the translation in the editing space and click the blue
SUGGESTbutton. The newly suggested version will not overwrite the translator’s work, but instead will appear at the top of the list under the editor.
+
+ - Switch to Suggest mode. Edit the translation in the editing space and click the blue
- Use translation comments to discuss a translation with the other translator. For example, discussing possible alternate translations or asking questions when something isn’t clear. +
+ - If a suggestion is acceptable:
+
Phase 3: implementing QA
+Translator A
+-
+
- In the project, select
Unreviewedfrom the filter search. Then compare the initial entries with those of the reviewer for changes.
+ - Review the remaining strings:
+
-
+
- If in agreement, confirm the reviewer’s version by clicking the green
SAVEbutton or the checkmark icon near the string in the list below the editor (it turns green when hovered).
+ - If suggesting an alternative, type it into the editor, then hit the blue
SUGGESTbutton. Then resubmit it to the reviewer from Phase 2.
+ - Reject suggestions not considered suitable by clicking on the cross icon near the string (it turns red when hovered). +
- If Translator A does not have the Translator or Team manager role, they will be unable to confirm or reject a suggestion. In that case, use translation comments to discuss the translation with the reviewer. +
+ - If in agreement, confirm the reviewer’s version by clicking the green
Repeat, switching translators, until a consensus is reached.
+Understanding Pontoon’s translation workspace
+-
+
- Main toolbar +
- String list and search + + +
- Main editing space
+
-
+
- String navigation +
- Source string
+
-
+
- Context +
+ - Editor + + +
- Translation list + + +
+ - Fluent - FTL files +
- Translation tools and comments + + +
- Smaller screens +
Pontoon’s translation workspace consists of the main toolbar and 3 columns:
+-
+
- The left column contains the string list for the current resource with a search field at the top. +
- The middle column contains the main editing space. +
- The right column contains terminology, source string comments, suggestions from translation memory, machine translation, and translations from other locales. +
Main toolbar
+The main toolbar at the top of the page allows users to navigate to the dashboards or to change the current resource.
+
Clicking the locale name will open the Team page for that locale, while clicking the project name will open the Localization page for that project.
+Clicking on the current resource (or All Resources) will display a list of all resources available for that project. It’s possible to search for a resource, and click one to load only the entities included in it. Clicking All Resources at the bottom of the list will go back to display all resources, while All Projects will show entities for all projects under the selected locale.
A progress chart showing the translation status of the current resource is located to the right of the resource name. A more detailed breakdown is displayed when clicking the chart.
+
The notifications icon, represented by a bell, is located on the right side of the main toolbar. By clicking the bell icon, users can view a list of the latest notifications they received.
+The profile menu is located at the far right of the main toolbar. Clicking the profile image will reveal a dropdown menu where users can perform several actions, like navigate to their profile page, download and upload translations, change their theme, etc.
+
Note that some profile menu items are only available to users with specific permissions.
+A selector to change the current theme is available in the profile menu and in the settings page. There are three theme options available:
+-
+
- Light. +
- Dark. +
- Match system (aligns with the theme used by the operating system). +
To change the theme, select the button corresponding to your preferred theme. The change will take effect immediately.
+String list and search
+The left column displays the list of strings in the current project resource. Each string is represented by:
+-
+
- A colored square that identifies the string status (i.e. Missing, Translated, etc.). +
- The source string. +
- The approved translation or the most recent suggestion if available. +
Color legend:
+-
+
- gray: translation is missing. +
- green: string is translated. +
- light-green: string is pretranslated. +
- orange: translation has warnings. +
- red: translation has errors. +
When a string is selected in the sidebar, a small icon with four arrows is displayed near the checkbox: this can be used to show strings that surround the selected string in the resource, bypassing the current filter. This is often helpful to provide more context for the localization, especially when translating missing strings.
+
Search
+It’s possible to search within the currently selected project using the search field. Searches include strings and string IDs.
+
Note that searches take active filters into account, for example a search would be performed only on missing strings if that filter was previously selected.
+Like in search engines, by default Pontoon will display matches that contain any of the search terms. For example, searching for new tab will match both Open links in tabs instead of new windows and New Tab.
To search for an exact match, wrap the search terms in double quotes, e.g. "new tab". On the other hand, to search for strings that contain double quotes, escape them with a backslash, e.g. \".
Search options
+In addition to the search filters listed below, Pontoon provides additional search options, allowing users to refine search results. Search options can be accessed by clicking the magnifying glass icon on the right side of the search box.
+
Search options include:
+-
+
- Match case: Exactly match the capitalization of the search term. +
- Match whole word: Provides the same result as surrounding a word with double quotes, exactly matching the search term (case insensitive), and avoiding partial matches. +
- Include string identifiers: Expand the search to include string identifiers (keys). +
- Include rejected translations: Expand the search to include translations that have been rejected. +
- Exclude source strings: Avoid searching for matches in source strings. +
All search options are disabled by default. Clicking anywhere on the name or checkbox will toggle only the specific search option. Once ready, clicking the APPLY SEARCH OPTIONS at the bottom of the panel will apply the selected search options.
Filters
+Translation status
+Strings in Pontoon can be filtered by their status. A string can be in one of the following statuses:
+-
+
- Translated: string has an approved translation. The translation is saved to the localized file when using a version control system (VCS). +
- Pretranslated: string has been pretranslated but has not been reviewed. Unreviewed pretranslation are saved to the localized file when using a VCS. +
- Warnings: string contains issues classified as warnings. +
- Errors: string contains critical issues. +
- Missing: string doesn’t have any approved translations. +
- Unreviewed: string has suggested translations that have not been reviewed yet by someone with the appropriate permissions. Note that, for both translated and missing strings, the suggested translation only exists within the Pontoon database and is not saved to the localized file when using a VCS. +
Extra filters
+In addition to statuses, additional filters can be used to further refine the list of strings. Extra filters include:
+-
+
- Unchanged: string is identical to the reference language (normally
en-US).
+ - Empty: string has a translation, but translation contains no content. +
- Fuzzy: string is marked as fuzzy in the localized file. +
- Rejected: string has rejected translations. +
- Missing without Unreviewed: string has
Missingtranslation status and does not haveUnreviewedtranslations.
+
Filters can be accessed by clicking the icon on the left of the search field.
+
At this point it’s possible to:
+-
+
- Click directly on the name of one of the filters. This will select and activate only this filter, and the search field placeholder will change accordingly. For example, clicking on
Missingwill show only missing strings, and the placeholder will readSearch in Missing.
+ - Click on one or more filter icons or user avatars (multiple filters can be applied at once). Hovering over the icons transforms the icon into check marks. Clicking an icon will select that filter and a new button
APPLY X FILTERSwill appear at the bottom of the panel, whereXis the number of active filters.
+ - Click
EDIT RANGEonTRANSLATION TIMEto select a time range. Pick one of the defaults (30 days, 7 days, 24 hours, 60 minutes), or use the date picker (or slider) to adapt the range. Click onSAVE RANGEto store the range as a filter. A new buttonAPPLY X FILTERSwill appear at the bottom of the panel, whereXis the number of active filters.
+
In this case 3 filters are selected.
+Tags
+For specific projects it’s also possible to filter strings based on tags. Tags are used to logically group resources based on their priority, allowing localizers to focus their work on important strings first, and project managers to better assess the overall localization status of the project.
+
In this case, there are 10 tags defined for the project (highlighted in red). Near each tag there is a representation of the priority: like for projects, it goes from 5 stars (highest priority) to 1 star (lowest priority).
+Note: translation time, translation authors, and tags are not available when All Projects is selected as a resource.
Main editing space
+The main editing space in the middle column is where translation takes place.
+
String navigation
+The top of this space contains a string navigation interface. It’s possible to navigate sequentially through the strings by clicking the PREVIOUS or NEXT buttons located at the top of the editing space, or by using keyboard shortcuts (ALT + arrow down or up). A link to the current string can be copied to the clipboard using the COPY LINK button.
Source string
+Below the navigation interface, the user can view the source string, any comments present in the resource regarding the string, and the resource path where the string is located.
+In the same area, the REQUEST CONTEXT or REPORT ISSUE button can be used to request more information about the current string: it will focus the COMMENTS section, and mention the project manager for the project.
Context
+Sometimes you may want to investigate more context about a particular string through an external resource such as a Version Control System. The CONTEXT information provided underneath the source string shows the identifier, file, and project for the string — allowing you to find the string within the codebase of the project. For example, for some Mozilla projects these can be used to track strings to bugs.
Editor
+The editor is located in the middle section of the column, and it’s where users can input or edit their translations.
+In the lower-right side of the editing space, it’s possible to COPY the source string to the editor, CLEAR the area where translations are typed, and SUGGEST or SAVE the translation by clicking the corresponding button. This area is also used to display warnings and errors when submitting a translation.
In the lower-left side:
+-
+
- Clicking the gear icon allows users to toggle
Translation Toolkit checksorMake suggestions, and navigate to the user settings. Note that access to some settings is restricted by user permissions.
+ - Clicking the keyboard icon displays a list of available shortcuts. +
- The numbers displayed to the right of the keyboard icon (e.g.
50|59) are the number of characters in the target and source string.
+
Read-only projects
+A project could be enabled in read-only mode for some locales: their translations will be available to other languages in the LOCALES tab, but it won’t be possible to change or submit translations directly in Pontoon. In this case, a note is displayed in the bar below the editor, and all other controls are hidden.
Translation list
+The space below the editor displays the list of translations for the current string.
+Each entry contains:
+-
+
- The name of the translator, their profile picture (linking to their profile page) and their banner (see User banners). +
- How long ago the entry was submitted (hover over to see the full date and time as a tooltip). +
- The translation. +
- Icons indicating translation status (see below). +
- Translation comments. +
Icons to the right indicate the status of each translation:
+-
+
- The solid green circle with checkmark indicates that the translation has been approved. +
- The outlined lime green circle with checkmark indicates a pretranslation that has not yet been reviewed. +
- If both icons are gray, translation has been suggested but not yet reviewed. +
- The red cross indicates that the translation has been rejected. The entire element will look opaque. +
- The trashcan, available only for rejected translations, can be used to completely delete a translation. Those with the contributor role can only remove their own translations, while those with a translator permissions can delete anyone’s. +
In the screenshot above, the first item is the approved translation (green checkmark), while the other two are rejected suggestions.
+User banners
+User banners provide immediate context about a user to other community members. They indicate either the role of the user, or that the user is new to Pontoon. Banners are displayed at the bottom of the user's avatar.
+
The available user banners are:
+-
+
MNGRfor team managers.
+TRNSLfor translators.
+PMfor project managers.
+ADMINfor administrators.
+NEWfor users who have joined within the last 3 months.
+
User banners will also appear in translation comments (see below).
+Translation comments
+By clicking the COMMENT button it’s possible to add a translation comment to this specific translation. To mention another user in the comment, start typing @ followed by their name.
If there is already a comment associated with a string, the button will display the number of comments (e.g. 1 COMMENT for the first rejected suggestion).
Viewing translation differences
+The DIFF option appears if there are multiple translations for one string. Toggling DIFF compares the text to the current approved translation, or the most recent suggestion if no translation has been approved yet. Text highlighted in green indicates content that has been added, while strikethrough text in red indicates removed content. Toggling DIFF again will display the original string.
Fluent - FTL files
+When working on FTL (Fluent) files, the editing space will look slightly different.
+
In the example above, the string has a value and an attribute title. Both are displayed in the source section (highlighted in red), and available as separate input fields in the editor (highlighted in orange).
The following image is an example of a string with plurals: while English only has two forms, plural and singular, other locales can have a different number of plural forms. In this case, Russian has three forms (highlighted in orange).
+
In the bottom left corner, the FTL button (highlighted in yellow) allows to switch between the standard UI (Simple FTL mode) and the Advanced FTL mode, where it’s possible to edit the original syntax directly, as you would in a text editor. For details on the Fluent syntax, see Fluent for localizers.
+
Note that the FTL button’s text is green when in Advanced FTL mode.
+Translation tools and comments
+Built-in translation tools are located in the rightmost column.
+Terminology
+The TERMS tab shows the definition and translation of a term, in case the source string includes matches with the built-in terminology. The matching term is also highlighted in the source string. A popup appears on click showing the definition and translation for a term.
Source string comments
+The COMMENTS tab is used to display existing source string comments, or add new ones. Source string comments, unlike translation comments, are associated with the string: it’s possible to have a comment in this section even if the string doesn’t have any suggestion or translation yet.
They’re designed for team members to have a conversation about the source string, for example to clarify its meaning, or to get more information from project managers.
+Administrators can pin or unpin a source string comment: this pinned comment will be displayed along existing comments in the editing area as PINNED COMMENT, and users will receive a notification.
The screenshot above shows a pinned comment, and the command to unpin it.
+Machinery
+Machinery shows possible translations from a variety of sources. These sources include:
+-
+
- Pontoon’s internal translation memory. +
- Microsoft Terminology. +
- Google Translate. +
- SYSTRAN. +
- Caighdean. +
- Bing Translator (not currently enabled on pontoon.mozilla.org). +
In addition, the user has the ability to search for translations containing words via Concordance search.
In the tab, the number of entries is visible alongside the MACHINERY title in white. If any of the machinery matches are from translation memory, the number of matches will appear separately in green. For example, the screenshot below shows 2+1, where the green 2 represents the two matches from translation memory and the 1 represents a machinery entry from Google Translate.
At the top of each entry, a diff view compares the current source string and the source string from the machinery entry. Strikethrough text highlighted in red indicates text that is present in the source string but not in the machinery source string, while text highlighted in green indicates text available only in the machinery source string.
+To the right of the entry, the number in green shows the percent match between the machinery source string and the current source string. The higher the percentage, the more likely machinery is to be useful; a 100% match indicates that the sources for the current string and for the machinery string are identical.
+The origin of the machinery entry is listed in gray above the source string. Clicking the gray text will open the origin in a new window. The green superscript to the right indicates the number of matches for the entry in the translation memory.
+Be careful when using the machinery tab as suggestions may not match the source string for the project being translated. Even if the source strings match, the context in which strings are used may not be the same. This could lead to incorrect or unnatural translations. Always keep the meaning and purpose of the string being translated in mind when using the machinery tab.
+Large language model (LLM) integration
+Pontoon will show a dropdown labeled AI for all locales that have Google Translate available as a translation source. This feature refines the Google Translate output using an LLM. Opening this dropdown will reveal three options:
-
+
REPHRASE: Generate an alternative to this translation.
+MAKE FORMAL: Generate a more formal version of this translation.
+MAKE INFORMAL: Generate a more informal version of this translation.
+
After selecting an option, the revised translation will replace the original suggestion. Once a new translation is generated, another option SHOW ORIGINAL will be available in the dropdown menu. Selecting it will revert to the original suggestion.
Concordance search
+Concordance search allows users to search across all projects in Pontoon. Users can search for translations using strings in either source or target language. Matching results are displayed with the source string, translation, and project name; clicking a result will automatically fill the translation into the editor. Note that the search does not need to be related to the current string or project.
+
Stand-alone machinery
+Pontoon machinery is also available as a stand-alone web page. Use the Machinery link in the main navigation to access the page (this is not accessible from the translation workspace).
To use the machinery, select the target locale from the dropdown menu to the right of the searchbar. Then input the English source string into the searchbar and press Enter. This will display all matching machinery entries. Information is organized exactly as in the translation workspace.
+Locales
+The locales tab shows approved translations from Pontoon projects in other locales.
+
Next to the LOCALES title, the number of available entries is visible. The number for preferred locales is green, while the number for all other locales is in gray.
Users can select locales to appear at the top of their Locales tab as a preferred locale. To add a locale to the preferred locale list, access the user settings page.
+Entries in the LOCALES tab above the green line are preferred locales. Non-preferred locales are displayed below the green line, sorted alphabetically by language name.
Each row displays the translation for the source string in the selected locale. Above each entry, the language name is visible in gray, while the locale code is displayed in green.
+The LOCALES tab is useful for seeing what general style choices are made by other localization communities. When encountering a difficult string, a translator can use other locales as a source of inspiration.
Note that, when using the LOCALES tab, the translator should always opt for fluency in their own locale. Languages vary linguistically on many levels. The locales tab can be extremely useful, but should be used carefully, and rarely as the sole translation resource for translation.
Smaller screens
+The translation workspace is responsive, which means the layout will adapt to smaller screens. Everything you do on your desktop computer or laptop, you can also do on your phone or tablet: review strings, fix typos or even translate a few strings on the go.
+
Team and project pages
+-
+
- Teams + + +
- Projects + + +
- Localization page +
- Insights graphs +
The Teams page, accessible using the /teams URL (e.g. pontoon.mozilla.org/teams), lists all locales that are enabled in Pontoon. From here it’s possible to access a specific Team page, which contains a list of all projects enabled for the requested locale. Selecting a project from the Team page leads to the so-called the Localization page.
From each locale’s Team page it’s also possible to Request a project or Request pretranslation. Note that this is a request to add the locale to a project already available in Pontoon, it can’t be used for requesting a brand new project.
+The Projects page, accessible using the /projects URL (e.g. pontoon.mozilla.org/projects), lists all projects that are available in Pontoon. From here it’s possible to access a Project page, which shows all locales that are enabled for the requested project. Selecting a locale in the Project page leads to the Localization page.
There is also a special Localization page that allows access to all resources for all projects enabled for a specific locale: /locale/all-projects/all-resources.
The following diagram shows how these pages are organized and connected to each other:
+
Teams
+Teams page
+The Teams page lists all locales that are enabled in Pontoon. It can be reached by clicking Teams in the page header (not displayed when translating a project) or by using the /teams URL (e.g. pontoon.mozilla.org/teams). Clicking on a specific locale will open the locale’s Team page.
Team page
+Access a specific team’s page by selecting it from the Teams page or by appending a locale code to the end of the Pontoon base URL with /{LOCALE} (e.g pontoon.mozilla.org/it for Italian).
The page header contains linguistic information about the current locale (plural form, writing direction, etc.), plus an indication of the overall status of completion and statistics. The statistics displayed in the rightmost column are active links to access the translation workspace for all projects. For example, select ALL STRINGS to show all the strings for all projects enabled for a specific locale in Pontoon, or select MISSING to filter for all strings missing translations.
Underneath the header, the following tabs are available to navigate between various Team page panels:
+-
+
- Projects: a list of all projects enabled in Pontoon for this locale. +
- Contributors: a list of active contributors with their statistics, filterable by time (all time, last 12/6/3/1 months). +
- Insights: data and trends on contributor and localization activity. +
- Bugs: a list of open bugs for the locale, retrieved from Bugzilla (available in Mozilla's deployment). +
- Info: information about the team. Team managers can edit this by clicking on the
EDITbutton.
+ - Permissions: permissions management panel (available to Team Managers). +
- TM: translation memory management panel (available to Translators and Team Managers). +
By default, the Projects tab opens, showing a list of all projects enabled for the locale. Clicking on one of these projects leads to the Localization page. Column headers can be used to sort the list of projects. For example, clicking on Priority will sort projects by their priority.
Hovering a project in the Projects list will replace the progress bar with a set of detailed statistics (untranslated strings, missing strings, etc.). Note that all these numbers are links, use them to open the project with a filter already enabled, for example to display only missing strings. Clicking ALL accesses All Resources (i.e. all strings in all files) for this project.
The rightmost column in the table will display a blue lightbulb icon if there are unreviewed translations. Note: clicking the lightbulb icon in the table header can be used to sort projects based on the number of unreviewed translations.
+
Requesting a project
+It’s possible to request a project from a Team page. Note that this is a request to add the locale to a project already available in Pontoon, it can’t be used for requesting a brand new project.
+
The button is hidden if all available projects are already enabled for the locale.
+Click on REQUEST MORE PROJECTS, select the projects to add and then click REQUEST NEW PROJECT (at least one project needs to be selected for the button to be displayed).
An email will be sent to Pontoon’s administrators, and the Project manager in charge of the project will act on the request. Please note that:
+-
+
- Some projects have a closed list of supported locales, meaning that these projects can’t be requested on Pontoon. +
- Some projects can be requested but may not be enabled for practical restrictions related to the project itself (e.g. lack of support for the locale in iOS). +
Requesting pretranslation
+For locales supported by Google AutoML Translation, it’s possible to request to enable pretranslation for specific projects from a Team page.
+
The button is only displayed to translators and team managers for the locale.
+Click on REQUEST PRETRANSLATION, select the projects to add and then click REQUEST PRETRANSLATION (at least one project needs to be selected for the button to be displayed).
An email will be sent to Pontoon’s administrators, and they will act on the request. Please note that:
+-
+
- If a locale doesn’t have pretranslation enabled for any projects yet, it’s necessary to set up and train a new custom model, and this operation requires several hours. +
- For
pontoon.mozilla.org, each request will be evaluated against specific opt-in guidelines.
+
Translation memory management
+The TM (translation memory) tab lists all TM entries for the team. A source string and translation are provided for each entry, which upon clicking leads to the translation workspace for the corresponding strings. Entries are only shown once for each unique combination of source string and translation. TM entries can be searched by source string or translation using the Search field.
The following actions are available:
+-
+
- Edit: after clicking the
Editbutton in the Actions column, the translation of the TM entry transforms into a textarea element and becomes editable. Next to it,SaveandCancelbuttons appear. ClickingSavesaves any changes to all corresponding TM entries and clickingCancelcancels the editing action.
+ - Delete: after clicking the
Deletebutton in the Actions column, the button changes into theDelete N TM entries?confirmation button (with N representing the number of corresponding TM entries). Clicking that button deletes all corresponding TM entries and clickingCancelcancels the editing action.
+ - Upload .TMX: after clicking the
Upload .TMXbutton above the TM entry list, an Open file dialog pops up. The user then selects the TMX file to upload, the TM entries from the file start to import into the team's TM, and eventually a success or error message appears.
+
Projects
+Projects page
+The Projects page lists all projects that are available in Pontoon. It can be reached by clicking Projects in the page header (not displayed when translating a project) or by using the /projects URL (e.g. pontoon.mozilla.org/projects). Clicking on a specific Project page will open the project’s Project page.
Project page
+Access a project’s page by selecting it from the Projects page (e.g. pontoon.mozilla.org/projects).
+The page header contains useful information about the current project:
+-
+
- Priority: priority from 5 stars (highest) to 1 star (lowest). +
- Target date: set only for some projects, it indicates when the translation is due. +
- Repository: link to the repository storing translations for this project. +
- Resources: links to useful external resources (e.g. testing instructions, screenshots, etc.). Project managers can set up custom links for each project. +
- Project manager: point of contact for this project. +
It also includes an indication of the overall status of completion and statistics across all enabled languages.
+
Underneath the header, the following tabs are available to navigate between various Team page panels:
+-
+
- Teams: a list of all locales enabled in Pontoon for this project. +
- Tags: a list of tags defined for this project. This tab will be visible only in projects where tags are enabled. For more information about tags, see [this page]translation_workspace.md#tags). +
- Contributors: a list of active contributors with their statistics, filterable by time (all time, last 12/6/3/1 months). +
- Insights: data and trends on contributor and localization activity. +
- Info: information about the project. +
By default, the Teams tab opens, showing a list of all locales enabled for the project. Clicking on one of these locales leads to the Localization page.
+Requesting a locale
+It’s possible to request an additional locale for some projects from its Project page.
+
Click on REQUEST NEW LANGUAGE, select the locale to add and then click REQUEST NEW LANGUAGE.
An email will be sent to Pontoon’s administrators, and the Project manager in charge of the project will act on the request. The same restrictions described in the Requesting a project section apply here.
+Localization page
+Access a project’s Localization page in two ways:
+-
+
- By selecting it from the Team page. +
- By selecting it from the Project page. +
The page header contains useful information about the current project (same as the Project page).
+
Underneath the header, the following tabs are available to navigate between various Team page panels:
+-
+
- Resources: files available in the project. +
- Tags: a list of tags defined for this project. This tab will be visible only in projects where tags are enabled. For more information about tags, see this page. +
- Contributors: a list of active contributors with their statistics, filterable by time. Unlike the tab available in the Team page, this only includes contributions to localization of the project for the current locale. +
- Insights: data and trends on contributor and localization activity. +
- Project info: same content as the Info tab in the Project page. +
- Team info: same content as the Info tab in the Team page. +
Insights graphs
+The Insights tab, accessible from either the Project, Team, or Localization page, displays data and trends on contributor and localization activity in a graphical format.
+The following insights appear on all pages:
+-
+
- Review activity: shows the number of unreviewed suggestions as a trend line. The Team page also shows the number of peer-approved, self-approved, and rejected suggestions for each month as a bar graph to display the impact of the review process on the number of unreviewed suggestions. New suggestions (hidden by default) can also be shown by clicking
New suggestionsat the bottom of the graph. Hover over a data point to get the detailed number of strings and percentages for that month.
+ - Translation activity: shows the translation completion percentage for the locale as a trend line. The Team page also shows the number of human translations and machinery translations for each month as a bar graph to display the impact of the translation process on the number of completed translations. New source strings (hidden by default) can also be shown by clicking
New source stringsat the bottom of the graph. Hover over a data point to get the detailed number of strings and percentages for that month.
+
The following insights only appear on Team pages:
+-
+
- Active users: shows the ratio of active versus total for each user role: managers (Team managers), reviewers (Team managers and Translators), and contributors, filterable by time period (last 12/6/3/1 months). +
- Time to review suggestions: shows the average age of suggestions reviewed for a particular month, and the 12 month average. Hover over a data point in the graph to see the exact age in days for that month’s current and 12 month average. +
- Age of unreviewed suggestions: this can be accessed by clicking
Age of unreviewedon the bottom of the Time to review suggestions graph. Shows the average age of unreviewed suggestions at a particular point in time. Hover over a data point in the graph to see the exact age in days for unreviewed suggestions for that month.
+
Note: clicking on the i icon in the top right of each insight will provide detailed definitions for the data shown.
User accounts and settings
+ +Creating an account
+While Pontoon can be configured to use different login systems (Django, GitHub, etc.), the Mozilla instance hosted at pontoon.mozilla.org uses Firefox accounts.
+To create an account, click on the Sign In button in the top right corner and follow the instructions.
User settings
+User settings can be accessed by:
+-
+
- Clicking the user avatar in the top right corner, and selecting
Settingsfrom the dropdown menu.
+ - Opening the
/settingsURL directly (e.g. pontoon.mozilla.org/settings).
+ - Using the
CHANGE SETTINGSbutton in the Profile page.
+
Profile picture
+The profile picture can be set or updated on Gravatar by clicking the image displayed at the top of the settings page (when hovered, the picture will display an Update profile picture message).
Personal information
+In this section it’s possible to update the display name and other personal information:
+-
+
Display name: it’s the name displayed in Pontoon, for example when submitting a translation or suggestion. It’s also used as the author name when committing translations to version control system (i.e. git or hg repositories).
+Username: this is currently used to generate the URL for the Profile page (e.g.https://pontoon.mozilla.org/contributors/USERNAME/). If not provided, a hash will be used instead of the username.
+Bio: a short text that will be displayed in the Profile page.
+
In this section it’s possible to update the display name and other personal information:
+-
+
Contact email address: if provided, this email address will be used for email communications and displayed in the Profile page instead of the login email address.
+News and updates: if enabled, you will get the latest updates about localization at Mozilla, announcements about new Pontoon features, invitations to contributor events and more.
+Monthly activity summary: if enabled, you will get an email summary of your personal activity and the activity within your teams for the previous month.
+
Notification subscriptions
+Pontoon can send internal notifications to users for specific events. All notifications are enabled by default, but can be disabled by using the corresponding checkbox.
+Additionally, for each notification type, users can choose to receive email updates in a digest format. These email digests can be scheduled to arrive either daily or weekly, depending on the user’s selection.
+For more information about this topic, refer to the page dedicated to notifications.
+External accounts
+In this section it’s possible to specify the username used in external accounts, like GitHub or Bugzilla. If provided, this information will be displayed in the Profile page.
+Visibility of data on the Profile page
+Users can determine the visibility of fields containing personal information — like email address or external accounts — and statistics about their contribution. From the smallest audience to the largest, a field can be visible to:
+-
+
Translators: these are users with translator permissions in Pontoon, independently from the locale. The rationale is that translators need to have access to specific information to either contact a contributor during review, or check stats about their previous contributions.
+Logged-in users: these are users logged-in to Pontoon, independently from their permissions.
+Public: this includes all users and not logged-in visitors.
+
These are the available data fields:
+-
+
Email address: by default, this field is only visible to translators. Visibility can be expanded to all logged-in users, but it’s always hidden to visitors to reduce the risk of spam. This setting is ignored for team and project managers, as their email address is always visible to logged-in users.
+External accounts: by default, this data is only visible to translators, but it can be made public.
+Approval rateandSelf-approval rate: by default, these fields are set as public, but can be limited to translators.
+
Appearance
+The user can chose between a light and dark combination of colors for Pontoon. There are three theme options available:
+-
+
- Light. +
- Dark. +
- Match system (aligns with the theme used by the operating system). +
To change the theme, select the button corresponding to your preferred theme. The change will take effect immediately.
+Editor
+Translation Toolkit Checks (checks for number of sentences, placeholders, HTML tags, punctuation, etc.) are performed when saving a translation. For more information about quality checks, see this document.
Make suggestions allows a translator or a team manager to submit suggestions instead of translations. This setting is also displayed to users with translator permissions.
Locale settings
+It’s possible to set the default homepage displayed when visiting Pontoon as a logged-in user. Current options are:
+-
+
- Default homepage (Pontoon’s homepage). +
- A Team page. +
Preferred source locales can be used to display a different source locale when translating. In Mozilla projects, the source locale is always English (en-US).
Preferred locales can be used to display a specific group of locales before others in the LOCALES tab when translating strings. In the image below, the user chose to display fr and es-ES before other translations — ordered alphabetically based on the locale name. Since they’re both available the tab displays 2+118, meaning 2 preferred locales plus all others.
User roles
+There are five user roles in Pontoon:
+-
+
- Contributors can only submit suggestions. This is the default role for new users. +
- Translators can submit translations directly in a specific locale, and review other contributors’ suggestions. +
- Team Managers can perform the same actions as translators, but also manage other users and update their permissions. +
- Project Managers don’t have translator permissions, but they act as the point of contact for a specific project. Their name is displayed in the header of Project and Localization pages, and using the
REQUEST CONTEXT or REPORT ISSUEfunction will tag them in a comment.
+ - Administrators can manage Pontoon, e.g. adding or removing projects, and act as Team Managers for all locales. +
Managing permissions
+A Team Manager can upgrade other users’ permissions within a locale. To manage users, open the team page and select the PERMISSIONS tab (it will only be visible to Team Managers and Administrators).
By default there’s only a General section: permissions defined here will apply to all projects, but can be overridden by custom project permissions.
To move a user to a different column, hover the email address: arrows will appear to move the element to the left or right. Note that a user needs to log in at least once in Pontoon in order to upgrade their permission – simply having an account is not sufficient.
+Use the SAVE button to store the configuration before leaving this window.
By default, the TEAM CONTRIBUTORS column will only include users that have already submitted suggestions for this locale. Click ALL USERS (highlighted in red) to display all existing users, then use the search field to narrow down the list.
By clicking ADD CUSTOM PERMISSIONS PER PROJECT (highlighted in orange), it’s possible to add specific permissions for a project. This can be useful to make sure that only some users can submit translations for a specific project, for example if it’s maintained by one person.
Note that:
+-
+
- The list of translators defined for a specific project overrides the list defined in the
Generalsection. If a user needs to be able to translate all projects, they need to be listed in all custom permissions on top of theGeneralsection.
+ - It’s not possible to override Team Managers, as they will always be able to submit translations in any of the projects available for their locale. +
Notifications
+Tracking updates across several projects can quickly become challenging. Pontoon tries to support users across different roles by sending notifications, to make sure important updates don’t get lost. Administrators can also use notifications to send messages about specific projects.
+When the user receives a notification, the bell icon near the user avatar in the top right corner will show a badge with the number of unread notifications. Clicking the bell icon will display the latest notifications in a dropdown menu.
+
Clicking See all Notifications at the bottom will take the user to the complete list of notifications. The same list can also be accessed by opening the /notifications URL directly (e.g. pontoon.mozilla.org/notifications).
Receiving notifications via email
+Pontoon also offers the option to receive notifications via email, allowing users to stay informed about important events even when they're not actively using the platform. They can choose to receive email notifications as a daily or weekly digest and customize their preferences by subscribing to specific notification types.
+Receiving notifications in the browser
+Pontoon notifications can be delivered directly to your browser through the Pontoon Add-on, which is compatible with both Firefox and Chrome.
+Disabling notifications
+Pontoon includes several types of notifications and most of them can be manually disabled by users if they don’t find them useful.
+Notification types
+New strings
+This notification informs users when new strings are added to a project. The notification is sent to all users who contributed translations to that project, as soon as new strings are available.
+Project target dates
+This notification informs users when a project is incomplete and it’s approaching the target date. The notification is sent to all users who contributed translations to that project, the first time 7 days before the target date, then again 2 days before.
+Comments
+Pontoon distinguishes between two types of comments:
+-
+
- Translation comments are associated with a specific translation. These comments are displayed under the translation itself. +
- Source string comments are associated with the source string. These comments are displayed in the
COMMENTStab in the right column.
+
For either type of comment, a notification is sent as soon as a comment is added.
+For translation comments, the recipients are:
+-
+
- Authors of other translation comments associated with the same translation. +
- Translation author. +
- Translation reviewer. +
For source strings comments, the recipients are:
+-
+
- Users with the ability to review translations for the string. +
- Authors of translation comments. +
- Authors of source string comments. +
- Translation authors. +
- Translation reviewers. +
New suggestions ready for review
+This notification is sent once a week to inform reviewers about new suggestions needing a review. It includes information about suggestions that were submitted, unapproved or unrejected over the last 7 days. Recipients include users with permissions to review these suggestions — translator and team managers — as well as the authors of previous translations or comments in the same string.
+Review actions on own suggestions
+This notification is sent once a day to authors of suggestions, to inform them that their work has been reviewed.
+New team contributors
+This notification is sent to team managers, as soon as a new user makes the first contribution to their team.
+Badge awarded
+This notification is sent to a user upon being awarded with a badge or new badge level from reviewing and submitting translations, or promoting users.
+Manual notifications
+Administrators can send manual notifications to a project, including all locales or a subset of them. Unlike other types of notifications, this can’t be disabled.
+Profile page
+The goal of the profile page in Pontoon is to provide a tool to showcase contributions, display useful contact information about the user, and help team managers to organize and grow their communities. A user’s personal profile page can be reached by clicking the avatar icon in the top right corner, and then clicking the profile picture in the dropdown menu, or by using the /profile URL (e.g. pontoon.mozilla.org/profile). Users can also view others’ personal profiles by clicking a user’s profile picture wherever it appears, such as in the list of contributors for a team or project.
The left column includes information about the user:
+-
+
- Profile picture and name. +
- Contact details. +
- Achievement badges. +
- Information on last known activity (when the user has submitted or reviewed a translation), last login in Pontoon, and the account’s creation date. +
- Roles in Pontoon (a user can have multiple roles across different locales). +
Users can customize their information and the visibility of specific fields in the settings page (reachable using the CHANGE SETTINGS button).
Achievement badges
+Achievement badges awarded to a user are displayed beneath their contact information. The available badge types, from left to right in the image below, include:
+-
+
- Translation Champion, awarded for submitting translations. +
- Review Master, awarded for reviewing translations. +
- Community Builder, awarded for promoting users to higher roles. +
Each badge has multiple levels. If a user holds a badge at level two or higher, the level is shown at the bottom left of the badge icon.
+Whenever they earn a new badge or level up an existing badge, users will be notified with a pop-up and a notification.
+Activity graphs
+In the top central section there are two graphs:
+-
+
- Approval rate shows the ratio between the number of translations approved and the total number of translations reviewed, excluding self-approved translations. +
- Self-approval rate is only visible for users with translator rights, and shows the ratio between the number of translations submitted directly — or self-approved after submitting them as suggestions — and the total number of translations approved. +
If both graphs are available, it’s possible to switch between them using the selector at the bottom (highlighted in red in the image above)
+Right below these graphs, there is a section showing a graphical representation of the user’s activity in the last year. Each square represents a day, while each row represents a day of the week. The brighter the color, the higher the number of contributions on that day.
+
By default, the chart will show data for all contributions over the last year, but it’s also possible to limit the chart to:
+-
+
- Submissions. +
- Reviews performed. +
- Reviews received. +
- Submissions and reviews. +
The activity log below this chart will display the user’s activity in more detail for the last month. Clicking on a specific square (day) in the chart will only show the activity for that day. Each line item in the activity log is a link that allows to jump to those specific strings in the translation editor.
+Glossary
+Explanation of common terms and concepts used across documentation.
+-
+
- Comment +
- Fuzzy +
- Locale +
- Permission +
- Pretranslation +
- Resource +
- Terminology +
- Translation +
- Translation memory +
- Translation mode +
- Version Control System +
Comment
+Comments can be used, for example, to discuss possible translations with other team members or request more information from project managers.
+Pontoon supports two types of user comments:
+-
+
- Source string comments are associated with the source string and displayed in the
COMMENTStab in the right column.
+ - Translation comments are associated with a specific translation and displayed under the editor in the translation list. +
User comments should not be confused with Resource comments, which developers can add directly to the resource file. This type of comment is displayed in the editing area, along with other information like the resource path and context.
+Fuzzy
+fuzzy is an internal state available only if the source file is a gettext (.po) file. A string can be marked as such in a few cases:
-
+
- The reference text changed after the string was already translated. +
- The string has been manually marked by translators because it needs review. +
- New strings were merged in the localized files, enabling the option to match existing translations (also called “fuzzy matching”). +
In all these cases a translation exists in the file, but is marked as fuzzy (equivalent to “need review”) and not used by the website or application. For more information, read the documentation about Fuzzy Entries in gettext.
+Locale
+A locale is the combination of a language and a region, represented in Pontoon by a locale code. For example, American English is referred to as en-US, where en stands for the language (English), and US for the region (United States). In some cases, the region is omitted, because the language is mostly spoken in one region.
In Pontoon, each locale maps to a team.
+Permission
+Users in Pontoon can have different permissions depending on their role:
+-
+
- Translators can either submit approved translations directly or review suggestions from other users. Unlike in some other Translation Management Systems, this is a single permission in Pontoon, and it’s referred to as Translator permission. +
- Team managers have translator permissions, but can also change permissions assigned to other users (i.e., ”promote” or ”demote” them). +
Pretranslation
+Pretranslation is a feature in Pontoon that relies on machine translation (Google AutoML Translation) and translation memory to automatically translate strings and save them in localized files.
+If pretranslation is enabled for a combination of a locale and a project, when a new string is added in Pontoon:
+-
+
- It will be translated (pretranslated) using a 100% match from translation memory or, should that not be available, using the Google AutoML Translation engine with a custom model. +
- The string will be stored in Pontoon with the pretranslated status. +
- For projects using version control systems, the translation will be stored in localized files outside of Pontoon. +
Resource
+Resources are localization files within a repository (see version control system) used to store source content and translations. They can be in different file formats but generally follow the same key-value structure, where the key (displayed as Context in the Source string panel) is a unique identifier and the value is a text snippet that needs to be translated.
Terminology
+Terminology — sometimes also referred to as a Glossary — is a list of terms and their definitions. Pontoon will highlight any terms in the source string and show their definitions as well as translations into the target language.
+TBX, or TermBase eXchange, is a standard file format used in the translation industry to represent and exchange terminological information. Pontoon Terminology can be downloaded in the TBX format.
Translation
+A translation is any submission of the target content. There are several types of translations:
+-
+
- Approved translations: translations submitted directly or approved by users with translator permissions. +
- Suggestions: translations that have not been reviewed yet (pending). +
- Pretranslations: translations that have been authored by the pretranslation feature. +
Translation memory
+Translation memory is a list of all approved translations for any string. It can be leveraged to provide suggestions when translating new content.
+TMX, or Translation Memory eXchange, is a standard file format used in the translation industry to represent and exchange translation memories. Pontoon Translation memory can be downloaded in the TMX format.
Translation mode
+Depending on their settings and permissions, users will be able to submit translations directly (Translation Mode), or only submit suggestions (Suggestion Mode).
+Contributors — users without translator permissions — can only access Suggestion Mode, while translators and team managers can manually switch between the modes.
+Version Control System
+Most projects store source content and translations outside of Pontoon, in repositories that use version control systems (VCS). The most popular are git and Mercurial (hg).
+Pontoon periodically (usually every 10 minutes) imports source content and translations from these repositories and writes translations back. This process is referred to as Sync.
+Pontoon also supports the so-called DB projects, where source content and translations are stored in Pontoon’s internal database (DB).
Fluent for localizers
+Fluent is a localization system, previously known as L20n, designed at Mozilla to unleash the expressive power of the natural language. The format used to describe translation resources used by Fluent is called FTL.
This section of documentation includes a brief introduction to Fluent’s syntax for localizers and covers specific details regarding Mozilla’s implementation (branding rules, additional functions available in Gecko, etc.). For a detailed overview of Fluent, consult the official documentation.
+ +Introduction to Fluent syntax
+ +Basic syntax
+A Message represents the basic unit of translation in Fluent. This is the simplest form messages can take:
+welcome-msg = Hello, World!
+welcome-msg is the message identifier (or message ID), and Hello, World! is the value of this message.
Messages can contain variables, for example:
+welcome-msg = Welcome { $user }
+$user is the name of the variable, and should never be translated. The fragment included between curly braces is called a placeable, and can be moved within the text. For example, the message above would be translated in Italian as follows, leaving the placeable unchanged:
welcome-msg = Benvenuto { $user }
+Messages can also reference other messages. In this case, the placeable won’t include the $ sign, simply the message identifier:
menu-settings = Settings
+help-menu-settings = Click { menu-settings } to save the file.
+A Term is a special category of Message:
+-
+
- Terms have identifiers starting with a dash, e.g.
-brand-short-name.
+ - They can’t be called directly in the source code, but only referenced within other messages. +
- Each localization can add or remove attributes, regardless of the reference language (typically
en-US).
+
For example, a term is used to define the Firefox brand name. For more details, see this document.
+-brand-short-name = Firefox
+close-msg = Close { -brand-short-name }
+Attributes
+For a single HTML object there might be multiple messages to localize: for example, a button could have a label and an accesskey, a link could have a text but also a tooltip. Such objects can be localized defining multiple attributes within a single message. For example, in the case of a button:
login-button =
+ .label = Login
+ .accesskey = L
+The message login-button doesn’t have a value, but has 2 attributes defined: label and accesskey. There are a few things to highlight in this FTL fragment:
-
+
- Attribute definitions must be indented and start with a period. +
- There is an equal sign following the message identifier, even if there is no value (i.e. the value is Null). +
- All attributes of messages found in the reference language – typically
en-US– must be present in the localization. This will be enforced by tools like compare-locales, which will warn on missing or obsolete (only available in the localization) attributes.
+
instructions-link = Log out
+ .tooltip = Disconnect from this account
+In this case, instructions-link has a value (Log out) and a tooltip attribute (Disconnect from this account).
It’s important to note that, in FTL files, indentation is part of the syntax; indenting elements incorrectly will lead to parsing errors.
+Selectors and plurals
+With the select expression, a single message can provide several alternatives. The selected value will depend on the value of a variable, another message attribute, or a function.
+The most common use of select expressions is for plural forms:
+emails = { $unreadEmails ->
+ [one] You have one unread email.
+ *[other] You have { $unreadEmails } unread emails.
+ }
+Notice that both the variants and the closing curly brace are indented. The same message can also be written as:
+emails =
+ { $unreadEmails ->
+ [one] You have one unread email.
+ *[other] You have { $unreadEmails } unread emails.
+ }
+One of the variants starts with a *: that indicates the default option, and it must always be defined in a select expression. The part before -> is called the selector.
In this case, the message displayed will change based on the numeric value of $unreadEmails. For plurals, the variant key can either be a perfect match to a number or one of the CLDR plural categories. This allows to define special cases, beyond the number of plurals expected for a language:
emails = { $unreadEmails ->
+ [one] You have one unread email.
+ [42] You have { $unreadEmails } unread emails. So Long, and Thanks for All the Fish.
+ *[other] You have { $unreadEmails } unread emails.
+ }
+Note how the [one] form in English doesn’t explicitly use the variable, in order to display the word one instead of the digit 1.
In plural messages is always possible to expose the number, even if the reference language doesn’t; the name of the variable is defined at the beginning of the select expression (in the selector), in this case $unreadEmails. The first example in this section can be translated in Italian using $unreadEmails in both forms:
emails = { $unreadEmails ->
+ [one] C’è { $unreadEmails } messaggio non letto.
+ *[other] Ci sono { $unreadEmails } messaggi non letti.
+ }
+Terms and parameterized terms
+As described at the beginning of the document, terms are a special type of messages. They are used to define translations of common words and phrases, which can then be used inside of other messages. They can be recognized because of the identifier starting with a dash, e.g. -brand-short-name. Terms can also define additional language-specific attributes which are not present in the reference language (typically en-US).
While in most cases terms will have a single value, it’s also possible to define multiple values associated controlled by a parameter. These parameterized values can be used to define grammatical cases or any other language-specific modifications of the value required by the grammar of the spelling rules. When referencing a term from another message, you can optionally specify a parameter and its value with the -term-identifier(parameter: "value") syntax.
Consider the following example in English:
+-fxaccount-brand-name = Firefox Account
+
+sync-signedout-account-title = Connect with a { -fxaccount-brand-name }
+In Italian this can become:
+-fxaccount-brand-name =
+ { $capitalization ->
+ [lowercase] account Firefox
+ *[uppercase] Account Firefox
+ }
+
+sync-signedout-account-title =
+ Connetti il tuo { -fxaccount-brand-name(capitalization: "lowercase") }
+Similar to select expressions, you must define a default value, identified by *. Also notice that parameter names are arbitrary, and don’t need to be in English. To get the default value (uppercase in the example), the term can be called without any parameter ({ -fxaccount-brand-name } or { -fxaccount-brand-name() }).
Parameters can also be nested for more complex situations, for example:
+-sync-brand-short-name =
+ { $case ->
+ *[nom] { $capitalization ->
+ *[upper] Синхронізація
+ [lower] синхронізація
+ }
+ [gen] { $capitalization ->
+ *[upper] Синхронізації
+ [lower] синхронізації
+ }
+ [dat] { $capitalization ->
+ *[upper] Синхронізації
+ [lower] синхронізації
+ }
+ [acc] { $capitalization ->
+ *[upper] Синхронізацію
+ [lower] синхронізацію
+ }
+ [abl] { $capitalization ->
+ *[upper] Синхронізацією
+ [lower] синхронізацією
+ }
+ }
+
+use-firefox-sync =
+ Підказка: При цьому використовуються окремі профілі. Скористайтеся
+ { -sync-brand-short-name(case: "abl", capitalization: "lower") }
+ для обміну даними між ними.
+Again, not all parameters need to be specified at all times when referencing a term. If some (or all) parameters are omitted, the corresponding default values will be used. In the example above, { -sync-brand-short-name(case: "abl") } will result in the uppercase Синхронізацією translation because upper is defined as the default value of the ablative case.
Functions
+Functions can be used in Fluent to format data according to the current language’s rules, or can provide additional data to fine tune the translation.
+Fluent includes some generic built-in functions, like NUMBER and DATETIME, for number and date formatting, respectively. Such functions can be used in placeables and selectors. For example:
dpi-ratio = Your DPI ratio is { NUMBER($ratio, minimumFractionDigits: 2) }
+
+your-score = { NUMBER($score, minimumFractionDigits: 1) ->
+ [0.0] You scored zero points. What happened?
+ *[other] You scored { NUMBER($score, minimumFractionDigits: 1) } points.
+ }
+This document describes additional functions available in Gecko products. Please refer to this document for references about the terminology used.
+PLATFORM
+PLATFORM is a function that allows localizers to tailor messages to the current platform. Allowed variant keys are: windows, macos, linux, android, other.
For example, Firefox settings are currently called Options in Windows, Preferences in macOS and Linux. Strings can be differentiated in Fluent by defining a message as follows:
+pref-page =
+ .title = { PLATFORM() ->
+ [windows] Options
+ *[other] Preferences
+ }
+PLATFORM() is used to determine the variant to use in the select expression, other is defined as default. If a variant isn’t defined, for example for linux, it will fall back to the default value.
The following example uses the PLATFORM() function for each attribute:
download-choose-folder =
+ .label =
+ { PLATFORM() ->
+ [macos] Choose…
+ *[other] Browse…
+ }
+ .accesskey =
+ { PLATFORM() ->
+ [macos] e
+ *[other] o
+ }
+Brand names
+Brand names, like Firefox or Sync, are stored as Terms in dedicated files, and shared across the application.
+Unless indicated otherwise in comments, the current policy is that brand names can’t be:
+-
+
- Declined to adapt to grammatical case. +
- Transliterated. +
- Translated. +
They need to be kept in English, and sentences adapted as needed to fit the undeclined name.
+For example, a term -brand-short-name is provided in browser/branding/official/brand.ftl
-brand-short-name = Firefox
+And it can be referenced in other messages as follows:
+
+close-msg = Do you want to close { -brand-short-name }?
+-brand-short-name is defined as a term to allow localizers to define custom attributes, for example to store grammatical properties. Mozilla tools like compare-locales won’t report those attributes as obsolete if the reference language (en-US) doesn’t have them. Each language is then free to put information about genders, animacy, the first letter being a vowel or not, and any more into attributes of terms.
Here’s an example in English:
+-brand-name = Firefox
+
+has-been-updated = { -brand-name } has been updated.
+And how Polish can adapt its translation depending on the gender of the brand. To understand this example, consider a scenario where -brand-name would be defined in a separate file, and could change depending on the version (e.g. Firefox vs Aurora).
-brand-name = Firefox
+ .gender = masculine
+
+has-been-updated =
+ { -brand-name.gender ->
+ [masculine] { -brand-name } został zaktualizowany.
+ [feminine] { -brand-name } została zaktualizowana.
+ [neuter] { -brand-name } zostało zaktualizowane.
+ *[other] Program { -brand-name } został zaktualizowany.
+ }
+Bugzilla for localizers
+-
+
- Triage localization bugs + + +
Bugzilla is the system used to track issues for most of Mozilla’s projects. For this reason, every localizer should have an account on Bugzilla, and check incoming emails and notifications. Since bugs need to be read and understood by several people, including developers, English is the language commonly used in Bugzilla.
+Bugs are filed in a Product, each product has multiple Components. For localization, there are two main products:
+-
+
Mozilla Localizations: this product has several components, including one for each locale.
+www.mozilla.org: there is one specific component used for localization (L10N).
+
Bugzilla components are often referenced in the form of product :: component, e.g. Mozilla Localizations :: it / Italian or www.mozilla.org :: L10N. For some components, there is also a Locale field, that allows selecting one or more languages affected.
A bug has a status, the most common ones are:
+-
+
- UNCONFIRMED: the bug was reported but it’s not confirmed yet. By default, a new user can only submit bugs as unconfirmed. +
- NEW: the bug has been confirmed, but it still requires action. +
- RESOLVED: the bug has been resolved. +
When a bug is marked as RESOLVED, there is an additional information that describes the type of resolution:
+-
+
- FIXED: the bug was fixed by a specific action. +
- INVALID: the problem described is not a bug. +
- WONTFIX: the problem described is a bug which will never be fixed. +
- DUPLICATE: the problem is a duplicate of an existing bug. +
- WORKSFORME: it wasn’t possible to reproduce the bug. +
- INCOMPLETE: the bug doesn’t contain enough information to reproduce it, or a clear description of the issue. +
When filing new bugs, the rule of thumb is:
+-
+
- If the issue can be fixed by the localization team, e.g. it’s about a typo or mistranslation, it should be filed in
Mozilla Localizations :: Languageorwww.mozilla.org :: L10N.
+ - If the issue needs work from a developer, e.g. a window is too narrow or a string is hardcoded, it’s a product bug, and should be filed accordingly. In case of doubt on which product or component to pick,
Firefox :: Untriagedis usually a good starting point for Firefox bugs. If you’re reporting a bug for a specific string, you should trace back that string to a bug, and file your report in the same product and component.
+
More information about Bugzilla are available in this guide.
+Triage localization bugs
+Each localization team should keep an eye on bugs filed for their languages. The simplest way to do it is to use the BUGS tab on their team page in Pontoon.
+Follow the Bugzilla component for your locale
+The simplest way to keep your bugs under control is to follow your locale in Mozilla Localizations:
+-
+
- Open your account preferences on Bugzilla. +
- Select Component Watching in the left sidebar. +
- In the right section, select Mozilla Localizations as product, then your locale in the Component list. +
- Click Add. +
The product will appear in the section You are currently watching: right below. From this moment, you will receive an email for all bugs filed in – or moved to – that component.
+There are a few limitations to this approach:
+-
+
- It’s not possible to follow a single locale within a component, for example for
www.mozilla.org :: L10N.
+ - By default, bugs marked as UNCONFIRMED won’t send any notification. In order to receive emails for unconfirmed bugs, you need to update the Email Preferences in your profile, removing the flag from the Component column in the line
The bug is in the UNCONFIRMED state.
+
Saved searches
+In Bugzilla, it’s possible to perform searches, and save them as templates. For example, let’s create a search for bugs reported against Italian in www.mozilla.org :: L10N.
Start from the Advanced Search page:
+-
+
- Leave the search field empty. +
- Select
www.mozilla.orgas Product.
+ - Select
L10Nas Component.
+ - Expand the Custom Search section at the bottom, and set it to Locale + contains the string + it. +
When the results appear, you can use the Remember search button and input field to save this search.
+
The list of your saved searches can be displayed by clicking in the search field at the top of the page: you simply need to click one of the items to perform the search.
+
At the bottom of the page displaying search results, there’s a link to delete the saved search just performed (Forget Search “NAME”).
+Note that you can select multiple products and multiple statuses (including UNCONFIRMED) to refine or expand the search criteria.
+Confirm and close bugs
+As already explained, each locale should address the bugs reported for their language in a timely manner. Bugs filed as UNCONFIRMED should be triaged, marked as NEW if they’re actual bugs or closed, and marked as fixed once the problem is solved.
+By default, users can’t confirm or close bugs filed by other users. In order to do that, you need a permission called editbugs, which is normally assigned to localizers only after they demonstrated a clear understanding of how Bugzilla works and its etiquette. The reason for this is that this permission is assigned across the entire Bugzilla, not on single products or components. If you need to upgrade your permissions, get in touch with l10n-drivers.
Documentation for Mercurial
+ +How to identify Bugzilla bugs that introduced a string
+Sometimes it’s helpful to identify which bug on Bugzilla introduced a specific string, for example to check if an issue was already reported, or find out more information on a feature.
+Note: These instructions apply only to projects that make use of Bugzilla, which currenly are Firefox projects for desktop and Android.
+Find the string
+The first step is to identify where the string is within the Mercurial repository by using Searchfox.
+For example, if you want to know which bug introduced the string Password quality meter, you can search for the string. This may return multiples strings with the same text, so to find the exact string you can use the the identifier (which can be found from CONTEXT in Pontoon).
The results may look something like this:
+
You can further refine results to only localization files by using specific localization file extensions in the Path filter field in the top right:
-
+
- For Firefox: limit the search to
.ftlor.propertiesfiles. You can find information on the file from its CONTEXT. Or you can use{.ftl,.properties}to only show files with those extensions.
+ - For Android: limit the search to
.xmlfiles.
+
Clicking on the string will open the file in Searchfox and highlight the string.
+Find the bug
+Searchfox shows details on the revision in which each line of code was introduced to the file, represented on the left hand sign as a bar with alternating shades of gray. Hovering over the bar next to the highlighted line containing your string will show you the revision details. The first line of the revision details contains a bug reference, a number represented as a link. Clicking the link will take you to Bugzilla where you can then check things like dependencies and comments.
+
Examining the changeset in Mercurial
+You can also access the changeset in Mercurial. To view that, click full diff on the third line that says Show annotated diff or full diff.
This will show the full commit message and all the changes made as part of the bug.
+
Looking at older revisions
+The above method doesn’t always work: sometimes a changeset only moves strings around, so you would need to repeat the process for an older revision of the file.
+If a string was moved, the changeset for the earliest version will show the bug that moved it. In Searchfox, from the bar on the lefthand side next to your string, you can click Show earliest version with this line. From the page that follows, hover over the left bar next to the string and click full diff to show the changeset for that revision in Mercurial.
Near the top of the changeset, there’s a list of the modified files. Near each file there’s a revisions link.
+
After clicking revisions, you can pick an older changeset of a file by clicking the diff link next to the changeset you’re interested in, or repeat the process by selecting annotate. This will display the revision associated to each line of that changeset.
+How to localize web projects
+This set of documentation contains basic information on localizing and testing web based projects.
+-
+
- Accounts.firefox.com (FxA) +
- Addons.mozilla.org (AMO). +
- Developer.mozilla.org (MDN). +
- Mozilla Donate website. +
- Support.mozilla.org (SUMO). +
Firefox Accounts (FxA): how to localize and test
+Firefox Accounts (or FxA) refers to https://accounts.firefox.com. There are three components in Pontoon that make up FxA:
+-
+
LC_MESSAGES/client.po: the content server for UI and frontend.
+LC_MESSAGES/server.po: strings for emails and backend templates.
+Main.ftl: payments for both frontend and backend.
+Settings.ftl: pages for account settings.
+
The above could change over time as the team is planning to migrate .po files to .ftl, which may involve restructuring the files.
+Key links
+ +Localizing the strings
+FxA lives in two file formats: .po and .ftl, both contain variable or placeable in the strings. The shorter the string, the more context you need to make sure you get the translation right. Look for clues or get clarifications through the following methods:
+-
+
- String comments: Pay attention to the comment or string ID. In Pontoon, the comments are displayed above the area where you can enter your translation for a string. +
- Matrix channel: Ping the L10n PM in charge with any issues you may have. +
- Localization on Discourse: Follow announcement and discussions, and raise questions you have. +
Errors in translations can break the build for all languages
+During translation, do not alter code in a string, such as variables and HTML markup.
+For .po file format, a few FxA contacts would be notified when code in a localized string is broken. Any subsequent commits by other localizers in other languages will trigger this warning until the broken string is fixed by one of the people notified. Here are a few common errors seen in localized content:
+Example: Alter the code by omitting or inserting space breaks the build.
+-
+
- Source:
The recipient’s consent is required. <a %(escapedLearnMoreAttributes)s>Learn more</a>
+ - Target:
+
-
+
- ❌
A címzett hozzájárulása szükséges. <a%(escapedLearnMoreAttributes)s >Tudjon meg többet</a>.
+ - ✅
A címzett hozzájárulása szükséges. <a% (escapedLearnMoreAttributes)s>Tudjon meg többet</a>.
+ - What changed in the broken translation (❌): space is removed from
<a% (to<a%(; extra space was added from)s>to)s >.
+
+ - ❌
Example: Attributes should remain unchanged.
+-
+
- Source:
<span class="number">2</span>Point the camera at the QR code and tap the link that appears
+ - Target:
+
-
+
- ❌
<span classe="numero">2</span>Puncta le camera al codice QR e tocca le ligamine que appare
+ - ✅
<span class="number">2</span>Puncta le camera al codice QR e tocca le ligamine que appare
+ - What changed in the broken translation (❌): both the attribute’s name
classand valuenumberwere localized.
+
+ - ❌
Example: Markup elements often come in pairs, one opens and one closes.
+-
+
- Source:
Thank you for reaching out to Mozilla Support about <b>%(escapedLowercaseTopic)s</b> for <b>%(escapedSelectedProduct)s</b>.
+ - Target:
+
-
+
- ❌
Köszönjük, hogy felkereste a Mozilla támogatást a következő témában: <b>%(escapedLowercaseTopic)s</b (<b>%(escapedSelectedProduct)s</b.
+ - ✅
Köszönjük, hogy felkereste a Mozilla támogatást a következő témában: <b>%(escapedLowercaseTopic)s</b><b>%(escapedSelectedProduct)s</b>.
+ - What changed in the broken translation (❌): the closing element
</b>was replaced by</b, leaving the tag open.
+
+ - ❌
For .ftl file format, such error checking mechanism is not in place either in Pontoon or GitHub: Pontoon doesn’t have a warning, and the FxA repository doesn’t send out notifications. Before a script is developed to catch the errors, please use the above examples as general guidelines to avoid making these common mistakes.
+Testing
+Product updates are deployed to Pontoon on Fridays. Localized content is pushed to production on Tuesdays. Localized strings in Pontoon syncs with the l10n repository in GitHub every 10 minutes, making the repository the source of truth.
+You can test on either staging and production, both involve having an account in order to access the environment. The payment feature will be rolling out to international markets through wave releases. It’s best to review localization work on the staging environment before the feature is launched to the market.
+Firefox Accounts can be tested through Firefox browsers for desktop and mobile. In addition to following the general localization testing guidelines, there are features unique to the product that need special attention. Make sure you test them thoroughly.
+Testing account setup
+Linguistic testing
+-
+
- Login screen. +
- Email notification. +
- Check all the setting configuration buttons and the page or expanded window each page leads to. +
- Translation is of good quality and makes sense in context. +
- No broken UI, especially in a mobile environment. Text wraps or line breaks correctly. +
- Terms are consistent between pages. +
- Basic font support. +
- Error and warning messages. +
Functionality testing
+-
+
- Configure the Settings. Go through all of the categories. +
- Check for email notifications with each of the initial setups. +
- Make changes to some of the settings, check for possible error messages or warnings; check for followup confirmation emails. +
Testing the subscription platform
+The subscription platform consists of a few features. Right now only the Payment and subscription creation is available for testing:
+-
+
- Payment and subscription creation: The initial payment funnel where users enter their credit card information to subscribe to a product. Mozilla partners with Stripe to handle this. +
- Billing: Ongoing billing and receipt emails once a subscription is entered. +
- Subscription management UI: Settings that allow the user to update their payment information. +
Payment testing is tied to the language of user preference and location. Payment service is market specific. For instance, the product is available in German, but the service is available in Germany and not in Switzerland.
+Before testing
+-
+
-
+
Tips: Feeling not having enough test accounts to use for testing? You are not alone. Here are some tips you can consider.
+-
+
- Add number(s) or letter(s) to your existing account to create more accounts by adding a
+in your email address. For example, if your main email isname@xyz.com, your expanded accounts could bename+1@xyz.comandname+m@xyz.com. You will receive email notifications in yourname@xyz.cominbox. You can add anything you want, several digits and/or letters. Note that this works with Gmail and Google Apps domains.
+ - Keep your password simple so you can log in and log out easily. Keep track of which account is connected with which password. Of course, there is Lockwise for the rescue! +
+ - Add number(s) or letter(s) to your existing account to create more accounts by adding a
-
+
Create a new Firefox account for testing purposes. Your existing account may or may not work.
+
+ -
+
Choose a Firefox browser for desktop, Android, or iOS.
+
+ -
+
Set the language you are testing in. Find out how to configure the correct display language by following the steps detailed in this SUMO article.
+
+ -
+
Have the link ready for the subscription testing server. Note, this link is for testing subscription only, different from the FxA staging server.
+
+
Testing payment and subscription creation
+-
+
- Go to the subscription testing server +
- Click on the Subscribe button which takes you to a subscription form. If you don’t have a Firefox account at this point or if your existing account doesn’t work, you will need to create one. +
- Fill out all the required fields in the form. +
- Key in credit card number
4242 4242 4242 4242. The mandatory fields for Expiration date, CCV and postal code can be filled with random values.
+ - Verify formatting accuracy for date, currency and postal code. Check the box on usage agreement. +
- Click on Pay Now +
- A Thank You payment confirmation message appears with the subscription summary on your browser page with an invitation to download. +
- An email confirmation arrives in your inbox. The content should match the summary on the page where you just completed your subscription. +
Note: the Privacy Notice and Terms of Use documents are not localized in all the languages where the product is offered. When not available, you will be redirected to the English versions.
+Reporting technical issues
+There are a few ways to report non-linguistic related bugs:
+-
+
- File an issue here. +
- Ping in the Matrix channel to the l10n PM responsible for the project. +
- Through Pontoon, click the REQUEST CONTEXT or REPORT ISSUE button next to the string and make a comment. This will notify the l10n PM in charge. +
- Send a direct email to the l10n PM responsible for the project. The email address can be found in the profile in Pontoon. +
Addons.mozilla.org (AMO): how to localize and test
+Product at a glance
+AMO refers to https://addons.mozilla.org/. It is one of Mozilla’s biggest web properties, with 12 million users per month. The product consists of three key components that require localization:
+-
+
- AMO server is the backend component of AMO. +
- AMO frontend covers the top page of
about:addonsand the user-facing pages of addons.mozilla.org on Firefox for Android.
+ - Discovery Pane is home of curated add-ons available on
about:addons.
+
Product updates are deployed every Thursday to production. Localizable strings can be extracted on Tuesdays, strings localized by 5pm UTC each Tuesday go live on Thursday. To report a problem, you can use GitHub issues.
+Now let’s take a look of these components in greater details.
+AMO and AMO frontend
+addons-server
+Addons-server is the default front-end for desktop users of AMO. It is also the API backend and home to the developer hub and reviewer tools.
+addons-frontend
+Addons-frontend is the default frontend for mobile user-agents, and it will eventually replace the addons-server frontend for user-pages.
+Test the server and the frontend
+The strings will be available on Dev or Staging server at different times. See this section for details.
+-
+
- Dev: https://addons-dev.allizom.org/ +
- Staging: https://addons.allizom.org/ +
- Production: https://addons.mozilla.org/ +
The hosts for the new frontend are the same as addons-server, except to display the new frontend, you either need:
+-
+
- Click View mobile site in the footer (this will set a
mamocookie with the valueonon your system).
+ - A Mobile user-agent string. +
Disco Pane app and editorial content
+The AMO Frontend (addons-frontend) repository is also home to the Disco Pane, short for Discovery Pane. This is the site that contains curated add-ons available by typing about:addons in the address bar. Another way to reach it is by clicking Tools in the menu bar, select Add-ons in the dropdown menu, and click Get Add-ons on the left panel. While this looks like it’s part of Firefox, it’s actually a remote web page.
The content for the Disco Pane is available for translation in the AMO (addons-server) project.
+Test the Discovery Pane
+The strings will be available on Dev or Staging server depending on when they were committed. See this section for details.
+The hosts for the Disco Pane are:
+-
+
- Dev:
https://discovery.addons-dev.allizom.org/.
+ - Staging:
https://discovery.addons.allizom.org/.
+ - Production:
https://discovery.addons.mozilla.org/.
+
The actual link is automatically generated and depends on the locale, operative system and version of Firefox. To get the correct production link for your system, you can open the Browser Console from Tools > Web Developer, copy and paste this code snippet in the input area at the bottom of the window, and press enter:
+Services.urlFormatter.formatURL(Services.prefs.getCharPref("extensions.webservice.discoverURL").replace("%COMPATIBILITY_MODE%", "normal"))
+This code reads the preference extensions.webservice.discoverURL from about:config, and replaces placeholders with the correct data for your system. For example:
-
+
- The original value of
extensions.webservice.discoverURLishttps://discovery.addons.mozilla.org/%LOCALE%/firefox/discovery/pane/%VERSION%/%OS%/%COMPATIBILITY_MODE%.
+ - If you’re using Firefox 57.0 in Italian on macOS, the resulting URL will be
https://discovery.addons.mozilla.org/it/firefox/discovery/pane/57.0a1/Darwin/normal.
+ - To reach the Dev server, replace
addons.mozillain the domain withaddons-dev.allizom, resulting inhttps://discovery.addons-dev.allizom.org/it/firefox/discovery/pane/57.0a1/Darwin/normal.
+
Frequency of strings extraction and push schedule
+Newly added strings are extracted every week after tagging, which happens at 9am PST on Tuesdays. The strings will be on the dev server and ready for localization.
+For localized content:
+-
+
- Dev server: once translations are committed into the repositories, they are visible on the dev server within 30 minutes (or as long as it takes to push the code). +
- Staging server:
masteris tagged and pushed to staging weekly on Tuesday at around 9am PST.
+ - Production: the push usually starts at 9am PST every Thursday. +
Developer.mozilla.org (MDN): how to localize and test
+MDN is the acronym for Mozilla Developer Network. It hosts references and guides to Web technologies as well as Firefox at Mozilla. It attracts users around the globe. The localization communities are a key part of the Mozilla project. Their work in translating and localizing the MDN documentations helps people around the world develop for the open Web.
+MDN consists of three parts:
+-
+
- The site user interface (or UI) strings that appear on almost all MDN pages to frame the main article content and provide navigation and user controls. +
- The main body of MDN pages consists of references, guides, and tutorial articles. Localization is done directly on the web. +
- Macro strings are the output by macro templates that construct certain kinds of navigation, messages, or generated structures. The strings currently live on GitHub, and changes can be done through pull requests. +
This document only covers the UI portion localizable in Pontoon.
+Localizing the strings
+The UI strings for MDN product live in Pontoon. The string changes are extracted and sent to Pontoon as part of the production push process. You can translate directly in Pontoon or download it as .po files and upload them back to Pontoon when done. Newly localized strings will be included in production updates.
+There is no sprint cycles. The staging and production sites are updated 1 - 3 times a week depending on product development. You should expect to see your new translations on production in 3-7 days.
+Pontoon will be synced up with MDN repository every 20 minutes. Updating localization strings is preferably done in Pontoon, and not through pull requests in the repository.
+Testing and reporting issues
+Staging and production pushes take place at the same time. Localized sites will have English strings for a few days before localization is caught up. There is no public developer server at the moment.
+Bugzilla is the best way to report localization issues.
+Communication channels
+-
+
- For live communication, use IRC channels: #mdndev or #mdn. +
- MDN Discussion Forum has recently moved away from mailing list to Discourse. Though there is no l10n category, MDN category is for discussing topics related to the MDN site. If you have a question, you can post it in the general MDN category. +
- If you want to be notified for string changes, one way is to check Pontoon project dashboard for pending task. Another way is by subscribing to the notification list: click the Watch icon on the top of MDN GitHub repository page and be notified about pull requests and code changes. +
Mozilla Donate website: how to localize and test
+donate.mozilla.org is our platform to collect donations. The main instance is for donations to the Mozilla Foundation, but there is also a separate instance for donations to Thunderbird.
+Testing
+Submitted translations are automatically deployed to the staging server, so you can test them a few minutes after they have been translated.
+-
+
- Staging server: https://donate-wagtail.mofostaging.net/. +
- Production server: https://donate.mozilla.org/. +
Testing the payment flow
+You may want to test the complete user journey on the website, but you don’t have to make an actual donation for that. Braintree (our payment processor for debit/credit cards) has a test mode that is enabled on the staging server only. Simply use the payment info from this page on the staging server and you should be able to simulate a payment. For instance, you can select an amount of money, click on donate by credit/debit card then fill out the form with the testing info. Make sure errors, as well as the page displayed when the donation has been successful, are properly localized.
+Testing currency settings
+The first thing to check is that the website supports all the relevant currencies for your locale.
+You also want to make sure the default currency selected for your locale is the one that makes the most sense. Only one default currency can be set per locale and it’s not possible to rely on geolocation to determine the best one.
+If your language is relevant in more than one country, make sure the other currencies are also available in the drop down.
+Check that the currency formatting on the page is correct for your language. If it’s not correct, please file an issue.
+How to report an issue
+The preferred way is to file an issue on the donate.mozilla.org GitHub repository.
+Support.mozilla.org(SUMO): how to localize and test
+SUMO, short for SUpport.MOzilla.org, is a knowledge base site, providing support to Mozilla product users. More than half of all Firefox users speak a language other than English. Mozilla depends on contributors to make support available to people around the globe.
+SUMO consists of two parts:
+-
+
- User interface (or UI), such as navigation and buttons. +
- Support articles, either used to troubleshoot issue or as knowledge base for Mozilla products. +
This document only covers the UI portion localizable in Pontoon.
+Localizing the strings
+There are two active components in Pontoon that make up the product:
+-
+
LC_MESSAGES/djangojs.pocontains strings for the JS bits of the platform.
+LC_MESSAGES/django.pocontains the majority of strings in the SUMO product.
+
SUMO is made up by several file types. In order to minimize revision and get translation right the first time, the key is to get the context right. Look for clues or ask others for help:
+-
+
- String comments: in Pontoon they’re displayed above the area where you can enter your translation for a string. They always include a reference to the code where the string is used, and you can use this information to search for context in the Kitsune GitHub repository. +
- The SUMO l10n forum. But first thing first, you need to create a Firefox account in order to participate in the discussions in the forum. +
Localized strings in Pontoon will be synced up with sumo-l10n on GitHub every 20 minutes, making the repository the source of truth.
+Ignore these legacy components:
+-
+
LC_MESSAGES/buddyup.pocontains strings for mobile-centric 1-to-1 support project.
+LC_MESSAGES/yaocho.pocontains strings for the mobile version of the support knowledge base.
+
Testing
+On Wednesdays, SUMO developers extract new strings from code and database edits. These strings are merged into the sumo-l10n repository and become available in Pontoon for translation.
+Translated strings from Pontoon are pushed automatically to the staging and production when there is a release to the respected environment. Usually this happens once a week.
+There are three ways to test the product:
+-
+
- Staging server: https://support.allizom.org. +
- Production server: http://support.mozilla.org/. +
Testing on production/staging
+Localization updates are pushed to the staging and production environments usually once a week. More often for staging. Either way, the SUMO team relies on contributors to find issues and report bugs that are usually fixed at a timely manner.
+FAQ
+For any additional questions not covered here, you can reach out to the #sumo room in Matrix to discuss it.
+How often are new strings added? Is there a sprint?
+No, there are no sprints. Strings are added at as needed basis. Whenever a release or change is required, new strings will be added to both Pontoon and Kitsune on Mondays.
+How do I participate in the SUMO l10n forum?
+To be part of the SUMO community, you need to create a Firefox account, which allows you to write in the community l10n forum and localize SUMO articles. This is separate from the account used to log into Pontoon in order to localize SUMO product.
+Are there email communications when new strings are added?
+Only when there is a release or a major change will there be communications to localizers through mailing list (sumo-locale-leaders@), private messages, and the SUMO l10n forum. The Pontoon dashboard is the best way to check for pending tasks.
+What are the ways to report an issue?
+-
+
- File a bug for SUMO. This is the quickest way to have a problem resolved. +
- Discuss it in the SUMO l10n forum. +
- Ping in the Matrix channel the l10n PM responsible for the project. +
- Through Pontoon, click the REQUEST CONTEXT or REPORT ISSUE button next to the string and make a comment. This will notify the l10n PM in charge. +
- Send a direct email to the l10n PM responsible for the project. The email address can be found in the profile in Pontoon. +
It is not recommended to file issues on GitHub sumo-l10n.
+Using l10n resources while translating
+What are l10n resources
+
+L10n resources are used to ensure consistency of translation and localization at specific levels of a document or set of documents. These levels are:
-
+
- Word or phrase level (terminology). +
- Sentence or string level (translation memory). +
- Whole document or project level (style guides). +
Terminology
+Terminology resources define specific words or phrases and their translated equivalents to be used in the translation process. These resources often go beyond providing one-to-one bilingual equivalents. They can include metadata about a particular term, including a monolingual definition, part of speech, context, images, and other relevant metadata that helps the translator understand the concept behind the term. A term belongs in the approved term base (terminology database) when it appears regularly, has a singular meaning in a particular context, or is specialized in nature.
+Term bases are useful in helping translators to maintain meaning and consistent terms across multiple projects. They’re especially useful in collaborative translation environments that involve multiple projects with similar content and audiences. Term bases also help to ensure that any new collaborators can translate effectively in a shorter period of time.
+Using term bases ensures that a user’s experience is consistent across platforms, products, and content types. For example, terminology used in the Firefox desktop UI also appears in Firefox for Android, Firefox for iOS, and SUMO documentation. If a user encounters a problem in Firefox, they will expect to find a solution by searching SUMO with the text from the Firefox desktop user interface. Consistent terminology use ensures a holistically consistent user experience for such cases.
+Translation memory
+Translation memory is a mechanism that reuses previously translated segments (i.e., strings, sentences, etc.). These segments are stored in a database as a key-value pair, with the source language segment as key and the target language segment as its value. Algorithms like the Levenshtein Distance are then used to compare an untranslated segment to the database of source language segments. If there’s a perfect match, the target language segment is returned for the translator to reuse. If there are partial matches (i.e., fuzzy match), they are returned as suggestions. Translators can then post-edit the closest matching suggestion without needing to repeat fully translating the segment.
+Translation memory is useful in helping translators to translate more in a shorter amount of time. For example, it allows source content authors to make regular updates to source content without causing translators to treat these updates as untranslated segments. As with term bases, translation memory also ensures consistency between similar projects and collaborative translation projects with rotating contributors.
+Style guides
+Style guides establish the norms for translating a full document or project. It establishes norms for many of the following topics:
+-
+
- Style. +
- Tone. +
- Grammar and spelling resources. +
- Instructions on handling cultural references. +
- Word forms (e.g., plurals, abbreviations). +
- Language and culture-specific units (e.g., dates, numerals, currency). +
- Criteria for identifying “Do-Not-Translate” content in a project. +
Style guides help translators to know to address their audience (or users) in the target language when translating. They ensure consistency between translators in all of the above-mentioned topics. In a collaborative translation environment, they serve as the standard against which peers can review and correct translations from both new and old translators.
+When are they used in the l10n process
+Term bases and translation memory are best used within the translation environment (e.g., Pontoon). These computer-assisted translation (CAT) tools are designed to make use of these resources as a translator is in the process of translating a project.
+Style guides are used primarily as a point of reference. A new translator should always begin their contributions by studying the style guide and refer back to it regularly while translating when they have questions. Reviewers use style guides to ensure that new translations meet the quality standards established in the style guide.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/firefox_android/index.html b/products/firefox_android/index.html
new file mode 100644
index 00000000..8fc17e3c
--- /dev/null
+++ b/products/firefox_android/index.html
@@ -0,0 +1,239 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Firefox for Android - How to localize
+Firefox for Android is on a four week rapid release cycle. This means that usually there is a new release going out every four weeks.
+Within this timeframe, localizers will usually have approximately four weeks to localize and test their strings for a given release: strings land continuously on Nightly during the first four weeks, and then these strings ride the train to the Beta version. The deadline in Pontoon is an indicator of when the next localization cut-off date is for the upcoming release - in other words, the last day to get localization updates into that release.
+Note that all files contained in the project should be localized in order for Firefox for Android to be complete.
+Localize Firefox for Android in Pontoon
+Localizers should go to the Firefox for Android page on Pontoon, and click "Request New Language". They will be notified by email once the locale is set up and the project is ready to be localized.
+When the locale has been set up, localizers can choose it from the list of locales on Pontoon, and start localizing the product from there.
+Once localization starts, the locale should become available in Nightly builds within the next few days, which will enable localizers to check and test their work (see this section for more information about testing).
+When the locale reaches 70% completion (and given that active testing has taken place), it can be added to the release version.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/firefox_android/testing.html b/products/firefox_android/testing.html
new file mode 100644
index 00000000..28271f61
--- /dev/null
+++ b/products/firefox_android/testing.html
@@ -0,0 +1,253 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ L10n and Firefox for Android
+Some documentation specific for common tasks regarding Firefox for Android and l10n:
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/firefox_desktop/files/webext_permissions.zip b/products/firefox_desktop/files/webext_permissions.zip
new file mode 100644
index 00000000..b0f7256a
Binary files /dev/null and b/products/firefox_desktop/files/webext_permissions.zip differ
diff --git a/products/firefox_desktop/index.html b/products/firefox_desktop/index.html
new file mode 100644
index 00000000..dbe3b382
--- /dev/null
+++ b/products/firefox_desktop/index.html
@@ -0,0 +1,238 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Testing Firefox for Android
+Testing Nightly builds
+Once you have localized all the strings needed to complete the Firefox for Android project, and your language is up in Nightly builds, you should start testing! This is the moment to engage as many people as possible: have them use and check out these builds regularly. The more eyes on them, the better.
+What to look out for?
+(For more detailed explanations about testing, please refer to testing localization of Mozilla projects)
+-
+
- Language quality. +
- Truncated words (cut-off from screen) or overlaps. +
- Anything that appears broken in the UI. +
- Check out at all the main screens, UI, menus, tabs, new features, etc. Make sure these all look good, that everything is properly translated and appears as expected. +
- Font support. +
- Check that all searchplugins are working correctly. +
If you find issues such as the ones listed above, there are two possible options: fix it by yourself directly via Pontoon, or get a mobile developer to fix it. It all depends what kind of issue you find.
+In fact, language quality, truncations, overlaps and unlocalized strings can usually be fixed directly via Pontoon. You can verify that your fix has worked by checking it in the new Nightly version that usually ships the next day.
+If the issue is something else, you will probably have to get a mobile developer’s help to fix it. Please file an issue here, and CC the mobile PM in charge (@ followed by the GitHub username, which is currently “delphine”). +Once more, please refer to testing localization of Mozilla projects for more details on how to fix different kind of issues.
+Please note that it is strongly suggested to start using Nightly builds on a daily basis - and even after your locale is shipping on release version - so that you can get into as many screens as possible and check that everything looks fine.
+Also, it is important that builds are tested by people outside the localization team. Ask other people from your community to help test in order to have fresh eyes looking at your work.
+l10n-drivers send out regular reminders about merge days, updates on Android projects, schedule and important info on the Discourse Localization category. Please make sure you’re following this category closely so that you get regular updates about which part of the cycle you’re at, when you need to finish your work, and anything relevant to what you are doing.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/firefox_desktop/testing.html b/products/firefox_desktop/testing.html
new file mode 100644
index 00000000..8600c8cd
--- /dev/null
+++ b/products/firefox_desktop/testing.html
@@ -0,0 +1,321 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ L10n and Firefox for desktop
+Some documentation specific for common tasks regarding Firefox desktop and l10n:
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/firefox_ios/adding_new_ios_locale.html b/products/firefox_ios/adding_new_ios_locale.html
new file mode 100644
index 00000000..f3102cd4
--- /dev/null
+++ b/products/firefox_ios/adding_new_ios_locale.html
@@ -0,0 +1,245 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Testing Firefox Desktop
+-
+
- Which build should I test? + + +
- How to test + + +
Which build should I test?
+As a localizer you will work against Nightly, which means you should be testing a localized build of Firefox Nightly provided directly by Mozilla.
+You can download the build from the pre-release download page, the download page for all systems and locales, or directly via FTP (search for your locale code and operative system).
+Why Nightly? Because it’s updated twice every day, which means that you can fix an error and verify if the correction was effective within a few hours. It’s definitely a good approach to use this version as your main browser.
+At the same time, you, or someone in your team, should be testing also Beta and Release, to make sure updates don’t introduce issues.
+Building a localized version of Firefox
+If you’re interested in building a localized version of Firefox from source code, please follow the official instructions available in Mozilla Source Tree Docs. Note that you will need to set up the build environment on your system.
+How to test
+Here are some tips on how to test Firefox once installed in your computer.
+Create a new profile
+From time to time create a new profile:
+-
+
- To test that the default searchplugins are still relevant and work as expected. +
- To check messages and pages displayed on first run. +
- To test dialogs and preferences at the default size. +
Search for untranslated strings
+-
+
- Open all the items available in the main menu and check that they’re properly localized. If you opted to keep Developer Tools in English, the language should be consistent across all the developer tools. +
- Check the “hamburger” menu, making sure to inspect subpanels for items displaying the
>symbol.
+ - Open Preferences/Options and navigate through all panels, try to open all dialogs like
Exceptions…. Make also sure to select theCustom settingsoption for History in the Privacy panel.
+ - Log in with you Firefox Account and make sure that all preferences and dialogs are properly localized. +
- Check for untranslated strings and errors in the Library (Bookmarks->View all bookmarks…). +
- Open a new Private Window and check the content of the page. +
- Type
about:supportin the address bar, press Enter, and check for errors or missing translations.
+ - Check the error pages for malware, unwanted software, deceptive website, harmful website. All strings are also visible in
about:blocked.
+ - Check permissions dialogs on this test website. +
- Visit secure and unsecure websites, and check the panel displayed when clicking the lock icon. +
- Check the Protections panel displayed when clicking the shield icon in the address bar, and the
about:protectionspage for the Protections Report.
+ - Right click on a page and verify all panels in the
View Page Infodialog.
+ - Enable login saving in Logins & Passwords, make sure that
about:loginsis correctly localized and works as expected.
+
Test the New Tab page and Contextual Feature Recommendations
+First of all, make sure that everything is correctly translated in about:newtab. That’s the default page displayed when opening a new tab in Firefox.
In order to test other features available for New Tab, it’s necessary to enable a devtools option: open about:config, search for browser.newtabpage.activity-stream.asrouter.devtoolsEnabled and set it to true. After that, in the top right corner of the New Tab page a small wrench icon will be displayed.
For example, the AS Router Admin page can be used to test contextual feature recommendations (CFR):
+-
+
- In the Messages section, select to show message for cfr. +
- Click the Show button in one of the available options. +
The suggestions is displayed at the end of the address bar (first as a bulb icon, then as a “suggestion” tag). Clicking the blue tag will display a doorhanger.
+Test webextension permissions dialog
+Create a new profile and open about:config in your browser:
-
+
- Right click on the list of available keys and create a new boolean key
extensions.webextPermissionPromptsset totrue.
+ - Search for the key
xpinstall.signatures.requiredand set it tofalse. This will allow installing unsigned add-ons.
+ - Open this link, select Download and save the file on your computer. +
- Extract the archive. +
- Drag each (one by one) of the .xpi files on your browser’s window to display the dialog (you don’t need to actually install it). +
Test accesskeys and shortcuts
+You can test accesskeys only on Windows and Linux, since they’re not available in OS X.
+If your locale uses a non Latin alphabet and opted to keep the English accesskeys, you don’t have anything to check. If you’re localizing accesskeys, you should check that:
+-
+
- Accesskeys use letters available in the associated label, and are not displayed between parenthesis at the end of the label itself. +
- There are no conflicts, which means there are no items in the same menu or preference panel using the same letter. Starting from Firefox 56, it’s not possible to avoid conflicts in preferences: the guideline in that case is to reduce to a minimum the number of times the same letter is used within a panel. +
For shortcuts, you should test at least the most common ones. You should never change a shortcut, unless that combination of keys is not available in the keyboard layout commonly used for your locale. For example, in the Italian keyboard the character [ is available pressing Alt and è. A shortcut based on Shift + [ would never work, because it would be read as Alt + Shift + è.
Transvision has a QA view to check both accesskeys and keyboard shortcuts for each locale.
+Test certificate error pages
+There are several certificate error pages in Firefox, the message displayed can vary depending on the error being bypassable or not:
+-
+
- SEC_ERROR_UNKNOWN_ISSUER: bypassable, not bypassable. +
- SSL_ERROR_BAD_CERT_DOMAIN: bypassable, not bypassable. +
- SEC_ERROR_EXPIRED_CERTIFICATE: bypassable. +
Other test pages for certificates, both valid and invalid, are available at https://badssl.com.
+Test the installer on Windows
+Download the installer version and make sure that everything is working correctly. In the FTP folder you have both the Full Installer and the Stub Installer (downloading the package from Internet). You should test both at least once.,
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/firefox_ios/index.html b/products/firefox_ios/index.html
new file mode 100644
index 00000000..877f712b
--- /dev/null
+++ b/products/firefox_ios/index.html
@@ -0,0 +1,239 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Adding a new locale to Firefox for iOS
+Prerequisites
+iOS language support
+iOS currently supports two tiers of locales, and a locale must be part of one of these two lists in order to ship on Firefox for iOS. Unlike Firefox for Android, there’s no locale switcher included in the app, so it’s possible to ship only locales that are supported by iOS.
+Note that for Tier 2 locales, some menu items in Firefox for iOS can not be translated since they are part of the OS itself. Strings will unfortunately appear in English on the final UI in these cases.
+To tell if a locale is supported or not, take a look on an actual device, under the Language Settings of the most recent iOS version available. Tier one locales are the ones listed under “iPod/iPhone/iPad Language”, and Tier 2 locales appear under “Other Language” (or “Add Language” if there are already some languages under that list). If a locale appears under none of these two lists, then it should be safe to assume the language is not supported by iOS.
+Request to add a localization
+Once it is determined if a locale is supported by the operating system and can ship on Firefox for iOS, a request can be made to work on the project through the usual localization tools.
+For Pontoon, go to the Firefox for iOS project page here, and click on the link to request to add a new language to the project.
+Shipping
+Once pending localization work is complete for a given release, l10n-drivers will work on adding the locale to the list of shipping locales.
+Remember to regularly check the Discourse Localization category for latest information and updates on the project.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/firefox_ios/testing.html b/products/firefox_ios/testing.html
new file mode 100644
index 00000000..449de26b
--- /dev/null
+++ b/products/firefox_ios/testing.html
@@ -0,0 +1,253 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ L10n and Firefox for iOS
+Some documentation specific for common tasks regarding Firefox for iOS and l10n:
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/focus/how_to_localize.html b/products/focus/how_to_localize.html
new file mode 100644
index 00000000..59f9751f
--- /dev/null
+++ b/products/focus/how_to_localize.html
@@ -0,0 +1,244 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Testing on iOS for a new release
+Localizers currently mostly rely on screenshots for testing. Latest information and updates about Firefox for iOS are generally announced on the Discourse Localization category, which you should follow if you are working on l10n for any of the existing Mozilla products.
+Testing with screenshots
+Screenshots are currently provided by the iOS team, and the latest iterations can be found right here. Once you find your locale in the list, you should choose and download the .zip file that contains your locale code.
+Test builds
+The beta version used for testing can be found here. In case the registration does not work from there, localizers can also reach out to the l10n mobile PM in order to be added to these builds (currently delphine at mozilla dot com). +Please note you will need an iOS device running v13.6 or above.
+Aspects to review
+Here is a list of issues you should try to identify when testing the build:
+-
+
- Language quality. +
- Truncated words (cut-off from screen). +
- Anything that appears broken on the UI. +
- Check out at all the main screens, UI, menus, tabs, new features, etc. Make sure these all look good, that everything is properly translated and appears as expected. +
- Font support. +
- Untranslated content. +
Concerning untranslated content: please note that we currently have two tiers of support in iOS. If your locale is only in the Tier 2 support list, then it sometimes happens that menu items, which are part of the OS itself, may not be localizable - and will therefore unfortunately appear in English on the final UI. To tell if a locale is supported or not, simply take a look on an actual device, under the Language Settings of the most recent iOS version available. Tier 1 locales are the ones listed under “iPod/iPhone/iPad Language”, and Tier 2 locales appear under “Other Language” (or “Add Language” if there are already some languages under that list).
+Shipping a brand new locale
+The locale is tested and has reached 20% completion, we will add the locale to release builds.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/focus/index.html b/products/focus/index.html
new file mode 100644
index 00000000..e7c0bc66
--- /dev/null
+++ b/products/focus/index.html
@@ -0,0 +1,239 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Focus - How to localize
+Focus for Android and Focus for iOS are both on a four week rapid release cycle. This means that usually there are new releases going out every four weeks.
+Within this timeframe, localizers will have approximately four weeks to localize and test their strings for a given release: strings land continuously on Nightly during the first four weeks, and then these strings ride the train to the Beta version.
+It is important to use the Nightly versions for both products, in order to test localization work regularly (see more details about testing here).
+Localizing Focus for Android and Focus for iOS in Pontoon
+Localizers should go to the Focus for Android page on Pontoon - or the Focus for iOS page on Pontoon - and click Request New Language. They will be notified by email once the locale is set up and the project is ready to be localized.
When the locale has been set up, localizers can choose it from the list of locales on Pontoon, in the same page from which they made the locale request (links above).
+Once localization starts, the locale should become available in Nightly builds within the next few days, which will enable localizers to check and test their work. For Nightly builds and testing instructions, please refer again here.
+Once the locale starts work and reaches even 1% completion in Pontoon (and assuming that active testing has taken place), it will be added to the release version either in the Google Play Store or the iOS App Store.
+Note that Focus for Android strings share common strings with android-components, just like Fenix (Firefox for Android) does. At the moment, android-components strings all live in the Firefox for Android project in Pontoon - these are all the files in your locale folder that start with mozilla-mobile/android-components/. If Firefox for Android is not yet enabled for your locale, you will be asked to complete that work first.
Localization deadlines for projects are noted as Resources in each project page in Pontoon, and the main Project Manager’s contact information can be found there as well.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/focus/testing_focus.html b/products/focus/testing_focus.html
new file mode 100644
index 00000000..6982eca5
--- /dev/null
+++ b/products/focus/testing_focus.html
@@ -0,0 +1,271 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ L10n and Focus for iOS and Android
+Some documentation specific for common tasks regarding Focus for iOS and Android:
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/index.html b/products/index.html
new file mode 100644
index 00000000..aca678c3
--- /dev/null
+++ b/products/index.html
@@ -0,0 +1,243 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Testing Focus for iOS and Focus for Android for a new release
+Given Focus for iOS and Focus for Android have very similar test procedures, this document will cover both at once. Please note that in certain markets, the app is named “Klar”. For the sake of simplicity, we will only call out the name “Focus” in this document.
+Localizers currently mostly rely on screenshots for testing Focus for iOS. Latest information and updates about testing are provided on the l10n Discourse Channel, which you should follow if you are working on localizing any of the existing Mozilla products. +Links to iOS screenshots are also provided under the Resources section in Pontoon, at the top of the project page. +For Focus for Android and iOS, there are also links to testing builds, if they are currently available.
+Testing with screenshots (currently available for Focus for iOS only)
+Screenshots are provided by the mobile teams for iOS and appear under the Resources section in Pontoon or in the l10n Discourse channel (see above point for more details).
+Test builds
+-
+
- For Focus for Android testing of either Nightly or Beta, you will first have to join this google group. Please note that you must use the same Google account you use on your device to download apps from Google Play. +
For Beta releases: +After you have joined the group, opt-in to receive Beta builds, (again with the same Google account) here. +Then, download Firefox Focus (Beta) from Google Play here.
+For Nightly releases: +After you have joined the group opt-in, to receive Nightly builds, (again with the same Google account) here. +Then, download Firefox Focus (Nightly) from Google Play here.
+-
+
- For Focus for iOS Nightly builds, check as well under the Resources section in Pontoon, at the top of the project page - or reach out directly to the mobile project manager (currently delphine at mozilla dot com) to be added to the TestFlight system. +
For Focus for iOS, please note an iOS device running v13.6 or above is needed. For Focus for Android, an Android device running v5.0 or above is needed.
+Aspects to review
+Here is a list of issues you should try to identify when testing the build:
+-
+
- Language quality. +
- Truncated words (cut-off from screen). +
- Anything that appears broken on the UI. +
- Check out all the main screens, UI, menus, tabs, new features, etc. Make sure these all look good, that everything is properly translated and appears as expected. +
- Font support: once you start translating, you should check against the screenshots provided that the fonts used appear correctly. +
- Untranslated content. +
Concerning untranslated content on Focus for iOS: please note that we currently have two tiers of support in iOS. If your locale is only in the Tier 2 support (which corresponds to the languages under Other Languages in the iOS system settings), then it sometimes happens that menu items and dialogs, which are part of the OS itself, may not be localizable - and will therefore unfortunately appear in the primary OS language on the final UI.
+Locale sign-offs
+Unless there are visible l10n errors upon review of the locale’s screenshots (e.g., significant truncation, text overflow, encoding, etc.) - and besides what +may have already been reported to the mobile team to correct - we will ship any locale that has started to localize (this applies to both Focus products).
+Focus for Android issues can be filed here.
+Focus for iOS issues can be filed here.
Details about any major updates concerning these products are always announced on the [l10n Discourse Channel - and are reflected in this document as well.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/l10n_testing.html b/products/l10n_testing.html
new file mode 100644
index 00000000..e9984f4f
--- /dev/null
+++ b/products/l10n_testing.html
@@ -0,0 +1,321 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Localization of Mozilla products
+Documentation regarding testing and localization of the following products:
+ +Documentation about testing localization of Mozilla projects in general.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/mozilla_org/index.html b/products/mozilla_org/index.html
new file mode 100644
index 00000000..cee714d4
--- /dev/null
+++ b/products/mozilla_org/index.html
@@ -0,0 +1,238 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Testing localization of Mozilla projects
+Mozilla encourages a three-stage review process:
+-
+
- Linguistic review in Pontoon by community. +
- Technical review by l10n-drivers. +
- In-context localization testing by community and users. +
Other documents will cover how the Mozilla approach to the first two stages of the review process. This document covers what to look for when performing in-context localization testing for a Mozilla product or Web project.
+Localization testing process
+Each Mozilla project has its own process for taking your translations and making them available for you to test. Generally speaking, the process moves like this:
+-
+
- You submit a translation through Pontoon or directly to version control (Mercurial, GitHub). +
- The translation goes through a linguistic review and a technical review. +
- Once approved, the translation is automatically pushed into the project’s repository. +
- Depending on the project, you’ll need to wait anywhere from 30 minutes to 24 hours to look for your translation in the Mozilla project. +
- Once you’ve found your translation, if you see a problem with it, you return to Pontoon to make any necessary corrections. +
Pontoon simplifies these steps for some Web projects by enabling the in-context editor (aka WYSIWYG editor). This allows you to see your translations in-context the moment you create them in Pontoon, cutting out the 30 minutes to 24 hours waiting period to test. Most projects do not have this enabled, however, so it is still important to know the typical testing process for your projects.
+You might be wondering, “what sort of problems am I supposed to be looking for when I test?” Good question :-) Here’s a list of common localization bugs with screenshots that illustrate the problems in context.
+Common localization bugs
+Encoding and fonts
+Character encoding errors occur when the browser can’t find the correct symbol to display for a character. Normally, you will recognize these errors when you see Unicode replacement characters (�), or strange glyphs, instead of letters or radicals in your language. In some cases the problem can be resolved by changing your browser’s default encoding, in other cases the problem is due to the website not serving content with the right encoding and can be fixed only by the website’s owner.
+
Fonts that do not include full support for a language’s set of glyphs can present similar issues, for example showing incorrect line spacing (leading), character spacing (kerning), or missing ligatures between characters. In the example below, the kerning of the Cherokee letters is too wide. This may be fixed by using a different font on the site.
+
Truncation
+Truncation happens when a translation is too long to fit in its corresponding space in the user interface. This error can cause problems with transmitting the right meaning to the user by hiding part of the translation from view. It can be corrected in one of two ways:
+-
+
- The developer increases the UI space to accommodate longer translations. +
- The localizer creates a shorter translation that captures the primary message but may not capture secondary or tertiary messages. +
String reuse
+String reuse occurs when the same string is used in different contexts, and it represents a poor approach to localization.
+Consider for example a string like Add to bookmarks: developers might consider a good idea to reuse the same string for both a button label and button tooltip, since it works fine for English. On the other hand, other languages might have completely different needs for these two contexts: while the button indicates an action (imperative verb), the tooltip is used to describe the action associated to the UI element and might need a sentence using a verb with the third person, and the element itself as implicit subject.
+String concatenation and empty strings
+String concatenation occurs when a developer takes one string, splits it into multiple strings, and tells the code to display these strings one after another.
+This is often used to overcome technical limitations, like including a link in the middle of a sentence without exposing HTML tags to localization and injecting unsafe HTML in the UI.
+Empty strings are also common when creating a sentence with a link. Typically 3 strings are used: before_link + link + after_link. English doesn’t need the part before or after the link, but that’s useful for other languages, so they’re kept empty in English. It’s expected for some locales to have a completely different behavior than English.
+UI layout
+Translated text often requires more space than the same text in the source language. For example, when translating between English and German, it’s common practice to expect a length increase of 30%. This can cause problems as wrapping text elements cause different parts of the user interface move around to accommodate a longer string. To fix this, the translator often needs to create a new, shorter translation that captures the primary meaning, but might lose some of the secondary or tertiary meaning.
+
Mistranslation
+Mistranslation occurs when meaning is lost between the source language and the target language. This can be caused accidentally by a lack of context for where a translation will be placed within a user interface (very common in software localization), a translator’s lack of subject matter expertise, or intentionally due to user interface text constraints (e.g., truncation).
+
Untranslated strings
+Untranslated strings appear in a user interface when developers don’t include that string in the string resource files available for localization, but instead in their code. It’s a practice called hardcoding. The best way to correct this error is to make sure that Pontoon does not contain the string for translation (or that it’s not in the string resource files) and then contact developers using Bugzilla to make the string available for localization.
+
Style bugs
+Mozilla’s official style guide serves as a primer to help communities create their own style guides. Style errors are when the tone or appearance of a translation does not match the tone or appearance described in a style guide. These can be corrected by making sure that localizers understand the style guide rules and follow them when translating.
+
Numbers, date, currency
+Every language and region displays numbers, dates, and currency differently. These errors occur when the user sees an incorrect number format, date format, or currency for the language and region of their localized Firefox. This can be fixed by filing a bug in Bugzilla.
+
XML parsing errors
+XML parsing errors (aka “the yellow screen of death”) cause Firefox to display a yellow error page. This is often due to a broken translated string in that localization of Firefox which causes the Firefox build to break. With Fluent, these errors will no longer be relevant.
+
Exposed variables and placeholders
+Variables and placeholders become exposed in the user interface when the translated string has a typo within the variable or placeholder. Because it is not exactly the variable that the software or website expected to find, the system simply displays the variable rather than its value. A very common example of this is with the variable &brandShortName. If that variable is typed correctly in the translation, it will return the variable’s value (in this case, it’s Firefox). If it contains a typo, the user will see the variable instead (e.g., &brandshortname). These are discoverable in the Mozilla localization dashboards and can be corrected in Pontoon.
Broken access keys
+Access keys are less effective when the same key is assigned to multiple functions within the same scope (menu, preference panel, etc.). Additionally, if the access key uses a letter not available in the label, it’s displayed near the label between parentheses. Multiple identical access keys in the same context (preference menu, toolbar menu) will require the user to press the letter twice to use it. Ideally, repetitions should be avoided, but that’s not possible in some places, e.g. the reorganized preferences shipping with Firefox 56 and later.
+It’s possible to see a list of access keys using letters not available in the associated label in your Firefox localization by looking at this page in Transvision for your locale.
+
Broken language preferences
+Users experience broken website language preferences in Firefox when the accept-lang preferences are left unchanged from the en-US default set of language preferences. This can lead to the user receiving web pages in a language they’re unfamiliar with by default, even when the web page is localized into their native language. It can be fixed in toolkit/chrome/global/intl.properties in the accept-lang setting.
Broken searchplugins
+Users experiencing a broken searchplugin will receive a “website unreachable” message when they attempt to perform a search from their awesome bar or search bar. If you discover that a searchplugin is broken, please file a bug with the l10n-drivers.
+Broken hyperlinks
+Broken hyperlinks occur in a couple of different ways:
+-
+
- When there are typos in the hyperlink markup, the markup is then exposed to users. +
- When the hyperlink links to a site that is not obvious by the text it’s linked to (e.g., linking to the wrong support article according to the link’s context). +These can only be discovered by using the website or software regularly and clicking each hyperlink available to ensure that they take the user to the intended website. +
What to do when you find an error while testing
+Congratulations! You’ve found a bug! No software is perfect and you’re very likely to find bugs while you test your localization. Once you’ve found a bug, you can either attempt to find the affected string in your community’s Pontoon projects or you can file a bug in Bugzilla for that language in Mozilla Localizations :: [your_locale]. Once a fix for that bug is landed, it’s important to test again to be sure that the issue has been resolved.
+For project-specific testing guides, please see these pages:
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/products/mozilla_org/testing.html b/products/mozilla_org/testing.html
new file mode 100644
index 00000000..11d5eda4
--- /dev/null
+++ b/products/mozilla_org/testing.html
@@ -0,0 +1,399 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Working on mozilla.org
+Some documentation specific for common tasks on mozilla.org
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/searcher.js b/searcher.js
new file mode 100644
index 00000000..dc03e0a0
--- /dev/null
+++ b/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Testing Mozilla.org
+-
+
- Key links +
- What to test + + +
- How to test localized pages on the production server + + +
- Testing content in Fluent + + +
- Testing dynamic pages + + +
Mozilla.org is highly visible because the site houses the basic info of all Mozilla products, conveys Mozilla’s mission, vision, and values it stands for. Additionally, it promotes initiatives and campaigns in time of these events. The localized versions reach 60% of the Mozilla users globally. It is very important that, not only the main pages are localized, they are thoroughly tested before they are launched on production.
+It’s highly advised you to ask other community members to conduct peer review not only on Pontoon, but on staging and production. While not all the languages are required for certain projects, each community can opt in the projects at a later time.
+Key links
+-
+
- Production: https://www.mozilla.org/{locale_code}/ +
- Staging: https://www-dev.allizom.org/{locale_code}/ +
- Repository: https://github.com/mozilla-l10n/www-l10n +
- Pontoon: https://pontoon.mozilla.org/projects/mozillaorg/ +
What to test
+Pre-l10n test
+-
+
- Have your glossary available as a reference, select mozilla.org as Repository, your language as your Target Locale. +
- For terminology consistency, reference the product or site that the page is for, assuming the product or site is localized (e.g.: Firefox, Monitor). +
- Have the matching US page up as reference, though some strings may not be identical due to A/B testing. +
- Have the project you just localized available for editing in Pontoon. +
Linguistic testing
+-
+
- Translation quality in context. +
- Grammar correctness in context. +
- Truncation: button text should remain inside the button. +
- Header line break wraps at proper place. +
- Text not overlapping graphic. +
- Terminology consistent with product across web pages. +
- Brand names remain in English, with a few exceptions due to declension. Check out these detailed guidelines when working with brands and trademarks. +
- Product names comply to Mozilla guideline and adhere to what the community has agreed to. +
- No corrupted characters. +
- Click the links on the page to navigate to localized pages in the same language. If a page is not localized, you will be redirected based on your language preference settings (e.g., Fulah > French > English). If no preferences are set, the default is en-US. +
- Navigation terms consistent with the page titles they are linked to (except when the navigation term is shortened due to space limitation). +
- Footer links don’t overlap with one another. +
You can make linguistic changes directly in Pontoon.
+Functionality testing
+-
+
- Click the download link, you should be able to download the product in your language, if it is localized, such as Firefox. +
- Font support and readability. +
- Footer: verify that the translation of the link is coherent and the link is functional. +
- Language list: is your language listed as one of the options? Check https://www-dev.allizom.org/firefox/all/ to confirm. See detailed steps below to get to the language list. +
- Error page: deliberately type a broken link, such as https://www.mozilla.org/firefox/neu/, check whether 404 page is localized. +
- If your language is RTL, make sure that the page layout and text flow in the correct directions. +
Compatibility testing:
+-
+
- Test the page layout in other major browsers and on other platforms. +
- Test the page layout on the leading locally developed browser if available. +
- Test the page layout on mobile devices of major platforms. +
How to test localized pages on the production server
+Updated translations are pushed to the production server regularly throughout the day.
+-
+
- New page: When a brand new page is available for localization, it will be enabled on production when it’s 80% complete. At that point, if it doesn’t reach 100% completion level, the page will be available on production with English content mixed with translation. Before the page is activated in production, use the staging server for testing. +
- Activated page with added strings: The strings will appear in English on production right away. Localized content will be pushed to production as soon as translations are available in the repository. +
- Activated page with string updates: The switch to the updated content happens when the replacements of obsolete strings are fully localized. In some cases, there is a defined time frame to show the new strings on production, so test the updates on staging server. The obsolete string will be removed three months after the introduction of the replacement strings. +
- Activated page with template change: In some cases, a page receives a major update that requires a complete rewrite of the template. If this happens, the old template is kept online only for a defined period of time. When removed, it will cause the URL to redirect users to the English version if the intended localized version is not ready, or other user preferred localized versions are not available either. +
- Activated page missing too many updates: An activated page falling far behind with multiple updates will create poor user experience. They may be subjected to removal. +
Sync and update frequencies
+Updated translations are pushed to the production server regularly throughout the day.
+-
+
- Pontoon syncs every 10 minutes to the repository. +
- GitHub update is pushed to production every 5 minutes. +
It is safe to say that it will take less than an hour to see your changes reflected on the production server.
+When a project has a firm deadline to meet, it will be indicated at the top left corner of the project page in Pontoon and at the page level. When necessary, it will be communicated through the l10n-community room on Matrix.
+Testing content in Fluent
+Reviewing and updating brands.ftl
+This file captures all the brand and product names that appear in all the pages on mozilla.org. As a general rule, brands and product names remain unchanged. The exceptions are:
+-
+
- Account/accounts in Mozilla account/accounts: Mozilla should be treated as a brand, but
accountandaccountsshould be translated. Both the singular and plural forms are used in lower cases. Uppercase is reserved for special use cases where headline case is necessary, for example legal document names and references.
+ - Browser/Browsers in Firefox Browser/Browsers. +
If your community decides to translate any of these products or feature names, translate it once and translate it in this file. Be sure to have a consensus among active contributors what the translation should be before updating this file. This practice will ensure term use consistency across all pages.
+Please refer to the guidelines for brands and trademarks when reviewing and updating this file.
+Reporting technical issues
+Report issues that can’t be resolved in Pontoon by:
+-
+
- Filing a bug in Bugzilla and selecting your locale. +
- Adding the l10n PM in charge for NI. The l10n PM information appears at the top left corner on the project page. +
- Including the file name plus a screenshot and/or URL. +
- If an extra tag is added to a string in order for it make sense in your language, the string will generate an error report. The l10n PM for the project will consult you whether to make this an exception so it will not generate an error report in the future. +
Reporting vendor translation errors
+If the mozilla.org project is not in your Pontoon dashboard, but the site is localized into your locale, it is likely being translated by a translation vendor. Report any translation errors by:
+-
+
- Filing a bug using one of these templates and selecting your locale in the component list: + + +
Testing dynamic pages
+This section focuses on instructions for testing pages with dynamically generated content. Each page or topic is different in terms of steps or flow. These instructions could change over time to reflect product design updates. Linguistic testing is the main focus. The instructions below are detailed steps to get to the localized content so it can be reviewed in context.
+firefox/accounts.ftl
+On the landing page of the Mozilla account page, click on the links under each of the following products which take you to product specific pages:
+-
+
- Firefox Browser +
- Firefox Monitor +
- Firefox Relay +
- Mozilla VPN +
If you already have an account, click on the Manage your account link on the right side of the landing page, which will take you to the subscription page. If you do not have an account, you will be invited to create an account by providing an email address in the Sign In box.
Note: You may see different languages between mozilla.org, the login window, and the products above. If any of these products is not localized in your locale, it will fall back to other languages set as preferred for content language negotiation, assuming any of them is available for the project, or English.
+firefox/all.ftl
+On the right side of the page, there is a four-step process to go through in order to download Firefox.
+-
+
- Browsers: choose one of the options either for desktop or mobile. Click on the
?next to the Browsers category, a popup window shows the descriptions of different versions of Firefox browsers available for download. Select one browser to proceed to the next step.
+ - Platforms: Click on the
?, a popup window shows the descriptions of different versions of installers available for download.
+ - Languages: A list of languages available in the build depending on what is selected in the above two categories. Check whether your current preferred language is shown by default. Change to a different language, check whether the download summary above the Download Now button corresponds to your new selection. +
- Download: The Download Now button appears. +
On the lower left side of each page, you will see these links:
+-
+
- These two sites are in English only: Check the system requirements and Release notes. +
- Click on the Source code link, you will be directed to the Firefox Source Docs page which is not localized. +
- The Firefox Privacy Notice document is localized in limited number of languages. +
- Click on the Need Help link, you will be directed to the SUMO home page. +
firefox/new/download.ftl
+-
+
- Click the Download Firefox button to check the thank you page that triggers an automatic download. +
- The Firefox Privacy Notice document is localized in limited number of languages. +
- Click on the Download options and other languages link, you will be directed to the firefox/all page. +
- Click on the Firefox Browser support link, you will be directed to the SUMO site featuring various topics on Firefox. +
navigation_v2.ftl
+The strings in this file are shared content and are activated on production whether they are localized or not. When clicking on any of these topics on the navigation bar, Firefox Browsers, Products, Who We Are or Innovation, you will see a drop-down panel with subcategory topics. Within each of the topics, there is a description and a few links to help you dive deeper further into a topic which takes you to a different page. When reviewing the content, keep in mind the following:
+-
+
- Not all links take you to a site that’s localizable for all locales. +
- Not all products are offered in your locale. +
- Brand and product names must remain unchanged. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/fluent/brand_names.html b/tools/fluent/brand_names.html
new file mode 100644
index 00000000..c6a3c989
--- /dev/null
+++ b/tools/fluent/brand_names.html
@@ -0,0 +1,267 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction to Fluent syntax
+ +Basic syntax
+A Message represents the basic unit of translation in Fluent. This is the simplest form messages can take:
+welcome-msg = Hello, World!
+welcome-msg is the message identifier (or message ID), and Hello, World! is the value of this message.
Messages can contain variables, for example:
+welcome-msg = Welcome { $user }
+$user is the name of the variable, and should never be translated. The fragment included between curly braces is called a placeable, and can be moved within the text. For example, the message above would be translated in Italian as follows, leaving the placeable unchanged:
welcome-msg = Benvenuto { $user }
+Messages can also reference other messages. In this case, the placeable won’t include the $ sign, simply the message identifier:
menu-settings = Settings
+help-menu-settings = Click { menu-settings } to save the file.
+A Term is a special category of Message:
+-
+
- Terms have identifiers starting with a dash, e.g.
-brand-short-name.
+ - They can’t be called directly in the source code, but only referenced within other messages. +
- Each localization can add or remove attributes, regardless of the reference language (typically
en-US).
+
For example, a term is used to define the Firefox brand name. For more details, see this document.
+-brand-short-name = Firefox
+close-msg = Close { -brand-short-name }
+Attributes
+For a single HTML object there might be multiple messages to localize: for example, a button could have a label and an accesskey, a link could have a text but also a tooltip. Such objects can be localized defining multiple attributes within a single message. For example, in the case of a button:
login-button =
+ .label = Login
+ .accesskey = L
+The message login-button doesn’t have a value, but has 2 attributes defined: label and accesskey. There are a few things to highlight in this FTL fragment:
-
+
- Attribute definitions must be indented and start with a period. +
- There is an equal sign following the message identifier, even if there is no value (i.e. the value is Null). +
- All attributes of messages found in the reference language – typically
en-US– must be present in the localization. This will be enforced by tools like compare-locales, which will warn on missing or obsolete (only available in the localization) attributes.
+
instructions-link = Log out
+ .tooltip = Disconnect from this account
+In this case, instructions-link has a value (Log out) and a tooltip attribute (Disconnect from this account).
It’s important to note that, in FTL files, indentation is part of the syntax; indenting elements incorrectly will lead to parsing errors.
+Selectors and plurals
+With the select expression, a single message can provide several alternatives. The selected value will depend on the value of a variable, another message attribute, or a function.
+The most common use of select expressions is for plural forms:
+emails = { $unreadEmails ->
+ [one] You have one unread email.
+ *[other] You have { $unreadEmails } unread emails.
+ }
+Notice that both the variants and the closing curly brace are indented. The same message can also be written as:
+emails =
+ { $unreadEmails ->
+ [one] You have one unread email.
+ *[other] You have { $unreadEmails } unread emails.
+ }
+One of the variants starts with a *: that indicates the default option, and it must always be defined in a select expression. The part before -> is called the selector.
In this case, the message displayed will change based on the numeric value of $unreadEmails. For plurals, the variant key can either be a perfect match to a number or one of the CLDR plural categories. This allows to define special cases, beyond the number of plurals expected for a language:
emails = { $unreadEmails ->
+ [one] You have one unread email.
+ [42] You have { $unreadEmails } unread emails. So Long, and Thanks for All the Fish.
+ *[other] You have { $unreadEmails } unread emails.
+ }
+Note how the [one] form in English doesn’t explicitly use the variable, in order to display the word one instead of the digit 1.
In plural messages is always possible to expose the number, even if the reference language doesn’t; the name of the variable is defined at the beginning of the select expression (in the selector), in this case $unreadEmails. The first example in this section can be translated in Italian using $unreadEmails in both forms:
emails = { $unreadEmails ->
+ [one] C’è { $unreadEmails } messaggio non letto.
+ *[other] Ci sono { $unreadEmails } messaggi non letti.
+ }
+Terms and parameterized terms
+As described at the beginning of the document, terms are a special type of messages. They are used to define translations of common words and phrases, which can then be used inside of other messages. They can be recognized because of the identifier starting with a dash, e.g. -brand-short-name. Terms can also define additional language-specific attributes which are not present in the reference language (typically en-US).
While in most cases terms will have a single value, it’s also possible to define multiple values associated controlled by a parameter. These parameterized values can be used to define grammatical cases or any other language-specific modifications of the value required by the grammar of the spelling rules. When referencing a term from another message, you can optionally specify a parameter and its value with the -term-identifier(parameter: "value") syntax.
Consider the following example in English:
+-fxaccount-brand-name = Firefox Account
+
+sync-signedout-account-title = Connect with a { -fxaccount-brand-name }
+In Italian this can become:
+-fxaccount-brand-name =
+ { $capitalization ->
+ [lowercase] account Firefox
+ *[uppercase] Account Firefox
+ }
+
+sync-signedout-account-title =
+ Connetti il tuo { -fxaccount-brand-name(capitalization: "lowercase") }
+Similar to select expressions, you must define a default value, identified by *. Also notice that parameter names are arbitrary, and don’t need to be in English. To get the default value (uppercase in the example), the term can be called without any parameter ({ -fxaccount-brand-name } or { -fxaccount-brand-name() }).
Parameters can also be nested for more complex situations, for example:
+-sync-brand-short-name =
+ { $case ->
+ *[nom] { $capitalization ->
+ *[upper] Синхронізація
+ [lower] синхронізація
+ }
+ [gen] { $capitalization ->
+ *[upper] Синхронізації
+ [lower] синхронізації
+ }
+ [dat] { $capitalization ->
+ *[upper] Синхронізації
+ [lower] синхронізації
+ }
+ [acc] { $capitalization ->
+ *[upper] Синхронізацію
+ [lower] синхронізацію
+ }
+ [abl] { $capitalization ->
+ *[upper] Синхронізацією
+ [lower] синхронізацією
+ }
+ }
+
+use-firefox-sync =
+ Підказка: При цьому використовуються окремі профілі. Скористайтеся
+ { -sync-brand-short-name(case: "abl", capitalization: "lower") }
+ для обміну даними між ними.
+Again, not all parameters need to be specified at all times when referencing a term. If some (or all) parameters are omitted, the corresponding default values will be used. In the example above, { -sync-brand-short-name(case: "abl") } will result in the uppercase Синхронізацією translation because upper is defined as the default value of the ablative case.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/fluent/functions.html b/tools/fluent/functions.html
new file mode 100644
index 00000000..fff9be34
--- /dev/null
+++ b/tools/fluent/functions.html
@@ -0,0 +1,267 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Brand names
+Brand names, like Firefox or Sync, are stored as Terms in dedicated files, and shared across the application.
+Unless indicated otherwise in comments, the current policy is that brand names can’t be:
+-
+
- Declined to adapt to grammatical case. +
- Transliterated. +
- Translated. +
They need to be kept in English, and sentences adapted as needed to fit the undeclined name.
+For example, a term -brand-short-name is provided in browser/branding/official/brand.ftl
-brand-short-name = Firefox
+And it can be referenced in other messages as follows:
+
+close-msg = Do you want to close { -brand-short-name }?
+-brand-short-name is defined as a term to allow localizers to define custom attributes, for example to store grammatical properties. Mozilla tools like compare-locales won’t report those attributes as obsolete if the reference language (en-US) doesn’t have them. Each language is then free to put information about genders, animacy, the first letter being a vowel or not, and any more into attributes of terms.
Here’s an example in English:
+-brand-name = Firefox
+
+has-been-updated = { -brand-name } has been updated.
+And how Polish can adapt its translation depending on the gender of the brand. To understand this example, consider a scenario where -brand-name would be defined in a separate file, and could change depending on the version (e.g. Firefox vs Aurora).
-brand-name = Firefox
+ .gender = masculine
+
+has-been-updated =
+ { -brand-name.gender ->
+ [masculine] { -brand-name } został zaktualizowany.
+ [feminine] { -brand-name } została zaktualizowana.
+ [neuter] { -brand-name } zostało zaktualizowane.
+ *[other] Program { -brand-name } został zaktualizowany.
+ }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/fluent/index.html b/tools/fluent/index.html
new file mode 100644
index 00000000..56cbf791
--- /dev/null
+++ b/tools/fluent/index.html
@@ -0,0 +1,241 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Functions
+Functions can be used in Fluent to format data according to the current language’s rules, or can provide additional data to fine tune the translation.
+Fluent includes some generic built-in functions, like NUMBER and DATETIME, for number and date formatting, respectively. Such functions can be used in placeables and selectors. For example:
dpi-ratio = Your DPI ratio is { NUMBER($ratio, minimumFractionDigits: 2) }
+
+your-score = { NUMBER($score, minimumFractionDigits: 1) ->
+ [0.0] You scored zero points. What happened?
+ *[other] You scored { NUMBER($score, minimumFractionDigits: 1) } points.
+ }
+This document describes additional functions available in Gecko products. Please refer to this document for references about the terminology used.
+PLATFORM
+PLATFORM is a function that allows localizers to tailor messages to the current platform. Allowed variant keys are: windows, macos, linux, android, other.
For example, Firefox settings are currently called Options in Windows, Preferences in macOS and Linux. Strings can be differentiated in Fluent by defining a message as follows:
+pref-page =
+ .title = { PLATFORM() ->
+ [windows] Options
+ *[other] Preferences
+ }
+PLATFORM() is used to determine the variant to use in the select expression, other is defined as default. If a variant isn’t defined, for example for linux, it will fall back to the default value.
The following example uses the PLATFORM() function for each attribute:
download-choose-folder =
+ .label =
+ { PLATFORM() ->
+ [macos] Choose…
+ *[other] Browse…
+ }
+ .accesskey =
+ { PLATFORM() ->
+ [macos] e
+ *[other] o
+ }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/mercurial/index.html b/tools/mercurial/index.html
new file mode 100644
index 00000000..c47e0a1f
--- /dev/null
+++ b/tools/mercurial/index.html
@@ -0,0 +1,237 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Fluent for localizers
+Fluent is a localization system, previously known as L20n, designed at Mozilla to unleash the expressive power of the natural language. The format used to describe translation resources used by Fluent is called FTL.
This section of documentation includes a brief introduction to Fluent’s syntax for localizers and covers specific details regarding Mozilla’s implementation (branding rules, additional functions available in Gecko, etc.). For a detailed overview of Fluent, consult the official documentation.
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/mercurial/tracking_back_string_to_bug.html b/tools/mercurial/tracking_back_string_to_bug.html
new file mode 100644
index 00000000..e82a7d79
--- /dev/null
+++ b/tools/mercurial/tracking_back_string_to_bug.html
@@ -0,0 +1,261 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Documentation for Mercurial
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/pontoon/glossary.html b/tools/pontoon/glossary.html
new file mode 100644
index 00000000..dbab7a89
--- /dev/null
+++ b/tools/pontoon/glossary.html
@@ -0,0 +1,303 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ How to identify Bugzilla bugs that introduced a string
+Sometimes it’s helpful to identify which bug on Bugzilla introduced a specific string, for example to check if an issue was already reported, or find out more information on a feature.
+Note: These instructions apply only to projects that make use of Bugzilla, which currenly are Firefox projects for desktop and Android.
+Find the string
+The first step is to identify where the string is within the Mercurial repository by using Searchfox.
+For example, if you want to know which bug introduced the string Password quality meter, you can search for the string. This may return multiples strings with the same text, so to find the exact string you can use the the identifier (which can be found from CONTEXT in Pontoon).
The results may look something like this:
+
You can further refine results to only localization files by using specific localization file extensions in the Path filter field in the top right:
-
+
- For Firefox: limit the search to
.ftlor.propertiesfiles. You can find information on the file from its CONTEXT. Or you can use{.ftl,.properties}to only show files with those extensions.
+ - For Android: limit the search to
.xmlfiles.
+
Clicking on the string will open the file in Searchfox and highlight the string.
+Find the bug
+Searchfox shows details on the revision in which each line of code was introduced to the file, represented on the left hand sign as a bar with alternating shades of gray. Hovering over the bar next to the highlighted line containing your string will show you the revision details. The first line of the revision details contains a bug reference, a number represented as a link. Clicking the link will take you to Bugzilla where you can then check things like dependencies and comments.
+
Examining the changeset in Mercurial
+You can also access the changeset in Mercurial. To view that, click full diff on the third line that says Show annotated diff or full diff.
This will show the full commit message and all the changes made as part of the bug.
+
Looking at older revisions
+The above method doesn’t always work: sometimes a changeset only moves strings around, so you would need to repeat the process for an older revision of the file.
+If a string was moved, the changeset for the earliest version will show the bug that moved it. In Searchfox, from the bar on the lefthand side next to your string, you can click Show earliest version with this line. From the page that follows, hover over the left bar next to the string and click full diff to show the changeset for that revision in Mercurial.
Near the top of the changeset, there’s a list of the modified files. Near each file there’s a revisions link.
+
After clicking revisions, you can pick an older changeset of a file by clicking the diff link next to the changeset you’re interested in, or repeat the process by selecting annotate. This will display the revision associated to each line of that changeset.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/pontoon/index.html b/tools/pontoon/index.html
new file mode 100644
index 00000000..879193bc
--- /dev/null
+++ b/tools/pontoon/index.html
@@ -0,0 +1,246 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Glossary
+Explanation of common terms and concepts used across documentation.
+-
+
- Comment +
- Fuzzy +
- Locale +
- Permission +
- Pretranslation +
- Resource +
- Terminology +
- Translation +
- Translation memory +
- Translation mode +
- Version Control System +
Comment
+Comments can be used, for example, to discuss possible translations with other team members or request more information from project managers.
+Pontoon supports two types of user comments:
+-
+
- Source string comments are associated with the source string and displayed in the
COMMENTStab in the right column.
+ - Translation comments are associated with a specific translation and displayed under the editor in the translation list. +
User comments should not be confused with Resource comments, which developers can add directly to the resource file. This type of comment is displayed in the editing area, along with other information like the resource path and context.
+Fuzzy
+fuzzy is an internal state available only if the source file is a gettext (.po) file. A string can be marked as such in a few cases:
-
+
- The reference text changed after the string was already translated. +
- The string has been manually marked by translators because it needs review. +
- New strings were merged in the localized files, enabling the option to match existing translations (also called “fuzzy matching”). +
In all these cases a translation exists in the file, but is marked as fuzzy (equivalent to “need review”) and not used by the website or application. For more information, read the documentation about Fuzzy Entries in gettext.
+Locale
+A locale is the combination of a language and a region, represented in Pontoon by a locale code. For example, American English is referred to as en-US, where en stands for the language (English), and US for the region (United States). In some cases, the region is omitted, because the language is mostly spoken in one region.
In Pontoon, each locale maps to a team.
+Permission
+Users in Pontoon can have different permissions depending on their role:
+-
+
- Translators can either submit approved translations directly or review suggestions from other users. Unlike in some other Translation Management Systems, this is a single permission in Pontoon, and it’s referred to as Translator permission. +
- Team managers have translator permissions, but can also change permissions assigned to other users (i.e., ”promote” or ”demote” them). +
Pretranslation
+Pretranslation is a feature in Pontoon that relies on machine translation (Google AutoML Translation) and translation memory to automatically translate strings and save them in localized files.
+If pretranslation is enabled for a combination of a locale and a project, when a new string is added in Pontoon:
+-
+
- It will be translated (pretranslated) using a 100% match from translation memory or, should that not be available, using the Google AutoML Translation engine with a custom model. +
- The string will be stored in Pontoon with the pretranslated status. +
- For projects using version control systems, the translation will be stored in localized files outside of Pontoon. +
Resource
+Resources are localization files within a repository (see version control system) used to store source content and translations. They can be in different file formats but generally follow the same key-value structure, where the key (displayed as Context in the Source string panel) is a unique identifier and the value is a text snippet that needs to be translated.
Terminology
+Terminology — sometimes also referred to as a Glossary — is a list of terms and their definitions. Pontoon will highlight any terms in the source string and show their definitions as well as translations into the target language.
+TBX, or TermBase eXchange, is a standard file format used in the translation industry to represent and exchange terminological information. Pontoon Terminology can be downloaded in the TBX format.
Translation
+A translation is any submission of the target content. There are several types of translations:
+-
+
- Approved translations: translations submitted directly or approved by users with translator permissions. +
- Suggestions: translations that have not been reviewed yet (pending). +
- Pretranslations: translations that have been authored by the pretranslation feature. +
Translation memory
+Translation memory is a list of all approved translations for any string. It can be leveraged to provide suggestions when translating new content.
+TMX, or Translation Memory eXchange, is a standard file format used in the translation industry to represent and exchange translation memories. Pontoon Translation memory can be downloaded in the TMX format.
Translation mode
+Depending on their settings and permissions, users will be able to submit translations directly (Translation Mode), or only submit suggestions (Suggestion Mode).
+Contributors — users without translator permissions — can only access Suggestion Mode, while translators and team managers can manually switch between the modes.
+Version Control System
+Most projects store source content and translations outside of Pontoon, in repositories that use version control systems (VCS). The most popular are git and Mercurial (hg).
+Pontoon periodically (usually every 10 minutes) imports source content and translations from these repositories and writes translations back. This process is referred to as Sync.
+Pontoon also supports the so-called DB projects, where source content and translations are stored in Pontoon’s internal database (DB).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/pontoon/notifications.html b/tools/pontoon/notifications.html
new file mode 100644
index 00000000..019bf086
--- /dev/null
+++ b/tools/pontoon/notifications.html
@@ -0,0 +1,280 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ How to use Pontoon
+This document covers how to work with Pontoon from the user’s perspective. While most of the documentation applies to any deployment of Pontoon, the Mozilla instance is referenced frequently as an example. Some limited portions apply specifically to using Pontoon to localize Mozilla projects online.
+If you’re interested in administrating Pontoon, please read these documents.
+-
+
- How to translate. +
- Translation workspace. +
- Team and project pages. +
- User accounts and settings. +
- Notifications. +
- Profile page. +
- Glossary. +
Note: The screenshots in this documentation use the dark theme, but a light theme is also available.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/pontoon/profile.html b/tools/pontoon/profile.html
new file mode 100644
index 00000000..679cc8ee
--- /dev/null
+++ b/tools/pontoon/profile.html
@@ -0,0 +1,272 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Notifications
+Tracking updates across several projects can quickly become challenging. Pontoon tries to support users across different roles by sending notifications, to make sure important updates don’t get lost. Administrators can also use notifications to send messages about specific projects.
+When the user receives a notification, the bell icon near the user avatar in the top right corner will show a badge with the number of unread notifications. Clicking the bell icon will display the latest notifications in a dropdown menu.
+
Clicking See all Notifications at the bottom will take the user to the complete list of notifications. The same list can also be accessed by opening the /notifications URL directly (e.g. pontoon.mozilla.org/notifications).
Receiving notifications via email
+Pontoon also offers the option to receive notifications via email, allowing users to stay informed about important events even when they're not actively using the platform. They can choose to receive email notifications as a daily or weekly digest and customize their preferences by subscribing to specific notification types.
+Receiving notifications in the browser
+Pontoon notifications can be delivered directly to your browser through the Pontoon Add-on, which is compatible with both Firefox and Chrome.
+Disabling notifications
+Pontoon includes several types of notifications and most of them can be manually disabled by users if they don’t find them useful.
+Notification types
+New strings
+This notification informs users when new strings are added to a project. The notification is sent to all users who contributed translations to that project, as soon as new strings are available.
+Project target dates
+This notification informs users when a project is incomplete and it’s approaching the target date. The notification is sent to all users who contributed translations to that project, the first time 7 days before the target date, then again 2 days before.
+Comments
+Pontoon distinguishes between two types of comments:
+-
+
- Translation comments are associated with a specific translation. These comments are displayed under the translation itself. +
- Source string comments are associated with the source string. These comments are displayed in the
COMMENTStab in the right column.
+
For either type of comment, a notification is sent as soon as a comment is added.
+For translation comments, the recipients are:
+-
+
- Authors of other translation comments associated with the same translation. +
- Translation author. +
- Translation reviewer. +
For source strings comments, the recipients are:
+-
+
- Users with the ability to review translations for the string. +
- Authors of translation comments. +
- Authors of source string comments. +
- Translation authors. +
- Translation reviewers. +
New suggestions ready for review
+This notification is sent once a week to inform reviewers about new suggestions needing a review. It includes information about suggestions that were submitted, unapproved or unrejected over the last 7 days. Recipients include users with permissions to review these suggestions — translator and team managers — as well as the authors of previous translations or comments in the same string.
+Review actions on own suggestions
+This notification is sent once a day to authors of suggestions, to inform them that their work has been reviewed.
+New team contributors
+This notification is sent to team managers, as soon as a new user makes the first contribution to their team.
+Badge awarded
+This notification is sent to a user upon being awarded with a badge or new badge level from reviewing and submitting translations, or promoting users.
+Manual notifications
+Administrators can send manual notifications to a project, including all locales or a subset of them. Unlike other types of notifications, this can’t be disabled.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/pontoon/search_filters.html b/tools/pontoon/search_filters.html
new file mode 100644
index 00000000..1ef1033e
--- /dev/null
+++ b/tools/pontoon/search_filters.html
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Profile page
+The goal of the profile page in Pontoon is to provide a tool to showcase contributions, display useful contact information about the user, and help team managers to organize and grow their communities. A user’s personal profile page can be reached by clicking the avatar icon in the top right corner, and then clicking the profile picture in the dropdown menu, or by using the /profile URL (e.g. pontoon.mozilla.org/profile). Users can also view others’ personal profiles by clicking a user’s profile picture wherever it appears, such as in the list of contributors for a team or project.
The left column includes information about the user:
+-
+
- Profile picture and name. +
- Contact details. +
- Achievement badges. +
- Information on last known activity (when the user has submitted or reviewed a translation), last login in Pontoon, and the account’s creation date. +
- Roles in Pontoon (a user can have multiple roles across different locales). +
Users can customize their information and the visibility of specific fields in the settings page (reachable using the CHANGE SETTINGS button).
Achievement badges
+Achievement badges awarded to a user are displayed beneath their contact information. The available badge types, from left to right in the image below, include:
+-
+
- Translation Champion, awarded for submitting translations. +
- Review Master, awarded for reviewing translations. +
- Community Builder, awarded for promoting users to higher roles. +
Each badge has multiple levels. If a user holds a badge at level two or higher, the level is shown at the bottom left of the badge icon.
+Whenever they earn a new badge or level up an existing badge, users will be notified with a pop-up and a notification.
+Activity graphs
+In the top central section there are two graphs:
+-
+
- Approval rate shows the ratio between the number of translations approved and the total number of translations reviewed, excluding self-approved translations. +
- Self-approval rate is only visible for users with translator rights, and shows the ratio between the number of translations submitted directly — or self-approved after submitting them as suggestions — and the total number of translations approved. +
If both graphs are available, it’s possible to switch between them using the selector at the bottom (highlighted in red in the image above)
+Right below these graphs, there is a section showing a graphical representation of the user’s activity in the last year. Each square represents a day, while each row represents a day of the week. The brighter the color, the higher the number of contributions on that day.
+
By default, the chart will show data for all contributions over the last year, but it’s also possible to limit the chart to:
+-
+
- Submissions. +
- Reviews performed. +
- Reviews received. +
- Submissions and reviews. +
The activity log below this chart will display the user’s activity in more detail for the last month. Clicking on a specific square (day) in the chart will only show the activity for that day. Each line item in the activity log is a link that allows to jump to those specific strings in the translation editor.
+ +Redirecting to... https://mozilla-l10n.github.io/localizer-documentation/tools/pontoon/translation_workspace.html#search.
+ + diff --git a/tools/pontoon/teams_projects.html b/tools/pontoon/teams_projects.html new file mode 100644 index 00000000..55cdafe2 --- /dev/null +++ b/tools/pontoon/teams_projects.html @@ -0,0 +1,370 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/pontoon/translate.html b/tools/pontoon/translate.html
new file mode 100644
index 00000000..1526d1d8
--- /dev/null
+++ b/tools/pontoon/translate.html
@@ -0,0 +1,356 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Team and project pages
+-
+
- Teams + + +
- Projects + + +
- Localization page +
- Insights graphs +
The Teams page, accessible using the /teams URL (e.g. pontoon.mozilla.org/teams), lists all locales that are enabled in Pontoon. From here it’s possible to access a specific Team page, which contains a list of all projects enabled for the requested locale. Selecting a project from the Team page leads to the so-called the Localization page.
From each locale’s Team page it’s also possible to Request a project or Request pretranslation. Note that this is a request to add the locale to a project already available in Pontoon, it can’t be used for requesting a brand new project.
+The Projects page, accessible using the /projects URL (e.g. pontoon.mozilla.org/projects), lists all projects that are available in Pontoon. From here it’s possible to access a Project page, which shows all locales that are enabled for the requested project. Selecting a locale in the Project page leads to the Localization page.
There is also a special Localization page that allows access to all resources for all projects enabled for a specific locale: /locale/all-projects/all-resources.
The following diagram shows how these pages are organized and connected to each other:
+
Teams
+Teams page
+The Teams page lists all locales that are enabled in Pontoon. It can be reached by clicking Teams in the page header (not displayed when translating a project) or by using the /teams URL (e.g. pontoon.mozilla.org/teams). Clicking on a specific locale will open the locale’s Team page.
Team page
+Access a specific team’s page by selecting it from the Teams page or by appending a locale code to the end of the Pontoon base URL with /{LOCALE} (e.g pontoon.mozilla.org/it for Italian).
The page header contains linguistic information about the current locale (plural form, writing direction, etc.), plus an indication of the overall status of completion and statistics. The statistics displayed in the rightmost column are active links to access the translation workspace for all projects. For example, select ALL STRINGS to show all the strings for all projects enabled for a specific locale in Pontoon, or select MISSING to filter for all strings missing translations.
Underneath the header, the following tabs are available to navigate between various Team page panels:
+-
+
- Projects: a list of all projects enabled in Pontoon for this locale. +
- Contributors: a list of active contributors with their statistics, filterable by time (all time, last 12/6/3/1 months). +
- Insights: data and trends on contributor and localization activity. +
- Bugs: a list of open bugs for the locale, retrieved from Bugzilla (available in Mozilla's deployment). +
- Info: information about the team. Team managers can edit this by clicking on the
EDITbutton.
+ - Permissions: permissions management panel (available to Team Managers). +
- TM: translation memory management panel (available to Translators and Team Managers). +
By default, the Projects tab opens, showing a list of all projects enabled for the locale. Clicking on one of these projects leads to the Localization page. Column headers can be used to sort the list of projects. For example, clicking on Priority will sort projects by their priority.
Hovering a project in the Projects list will replace the progress bar with a set of detailed statistics (untranslated strings, missing strings, etc.). Note that all these numbers are links, use them to open the project with a filter already enabled, for example to display only missing strings. Clicking ALL accesses All Resources (i.e. all strings in all files) for this project.
The rightmost column in the table will display a blue lightbulb icon if there are unreviewed translations. Note: clicking the lightbulb icon in the table header can be used to sort projects based on the number of unreviewed translations.
+
Requesting a project
+It’s possible to request a project from a Team page. Note that this is a request to add the locale to a project already available in Pontoon, it can’t be used for requesting a brand new project.
+
The button is hidden if all available projects are already enabled for the locale.
+Click on REQUEST MORE PROJECTS, select the projects to add and then click REQUEST NEW PROJECT (at least one project needs to be selected for the button to be displayed).
An email will be sent to Pontoon’s administrators, and the Project manager in charge of the project will act on the request. Please note that:
+-
+
- Some projects have a closed list of supported locales, meaning that these projects can’t be requested on Pontoon. +
- Some projects can be requested but may not be enabled for practical restrictions related to the project itself (e.g. lack of support for the locale in iOS). +
Requesting pretranslation
+For locales supported by Google AutoML Translation, it’s possible to request to enable pretranslation for specific projects from a Team page.
+
The button is only displayed to translators and team managers for the locale.
+Click on REQUEST PRETRANSLATION, select the projects to add and then click REQUEST PRETRANSLATION (at least one project needs to be selected for the button to be displayed).
An email will be sent to Pontoon’s administrators, and they will act on the request. Please note that:
+-
+
- If a locale doesn’t have pretranslation enabled for any projects yet, it’s necessary to set up and train a new custom model, and this operation requires several hours. +
- For
pontoon.mozilla.org, each request will be evaluated against specific opt-in guidelines.
+
Translation memory management
+The TM (translation memory) tab lists all TM entries for the team. A source string and translation are provided for each entry, which upon clicking leads to the translation workspace for the corresponding strings. Entries are only shown once for each unique combination of source string and translation. TM entries can be searched by source string or translation using the Search field.
The following actions are available:
+-
+
- Edit: after clicking the
Editbutton in the Actions column, the translation of the TM entry transforms into a textarea element and becomes editable. Next to it,SaveandCancelbuttons appear. ClickingSavesaves any changes to all corresponding TM entries and clickingCancelcancels the editing action.
+ - Delete: after clicking the
Deletebutton in the Actions column, the button changes into theDelete N TM entries?confirmation button (with N representing the number of corresponding TM entries). Clicking that button deletes all corresponding TM entries and clickingCancelcancels the editing action.
+ - Upload .TMX: after clicking the
Upload .TMXbutton above the TM entry list, an Open file dialog pops up. The user then selects the TMX file to upload, the TM entries from the file start to import into the team's TM, and eventually a success or error message appears.
+
Projects
+Projects page
+The Projects page lists all projects that are available in Pontoon. It can be reached by clicking Projects in the page header (not displayed when translating a project) or by using the /projects URL (e.g. pontoon.mozilla.org/projects). Clicking on a specific Project page will open the project’s Project page.
Project page
+Access a project’s page by selecting it from the Projects page (e.g. pontoon.mozilla.org/projects).
+The page header contains useful information about the current project:
+-
+
- Priority: priority from 5 stars (highest) to 1 star (lowest). +
- Target date: set only for some projects, it indicates when the translation is due. +
- Repository: link to the repository storing translations for this project. +
- Resources: links to useful external resources (e.g. testing instructions, screenshots, etc.). Project managers can set up custom links for each project. +
- Project manager: point of contact for this project. +
It also includes an indication of the overall status of completion and statistics across all enabled languages.
+
Underneath the header, the following tabs are available to navigate between various Team page panels:
+-
+
- Teams: a list of all locales enabled in Pontoon for this project. +
- Tags: a list of tags defined for this project. This tab will be visible only in projects where tags are enabled. For more information about tags, see [this page]translation_workspace.md#tags). +
- Contributors: a list of active contributors with their statistics, filterable by time (all time, last 12/6/3/1 months). +
- Insights: data and trends on contributor and localization activity. +
- Info: information about the project. +
By default, the Teams tab opens, showing a list of all locales enabled for the project. Clicking on one of these locales leads to the Localization page.
+Requesting a locale
+It’s possible to request an additional locale for some projects from its Project page.
+
Click on REQUEST NEW LANGUAGE, select the locale to add and then click REQUEST NEW LANGUAGE.
An email will be sent to Pontoon’s administrators, and the Project manager in charge of the project will act on the request. The same restrictions described in the Requesting a project section apply here.
+Localization page
+Access a project’s Localization page in two ways:
+-
+
- By selecting it from the Team page. +
- By selecting it from the Project page. +
The page header contains useful information about the current project (same as the Project page).
+
Underneath the header, the following tabs are available to navigate between various Team page panels:
+-
+
- Resources: files available in the project. +
- Tags: a list of tags defined for this project. This tab will be visible only in projects where tags are enabled. For more information about tags, see this page. +
- Contributors: a list of active contributors with their statistics, filterable by time. Unlike the tab available in the Team page, this only includes contributions to localization of the project for the current locale. +
- Insights: data and trends on contributor and localization activity. +
- Project info: same content as the Info tab in the Project page. +
- Team info: same content as the Info tab in the Team page. +
Insights graphs
+The Insights tab, accessible from either the Project, Team, or Localization page, displays data and trends on contributor and localization activity in a graphical format.
+The following insights appear on all pages:
+-
+
- Review activity: shows the number of unreviewed suggestions as a trend line. The Team page also shows the number of peer-approved, self-approved, and rejected suggestions for each month as a bar graph to display the impact of the review process on the number of unreviewed suggestions. New suggestions (hidden by default) can also be shown by clicking
New suggestionsat the bottom of the graph. Hover over a data point to get the detailed number of strings and percentages for that month.
+ - Translation activity: shows the translation completion percentage for the locale as a trend line. The Team page also shows the number of human translations and machinery translations for each month as a bar graph to display the impact of the translation process on the number of completed translations. New source strings (hidden by default) can also be shown by clicking
New source stringsat the bottom of the graph. Hover over a data point to get the detailed number of strings and percentages for that month.
+
The following insights only appear on Team pages:
+-
+
- Active users: shows the ratio of active versus total for each user role: managers (Team managers), reviewers (Team managers and Translators), and contributors, filterable by time period (last 12/6/3/1 months). +
- Time to review suggestions: shows the average age of suggestions reviewed for a particular month, and the 12 month average. Hover over a data point in the graph to see the exact age in days for that month’s current and 12 month average. +
- Age of unreviewed suggestions: this can be accessed by clicking
Age of unreviewedon the bottom of the Time to review suggestions graph. Shows the average age of unreviewed suggestions at a particular point in time. Hover over a data point in the graph to see the exact age in days for unreviewed suggestions for that month.
+
Note: clicking on the i icon in the top right of each insight will provide detailed definitions for the data shown.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/pontoon/translation_workspace.html b/tools/pontoon/translation_workspace.html
new file mode 100644
index 00000000..eed205b9
--- /dev/null
+++ b/tools/pontoon/translation_workspace.html
@@ -0,0 +1,514 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ How to translate
+This document describes briefly how to translate and review strings in Pontoon and provides an example of translation workflow within a team. The documentation also includes a dedicated page about Pontoon’s translation workspace, including translation tools.
+Translating strings
+When a string is selected in the sidebar, users can input a translation using the editor available in the middle of the page. Note that, if the string already has a translation, the editor will be pre-populated with text that the user can modify.
+Depending on the current translation mode, the UI will look slightly different.
+When the user is in Suggestion Mode — manually selected, or because the user doesn’t have permissions to submit translations directly — a blue SUGGEST button will be displayed in the lower-right side of the editing space.
To suggest a translation, the user can input the text in the editor and click SUGGEST. The suggestion will then be displayed below the editing space and in the sidebar where, in the case of multiple suggestions, only the most recent one will be displayed.
Note that a suggestion exists only in the Pontoon database, and it’s not added to the translation memory. For projects using version control systems, the translation is not stored in localized files outside of Pontoon.
+When the user is in Translation Mode, a green SAVE button will be displayed instead of SUBMIT. When saving a translation:
-
+
- The translation will be displayed directly below the editing space and in the sidebar. +
- The translation will be stored in the version control system (where applicable). +
- All pending suggestions or pretranslations will be rejected. +
Manually switch to suggestion mode
+Even if the user has permissions to add translations directly, submitting suggestions to be reviewed by another person helps ensure quality. To manually switch to Suggestion Mode, click the settings icon in the lower-left side of the editing space and select Make suggestions. The SUGGEST button will be displayed in the lower-right side of the editing space, replacing the green SAVE button.
To switch back to Translation Mode, click the settings icon again and turn off Make suggestions.
Reviewing strings
+To review a suggestion or pretranslation, search for unreviewed or pretranslated strings in the sidebar.
+If the current translation is acceptable, either click on the APPROVE button in the lower-right side of the editing space, or click on the approve icon to the right of the text. This will transform the suggestion or pretranslation into an approved translation. In the case of suggestions, the approved translation will also be stored in the version control system (where applicable).
If the current translation is not acceptable, it can be rejected by clicking the reject icon to the right of the suggestion. After rejecting a suggestion or pretranslation, it’s also possible to delete it completely by clicking the trashcan icon. In the case of pretranslations, the rejected text will be also removed from version control systems (where applicable).
+Alternatively, it’s possible to provide a different suggestion: turn on Make suggestions, edit the translation as appropriate, and click SUGGEST. This will add the translation as a new suggested string.
Quality checks
+When submitting a translation or suggestion, Pontoon performs automated quality checks. They are meant to help localizers identify issues with punctuation, capitalization, variables, etc. before translations are saved. Failures for these checks are stored in the database, and it’s possible to filter strings with issues from the search bar.
+There are two types of quality check failures: errors and warnings.
+Errors
+Errors cover critical issues that would cause the string to be removed from products. For this reason, errors cannot be bypassed by localizers - the button to submit a translation is removed and the error needs to be fixed before the translation can be saved.
+Examples include exceeding the maximum string length, incorrect syntax, etc. Errors are denoted with a circled X with red background.
+
Warnings
+Warnings are displayed when potential issues are detected in the string, but it’s not certain that they will create problems in products (unlike errors). For that reason, warnings can be bypassed by localizers, allowing them to save a translation anyway.
+Examples include missing punctuation, differences in number of sentences and capitalization, etc. Warnings are denoted with a circled X with gray background.
+
Certain types of checks reported by the Translate Toolkit library may result in many false positives. For this reason, they can be completely disabled.
+Performing batch actions on strings
+Mass actions can be performed on multiple strings at once by clicking on the square to the left of any string in the sidebar. When clicked, the square will show a checkmark and the editing space will show the mass action panel. Note that mass actions are only available to users with translator permissions.
+
To select a range of strings, select the first one and hold SHIFT, then select the last one. To select all strings, click SELECT ALL on the top-right of the mass action panel. The number of selected strings will appear on the top-left, next to the Exit icon.
To return back to the default editing space, click the Exit icon on the top-right of the mass action panel.
+In the REVIEW TRANSLATIONS section, the user can approve or reject suggestions for all selected strings. Upon clicking APPROVE ALL or REJECT ALL SUGGESTIONS, the label of the button will be replaced with the number of affected translations.
+Note that APPROVE ALL accepts the latest suggestion, but doesn’t reject other suggestions if available.
In the FIND & REPLACE IN TRANSLATIONS section, the user can input the text to search for, and the text to replace it with. This is a basic find and replace feature that will work only on the selected strings.
Downloading and uploading translations
+Pontoon provides the ability to download and upload translations, including terminology and translation memories. To access these features, click on the profile icon in the top-right corner of any page. Note that the user must be in the translation workspace for the download/upload options to be displayed in the dropdown menu.
+
Anyone can download terminology (.tbx), translation memory (.tmx) and translations, while only users with translator permissions can upload translations. When downloading translations:
-
+
- The resource currently selected is downloaded in its original format, it’s not converted in any way. +
- If the project contains multiple files, a ZIP of all files is downloaded. If the project contains more than 10 files, only the file currently translated will be downloaded. +
When uploading translations to Pontoon:
+-
+
- Translations different from the ones in Pontoon will be imported and attributed to the user uploading the file. +
- Translations matching the ones in Pontoon will be ignored. +
Downloading .tbx and .tmx files via command line
+Terminology (.tbx) and translation memory (.tmx) files can grow big in size over time. To download files via command line it is advised to use curl command with the --compressed flag, to reduce download times and avoid request timeouts.
Here’s an example command to download German (de) .tmx file across all projects from pontoon.mozilla.org:
curl -o de.all-projects.tmx --compressed https://pontoon.mozilla.org/translation-memory/de.all-projects.tmx
+Note that Terminology files can be downloaded in the TBX 2008 (v2) format in addition to the default TBX v3 format available via the profile menu.
Here’s an example command to download German (de) .tbx file in the TBX 2008 (v2) format from pontoon.mozilla.org:
curl -o de.v2.tbx --compressed https://pontoon.mozilla.org/terminology/de.v2.tbx
+Workflow example
+This workflow utilizes the full power of Pontoon’s online translation features. It assumes that at least two translators are available for the project (AB workflow); however, this workflow can be completed by a single translator performing each phase (AA workflow), or by multiple translators in an ABCn workflow repeating Phase 3.
+Phase 1: translation
+Translator A
+-
+
- Log in to Pontoon. +
- Browse to the project. +
- Using filters select
Missingto display only the strings currently missing a translation, marked as fuzzy or containing errors.
+ - Access personal settings by clicking on the gear icon below the editing field and turn on
Make suggestions.
Note that new contributors who have not yet been granted Translator permissions will only have the ability toMake suggestions, which will be enabled by default.
+ - For each string, type a translation and save it with the blue
SUGGESTbutton. The string will be stored and displayed under the editor. Each translation submitted shows the name of the author and when it was saved. +-
+
- If something is unclear or there is a question about the source string, use the REQUEST CONTEXT or REPORT ISSUE feature to ask the Project manager. +
+
General notes:
+-
+
- Rely on Pontoon’s translation tools to ensure consistency and make the translation process faster. +
- When using Firefox, make sure to have a dictionary installed for the translation language, and that spell checking is enabled in the translation text area. +
Phase 2: review suggestions
+Translator B
+-
+
- Log in to Pontoon. +
- Browse to the project. +
- In filters select
Unreviewed, to isolate the strings previously suggested by another translator.
+ - Review the suggested strings.
+
-
+
- If a suggestion is acceptable:
+
-
+
- Confirm it as an approved translation by clicking the green
SAVEbutton or the checkmark icon near the string in the list below the editor (it turns green when hovered).
+
+ - Confirm it as an approved translation by clicking the green
- If a suggestion is not acceptable:
+
-
+
- Switch to Suggest mode. Edit the translation in the editing space and click the blue
SUGGESTbutton. The newly suggested version will not overwrite the translator’s work, but instead will appear at the top of the list under the editor.
+
+ - Switch to Suggest mode. Edit the translation in the editing space and click the blue
- Use translation comments to discuss a translation with the other translator. For example, discussing possible alternate translations or asking questions when something isn’t clear. +
+ - If a suggestion is acceptable:
+
Phase 3: implementing QA
+Translator A
+-
+
- In the project, select
Unreviewedfrom the filter search. Then compare the initial entries with those of the reviewer for changes.
+ - Review the remaining strings:
+
-
+
- If in agreement, confirm the reviewer’s version by clicking the green
SAVEbutton or the checkmark icon near the string in the list below the editor (it turns green when hovered).
+ - If suggesting an alternative, type it into the editor, then hit the blue
SUGGESTbutton. Then resubmit it to the reviewer from Phase 2.
+ - Reject suggestions not considered suitable by clicking on the cross icon near the string (it turns red when hovered). +
- If Translator A does not have the Translator or Team manager role, they will be unable to confirm or reject a suggestion. In that case, use translation comments to discuss the translation with the reviewer. +
+ - If in agreement, confirm the reviewer’s version by clicking the green
Repeat, switching translators, until a consensus is reached.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/pontoon/ui.html b/tools/pontoon/ui.html
new file mode 100644
index 00000000..d5a36421
--- /dev/null
+++ b/tools/pontoon/ui.html
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Understanding Pontoon’s translation workspace
+-
+
- Main toolbar +
- String list and search + + +
- Main editing space
+
-
+
- String navigation +
- Source string
+
-
+
- Context +
+ - Editor + + +
- Translation list + + +
+ - Fluent - FTL files +
- Translation tools and comments + + +
- Smaller screens +
Pontoon’s translation workspace consists of the main toolbar and 3 columns:
+-
+
- The left column contains the string list for the current resource with a search field at the top. +
- The middle column contains the main editing space. +
- The right column contains terminology, source string comments, suggestions from translation memory, machine translation, and translations from other locales. +
Main toolbar
+The main toolbar at the top of the page allows users to navigate to the dashboards or to change the current resource.
+
Clicking the locale name will open the Team page for that locale, while clicking the project name will open the Localization page for that project.
+Clicking on the current resource (or All Resources) will display a list of all resources available for that project. It’s possible to search for a resource, and click one to load only the entities included in it. Clicking All Resources at the bottom of the list will go back to display all resources, while All Projects will show entities for all projects under the selected locale.
A progress chart showing the translation status of the current resource is located to the right of the resource name. A more detailed breakdown is displayed when clicking the chart.
+
The notifications icon, represented by a bell, is located on the right side of the main toolbar. By clicking the bell icon, users can view a list of the latest notifications they received.
+The profile menu is located at the far right of the main toolbar. Clicking the profile image will reveal a dropdown menu where users can perform several actions, like navigate to their profile page, download and upload translations, change their theme, etc.
+
Note that some profile menu items are only available to users with specific permissions.
+A selector to change the current theme is available in the profile menu and in the settings page. There are three theme options available:
+-
+
- Light. +
- Dark. +
- Match system (aligns with the theme used by the operating system). +
To change the theme, select the button corresponding to your preferred theme. The change will take effect immediately.
+String list and search
+The left column displays the list of strings in the current project resource. Each string is represented by:
+-
+
- A colored square that identifies the string status (i.e. Missing, Translated, etc.). +
- The source string. +
- The approved translation or the most recent suggestion if available. +
Color legend:
+-
+
- gray: translation is missing. +
- green: string is translated. +
- light-green: string is pretranslated. +
- orange: translation has warnings. +
- red: translation has errors. +
When a string is selected in the sidebar, a small icon with four arrows is displayed near the checkbox: this can be used to show strings that surround the selected string in the resource, bypassing the current filter. This is often helpful to provide more context for the localization, especially when translating missing strings.
+
Search
+It’s possible to search within the currently selected project using the search field. Searches include strings and string IDs.
+
Note that searches take active filters into account, for example a search would be performed only on missing strings if that filter was previously selected.
+Like in search engines, by default Pontoon will display matches that contain any of the search terms. For example, searching for new tab will match both Open links in tabs instead of new windows and New Tab.
To search for an exact match, wrap the search terms in double quotes, e.g. "new tab". On the other hand, to search for strings that contain double quotes, escape them with a backslash, e.g. \".
Search options
+In addition to the search filters listed below, Pontoon provides additional search options, allowing users to refine search results. Search options can be accessed by clicking the magnifying glass icon on the right side of the search box.
+
Search options include:
+-
+
- Match case: Exactly match the capitalization of the search term. +
- Match whole word: Provides the same result as surrounding a word with double quotes, exactly matching the search term (case insensitive), and avoiding partial matches. +
- Include string identifiers: Expand the search to include string identifiers (keys). +
- Include rejected translations: Expand the search to include translations that have been rejected. +
- Exclude source strings: Avoid searching for matches in source strings. +
All search options are disabled by default. Clicking anywhere on the name or checkbox will toggle only the specific search option. Once ready, clicking the APPLY SEARCH OPTIONS at the bottom of the panel will apply the selected search options.
Filters
+Translation status
+Strings in Pontoon can be filtered by their status. A string can be in one of the following statuses:
+-
+
- Translated: string has an approved translation. The translation is saved to the localized file when using a version control system (VCS). +
- Pretranslated: string has been pretranslated but has not been reviewed. Unreviewed pretranslation are saved to the localized file when using a VCS. +
- Warnings: string contains issues classified as warnings. +
- Errors: string contains critical issues. +
- Missing: string doesn’t have any approved translations. +
- Unreviewed: string has suggested translations that have not been reviewed yet by someone with the appropriate permissions. Note that, for both translated and missing strings, the suggested translation only exists within the Pontoon database and is not saved to the localized file when using a VCS. +
Extra filters
+In addition to statuses, additional filters can be used to further refine the list of strings. Extra filters include:
+-
+
- Unchanged: string is identical to the reference language (normally
en-US).
+ - Empty: string has a translation, but translation contains no content. +
- Fuzzy: string is marked as fuzzy in the localized file. +
- Rejected: string has rejected translations. +
- Missing without Unreviewed: string has
Missingtranslation status and does not haveUnreviewedtranslations.
+
Filters can be accessed by clicking the icon on the left of the search field.
+
At this point it’s possible to:
+-
+
- Click directly on the name of one of the filters. This will select and activate only this filter, and the search field placeholder will change accordingly. For example, clicking on
Missingwill show only missing strings, and the placeholder will readSearch in Missing.
+ - Click on one or more filter icons or user avatars (multiple filters can be applied at once). Hovering over the icons transforms the icon into check marks. Clicking an icon will select that filter and a new button
APPLY X FILTERSwill appear at the bottom of the panel, whereXis the number of active filters.
+ - Click
EDIT RANGEonTRANSLATION TIMEto select a time range. Pick one of the defaults (30 days, 7 days, 24 hours, 60 minutes), or use the date picker (or slider) to adapt the range. Click onSAVE RANGEto store the range as a filter. A new buttonAPPLY X FILTERSwill appear at the bottom of the panel, whereXis the number of active filters.
+
In this case 3 filters are selected.
+Tags
+For specific projects it’s also possible to filter strings based on tags. Tags are used to logically group resources based on their priority, allowing localizers to focus their work on important strings first, and project managers to better assess the overall localization status of the project.
+
In this case, there are 10 tags defined for the project (highlighted in red). Near each tag there is a representation of the priority: like for projects, it goes from 5 stars (highest priority) to 1 star (lowest priority).
+Note: translation time, translation authors, and tags are not available when All Projects is selected as a resource.
Main editing space
+The main editing space in the middle column is where translation takes place.
+
String navigation
+The top of this space contains a string navigation interface. It’s possible to navigate sequentially through the strings by clicking the PREVIOUS or NEXT buttons located at the top of the editing space, or by using keyboard shortcuts (ALT + arrow down or up). A link to the current string can be copied to the clipboard using the COPY LINK button.
Source string
+Below the navigation interface, the user can view the source string, any comments present in the resource regarding the string, and the resource path where the string is located.
+In the same area, the REQUEST CONTEXT or REPORT ISSUE button can be used to request more information about the current string: it will focus the COMMENTS section, and mention the project manager for the project.
Context
+Sometimes you may want to investigate more context about a particular string through an external resource such as a Version Control System. The CONTEXT information provided underneath the source string shows the identifier, file, and project for the string — allowing you to find the string within the codebase of the project. For example, for some Mozilla projects these can be used to track strings to bugs.
Editor
+The editor is located in the middle section of the column, and it’s where users can input or edit their translations.
+In the lower-right side of the editing space, it’s possible to COPY the source string to the editor, CLEAR the area where translations are typed, and SUGGEST or SAVE the translation by clicking the corresponding button. This area is also used to display warnings and errors when submitting a translation.
In the lower-left side:
+-
+
- Clicking the gear icon allows users to toggle
Translation Toolkit checksorMake suggestions, and navigate to the user settings. Note that access to some settings is restricted by user permissions.
+ - Clicking the keyboard icon displays a list of available shortcuts. +
- The numbers displayed to the right of the keyboard icon (e.g.
50|59) are the number of characters in the target and source string.
+
Read-only projects
+A project could be enabled in read-only mode for some locales: their translations will be available to other languages in the LOCALES tab, but it won’t be possible to change or submit translations directly in Pontoon. In this case, a note is displayed in the bar below the editor, and all other controls are hidden.
Translation list
+The space below the editor displays the list of translations for the current string.
+Each entry contains:
+-
+
- The name of the translator, their profile picture (linking to their profile page) and their banner (see User banners). +
- How long ago the entry was submitted (hover over to see the full date and time as a tooltip). +
- The translation. +
- Icons indicating translation status (see below). +
- Translation comments. +
Icons to the right indicate the status of each translation:
+-
+
- The solid green circle with checkmark indicates that the translation has been approved. +
- The outlined lime green circle with checkmark indicates a pretranslation that has not yet been reviewed. +
- If both icons are gray, translation has been suggested but not yet reviewed. +
- The red cross indicates that the translation has been rejected. The entire element will look opaque. +
- The trashcan, available only for rejected translations, can be used to completely delete a translation. Those with the contributor role can only remove their own translations, while those with a translator permissions can delete anyone’s. +
In the screenshot above, the first item is the approved translation (green checkmark), while the other two are rejected suggestions.
+User banners
+User banners provide immediate context about a user to other community members. They indicate either the role of the user, or that the user is new to Pontoon. Banners are displayed at the bottom of the user's avatar.
+
The available user banners are:
+-
+
MNGRfor team managers.
+TRNSLfor translators.
+PMfor project managers.
+ADMINfor administrators.
+NEWfor users who have joined within the last 3 months.
+
User banners will also appear in translation comments (see below).
+Translation comments
+By clicking the COMMENT button it’s possible to add a translation comment to this specific translation. To mention another user in the comment, start typing @ followed by their name.
If there is already a comment associated with a string, the button will display the number of comments (e.g. 1 COMMENT for the first rejected suggestion).
Viewing translation differences
+The DIFF option appears if there are multiple translations for one string. Toggling DIFF compares the text to the current approved translation, or the most recent suggestion if no translation has been approved yet. Text highlighted in green indicates content that has been added, while strikethrough text in red indicates removed content. Toggling DIFF again will display the original string.
Fluent - FTL files
+When working on FTL (Fluent) files, the editing space will look slightly different.
+
In the example above, the string has a value and an attribute title. Both are displayed in the source section (highlighted in red), and available as separate input fields in the editor (highlighted in orange).
The following image is an example of a string with plurals: while English only has two forms, plural and singular, other locales can have a different number of plural forms. In this case, Russian has three forms (highlighted in orange).
+
In the bottom left corner, the FTL button (highlighted in yellow) allows to switch between the standard UI (Simple FTL mode) and the Advanced FTL mode, where it’s possible to edit the original syntax directly, as you would in a text editor. For details on the Fluent syntax, see Fluent for localizers.
+
Note that the FTL button’s text is green when in Advanced FTL mode.
+Translation tools and comments
+Built-in translation tools are located in the rightmost column.
+Terminology
+The TERMS tab shows the definition and translation of a term, in case the source string includes matches with the built-in terminology. The matching term is also highlighted in the source string. A popup appears on click showing the definition and translation for a term.
Source string comments
+The COMMENTS tab is used to display existing source string comments, or add new ones. Source string comments, unlike translation comments, are associated with the string: it’s possible to have a comment in this section even if the string doesn’t have any suggestion or translation yet.
They’re designed for team members to have a conversation about the source string, for example to clarify its meaning, or to get more information from project managers.
+Administrators can pin or unpin a source string comment: this pinned comment will be displayed along existing comments in the editing area as PINNED COMMENT, and users will receive a notification.
The screenshot above shows a pinned comment, and the command to unpin it.
+Machinery
+Machinery shows possible translations from a variety of sources. These sources include:
+-
+
- Pontoon’s internal translation memory. +
- Microsoft Terminology. +
- Google Translate. +
- SYSTRAN. +
- Caighdean. +
- Bing Translator (not currently enabled on pontoon.mozilla.org). +
In addition, the user has the ability to search for translations containing words via Concordance search.
In the tab, the number of entries is visible alongside the MACHINERY title in white. If any of the machinery matches are from translation memory, the number of matches will appear separately in green. For example, the screenshot below shows 2+1, where the green 2 represents the two matches from translation memory and the 1 represents a machinery entry from Google Translate.
At the top of each entry, a diff view compares the current source string and the source string from the machinery entry. Strikethrough text highlighted in red indicates text that is present in the source string but not in the machinery source string, while text highlighted in green indicates text available only in the machinery source string.
+To the right of the entry, the number in green shows the percent match between the machinery source string and the current source string. The higher the percentage, the more likely machinery is to be useful; a 100% match indicates that the sources for the current string and for the machinery string are identical.
+The origin of the machinery entry is listed in gray above the source string. Clicking the gray text will open the origin in a new window. The green superscript to the right indicates the number of matches for the entry in the translation memory.
+Be careful when using the machinery tab as suggestions may not match the source string for the project being translated. Even if the source strings match, the context in which strings are used may not be the same. This could lead to incorrect or unnatural translations. Always keep the meaning and purpose of the string being translated in mind when using the machinery tab.
+Large language model (LLM) integration
+Pontoon will show a dropdown labeled AI for all locales that have Google Translate available as a translation source. This feature refines the Google Translate output using an LLM. Opening this dropdown will reveal three options:
-
+
REPHRASE: Generate an alternative to this translation.
+MAKE FORMAL: Generate a more formal version of this translation.
+MAKE INFORMAL: Generate a more informal version of this translation.
+
After selecting an option, the revised translation will replace the original suggestion. Once a new translation is generated, another option SHOW ORIGINAL will be available in the dropdown menu. Selecting it will revert to the original suggestion.
Concordance search
+Concordance search allows users to search across all projects in Pontoon. Users can search for translations using strings in either source or target language. Matching results are displayed with the source string, translation, and project name; clicking a result will automatically fill the translation into the editor. Note that the search does not need to be related to the current string or project.
+
Stand-alone machinery
+Pontoon machinery is also available as a stand-alone web page. Use the Machinery link in the main navigation to access the page (this is not accessible from the translation workspace).
To use the machinery, select the target locale from the dropdown menu to the right of the searchbar. Then input the English source string into the searchbar and press Enter. This will display all matching machinery entries. Information is organized exactly as in the translation workspace.
+Locales
+The locales tab shows approved translations from Pontoon projects in other locales.
+
Next to the LOCALES title, the number of available entries is visible. The number for preferred locales is green, while the number for all other locales is in gray.
Users can select locales to appear at the top of their Locales tab as a preferred locale. To add a locale to the preferred locale list, access the user settings page.
+Entries in the LOCALES tab above the green line are preferred locales. Non-preferred locales are displayed below the green line, sorted alphabetically by language name.
Each row displays the translation for the source string in the selected locale. Above each entry, the language name is visible in gray, while the locale code is displayed in green.
+The LOCALES tab is useful for seeing what general style choices are made by other localization communities. When encountering a difficult string, a translator can use other locales as a source of inspiration.
Note that, when using the LOCALES tab, the translator should always opt for fluency in their own locale. Languages vary linguistically on many levels. The locales tab can be extremely useful, but should be used carefully, and rarely as the sole translation resource for translation.
Smaller screens
+The translation workspace is responsive, which means the layout will adapt to smaller screens. Everything you do on your desktop computer or laptop, you can also do on your phone or tablet: review strings, fix typos or even translate a few strings on the go.
+
Redirecting to... https://mozilla-l10n.github.io/localizer-documentation/tools/pontoon/translation_workspace.html.
+ + diff --git a/tools/pontoon/users.html b/tools/pontoon/users.html new file mode 100644 index 00000000..5558989b --- /dev/null +++ b/tools/pontoon/users.html @@ -0,0 +1,341 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/pontoon/workflow.html b/tools/pontoon/workflow.html
new file mode 100644
index 00000000..16819315
--- /dev/null
+++ b/tools/pontoon/workflow.html
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email
+
+
+
+
+ User accounts and settings
+ +Creating an account
+While Pontoon can be configured to use different login systems (Django, GitHub, etc.), the Mozilla instance hosted at pontoon.mozilla.org uses Firefox accounts.
+To create an account, click on the Sign In button in the top right corner and follow the instructions.
User settings
+User settings can be accessed by:
+-
+
- Clicking the user avatar in the top right corner, and selecting
Settingsfrom the dropdown menu.
+ - Opening the
/settingsURL directly (e.g. pontoon.mozilla.org/settings).
+ - Using the
CHANGE SETTINGSbutton in the Profile page.
+
Profile picture
+The profile picture can be set or updated on Gravatar by clicking the image displayed at the top of the settings page (when hovered, the picture will display an Update profile picture message).
Personal information
+In this section it’s possible to update the display name and other personal information:
+-
+
Display name: it’s the name displayed in Pontoon, for example when submitting a translation or suggestion. It’s also used as the author name when committing translations to version control system (i.e. git or hg repositories).
+Username: this is currently used to generate the URL for the Profile page (e.g.https://pontoon.mozilla.org/contributors/USERNAME/). If not provided, a hash will be used instead of the username.
+Bio: a short text that will be displayed in the Profile page.
+
In this section it’s possible to update the display name and other personal information:
+-
+
Contact email address: if provided, this email address will be used for email communications and displayed in the Profile page instead of the login email address.
+News and updates: if enabled, you will get the latest updates about localization at Mozilla, announcements about new Pontoon features, invitations to contributor events and more.
+Monthly activity summary: if enabled, you will get an email summary of your personal activity and the activity within your teams for the previous month.
+
Notification subscriptions
+Pontoon can send internal notifications to users for specific events. All notifications are enabled by default, but can be disabled by using the corresponding checkbox.
+Additionally, for each notification type, users can choose to receive email updates in a digest format. These email digests can be scheduled to arrive either daily or weekly, depending on the user’s selection.
+For more information about this topic, refer to the page dedicated to notifications.
+External accounts
+In this section it’s possible to specify the username used in external accounts, like GitHub or Bugzilla. If provided, this information will be displayed in the Profile page.
+Visibility of data on the Profile page
+Users can determine the visibility of fields containing personal information — like email address or external accounts — and statistics about their contribution. From the smallest audience to the largest, a field can be visible to:
+-
+
Translators: these are users with translator permissions in Pontoon, independently from the locale. The rationale is that translators need to have access to specific information to either contact a contributor during review, or check stats about their previous contributions.
+Logged-in users: these are users logged-in to Pontoon, independently from their permissions.
+Public: this includes all users and not logged-in visitors.
+
These are the available data fields:
+-
+
Email address: by default, this field is only visible to translators. Visibility can be expanded to all logged-in users, but it’s always hidden to visitors to reduce the risk of spam. This setting is ignored for team and project managers, as their email address is always visible to logged-in users.
+External accounts: by default, this data is only visible to translators, but it can be made public.
+Approval rateandSelf-approval rate: by default, these fields are set as public, but can be limited to translators.
+
Appearance
+The user can chose between a light and dark combination of colors for Pontoon. There are three theme options available:
+-
+
- Light. +
- Dark. +
- Match system (aligns with the theme used by the operating system). +
To change the theme, select the button corresponding to your preferred theme. The change will take effect immediately.
+Editor
+Translation Toolkit Checks (checks for number of sentences, placeholders, HTML tags, punctuation, etc.) are performed when saving a translation. For more information about quality checks, see this document.
Make suggestions allows a translator or a team manager to submit suggestions instead of translations. This setting is also displayed to users with translator permissions.
Locale settings
+It’s possible to set the default homepage displayed when visiting Pontoon as a logged-in user. Current options are:
+-
+
- Default homepage (Pontoon’s homepage). +
- A Team page. +
Preferred source locales can be used to display a different source locale when translating. In Mozilla projects, the source locale is always English (en-US).
Preferred locales can be used to display a specific group of locales before others in the LOCALES tab when translating strings. In the image below, the user chose to display fr and es-ES before other translations — ordered alphabetically based on the locale name. Since they’re both available the tab displays 2+118, meaning 2 preferred locales plus all others.
User roles
+There are five user roles in Pontoon:
+-
+
- Contributors can only submit suggestions. This is the default role for new users. +
- Translators can submit translations directly in a specific locale, and review other contributors’ suggestions. +
- Team Managers can perform the same actions as translators, but also manage other users and update their permissions. +
- Project Managers don’t have translator permissions, but they act as the point of contact for a specific project. Their name is displayed in the header of Project and Localization pages, and using the
REQUEST CONTEXT or REPORT ISSUEfunction will tag them in a comment.
+ - Administrators can manage Pontoon, e.g. adding or removing projects, and act as Team Managers for all locales. +
Managing permissions
+A Team Manager can upgrade other users’ permissions within a locale. To manage users, open the team page and select the PERMISSIONS tab (it will only be visible to Team Managers and Administrators).
By default there’s only a General section: permissions defined here will apply to all projects, but can be overridden by custom project permissions.
To move a user to a different column, hover the email address: arrows will appear to move the element to the left or right. Note that a user needs to log in at least once in Pontoon in order to upgrade their permission – simply having an account is not sufficient.
+Use the SAVE button to store the configuration before leaving this window.
By default, the TEAM CONTRIBUTORS column will only include users that have already submitted suggestions for this locale. Click ALL USERS (highlighted in red) to display all existing users, then use the search field to narrow down the list.
By clicking ADD CUSTOM PERMISSIONS PER PROJECT (highlighted in orange), it’s possible to add specific permissions for a project. This can be useful to make sure that only some users can submit translations for a specific project, for example if it’s maintained by one person.
Note that:
+-
+
- The list of translators defined for a specific project overrides the list defined in the
Generalsection. If a user needs to be able to translate all projects, they need to be listed in all custom permissions on top of theGeneralsection.
+ - It’s not possible to override Team Managers, as they will always be able to submit translations in any of the projects available for their locale. +
Redirecting to... https://mozilla-l10n.github.io/localizer-documentation/tools/pontoon/translate.html#workflow-example.
+ + diff --git a/webprojects/amo.html b/webprojects/amo.html new file mode 100644 index 00000000..0d23033a --- /dev/null +++ b/webprojects/amo.html @@ -0,0 +1,288 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/webprojects/fundraising.html b/webprojects/fundraising.html
new file mode 100644
index 00000000..73e8ff2b
--- /dev/null
+++ b/webprojects/fundraising.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Addons.mozilla.org (AMO): how to localize and test
+Product at a glance
+AMO refers to https://addons.mozilla.org/. It is one of Mozilla’s biggest web properties, with 12 million users per month. The product consists of three key components that require localization:
+-
+
- AMO server is the backend component of AMO. +
- AMO frontend covers the top page of
about:addonsand the user-facing pages of addons.mozilla.org on Firefox for Android.
+ - Discovery Pane is home of curated add-ons available on
about:addons.
+
Product updates are deployed every Thursday to production. Localizable strings can be extracted on Tuesdays, strings localized by 5pm UTC each Tuesday go live on Thursday. To report a problem, you can use GitHub issues.
+Now let’s take a look of these components in greater details.
+AMO and AMO frontend
+addons-server
+Addons-server is the default front-end for desktop users of AMO. It is also the API backend and home to the developer hub and reviewer tools.
+addons-frontend
+Addons-frontend is the default frontend for mobile user-agents, and it will eventually replace the addons-server frontend for user-pages.
+Test the server and the frontend
+The strings will be available on Dev or Staging server at different times. See this section for details.
+-
+
- Dev: https://addons-dev.allizom.org/ +
- Staging: https://addons.allizom.org/ +
- Production: https://addons.mozilla.org/ +
The hosts for the new frontend are the same as addons-server, except to display the new frontend, you either need:
+-
+
- Click View mobile site in the footer (this will set a
mamocookie with the valueonon your system).
+ - A Mobile user-agent string. +
Disco Pane app and editorial content
+The AMO Frontend (addons-frontend) repository is also home to the Disco Pane, short for Discovery Pane. This is the site that contains curated add-ons available by typing about:addons in the address bar. Another way to reach it is by clicking Tools in the menu bar, select Add-ons in the dropdown menu, and click Get Add-ons on the left panel. While this looks like it’s part of Firefox, it’s actually a remote web page.
The content for the Disco Pane is available for translation in the AMO (addons-server) project.
+Test the Discovery Pane
+The strings will be available on Dev or Staging server depending on when they were committed. See this section for details.
+The hosts for the Disco Pane are:
+-
+
- Dev:
https://discovery.addons-dev.allizom.org/.
+ - Staging:
https://discovery.addons.allizom.org/.
+ - Production:
https://discovery.addons.mozilla.org/.
+
The actual link is automatically generated and depends on the locale, operative system and version of Firefox. To get the correct production link for your system, you can open the Browser Console from Tools > Web Developer, copy and paste this code snippet in the input area at the bottom of the window, and press enter:
+Services.urlFormatter.formatURL(Services.prefs.getCharPref("extensions.webservice.discoverURL").replace("%COMPATIBILITY_MODE%", "normal"))
+This code reads the preference extensions.webservice.discoverURL from about:config, and replaces placeholders with the correct data for your system. For example:
-
+
- The original value of
extensions.webservice.discoverURLishttps://discovery.addons.mozilla.org/%LOCALE%/firefox/discovery/pane/%VERSION%/%OS%/%COMPATIBILITY_MODE%.
+ - If you’re using Firefox 57.0 in Italian on macOS, the resulting URL will be
https://discovery.addons.mozilla.org/it/firefox/discovery/pane/57.0a1/Darwin/normal.
+ - To reach the Dev server, replace
addons.mozillain the domain withaddons-dev.allizom, resulting inhttps://discovery.addons-dev.allizom.org/it/firefox/discovery/pane/57.0a1/Darwin/normal.
+
Frequency of strings extraction and push schedule
+Newly added strings are extracted every week after tagging, which happens at 9am PST on Tuesdays. The strings will be on the dev server and ready for localization.
+For localized content:
+-
+
- Dev server: once translations are committed into the repositories, they are visible on the dev server within 30 minutes (or as long as it takes to push the code). +
- Staging server:
masteris tagged and pushed to staging weekly on Tuesday at around 9am PST.
+ - Production: the push usually starts at 9am PST every Thursday. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/webprojects/fxa.html b/webprojects/fxa.html
new file mode 100644
index 00000000..8fe6ad41
--- /dev/null
+++ b/webprojects/fxa.html
@@ -0,0 +1,365 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mozilla Donate website: how to localize and test
+donate.mozilla.org is our platform to collect donations. The main instance is for donations to the Mozilla Foundation, but there is also a separate instance for donations to Thunderbird.
+Testing
+Submitted translations are automatically deployed to the staging server, so you can test them a few minutes after they have been translated.
+-
+
- Staging server: https://donate-wagtail.mofostaging.net/. +
- Production server: https://donate.mozilla.org/. +
Testing the payment flow
+You may want to test the complete user journey on the website, but you don’t have to make an actual donation for that. Braintree (our payment processor for debit/credit cards) has a test mode that is enabled on the staging server only. Simply use the payment info from this page on the staging server and you should be able to simulate a payment. For instance, you can select an amount of money, click on donate by credit/debit card then fill out the form with the testing info. Make sure errors, as well as the page displayed when the donation has been successful, are properly localized.
+Testing currency settings
+The first thing to check is that the website supports all the relevant currencies for your locale.
+You also want to make sure the default currency selected for your locale is the one that makes the most sense. Only one default currency can be set per locale and it’s not possible to rely on geolocation to determine the best one.
+If your language is relevant in more than one country, make sure the other currencies are also available in the drop down.
+Check that the currency formatting on the page is correct for your language. If it’s not correct, please file an issue.
+How to report an issue
+The preferred way is to file an issue on the donate.mozilla.org GitHub repository.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/webprojects/index.html b/webprojects/index.html
new file mode 100644
index 00000000..a184586b
--- /dev/null
+++ b/webprojects/index.html
@@ -0,0 +1,242 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Firefox Accounts (FxA): how to localize and test
+Firefox Accounts (or FxA) refers to https://accounts.firefox.com. There are three components in Pontoon that make up FxA:
+-
+
LC_MESSAGES/client.po: the content server for UI and frontend.
+LC_MESSAGES/server.po: strings for emails and backend templates.
+Main.ftl: payments for both frontend and backend.
+Settings.ftl: pages for account settings.
+
The above could change over time as the team is planning to migrate .po files to .ftl, which may involve restructuring the files.
+Key links
+ +Localizing the strings
+FxA lives in two file formats: .po and .ftl, both contain variable or placeable in the strings. The shorter the string, the more context you need to make sure you get the translation right. Look for clues or get clarifications through the following methods:
+-
+
- String comments: Pay attention to the comment or string ID. In Pontoon, the comments are displayed above the area where you can enter your translation for a string. +
- Matrix channel: Ping the L10n PM in charge with any issues you may have. +
- Localization on Discourse: Follow announcement and discussions, and raise questions you have. +
Errors in translations can break the build for all languages
+During translation, do not alter code in a string, such as variables and HTML markup.
+For .po file format, a few FxA contacts would be notified when code in a localized string is broken. Any subsequent commits by other localizers in other languages will trigger this warning until the broken string is fixed by one of the people notified. Here are a few common errors seen in localized content:
+Example: Alter the code by omitting or inserting space breaks the build.
+-
+
- Source:
The recipient’s consent is required. <a %(escapedLearnMoreAttributes)s>Learn more</a>
+ - Target:
+
-
+
- ❌
A címzett hozzájárulása szükséges. <a%(escapedLearnMoreAttributes)s >Tudjon meg többet</a>.
+ - ✅
A címzett hozzájárulása szükséges. <a% (escapedLearnMoreAttributes)s>Tudjon meg többet</a>.
+ - What changed in the broken translation (❌): space is removed from
<a% (to<a%(; extra space was added from)s>to)s >.
+
+ - ❌
Example: Attributes should remain unchanged.
+-
+
- Source:
<span class="number">2</span>Point the camera at the QR code and tap the link that appears
+ - Target:
+
-
+
- ❌
<span classe="numero">2</span>Puncta le camera al codice QR e tocca le ligamine que appare
+ - ✅
<span class="number">2</span>Puncta le camera al codice QR e tocca le ligamine que appare
+ - What changed in the broken translation (❌): both the attribute’s name
classand valuenumberwere localized.
+
+ - ❌
Example: Markup elements often come in pairs, one opens and one closes.
+-
+
- Source:
Thank you for reaching out to Mozilla Support about <b>%(escapedLowercaseTopic)s</b> for <b>%(escapedSelectedProduct)s</b>.
+ - Target:
+
-
+
- ❌
Köszönjük, hogy felkereste a Mozilla támogatást a következő témában: <b>%(escapedLowercaseTopic)s</b (<b>%(escapedSelectedProduct)s</b.
+ - ✅
Köszönjük, hogy felkereste a Mozilla támogatást a következő témában: <b>%(escapedLowercaseTopic)s</b><b>%(escapedSelectedProduct)s</b>.
+ - What changed in the broken translation (❌): the closing element
</b>was replaced by</b, leaving the tag open.
+
+ - ❌
For .ftl file format, such error checking mechanism is not in place either in Pontoon or GitHub: Pontoon doesn’t have a warning, and the FxA repository doesn’t send out notifications. Before a script is developed to catch the errors, please use the above examples as general guidelines to avoid making these common mistakes.
+Testing
+Product updates are deployed to Pontoon on Fridays. Localized content is pushed to production on Tuesdays. Localized strings in Pontoon syncs with the l10n repository in GitHub every 10 minutes, making the repository the source of truth.
+You can test on either staging and production, both involve having an account in order to access the environment. The payment feature will be rolling out to international markets through wave releases. It’s best to review localization work on the staging environment before the feature is launched to the market.
+Firefox Accounts can be tested through Firefox browsers for desktop and mobile. In addition to following the general localization testing guidelines, there are features unique to the product that need special attention. Make sure you test them thoroughly.
+Testing account setup
+Linguistic testing
+-
+
- Login screen. +
- Email notification. +
- Check all the setting configuration buttons and the page or expanded window each page leads to. +
- Translation is of good quality and makes sense in context. +
- No broken UI, especially in a mobile environment. Text wraps or line breaks correctly. +
- Terms are consistent between pages. +
- Basic font support. +
- Error and warning messages. +
Functionality testing
+-
+
- Configure the Settings. Go through all of the categories. +
- Check for email notifications with each of the initial setups. +
- Make changes to some of the settings, check for possible error messages or warnings; check for followup confirmation emails. +
Testing the subscription platform
+The subscription platform consists of a few features. Right now only the Payment and subscription creation is available for testing:
+-
+
- Payment and subscription creation: The initial payment funnel where users enter their credit card information to subscribe to a product. Mozilla partners with Stripe to handle this. +
- Billing: Ongoing billing and receipt emails once a subscription is entered. +
- Subscription management UI: Settings that allow the user to update their payment information. +
Payment testing is tied to the language of user preference and location. Payment service is market specific. For instance, the product is available in German, but the service is available in Germany and not in Switzerland.
+Before testing
+-
+
-
+
Tips: Feeling not having enough test accounts to use for testing? You are not alone. Here are some tips you can consider.
+-
+
- Add number(s) or letter(s) to your existing account to create more accounts by adding a
+in your email address. For example, if your main email isname@xyz.com, your expanded accounts could bename+1@xyz.comandname+m@xyz.com. You will receive email notifications in yourname@xyz.cominbox. You can add anything you want, several digits and/or letters. Note that this works with Gmail and Google Apps domains.
+ - Keep your password simple so you can log in and log out easily. Keep track of which account is connected with which password. Of course, there is Lockwise for the rescue! +
+ - Add number(s) or letter(s) to your existing account to create more accounts by adding a
-
+
Create a new Firefox account for testing purposes. Your existing account may or may not work.
+
+ -
+
Choose a Firefox browser for desktop, Android, or iOS.
+
+ -
+
Set the language you are testing in. Find out how to configure the correct display language by following the steps detailed in this SUMO article.
+
+ -
+
Have the link ready for the subscription testing server. Note, this link is for testing subscription only, different from the FxA staging server.
+
+
Testing payment and subscription creation
+-
+
- Go to the subscription testing server +
- Click on the Subscribe button which takes you to a subscription form. If you don’t have a Firefox account at this point or if your existing account doesn’t work, you will need to create one. +
- Fill out all the required fields in the form. +
- Key in credit card number
4242 4242 4242 4242. The mandatory fields for Expiration date, CCV and postal code can be filled with random values.
+ - Verify formatting accuracy for date, currency and postal code. Check the box on usage agreement. +
- Click on Pay Now +
- A Thank You payment confirmation message appears with the subscription summary on your browser page with an invitation to download. +
- An email confirmation arrives in your inbox. The content should match the summary on the page where you just completed your subscription. +
Note: the Privacy Notice and Terms of Use documents are not localized in all the languages where the product is offered. When not available, you will be redirected to the English versions.
+Reporting technical issues
+There are a few ways to report non-linguistic related bugs:
+-
+
- File an issue here. +
- Ping in the Matrix channel to the l10n PM responsible for the project. +
- Through Pontoon, click the REQUEST CONTEXT or REPORT ISSUE button next to the string and make a comment. This will notify the l10n PM in charge. +
- Send a direct email to the l10n PM responsible for the project. The email address can be found in the profile in Pontoon. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/webprojects/mdn.html b/webprojects/mdn.html
new file mode 100644
index 00000000..53e1274b
--- /dev/null
+++ b/webprojects/mdn.html
@@ -0,0 +1,255 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ How to localize web projects
+This set of documentation contains basic information on localizing and testing web based projects.
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/webprojects/sumo.html b/webprojects/sumo.html
new file mode 100644
index 00000000..b26ec840
--- /dev/null
+++ b/webprojects/sumo.html
@@ -0,0 +1,285 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Developer.mozilla.org (MDN): how to localize and test
+MDN is the acronym for Mozilla Developer Network. It hosts references and guides to Web technologies as well as Firefox at Mozilla. It attracts users around the globe. The localization communities are a key part of the Mozilla project. Their work in translating and localizing the MDN documentations helps people around the world develop for the open Web.
+MDN consists of three parts:
+-
+
- The site user interface (or UI) strings that appear on almost all MDN pages to frame the main article content and provide navigation and user controls. +
- The main body of MDN pages consists of references, guides, and tutorial articles. Localization is done directly on the web. +
- Macro strings are the output by macro templates that construct certain kinds of navigation, messages, or generated structures. The strings currently live on GitHub, and changes can be done through pull requests. +
This document only covers the UI portion localizable in Pontoon.
+Localizing the strings
+The UI strings for MDN product live in Pontoon. The string changes are extracted and sent to Pontoon as part of the production push process. You can translate directly in Pontoon or download it as .po files and upload them back to Pontoon when done. Newly localized strings will be included in production updates.
+There is no sprint cycles. The staging and production sites are updated 1 - 3 times a week depending on product development. You should expect to see your new translations on production in 3-7 days.
+Pontoon will be synced up with MDN repository every 20 minutes. Updating localization strings is preferably done in Pontoon, and not through pull requests in the repository.
+Testing and reporting issues
+Staging and production pushes take place at the same time. Localized sites will have English strings for a few days before localization is caught up. There is no public developer server at the moment.
+Bugzilla is the best way to report localization issues.
+Communication channels
+-
+
- For live communication, use IRC channels: #mdndev or #mdn. +
- MDN Discussion Forum has recently moved away from mailing list to Discourse. Though there is no l10n category, MDN category is for discussing topics related to the MDN site. If you have a question, you can post it in the general MDN category. +
- If you want to be notified for string changes, one way is to check Pontoon project dashboard for pending task. Another way is by subscribing to the notification list: click the Watch icon on the top of MDN GitHub repository page and be notified about pull requests and code changes. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Support.mozilla.org(SUMO): how to localize and test
+SUMO, short for SUpport.MOzilla.org, is a knowledge base site, providing support to Mozilla product users. More than half of all Firefox users speak a language other than English. Mozilla depends on contributors to make support available to people around the globe.
+SUMO consists of two parts:
+-
+
- User interface (or UI), such as navigation and buttons. +
- Support articles, either used to troubleshoot issue or as knowledge base for Mozilla products. +
This document only covers the UI portion localizable in Pontoon.
+Localizing the strings
+There are two active components in Pontoon that make up the product:
+-
+
LC_MESSAGES/djangojs.pocontains strings for the JS bits of the platform.
+LC_MESSAGES/django.pocontains the majority of strings in the SUMO product.
+
SUMO is made up by several file types. In order to minimize revision and get translation right the first time, the key is to get the context right. Look for clues or ask others for help:
+-
+
- String comments: in Pontoon they’re displayed above the area where you can enter your translation for a string. They always include a reference to the code where the string is used, and you can use this information to search for context in the Kitsune GitHub repository. +
- The SUMO l10n forum. But first thing first, you need to create a Firefox account in order to participate in the discussions in the forum. +
Localized strings in Pontoon will be synced up with sumo-l10n on GitHub every 20 minutes, making the repository the source of truth.
+Ignore these legacy components:
+-
+
LC_MESSAGES/buddyup.pocontains strings for mobile-centric 1-to-1 support project.
+LC_MESSAGES/yaocho.pocontains strings for the mobile version of the support knowledge base.
+
Testing
+On Wednesdays, SUMO developers extract new strings from code and database edits. These strings are merged into the sumo-l10n repository and become available in Pontoon for translation.
+Translated strings from Pontoon are pushed automatically to the staging and production when there is a release to the respected environment. Usually this happens once a week.
+There are three ways to test the product:
+-
+
- Staging server: https://support.allizom.org. +
- Production server: http://support.mozilla.org/. +
Testing on production/staging
+Localization updates are pushed to the staging and production environments usually once a week. More often for staging. Either way, the SUMO team relies on contributors to find issues and report bugs that are usually fixed at a timely manner.
+FAQ
+For any additional questions not covered here, you can reach out to the #sumo room in Matrix to discuss it.
+How often are new strings added? Is there a sprint?
+No, there are no sprints. Strings are added at as needed basis. Whenever a release or change is required, new strings will be added to both Pontoon and Kitsune on Mondays.
+How do I participate in the SUMO l10n forum?
+To be part of the SUMO community, you need to create a Firefox account, which allows you to write in the community l10n forum and localize SUMO articles. This is separate from the account used to log into Pontoon in order to localize SUMO product.
+Are there email communications when new strings are added?
+Only when there is a release or a major change will there be communications to localizers through mailing list (sumo-locale-leaders@), private messages, and the SUMO l10n forum. The Pontoon dashboard is the best way to check for pending tasks.
+What are the ways to report an issue?
+-
+
- File a bug for SUMO. This is the quickest way to have a problem resolved. +
- Discuss it in the SUMO l10n forum. +
- Ping in the Matrix channel the l10n PM responsible for the project. +
- Through Pontoon, click the REQUEST CONTEXT or REPORT ISSUE button next to the string and make a comment. This will notify the l10n PM in charge. +
- Send a direct email to the l10n PM responsible for the project. The email address can be found in the profile in Pontoon. +
It is not recommended to file issues on GitHub sumo-l10n.
+ +