Add translate="no" tags throughout the project

We skip translation only on names of modules, types, functions, and code snippets. For example, the subsection inside a module page are still translated. The rationale is that terms like "function" and "macro" appear as is in the text, without code tags, therefore they are translated, so they same should apply to subsections headers.
elixir-lang · Nov 21, 2021 · add7a0d · add7a0d
1 parent f49e099
commit add7a0d
Show file tree

Hide file tree

Showing 20 changed files with 110 additions and 110 deletions.
diff --git a/assets/js/handlebars/templates/autocomplete-suggestions.handlebars b/assets/js/handlebars/templates/autocomplete-suggestions.handlebars
@@ -6,14 +6,14 @@
   {{#each suggestions}}
     <a href="{{link}}" class="autocomplete-suggestion" data-index="{{@index}}" tabindex="-1">
       <div class="title">
-        {{{title}}}
+        <span translate="no">{{{title}}}</span>
         {{#if label}}
           <span class="label">({{label}})</span>
         {{/if}}
       </div>
 
       {{#if description}}
-        <div class="description">
+        <div class="description" translate="no">
           {{{description}}}
         </div>
       {{/if}}

diff --git a/assets/js/handlebars/templates/search-results.handlebars b/assets/js/handlebars/templates/search-results.handlebars
@@ -8,7 +8,9 @@
   {{#each results}}
     <div class="result">
       <h2 class="result-id">
-        <a href="{{this.ref}}">{{this.title}} <small>({{this.type}})</small></a>
+        <a href="{{this.ref}}">
+          <span translate="no">{{this.title}}</span> <small>({{this.type}})</small>
+        </a>
       </h2>
         {{#each excerpts}}
           <p class="result-elem">{{{this}}}</p>

diff --git a/assets/js/handlebars/templates/sidebar-items.handlebars b/assets/js/handlebars/templates/sidebar-items.handlebars
@@ -1,17 +1,19 @@
 {{#each nodes as |node nodeId|}}
   {{#groupChanged ../this node.group}}
-    <li class="group">{{node.group}}</li>
+    <li class="group" {{#isArray node.headers}}{{else}}translate="no"{{/isArray}}>
+      {{node.group}}
+    </li>
   {{/groupChanged}}
 
   {{#nestingChanged ../this node}}
-    <li class="nesting-context" aria-hidden="true">{{node.nested_context}}</li>
+    <li class="nesting-context" aria-hidden="true" translate="no">{{node.nested_context}}</li>
   {{/nestingChanged}}
 
   <li class="{{#isLocal node.id}}current-page open{{/isLocal}} {{#if node.nested_title}}nested{{/if}}">
     {{! When visiting a module page, the link to this module page
     in the menu should not link to a new page, instead should link
     to the top of the page itself. }}
-    <a href="{{node.id}}.html" class="expand">
+    <a href="{{node.id}}.html" class="expand" {{#isArray node.headers}}{{else}}translate="no"{{/isArray}}>
       {{#if node.nested_title}}
         {{{node.nested_title}}}
       {{else}}
@@ -62,7 +64,7 @@
             <ul class="{{group.key}}-list deflist">
               {{#each group.nodes}}
                 <li>
-                  <a href="{{node.id}}.html#{{anchor}}">{{id}}</a>
+                  <a href="{{node.id}}.html#{{anchor}}" translate="no">{{id}}</a>
                 </li>
               {{/each}}
             </ul>

diff --git a/assets/js/handlebars/templates/tooltip-body.handlebars b/assets/js/handlebars/templates/tooltip-body.handlebars
@@ -5,8 +5,8 @@
 {{else}}
   <div class="detail-header">
     <h1 class="signature">
-      {{this.hint.title}}
-      <div class="version-info">{{this.hint.version}}</div>
+      <span translate="no">{{this.hint.title}}</span>
+      <div class="version-info" translate="no">{{this.hint.version}}</div>
     </h1>
   </div>
   {{#if this.hint.description}}

diff --git a/assets/js/handlebars/templates/versions-dropdown.handlebars b/assets/js/handlebars/templates/versions-dropdown.handlebars
@@ -1,7 +1,7 @@
 <form autocomplete="off">
   <select class="sidebar-projectVersionsDropdown" dir="rtl">
     {{#each nodes}}
-      <option value="{{url}}"{{#if isCurrentVersion}} selected disabled{{/if}}>
+      <option translate="no" value="{{url}}"{{#if isCurrentVersion}} selected disabled{{/if}}>
         {{version}}
       </option>
     {{/each}}

diff --git a/formatters/html/dist/app-a404e1e870b77c874f9e.js b/formatters/html/dist/app-a404e1e870b77c874f9e.js
diff --git a/...t/app-b80d21cdb7d74c374d29.js.LICENSE.txt → ...t/app-a404e1e870b77c874f9e.js.LICENSE.txt b/...t/app-b80d21cdb7d74c374d29.js.LICENSE.txt → ...t/app-a404e1e870b77c874f9e.js.LICENSE.txt
diff --git a/formatters/html/dist/app-b80d21cdb7d74c374d29.js b/formatters/html/dist/app-b80d21cdb7d74c374d29.js
diff --git a/lib/ex_doc/formatter/epub/templates/module_template.eex b/lib/ex_doc/formatter/epub/templates/module_template.eex
@@ -1,6 +1,6 @@
 <%= head_template(config, %{title: module.title}) %>
     <h1 id="content">
-      <%= H.module_title(module) %>
+      <%= module.title %> <%= H.module_type(module) %>
     </h1>
 
     <%= if deprecated = module.deprecated do %>

diff --git a/lib/ex_doc/formatter/html/templates.ex b/lib/ex_doc/formatter/html/templates.ex
@@ -51,14 +51,9 @@ defmodule ExDoc.Formatter.HTML.Templates do
   @doc """
   Returns the HTML formatted title for the module page.
   """
-  def module_title(%{type: :task, title: title}),
-    do: title
-
-  def module_title(%{type: :module, title: title}),
-    do: title
-
-  def module_title(%{type: type, title: title}),
-    do: title <> " <small>#{type}</small>"
+  def module_type(%{type: :task}), do: ""
+  def module_type(%{type: :module}), do: ""
+  def module_type(%{type: type}), do: "<small>#{type}</small>"
 
   @doc """
   Gets the first paragraph of the documentation of a node. It strips
@@ -277,7 +272,6 @@ defmodule ExDoc.Formatter.HTML.Templates do
     search_template: [:config, :nodes_map],
     sidebar_template: [:config, :nodes_map],
     summary_template: [:name, :nodes],
-    summary_entry_template: [:node],
     redirect_template: [:config, :redirect_to],
     bottom_actions_template: [:refs]
   ]

diff --git a/lib/ex_doc/formatter/html/templates/api_reference_entry_template.eex b/lib/ex_doc/formatter/html/templates/api_reference_entry_template.eex
@@ -1,6 +1,6 @@
 <div class="summary-row">
   <div class="summary-signature">
-    <a href="<%=enc module_node.id %>.html"><%=h module_node.title %></a>
+    <a href="<%=enc module_node.id %>.html" translate="no"><%=h module_node.title %></a>
     <%= if deprecated = module_node.deprecated do %>
       <span class="deprecated" title="<%= h(deprecated) %>">deprecated</span>
     <% end %>

diff --git a/lib/ex_doc/formatter/html/templates/detail_template.eex b/lib/ex_doc/formatter/html/templates/detail_template.eex
@@ -7,7 +7,7 @@
       <span class="icon-link" aria-hidden="true"></span>
       <span class="sr-only">Link to this <%= pretty_type(node) %></span>
     </a>
-    <h1 class="signature"><%=h node.signature %></h1>
+    <h1 class="signature" translate="no"><%=h node.signature %></h1>
     <%= if node.source_url do %>
       <a href="<%= node.source_url %>" class="view-source" rel="help" title="View Source">
        <span class="icon-code" aria-hidden="true"></span>
@@ -29,11 +29,11 @@
       <h2>Specs</h2>
       <div class="specs">
         <%= for spec <- specs do %>
-          <pre><%= spec %></pre>
+          <pre translate="no"><%= spec %></pre>
         <% end %>
       </div>
     <% end %>
 
-    <%= node.rendered_doc |> link_detail_headings(enc(node.id)) %>
+    <%= link_detail_headings(node.rendered_doc, enc(node.id)) %>
   </section>
 </section>
diff --git a/lib/ex_doc/formatter/html/templates/footer_template.eex b/lib/ex_doc/formatter/html/templates/footer_template.eex
@@ -14,12 +14,12 @@
         <p>
           <span class="line">
             Built using
-            <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v<%= ExDoc.version() %>) for the
-            <a href="https://elixir-lang.org" title="Elixir" target="_blank">Elixir programming language</a>.
+            <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v<%= ExDoc.version() %>) for the
+            <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>.
           </span>
           <span class="line">
             Designed by
-            <a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
+            <a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire" translate="no">Friedel Ziegelmayer</a>.
           </span>
         </p>
         <p>

diff --git a/lib/ex_doc/formatter/html/templates/module_template.eex b/lib/ex_doc/formatter/html/templates/module_template.eex
@@ -1,56 +1,57 @@
-    <%= head_template(config, %{title: module.title, type: module.type}) %>
-    <%= sidebar_template(config, nodes_map) %>
+<%= head_template(config, %{title: module.title, type: module.type}) %>
+<%= sidebar_template(config, nodes_map) %>
 
-      <h1>
-        <%= module_title(module) %> <small class="app-vsn">(<%= config.project %> v<%= config.version %>)</small>
-        <%= if module.source_url do %>
-          <a href="<%= module.source_url %>" title="View Source" class="view-source" rel="help">
-            <span class="icon-code" aria-hidden="true"></span>
-            <span class="sr-only">View Source</span>
-          </a>
-        <% end %>
-        <%= for annotation <- module.annotations do %>
-          <span class="note">(<%= annotation %>)</span>
-        <% end %>
-      </h1>
+<h1>
+  <span translate="no"><%= module.title %></span> <%= module_type(module) %>
+  <small class="app-vsn" translate="no">(<%= config.project %> v<%= config.version %>)</small>
+  <%= if module.source_url do %>
+    <a href="<%= module.source_url %>" title="View Source" class="view-source" rel="help">
+      <span class="icon-code" aria-hidden="true"></span>
+      <span class="sr-only">View Source</span>
+    </a>
+  <% end %>
+  <%= for annotation <- module.annotations do %>
+    <span class="note">(<%= annotation %>)</span>
+  <% end %>
+</h1>
 
-      <%= if deprecated = module.deprecated do %>
-        <div class="deprecated">
-          This <%= module.type %> is deprecated. <%= h(deprecated) %>.
-        </div>
-      <% end %>
+<%= if deprecated = module.deprecated do %>
+  <div class="deprecated">
+    This <%= module.type %> is deprecated. <%= h(deprecated) %>.
+  </div>
+<% end %>
 
-      <%= if doc = module.rendered_doc do %>
-        <section id="moduledoc">
-          <%= link_moduledoc_headings(doc) %>
-        </section>
-      <% end %>
+<%= if doc = module.rendered_doc do %>
+  <section id="moduledoc">
+    <%= link_moduledoc_headings(doc) %>
+  </section>
+<% end %>
 
-      <%= if Enum.any?(summary, fn {_, v} -> v != [] end) do %>
-        <section id="summary" class="details-list">
-          <h1 class="section-heading">
-            <a class="hover-link" href="#summary">
-              <span class="icon-link" aria-hidden="true"></span>
-              <span class="sr-only">Link to this section</span>
-            </a>
-            Summary
-          </h1>
-          <%= for {name, nodes} <- summary, do: summary_template(name, nodes) %>
-        </section>
-      <% end %>
+<%= if Enum.any?(summary, fn {_, v} -> v != [] end) do %>
+  <section id="summary" class="details-list">
+    <h1 class="section-heading">
+      <a class="hover-link" href="#summary">
+        <span class="icon-link" aria-hidden="true"></span>
+        <span class="sr-only">Link to this section</span>
+      </a>
+      Summary
+    </h1>
+    <%= for {name, nodes} <- summary, do: summary_template(name, nodes) %>
+  </section>
+<% end %>
 
-      <%= for {name, nodes} <- summary, nodes != [], key = HTML.text_to_id(name) do %>
-        <section id="<%= key %>" class="details-list">
-          <h1 class="section-heading">
-            <a class="hover-link" href="#<%= key %>">
-              <span class="icon-link" aria-hidden="true"></span>
-              <span class="sr-only">Link to this section</span>
-            </a>
-            <%= name %>
-          </h1>
-          <div class="<%= key %>-list">
-            <%= for node <- nodes, do: detail_template(node, module) %>
-          </div>
-        </section>
-      <% end %>
-    <%= footer_template(config, module) %>
+<%= for {name, nodes} <- summary, nodes != [], key = HTML.text_to_id(name) do %>
+  <section id="<%= key %>" class="details-list">
+    <h1 class="section-heading">
+      <a class="hover-link" href="#<%= key %>">
+        <span class="icon-link" aria-hidden="true"></span>
+        <span class="sr-only">Link to this section</span>
+      </a>
+      <%= name %>
+    </h1>
+    <div class="<%= key %>-list">
+      <%= for node <- nodes, do: detail_template(node, module) %>
+    </div>
+  </section>
+<% end %>
+<%= footer_template(config, module) %>
diff --git a/lib/ex_doc/formatter/html/templates/sidebar_template.eex b/lib/ex_doc/formatter/html/templates/sidebar_template.eex
@@ -25,10 +25,10 @@
   <% url = config.homepage_url || "#{config.main}.html" %>
   <div class="sidebar-header">
     <div class="sidebar-projectDetails">
-      <a href="<%= url %>" class="sidebar-projectName">
+      <a href="<%= url %>" class="sidebar-projectName" translate="no">
         <%= config.project %>
       </a>
-      <strong class="sidebar-projectVersion">
+      <strong class="sidebar-projectVersion" translate="no">
         v<%= config.version %>
       </strong>
     </div>
@@ -47,7 +47,7 @@
     <% end %>
 
     <%= if nodes_map.tasks != [] do %>
-      <li><a id="tasks-list-link" href="#full-list">Mix Tasks</a></li>
+      <li><a id="tasks-list-link" href="#full-list"><span translate="no">Mix</span> Tasks</a></li>
     <% end %>
   </ul>
   <div class="gradient"></div>

diff --git a/lib/ex_doc/formatter/html/templates/summary_entry_template.eex b/lib/ex_doc/formatter/html/templates/summary_entry_template.eex
diff --git a/lib/ex_doc/formatter/html/templates/summary_template.eex b/lib/ex_doc/formatter/html/templates/summary_template.eex
@@ -3,6 +3,18 @@
     <h2>
       <a href="#<%= HTML.text_to_id(name) %>"><%= name %></a>
     </h2>
-    <%= for node <- nodes, do: summary_entry_template(node) %>
+    <%= for node <- nodes do %>
+      <div class="summary-row">
+        <div class="summary-signature">
+          <a href="#<%=enc node.id %>" translate="no"><%=h node.signature %></a>
+          <%= if deprecated = node.deprecated do %>
+            <span class="deprecated" title="<%= h(deprecated) %>">deprecated</span>
+          <% end %>
+        </div>
+        <%= if doc = node.rendered_doc do %>
+          <div class="summary-synopsis"><%= synopsis(doc) %></div>
+        <% end %>
+      </div>
+    <% end %>
   </div>
 <% end %>
diff --git a/test/ex_doc/formatter/epub/templates_test.exs b/test/ex_doc/formatter/epub/templates_test.exs
@@ -89,7 +89,7 @@ defmodule ExDoc.Formatter.EPUB.TemplatesTest do
 
     test "outputs summaries" do
       content = get_module_page([CompiledWithDocs])
-      assert content =~ ~r{<div class="summary-signature">\s*<a href="#example_1/0">}
+      assert content =~ ~r{<div class="summary-signature">\s*<a href="#example_1/0" translate="no">}
     end
 
     test "contains links to summary sections when those exist" do