Open preferences in new window

[orymate@…]

In the reporter fieldset of the ticket submission form there is a notice: E-mail address and user name can be saved in the Preferences.

New users of a trac system find this notice after filling in the form. If they click on the suggested preferences link, they will lose their ticket (at least in Firefox).

A workaround is opening this page in a new window/tab.

[Ryan J Ollos]

Should we just add the ​target=_blank attribute to the link?

[Remy Blank]

There's no target attribute on links in XHTML. So you would have to do this with JavaScript.

[Ryan J Ollos]

Thanks, I will investigate a JavaScript implementation after 1.0.2.

[Ryan J Ollos]

How about this?:

trac/ticket/templates/ticket.html

@@ -18 +18 @@
       jQuery(document).ready(function($) {
         $("div.description").find("h1,h2,h3,h4,h5,h6").addAnchor(_("Link to this section"));
         $(".foldable").enableFolding(false, true);
+        $(".trac-target-new").attr("target", "_blank");
       <py:when test="ticket.exists">/*<![CDATA[*/
         $("#attachments").toggleClass("collapsed");
         $("#trac-up-attachments").click(function () {
@@ -359 +360 @@
               </tr>
             </table>
             <p py:if="author_id == 'anonymous'" class="hint">
-              <i18n:msg>E-mail address and user name can be saved in the <a href="${href.prefs()}">Preferences</a>.</i18n:msg>
+              <i18n:msg>E-mail address and user name can be saved in the
+                <a href="${href.prefs()}" class="trac-target-new">Preferences</a>.
+              </i18n:msg>
             </p>
           </fieldset>
         </div>

In fact, the $(".trac-target-new").attr("target", "_blank"); could go in layout.html​, as we've done with trac-focus in #11084 and propose to do with trac-scroll in #11084.

[Remy Blank]

Heh, I was actually thinking of setting an onclick handler, and opening a new window from JavaScript, but this is a very neat idea. Putting it in layout.html definitely makes sense.

[Ryan J Ollos]

I was a bit concerned that this was somehow cheating. I mean, if I add the target=_blank attribute, is it still valid XHTML on the page? Is this somehow okay if/because I'm only changing the DOM, not the page HTML?

[Remy Blank]

I had the same thoughts, but I think it's ok. We validate the documents that are sent over the wire, and these are XHTML-Strict compliant. Whatever happens in the browser is another subject, unrelated to XHTML.

I did check that HTML5 still has the target attribute. So at least we're not driving into a dead end.

[Ryan J Ollos]

When I added a line-break to the very long line as shown in comment:4, and regenerated messages.pot, the line changed from:

#: trac/ticket/templates/ticket.html:362
#: trac/wiki/templates/wiki_edit_form.html:46
msgid "E-mail address and user name can be saved in the [1:Preferences]."
msgstr ""

to:

#: trac/ticket/templates/ticket.html:362
msgid ""
"E-mail address and user name can be saved in the\n"
"                  [1:Preferences]."
msgstr ""

Does the addition of the newline and whitespace add more work for translators?

Here is the latest version of the patch:

trac/templates/layout.html

@@ -48 +48 @@
     <script type="text/javascript">
       jQuery(document).ready(function($) {
         $(".trac-focus").focus();
+        $(".trac-target-new").attr("target", "_blank");
       });
     </script>
     ${select("*[local-name() != 'title']|text()|comment()")}

trac/ticket/templates/ticket.html

@@ -359 +359 @@
               </tr>
             </table>
             <p py:if="author_id == 'anonymous'" class="hint">
-              <i18n:msg>E-mail address and user name can be saved in the <a href="${href.prefs()}">Preferences</a>.</i18n:msg>
+              <i18n:msg>E-mail address and user name can be saved in the <a href="${href.prefs()}" class="trac-target-new">Preferences</a>.</i18n:msg>
             </p>
           </fieldset>
         </div>

trac/wiki/templates/wiki_edit_form.html

@@ -43 +43 @@
             <input id="author" type="text" name="author" size="30" value="$author" />
           </label>
           <p py:if="author == 'anonymous'" class="hint">
-            <i18n:msg>E-mail address and user name can be saved in the <a href="${href.prefs()}">Preferences</a>.</i18n:msg>
+            <i18n:msg>E-mail address and user name can be saved in the <a href="${href.prefs()}" class="trac-target-new">Preferences</a>.</i18n:msg>
           </p>
         </div>
         <div class="field">

[Remy Blank]

Replying to rjollos:

Does the addition of the newline and whitespace add more work for translators?

Yes, it does. However, the translation systems are usually fairly good at identifying the old translation, so the translator usually only has to make the corresponding whitespace fixes (if at all).

[Ryan J Ollos]

Replying to rblank:

Yes, it does. However, the translation systems are usually fairly good at identifying the old translation, so the translator usually only has to make the corresponding whitespace fixes (if at all).

Thanks, I'll leave it as is now then; the line is not too insanely long yet.

Committed to 1.0-stable in [12119], and merged to trunk in [12120].

[Jun Omae]

Replying to rjollos:

I'll leave it as is now then; the line is not too insanely long yet.

We have two ways to insert line-breaks with no changes for the extracted messages, but not elegant. I like the extracted messages with no line-breaks from Genshi templates because changes of the indents will lead changes of the messages.

• Inserting line-breaks in the tag

  trac/ticket/templates/ticket.html

  @@ -359 +359 @@
                 </tr>
               </table>
               <p py:if="author_id == 'anonymous'" class="hint">
  -              <i18n:msg>E-mail address and user name can be saved in the <a href="${href.prefs()}" class="trac-target-new">Preferences</a>.</i18n:msg>
  +              <i18n:msg>E-mail address and user name can be saved in the <a
  +                href="${href.prefs()}" class="trac-target-new"
  +                >Preferences</a>.</i18n:msg>
               </p>
             </fieldset>
           </div>

• Using comment of Genshi template with line-breaks

  trac/ticket/templates/ticket.html

  @@ -359 +359 @@
                 </tr>
               </table>
               <p py:if="author_id == 'anonymous'" class="hint">
  -              <i18n:msg>E-mail address and user name can be saved in the <a href="${href.prefs()}" class="trac-target-new">Preferences</a>.</i18n:msg>
  +              <i18n:msg>E-mail address and user name can be saved in <!--!
  +                -->the <a href="${href.prefs()}" class="trac-target-new"><!--!
  +                -->Preferences</a>.</i18n:msg>
               </p>
             </fieldset>
           </div>

[Ryan J Ollos]

I like the use of the comment marker, since it will probably be more obvious to most developers that something is being done there for "some sort of reason", and the hint could be documented in the TracDev/CodingStyle. If the tag is split across the line, it is not obvious why that would be needed, and more likely that some dummy like me would come along and try to "clean it up" later on.

[Ryan J Ollos]

In [bbf16363/rjollos.git#file3] I utilized the comment marker to insert a line break into a line of translatable text and updated the catalog to confirm that it works. Thanks for the hint Jun!

There seem to be more than a few strings that have quite a bit of whitespace. Maybe in the future it would be good to fix those up on the trunk.