Add SUMO rules mentions & Improve AAQ step 3 #7114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

denyshon wants to merge 14 commits into mozilla:main from denyshon:improve-aaq-3

kitsune/flagit/jinja2/flagit/content_moderation.html

-Original file line number
+Diff line change
@@ Expand Up @@
                     hx-swap="delete">
                 {% csrf_token %}
                 <select name="status">
+                  {# L10n: A default option for dropdown menus (displayed when none of the actual options is selected). #}
                   <option value="">{{ _('Please select...') }}</option>
                   <option value="1">{{ _('Content categorization is updated.') }}</option>
                   <option value="2">{{ _('Content is appropriately categorized.') }}</option>
@@ Expand Down @@

kitsune/flagit/jinja2/flagit/queue.html

-Original file line number
+Diff line change
@@ Expand Up @@
               <form class="update inline-form" action="{{ object.form_action }}" method="post">
                 {% csrf_token %}
                 <select name="status">
+                  {# L10n: A default option for dropdown menus (displayed when none of the actual options is selected). #}
                   <option value="">{{ _('Please select...') }}</option>
                   {% if object.reason == "spam" %}
                     <option value="1">{{ _('Removed spam content.') }}</option>
@@ Expand Down @@

kitsune/flagit/jinja2/flagit/zendesk_spam.html

-Original file line number
+Diff line change
@@ Expand Up @@
               <form class="update inline-form" action="{{ object.form_action }}" method="post">
                 {% csrf_token %}
                 <select name="status">
+                  {# L10n: A default option for dropdown menus (displayed when none of the actual options is selected). #}
                   <option value="">{{ _('Please select...') }}</option>
                   <option value="1">{{ _('Removed spam content.') }}</option>
                   <option value="2">{{ _('No spam found.') }}</option>
@@ Expand Down @@

kitsune/forums/jinja2/forums/edit_post.html

-Original file line number
+Diff line change
@@ Expand Up / @@ -21,7 +21,7 @@ <h1>{{ _('Edit a post') }}</h1> @@
           <div class="form-widget{% if form.content.errors %} invalid{% endif %}">
             {{ form.content.label_tag()|safe }}
             <div class="content-box">
-              {{ content_editor(form.content) }}
+              {{ content_editor(form.content, mention_rules=true) }}
             </div>
           </div>
@@ Expand Down @@

kitsune/forums/jinja2/forums/new_thread.html

-Original file line number
+Diff line change
@@ Expand Up @@
               {{ field.label_tag()|safe }}
               {% if field.name == 'content' %}
                 <div class="content-box">
-                  {{ content_editor(field) }}
+                  {{ content_editor(field, mention_rules=true) }}
                 </div>
               {% else %}
                 {{ field|safe }}
@@ Expand Down @@

kitsune/forums/jinja2/forums/posts.html

-Original file line number
+Diff line change
@@ Expand Up @@
             {% endif %}
             <div id="thread-reply">
-              {{ content_editor(form.content) }}
+              {{ content_editor(form.content, mention_rules=true) }}
             </div>
             <div class="editor-actions sumo-button-wrap reverse-on-desktop align-end">
               <button type="submit" class="sumo-button primary-button">{{ _('Post Reply') }}</button>
@@ Expand Down @@

kitsune/kbforums/jinja2/kbforums/edit_post.html

-Original file line number
+Diff line change
@@ Expand Up / @@ -22,7 +22,7 @@ <h1 class="sumo-page-subheading">{{ _('Edit a post') }}</h1> @@
           <div class="form-widget{% if form.content.errors %} invalid{% endif %}">
             {{ form.content.label_tag()|safe }}
             <div class="content-box">
-              {{ content_editor(form.content) }}
+              {{ content_editor(form.content, mention_rules=true) }}
             </div>
           </div>
@@ Expand Down @@

kitsune/kbforums/jinja2/kbforums/new_thread.html

-Original file line number
+Diff line change
@@ Expand Up @@
               {{ field.label_tag()|safe }}
               {% if field.name == 'content' %}
                 <div class="content-box">
-                  {{ content_editor(field) }}
+                  {{ content_editor(field, mention_rules=true) }}
                 </div>
               {% else %}
                 {{ field|safe }}
@@ Expand Down @@

kitsune/kbforums/jinja2/kbforums/posts.html

-Original file line number
+Diff line change
@@ Expand Up @@
               {% endif %}
               <div id="thread-reply">
-                {{ content_editor(form.content) }}
+                {{ content_editor(form.content, mention_rules=true) }}
               </div>
               <div class="editor-actions sumo-button-wrap reverse-on-desktop align-end">
@@ Expand Down @@

kitsune/questions/forms.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -14,55 +14,75 @@ @@
     from kitsune.sumo.forms import KitsuneBaseForumForm
     from kitsune.upload.models import ImageAttachment
-    # labels and help text
+    # unused labels and help text
+    # L10n: Unused. A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
     SITE_AFFECTED_LABEL = _lazy("URL of affected site")
+    # L10n: Unused. A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
     CRASH_ID_LABEL = _lazy("Crash ID(s)")
-    CRASH_ID_HELP = _lazy(
-        "If you submit information to Mozilla when you crash, "
-        "you'll be given a crash ID which uniquely identifies "
-        "your crash and lets us look at details that may help "
-        "identify the cause. To find your recently submitted "
-        "crash IDs, go to <strong>about:crashes</strong> in "
-        "your location bar. <a href='https://support.mozilla."
-        "com/en-US/kb/Firefox+crashes#Getting_the_most_"
-        "accurate_help_with_your_Firefox_crash' "
-        "target='_blank'>Click for detailed instructions</a>."
-    )
-    TROUBLESHOOTING_LABEL = _lazy("Troubleshooting Information")
-    TROUBLESHOOTING_HELP = _lazy(
-        "This information gives details about the "
-        "internal workings of your browser that will "
-        "help in answering your question."
-    )
+    # if you want to use the following string, update it to remove "en-US" from the link first
+    # when updating, don't remove the original string, just mark it as deprecated and create a new one
+    # L10n: Unused. A description of the "Crash ID(s)" field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
+    CRASH_ID_HELP = _lazy("If you submit information to Mozilla when you crash, you'll be given a crash ID which uniquely identifies your crash and lets us look at details that may help identify the cause. To find your recently submitted crash IDs, go to <strong>about:crashes</strong> in your location bar. <a href='https://support.mozilla.com/en-US/kb/Firefox+crashes#Getting_the_most_accurate_help_with_your_Firefox_crash' target='_blank'>Click for detailed instructions</a>.")
+    # L10n: Unused. A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
     FREQUENCY_LABEL = _lazy("This happens")
     FREQUENCY_CHOICES = [
         ("", ""),
+        # L10n: Unused. An option for the "This happens" field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
         ("NOT_SURE", _lazy("Not sure how often")),
+        # L10n: Unused. An option for the "This happens" field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
         ("ONCE_OR_TWICE", _lazy("Just once or twice")),
+        # L10n: Unused. An option for the "This happens" field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
         ("FEW_TIMES_WEEK", _lazy("A few times a week")),
+        # L10n: Unused. An option for the "This happens" field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
         ("EVERY_TIME", _lazy("Every time Firefox opened")),
     ]
+    # L10n: Unused. A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
     STARTED_LABEL = _lazy("This started when...")
-    TITLE_LABEL = _lazy("Subject")
-    CONTENT_LABEL = _lazy("How can we help?")
-    FF_VERSION_LABEL = _lazy("Firefox version")
-    OS_LABEL = _lazy("Operating system")
+    # L10n: Unused. A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
     PLUGINS_LABEL = _lazy("Installed plugins")
+    # L10n: Unused. A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
     ADDON_LABEL = _lazy("Extension/plugin you are having trouble with")
+    # L10n: Unused. A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
     DEVICE_LABEL = _lazy("Mobile device")
+    # unused labels and help text
+    # L10n: A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
+    TROUBLESHOOTING_LABEL = _lazy("Troubleshooting Information")
+    # L10n: A description of the "Troubleshooting Information" field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
+    TROUBLESHOOTING_HELP = _lazy("This information gives details about the internal workings of your browser that will help in answering your question.")
+    # L10n: A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
+    TITLE_LABEL = _lazy("Summarize your question")
+    # L10n: A description of the "Summarize your question" field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
+    TITLE_HELP_TEXT = _lazy("Please summarize your question in one sentence:")
+    # L10n: A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
+    CONTENT_LABEL = _lazy("How can we help?")
+    # L10n: A description of the "How can we help?" field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
+    CONTENT_HELP_TEXT = _lazy('Please include as much detail as possible. Also, remember to follow our <a href="https://support.mozilla.org/kb/mozilla-support-rules-guidelines" target="_blank">rules and guidelines</a>.')
+    # L10n: A label for a field, displayed when filing a Firefox-related question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
+    FF_VERSION_LABEL = _lazy("Firefox version")
+    # L10n: A label for a field, displayed when filing a Thunderbird-related question form (e.g., on https://support.mozilla.org/questions/new/thunderbird/form).
+    TB_VERSION_LABEL = _lazy("Thunderbird version")
+    # L10n: A placeholder for the "Thunderbird version" field, displayed when filing a Thunderbird-related question form (e.g., on https://support.mozilla.org/questions/new/thunderbird/form).
+    TB_VERSION_PLACEHOLDER = _lazy("e.g., 140.5.0esr, 146.1.0 release or 147.0b4")
+    # L10n: A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
+    OS_LABEL = _lazy("Operating system")
+    # L10n: A label for a field, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
     CATEGORY_LABEL = _lazy("Which topic best describes your question?")
+    # L10n: A label for a checkbox, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form).
     NOTIFICATIONS_LABEL = _lazy("Email me when someone answers the thread")
+    # L10n: A placeholder for the "Post a Reply" editor.
     REPLY_PLACEHOLDER = _lazy("Enter your reply here.")
+    # L10n: A placeholder for the email field, displayed when subscribing to a question while not signed in.
     EMAIL_PLACEHOLDER = _lazy("Enter your email address here.")
     class EditQuestionForm(forms.ModelForm):
         """Form to edit an existing question"""
-        title = forms.CharField(label=TITLE_LABEL, min_length=5)
+        title = forms.CharField(label=TITLE_LABEL, help_text=TITLE_HELP_TEXT, min_length=5)
-        content = forms.CharField(label=CONTENT_LABEL, min_length=5, widget=forms.Textarea())
+        content = forms.CharField(label=CONTENT_LABEL, help_text=CONTENT_HELP_TEXT, min_length=5, widget=forms.Textarea())
         class Meta:
             model = Question
@@ Expand All / @@ -75,6 +95,7 @@ def __init__(self, product=None, *args, **kwargs): @@
             form fields to include depend on the selected product/category.
             """
             super().__init__(*args, **kwargs)
+            self.label_suffix = None
             #  Extra fields required by product/category selected
             extra_fields = []
@@ Expand All / @@ -89,6 +110,13 @@ def __init__(self, product=None, *args, **kwargs): @@
                     required=False,
                 )
+            if "tb_version" in extra_fields:
+                self.fields["tb_version"] = forms.CharField(
+                    label=TB_VERSION_LABEL,
+                    required=False,
+                    widget=forms.TextInput(attrs={"placeholder": TB_VERSION_PLACEHOLDER}),
+                )
             if "os" in extra_fields:
                 self.fields["os"] = forms.CharField(
                     label=OS_LABEL,
@@ Expand All / @@ -108,15 +136,26 @@ def __init__(self, product=None, *args, **kwargs): @@
             for field in self.fields.values():
                 if not field.required:
+                    # L10n: A label suffix for optional fields, displayed when filing a question form (e.g., on https://support.mozilla.org/questions/new/firefox/form). The leading space must be preserved.
                     field.label_suffix = _lazy(" (optional):")
+            for name, field in self.fields.items():
+                if field.help_text:
+                    bound = self[name]
+                    bound.help_id = f"{bound.id_for_label}_help"
+                    if field.widget.attrs.get("aria-describedby"):
+                        field.widget.attrs["aria-describedby"] += " " + bound.help_id
+                    else:
+                        field.widget.attrs["aria-describedby"] = bound.help_id
         def clean_content(self):
             """Validate that content field contains actual text, not just HTML markup."""
             content = self.cleaned_data.get("content", "")
             text_only = strip_tags(content)
             text_only = html.unescape(text_only).strip()
             if len(text_only) < 5:
+                # L10n: An error message displayed under the "How can we help?" field when filing a question form if the submitted value contains too few non-HTML symbols.
                 raise forms.ValidationError(_("Question content cannot be empty."))
             return content
@@ Expand Down Expand Up / @@ -177,7 +216,8 @@ class NewQuestionForm(EditQuestionForm): @@
         category = forms.ModelChoiceField(
             label=CATEGORY_LABEL,
             queryset=Topic.objects.none(),
-            empty_label="Please select",
+            # L10n: A default option for dropdown menus (displayed when none of the actual options is selected).
+            empty_label=_lazy("Please select..."),
             required=True,
         )
@@ Expand Down Expand Up / @@ -275,6 +315,3 @@ def clean_email(self): @@
                 return self.cleaned_data["email"]
             # Clear out the email for logged in users, we don't want to use it.
             return None
-    bucket_choices = [(1, "1 day"), (7, "1 week"), (30, "1 month")]

kitsune/questions/jinja2/questions/edit_answer.html

-Original file line number
+Diff line change
@@ Expand Up / @@ -49,7 +49,7 @@ <h2 class="sumo-page-heading">{{ _('Edit an answer') }}</h2> @@
               {{ errorlist(form) }}
               <div class="form-widget{% if form.content.errors %} invalid{% endif %}">
-                {{ content_editor(form.content) }}
+                {{ content_editor(form.content, mention_rules=true) }}
               </div>
               {{ attachments_form('questions.Answer', answer.pk, answer.images.all(), settings, request.user) }}
@@ Expand Down @@

kitsune/questions/jinja2/questions/edit_question.html

-Original file line number
+Diff line change
@@ Expand Up / @@ -22,6 +22,7 @@ @@
       <p>{{ _('When editing a question, uploading new images or deleting existing ones will happen instantly.') }}</p>
     {% endblock %}
+    {# L10n: A button displayed when editing an existing question. #}
     {% block submit_button_value %}{{ _('Save Question') }}{% endblock %}
     {% block more_submit_buttons %}
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SUMO rules mentions & Improve AAQ step 3 #7114

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!