haveapi 0.32.1 → 0.32.2

data/lib/haveapi/public/js/documentation.js

@@ -3,6 +3,29 @@
 
   var storageKey = 'haveapi.docs.preferences.v1';
 
+  var messages = Object.create(null);
+
+  function setDocumentationMessages(value) {
+    messages = value && typeof value === 'object' && !Array.isArray(value) ? value : Object.create(null);
+  }
+
+  function documentationMessage(key, values) {
+    var text = typeof messages[key] === 'string' ? messages[key] : key;
+    return text.replace(/%\{([a-z_]+)\}/g, function (placeholder, name) {
+      return values && Object.prototype.hasOwnProperty.call(values, name) ? String(values[name]) : placeholder;
+    });
+  }
+
+  function documentationLanguageURL(href, locale) {
+    if (['en', 'cs'].indexOf(locale) < 0) return null;
+    try {
+      var destination = new URL(href);
+      if (!/^https?:$/.test(destination.protocol)) return null;
+      destination.searchParams.set('doc_lang', locale);
+      return destination.href;
+    } catch (error) { return null; }
+  }
+
   function preferences(value) {
     var source = value && typeof value === 'object' ? value : {};
     var clients = Object.create(null);
@@ -131,8 +154,8 @@
       var button = doc.createElement('button');
       button.type = 'button';
       button.setAttribute('data-copy-example', '');
-      button.setAttribute('aria-label', 'Copy example');
-      button.title = 'Copy example';
+      button.setAttribute('aria-label', documentationMessage('copy_example'));
+      button.title = documentationMessage('copy_example');
       var icon = doc.createElementNS('http://www.w3.org/2000/svg', 'svg');
       icon.setAttribute('viewBox', '0 0 24 24');
       icon.setAttribute('aria-hidden', 'true');
@@ -160,7 +183,7 @@
         var current = generation;
         copyText(code.textContent, win, doc, navigator).then(function (success) {
           if (current !== generation || visibleExampleCode(panel) !== code) return;
-          status.textContent = success ? 'Copied' : 'Select the code and copy it.';
+          status.textContent = success ? documentationMessage('copied') : documentationMessage('copy_failed');
         });
       });
     });
@@ -324,12 +347,13 @@
       if (!/^https?:$/.test(base.protocol) || base.origin !== current.origin || base.username || base.password
         || base.search || base.hash || !base.pathname.endsWith('/') || url.origin !== base.origin
         || url.pathname !== base.pathname || url.username || url.password || url.hash
-        || Array.from(url.searchParams).length !== 2 || url.searchParams.getAll('page').length !== 1
+        || Array.from(url.searchParams).length !== (url.searchParams.has('doc_lang') ? 3 : 2)
+        || (url.searchParams.has('doc_lang') && (url.searchParams.getAll('doc_lang').length !== 1 || ['en', 'cs'].indexOf(url.searchParams.get('doc_lang')) < 0)) || url.searchParams.getAll('page').length !== 1
         || url.searchParams.get('page') !== 'resources' || url.searchParams.getAll('search_index').length !== 1
         || typeof version !== 'string' || !version || (key !== '' && !/^[a-f0-9]{64}$/.test(key))) return null;
       if (url.searchParams.get('search_index') !== (key || 'current')) return null;
       if (bootstrap) { url.searchParams.set('search_index', 'current'); key = ''; }
-      return { url: url.href, origin: base.origin, base_path: base.pathname, version: version, key: key };
+      return { url: url.href, origin: base.origin, base_path: base.pathname, version: version, key: key, locale: url.searchParams.get('doc_lang') };
     } catch (error) { return null; }
   }
 
@@ -355,6 +379,7 @@
     var index = envelope.index;
     shape(index, ['format', 'version', 'base_path', 'locale', 'visibility', 'resources', 'actions', 'parameters']);
     if (index.format !== 1 || index.version !== expected.version || index.base_path !== expected.base_path
+      || (expected.locale && index.locale !== expected.locale)
       || ['anonymous', 'authenticated'].indexOf(index.visibility) < 0) fail();
     ['version', 'base_path', 'locale', 'visibility'].forEach(function (field) { string(index[field]); });
     if (!Array.isArray(index.resources) || !Array.isArray(index.actions) || !Array.isArray(index.parameters)) fail();
@@ -462,7 +487,7 @@
     var link = doc.createElement('a');
     var name = result.kind === 'resource' ? result.resource_path.join('.') : result.name;
     link.href = searchResultURL(index, result, origin);
-    link.textContent = result.kind.charAt(0).toUpperCase() + result.kind.slice(1) + ': ';
+    link.textContent = documentationMessage(result.kind) + ': ';
     var code = doc.createElement('code');
     code.textContent = name;
     link.appendChild(code);
@@ -473,8 +498,8 @@
     } else {
       context.push(result.resource_path.join('.') + (result.action_name !== null ? ' · ' + result.action_name : ''));
     }
-    if (result.kind === 'parameter') context.push(result.direction.charAt(0).toUpperCase() + result.direction.slice(1) + ' · ' + result.type);
-    if (result.authentication !== null) context.push('Authentication: ' + result.authentication);
+    if (result.kind === 'parameter') context.push(documentationMessage(result.direction) + ' · ' + result.type);
+    if (result.authentication !== null) context.push(documentationMessage('authentication', { provider: result.authentication }));
     if (result.kind !== 'resource' && typeof result.label === 'string' && result.label !== result.name) context.push(result.label);
     context.forEach(function (text) {
       var detail = doc.createElement('span');
@@ -523,7 +548,7 @@
 
   // Pure helpers keep saved-state and legacy-link contracts independently testable.
   if (typeof module !== 'undefined' && module.exports) {
-    module.exports = { preferences: preferences, readPreferences: readPreferences, clientChoice: clientChoice,
+    module.exports = { setDocumentationMessages: setDocumentationMessages, documentationLanguageURL: documentationLanguageURL, documentationMessage: documentationMessage, preferences: preferences, readPreferences: readPreferences, clientChoice: clientChoice,
       detailLevels: detailLevels, effectiveDetail: effectiveDetail, exampleDetail: exampleDetail, copyText: copyText,
       exampleCopyControls: exampleCopyControls, disclosureMenus: disclosureMenus,
       legacyTarget: legacyTarget, loginTarget: loginTarget,
@@ -561,12 +586,27 @@
       try { return element ? JSON.parse(element.textContent) : fallback; }
       catch (error) { return fallback; }
     };
+    setDocumentationMessages(json('[data-documentation-messages]', {}));
     var metadata = json('[data-documentation-clients]', []);
     var clients = Array.isArray(metadata) ? metadata.filter(function (client, index, list) {
       return client && typeof client.id === 'string' && typeof client.language === 'string'
         && typeof client.language_label === 'string' && client.id && client.language
         && list.findIndex(function (entry) { return entry && entry.id === client.id; }) === index;
     }) : [];
+    all('[data-example-preferences]').forEach(function (form) {
+      try {
+        var selected = JSON.parse(form.getAttribute('data-example-selection'));
+        var client = selected && clients.find(function (entry) { return entry.id === selected.client && entry.language === selected.language; });
+        if (client) {
+          state.language = client.language;
+          state.clients[client.language] = client.id;
+          state.detail = selected.detail === 'thorough' ? 'thorough' : 'simple';
+        }
+      } catch (error) { /* Invalid optional selection leaves saved preferences available. */ }
+      form.addEventListener('submit', function (event) { event.preventDefault(); });
+      var apply = form.querySelector('[data-apply-examples]');
+      if (apply) apply.hidden = true;
+    });
     var sidebar = root.querySelector('[data-docs-sidebar]');
     var examples = all('[data-example]');
     var sections = all('[data-doc-section]');
@@ -685,8 +725,8 @@
       all('[data-detail-select]').forEach(function (select) {
         var levels = choice ? detailLevels(choice) : [];
         select.replaceChildren();
-        levels.forEach(function (detail) { option(select, detail, detail === 'thorough' ? 'With error handling' : 'Simple'); });
-        (select.closest('[data-detail-control]') || select).hidden = false;
+        levels.forEach(function (detail) { option(select, detail, documentationMessage(detail === 'thorough' ? 'thorough' : 'simple')); });
+        (select.closest('[data-detail-control]') || select).hidden = levels.length < 2;
         select.disabled = levels.length < 2;
         select.value = effectiveDetail(state, choice);
       });
@@ -696,8 +736,8 @@
       if (status) {
         var fallback = choice && ((state.language && state.language !== choice.language)
           || (state.clients[choice.language] && state.clients[choice.language] !== choice.id));
-        status.textContent = fallback ? 'Your saved example is unavailable. Showing ' + choice.language_label
-          + (choice.variant ? ' (' + choice.variant + ')' : '') + '.' : '';
+        status.textContent = fallback ? documentationMessage('saved_example_unavailable', { client: choice.language_label
+          + (choice.variant ? ' (' + choice.variant + ')' : '') }) : '';
         status.hidden = !fallback;
       }
     }
@@ -724,7 +764,7 @@
           unavailable = document.createElement('p');
           unavailable.setAttribute('data-example-unavailable', '');
           unavailable.className = 'docs-notice';
-          unavailable.textContent = 'No example is available for this client.';
+          unavailable.textContent = documentationMessage('example_unavailable');
           example.appendChild(unavailable);
         }
         unavailable.hidden = !!chosen;
@@ -762,6 +802,20 @@
       });
     }
 
+    all('[data-documentation-language]').forEach(function (form) {
+      var select = form.querySelector('[name="doc_lang"]');
+      if (!select) return;
+      function navigate(event) {
+        var destination = documentationLanguageURL(window.location.href, select.value);
+        if (!destination) return;
+        if (event) event.preventDefault();
+        window.location.assign(destination);
+      }
+      form.addEventListener('submit', navigate);
+      select.addEventListener('change', navigate);
+      var submit = form.querySelector('[data-documentation-language-submit]');
+      if (submit) submit.hidden = true;
+    });
     all('[data-language-select]').forEach(function (select) {
       select.addEventListener('change', function () { state.language = select.value; persist(); updatePreservingPosition(select); });
     });
@@ -841,9 +895,8 @@
           list.appendChild(renderSearchResult(document, snapshot.index, result, window.location.origin));
         });
         preview.replaceChildren(list);
-        searchStatus.textContent = !results.results.length ? 'No matches. Try another resource, action or parameter name.'
-          : results.more ? 'Showing ' + results.results.length + ' results. More matches are available; refine your search.'
-            : results.results.length + (results.results.length === 1 ? ' result.' : ' results.');
+        searchStatus.textContent = documentationMessage(!results.results.length ? 'search_empty' : results.more ? 'search_more'
+          : results.results.length === 1 ? 'search_one' : 'search_count', { count: results.results.length });
         suggestions.hidden = false;
       }
       function intent() {
@@ -853,18 +906,18 @@
         var config = searchConfiguration(form.action, form.getAttribute('data-search-index-url'),
           form.getAttribute('data-search-view-key'), form.getAttribute('data-search-version'), window.location.href, bootstrapSearch);
         if (!config) {
-          if (query) { suggestions.hidden = false; searchStatus.textContent = 'Search could not be loaded. Submit to open the results page.'; }
+          if (query) { suggestions.hidden = false; searchStatus.textContent = documentationMessage('search_failed'); }
           return;
         }
         var loaded = indexLoader.peek(config);
         if (loaded) { if (query && Array.from(query).length <= 256) render(loaded, query); return; }
-        if (query) { suggestions.hidden = false; searchStatus.textContent = 'Loading search…'; }
+        if (query) { suggestions.hidden = false; searchStatus.textContent = documentationMessage('search_loading'); }
         indexLoader.load(config).then(function (snapshot) {
           if (current !== generation || input.value.trim() !== query || !query || Array.from(query).length > 256) return;
           render(snapshot, query);
         }).catch(function () {
           if (current === generation && query) {
-            searchStatus.textContent = 'Search could not be loaded. Submit to open the results page.';
+            searchStatus.textContent = documentationMessage('search_failed');
             suggestions.hidden = false;
           }
         });

data/lib/haveapi/server.rb

@@ -5,6 +5,7 @@ require 'cgi'
 require 'haveapi/hooks'
 require 'haveapi/documentation_clients'
 require 'haveapi/documentation_helpers'
+require 'haveapi/documentation_locale'
 require 'haveapi/documentation_validators'
 require 'haveapi/documentation_search'
 require 'haveapi/shared_documentation_helpers'
@@ -237,7 +238,9 @@ module HaveAPI
       end
 
       def doc(file)
-        markdown :"../../../doc/#{file}", with_toc_data: true, tables: true, fenced_code_blocks: true, lax_spacing: true
+        path = documentation_article_path(file)
+        shared_documentation_links(markdown(File.read(path), with_toc_data: true, tables: true,
+                                                             fenced_code_blocks: true, lax_spacing: true))
       end
 
       def base_url
@@ -255,7 +258,7 @@ module HaveAPI
         @documentation_context ||= HaveAPI::ClientExample::Context.new(
           version: @v, host:, base_url: "#{base_url}#{root.end_with?('/') ? root : "#{root}/"}",
           version_url: "#{base_url}#{root.end_with?('/') ? root : "#{root}/"}v#{@v}/",
-          description: @help
+          description: @help, locale: documentation_locale
         )
         profile = if client
                     settings.api_server.documentation_client_profiles(@v)[client.code&.to_sym]
@@ -274,7 +277,8 @@ module HaveAPI
       end
 
       def documentation_clients
-        HaveAPI::ClientExample.clients.select { |client| client.available?(documentation_context(client)) }
+        # The server's @documentation_clients owns profiles, not this request list.
+        @documentation_available_clients ||= HaveAPI::ClientExample.clients.select { |client| client.available?(documentation_context(client)) } # rubocop:disable Naming/MemoizedInstanceVariableName
       end
 
       def documentation_panels(kind, auth_method: nil, auth_description: nil, **changes)
@@ -513,6 +517,7 @@ module HaveAPI
         helpers ServerHelpers
         helpers DocHelpers
         helpers DocumentationHelpers
+        helpers DocumentationLocale
         helpers DocumentationSearch::Helpers
         helpers SharedDocumentationHelpers
         helpers DocumentationOAuth::Helpers
@@ -561,23 +566,25 @@ module HaveAPI
           [version, documentation_authenticated?(version)]
         end
 
-        @api = settings.api_server.describe(Context.new(
-                                              settings.api_server,
-                                              user: auth_users_by_version[settings.api_server.default_version],
-                                              params:,
-                                              auth_users_by_version:
-                                            ))
-
-        if single_version
-          version = settings.api_server.default_version
-          @documentation_index_account = {
-            version:, user: auth_users_by_version[version],
-            authentication: @api[:versions].fetch(version).fetch(:authentication)
-          }
-        end
+        with_documentation_locale do
+          @api = settings.api_server.describe(Context.new(
+                                                settings.api_server,
+                                                user: auth_users_by_version[settings.api_server.default_version],
+                                                params:,
+                                                auth_users_by_version:
+                                              ))
+
+          if single_version
+            version = settings.api_server.default_version
+            @documentation_index_account = {
+              version:, user: auth_users_by_version[version],
+              authentication: @api[:versions].fetch(version).fetch(:authentication)
+            }
+          end
 
-        content_type 'text/html'
-        render_documentation_index
+          content_type 'text/html'
+          render_documentation_index
+        end
       end
 
       @sinatra.options @root do
@@ -621,36 +628,14 @@ module HaveAPI
 
       # Shared documentation keeps the existing content and URL aliases.
       @sinatra.get "#{@root}doc" do
-        render_shared_readme
-      end
-
-      @sinatra.get "#{@root}doc/readme" do
-        render_shared_readme
-      end
-
-      @sinatra.get "#{@root}doc/json-schema" do
-        begin
-          content = File.read(File.join(settings.root, '../../doc/json-schema.html'))
-        rescue Errno::ENOENT
-          halt 404
-        end
-        render_shared_documentation(content:, title: 'JSON schema', sidebar: erb(:'doc_sidebars/json-schema'))
+        with_documentation_locale { render_shared_article('readme') }
       end
 
-      @sinatra.get %r{#{@root}doc/([^.]+)(\.md)?} do |file, _|
-        next render_shared_readme if file == 'index'
+      @sinatra.get %r{#{@root}doc/([a-z0-9-]+)(\.md)?} do |file, extension|
+        halt 404 if extension && %w[readme json-schema].include?(file)
 
-        begin
-          content = doc(file)
-        rescue Errno::ENOENT
-          halt 404
-        end
-        sidebar = begin
-          erb :"doc_sidebars/#{file}"
-        rescue Errno::ENOENT
-          nil
-        end
-        render_shared_documentation(content:, title: file.humanize, sidebar:)
+        file = 'readme' if file == 'index'
+        with_documentation_locale { render_shared_article(file) }
       end
 
       # Retain old documentation links without engaging browser credentials.
@@ -693,7 +678,7 @@ module HaveAPI
 
         headers 'Cache-Control' => 'private, no-store'
         query = request.query_string
-        halt 400, 'Invalid documentation query' if query.bytes.any? { |byte| byte < 32 || byte == 127 }
+        halt 400, documentation_t('errors.query') if query.bytes.any? { |byte| byte < 32 || byte == 127 }
         destination = url(prefix, false)
         destination += "?#{query}" unless query.empty?
         halt 308, { 'Location' => destination }, ''

data/lib/haveapi/shared_documentation_helpers.rb

@@ -1,7 +1,7 @@
 module HaveAPI
   module SharedDocumentationHelpers
     def render_documentation_index
-      render_neutral_documentation(content: erb(:index), title: 'API versions', page: 'versions')
+      render_neutral_documentation(content: erb(:index), title: documentation_t('labels.api_versions'), page: 'versions')
     end
 
     def render_shared_documentation(content:, title:, sidebar: nil)
@@ -9,9 +9,57 @@ module HaveAPI
     end
 
     def render_shared_readme
-      content = markdown(File.read("#{settings.views}/../../../README.md"),
-                         with_toc_data: true, tables: true, fenced_code_blocks: true, lax_spacing: true)
-      render_shared_documentation(content:, title: 'HaveAPI internals')
+      render_shared_article('readme')
+    end
+
+    def documentation_article_path(article, extension: 'md')
+      halt 404 unless article.match?(/\A[a-z0-9-]+\z/) && %w[md html].include?(extension)
+
+      directory = File.expand_path('../../doc', __dir__)
+      locale = documentation_locale
+      path = File.join(directory, locale, "#{article}.#{extension}")
+      unless File.file?(path)
+        locale = 'en'
+        path = File.join(directory, locale, "#{article}.#{extension}")
+      end
+      halt 404 unless File.file?(path)
+
+      @documentation_article_locale = locale
+      path
+    end
+
+    def render_shared_article(article)
+      @documentation_article_id = article
+      content = if article == 'json-schema'
+                  File.read(documentation_article_path(article, extension: 'html'))
+                else
+                  doc(article)
+                end
+      title = documentation_t("articles.#{article.tr('-', '_')}", default: article.humanize)
+      sidebar = begin
+        erb :"doc_sidebars/#{article}"
+      rescue Errno::ENOENT
+        nil
+      end
+      render_shared_documentation(content:, title:, sidebar:)
+    rescue Errno::ENOENT
+      halt 404
+    end
+
+    def shared_documentation_links(content)
+      content.gsub(/(href|src)="([^"#]*)(#[^"]*)?"/) do |attribute|
+        kind = Regexp.last_match(1)
+        path = Regexp.last_match(2)
+        fragment = Regexp.last_match(3).to_s
+        if path.match?(%r{\A(?:(?:\.\./)*(?:en/|cs/)?|/doc/(?:en/|cs/)?)[a-z0-9-]+\.md\z})
+          article = File.basename(path, '.md')
+          %(#{kind}="#{escape_html(shared_documentation_url("doc/#{article}"))}#{fragment}")
+        elsif path.match?(%r{\A(?:\.\./)+[a-z0-9-]+\.png\z})
+          %(#{kind}="#{escape_html(shared_documentation_url("doc/#{File.basename(path)}"))}#{fragment}")
+        else
+          attribute
+        end
+      end
     end
 
     def shared_documentation_url(path = '')
@@ -47,7 +95,7 @@ module HaveAPI
     def shared_documentation_tables(content)
       # Trusted repository HTML is rendered before this presentation-only pass.
       content.gsub(%r{<table\b[^>]*>.*?</table>}m) do |table|
-        %(<div class="docs-table-scroll" role="region" aria-label="Documentation table" tabindex="0">#{table}</div>)
+        %(<div class="docs-table-scroll" role="region" aria-label="#{escape_html(documentation_t('accessibility.documentation_table'))}" tabindex="0">#{table}</div>)
       end
     end
   end

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '2.0'.freeze
-  VERSION = '0.32.1'.freeze
+  VERSION = '0.32.2'.freeze
 end

data/lib/haveapi/views/doc_layout.erb

@@ -1,14 +1,15 @@
 <% yield %>
 <% if @documentation_ui %>
 <div data-docs data-page="<%= @documentation_page %>" data-resource="<%= escape_html(@documentation_resource && @documentation_resource[:key]) %>">
-  <a class="docs-skip-link" href="#docs-main">Skip to content</a>
+  <a class="docs-skip-link" href="#docs-main"><%= escape_html(documentation_t('accessibility.skip')) %></a>
   <div class="docs-mobile-toolbar">
-    <button type="button" data-nav-toggle aria-controls="docs-navigation" aria-expanded="false">Navigation</button>
+    <button type="button" data-nav-toggle aria-controls="docs-navigation" aria-expanded="false"><%= escape_html(documentation_t('accessibility.navigation')) %></button>
   </div>
   <div class="docs-layout">
     <aside class="docs-sidebar" id="docs-navigation" data-docs-sidebar><%= @sidebar %></aside>
     <main class="docs-main" id="docs-main" tabindex="-1"><%= @content %></main>
   </div>
+  <script type="application/json" data-documentation-messages><%= documentation_json(documentation_t('browser')) %></script>
   <script type="application/json" data-documentation-clients><%= documentation_json(@help ? documentation_client_metadata : []) %></script>
   <script type="application/json" data-legacy-anchors><%= documentation_json(@documentation_page == 'overview' ? documentation_legacy_anchors : {}) %></script>
 </div>

data/lib/haveapi/views/doc_sidebars/create-client.erb

@@ -1,20 +1,20 @@
-<h2>Contents</h2>
+<h2><%= escape_html(documentation_t('labels.contents')) %></h2>
 <ul class="top-level">
-  <li><a href="#client-definition">Client definition</a></li>
-  <li><a href="#design-rules">Design rules</a></li>
+  <li><a href="#client-definition"><%= escape_html(documentation_t('toc.client_definition')) %></a></li>
+  <li><a href="#design-rules"><%= escape_html(documentation_t('toc.design_rules')) %></a></li>
   <li>
-    <a href="#necessary-features-to-implement">Necessary features to implement</a>
+    <a href="#necessary-features-to-implement"><%= escape_html(documentation_t('toc.necessary_features_to_implement')) %></a>
     <ul>
-      <li><a href="#resource-tree">Resource tree</a></li>
-      <li><a href="#input-output-parameters">Input/output parameters</a></li>
-      <li><a href="#authentication">Authentication</a></li>
-      <li><a href="#object-like-access">Object-like access</a></li>
+      <li><a href="#resource-tree"><%= escape_html(documentation_t('toc.resource_tree')) %></a></li>
+      <li><a href="#input-output-parameters"><%= escape_html(documentation_t('toc.input_output_parameters')) %></a></li>
+      <li><a href="#authentication"><%= escape_html(documentation_t('labels.authentication')) %></a></li>
+      <li><a href="#object-like-access"><%= escape_html(documentation_t('toc.object_like_access')) %></a></li>
     </ul>
   </li>
   <li>
-    <a href="#supplemental-features">Supplemental features</a>
+    <a href="#supplemental-features"><%= escape_html(documentation_t('toc.supplemental_features')) %></a>
     <ul>
-      <li><a href="#client-side-validations">Client-side validations</a></li>
+      <li><a href="#client-side-validations"><%= escape_html(documentation_t('toc.client_side_validations')) %></a></li>
     </ul>
   </li>
 </ul>

data/lib/haveapi/views/doc_sidebars/json-schema.erb

@@ -1,6 +1,6 @@
-<h2>Contents</h2>
+<h2><%= escape_html(documentation_t('labels.contents')) %></h2>
 <ul class="top-level">
-  <li><a href="#envelope">Envelope</a></li>
+  <li><a href="#envelope"><%= escape_html(documentation_t('schema.envelope')) %></a></li>
   <li><a href="#all">OPTIONS /</a></li>
   <li><a href="#versions">OPTIONS /?describe=versions</a></li>
   <li><a href="#default">OPTIONS /?describe=default</a></li>

data/lib/haveapi/views/doc_sidebars/protocol.erb

@@ -1,42 +1,42 @@
-<h2>Contents</h2>
+<h2><%= escape_html(documentation_t('labels.contents')) %></h2>
 <ul class="top-level">
-  <li><a href="#protocol-definition">Protocol definition</a></li>
-  <li><a href="#self-description">Self-description</a></li>
-  <li><a href="#envelope">Envelope</a></li>
+  <li><a href="#protocol-definition"><%= escape_html(documentation_t('toc.protocol_definition')) %></a></li>
+  <li><a href="#self-description"><%= escape_html(documentation_t('toc.self_description')) %></a></li>
+  <li><a href="#envelope"><%= escape_html(documentation_t('schema.envelope')) %></a></li>
   <li>
-    <a href="#description-format">Description format</a>
+    <a href="#description-format"><%= escape_html(documentation_t('toc.description_format')) %></a>
     <ul>
-      <li><a href="#api-version">Version</a></li>
+      <li><a href="#api-version"><%= escape_html(documentation_t('toc.version')) %></a></li>
       <li>
-        <a href="#authentication">Authentication</a>
+        <a href="#authentication"><%= escape_html(documentation_t('labels.authentication')) %></a>
         <ul>
-          <li><a href="#http-basic-authentication">HTTP basic authentication</a></li>
-          <li><a href="#token-authentication">Token authentication</a></li>
+          <li><a href="#http-basic-authentication"><%= escape_html(documentation_t('toc.http_basic_authentication')) %></a></li>
+          <li><a href="#token-authentication"><%= escape_html(documentation_t('toc.token_authentication')) %></a></li>
         </ul>
       </li>
-      <li><a href="#resources">Resources</a></li>
+      <li><a href="#resources"><%= escape_html(documentation_t('labels.resources')) %></a></li>
       <li>
-        <a href="#actions">Actions</a>
+        <a href="#actions"><%= escape_html(documentation_t('labels.actions')) %></a>
         <ul>
-          <li><a href="#layouts">Layouts</a></li>
-          <li><a href="#namespace">Namespace</a></li>
+          <li><a href="#layouts"><%= escape_html(documentation_t('toc.layouts')) %></a></li>
+          <li><a href="#namespace"><%= escape_html(documentation_t('labels.namespace')) %></a></li>
         </ul>
       </li>
       <li>
-        <a href="#parameters">Parameters</a>
+        <a href="#parameters"><%= escape_html(documentation_t('toc.parameters')) %></a>
         <ul>
-          <li><a href="#data-types">Data types</a></li>
-          <li><a href="#resource-association">Resource associations</a></li>
+          <li><a href="#data-types"><%= escape_html(documentation_t('toc.data_types')) %></a></li>
+          <li><a href="#resource-association"><%= escape_html(documentation_t('toc.resource_associations')) %></a></li>
         </ul>
       </li>
-      <li><a href="#examples">Examples</a></li>
-      <li><a href="#list-api-versions">List API versions</a></li>
-      <li><a href="#describe-default-version">Describe default version</a></li>
-      <li><a href="#describe-the-whole-api">Describe the whole API</a></li>
+      <li><a href="#examples"><%= escape_html(documentation_t('labels.examples')) %></a></li>
+      <li><a href="#list-api-versions"><%= escape_html(documentation_t('toc.list_api_versions')) %></a></li>
+      <li><a href="#describe-default-version"><%= escape_html(documentation_t('toc.describe_default_version')) %></a></li>
+      <li><a href="#describe-the-whole-api"><%= escape_html(documentation_t('toc.describe_the_whole_api')) %></a></li>
     </ul>
   </li>
-  <li><a href="#authorization">Authorization</a></li>
-  <li><a href="#input-output-formats">Input/output formats</a></li>
-  <li><a href="#request">Request</a></li>
-  <li><a href="#response">Response</a></li>
+  <li><a href="#authorization"><%= escape_html(documentation_t('toc.authorization')) %></a></li>
+  <li><a href="#input-output-formats"><%= escape_html(documentation_t('toc.input_output_formats')) %></a></li>
+  <li><a href="#request"><%= escape_html(documentation_t('toc.request')) %></a></li>
+  <li><a href="#response"><%= escape_html(documentation_t('toc.response')) %></a></li>
 </ul>

data/lib/haveapi/views/documentation/search_form.erb

@@ -1,9 +1,10 @@
 <form data-documentation-search method="get" action="<%= escape_html(action) %>" data-search-version="<%= escape_html(version) %>" data-search-index-url="<%= escape_html(index_url) %>" data-search-view-key="<%= escape_html(view_key) %>">
   <input type="hidden" name="page" value="resources">
-  <label for="<%= escape_html(id) %>-query">Search API v<%= escape_html(version) %></label>
-  <input type="search" name="q" data-search-query id="<%= escape_html(id) %>-query" value="<%= escape_html(query) %>" placeholder="Resource..." maxlength="256">
-  <button type="submit">Search</button>
-  <div data-search-suggestions role="region" aria-label="Search suggestions" hidden>
+  <input type="hidden" name="doc_lang" value="<%= escape_html(documentation_locale) %>">
+  <label for="<%= escape_html(id) %>-query"><%= escape_html(documentation_t('search.label', version: version)) %></label>
+  <input type="search" name="q" data-search-query id="<%= escape_html(id) %>-query" value="<%= escape_html(query) %>" placeholder="<%= escape_html(documentation_t('search.placeholder')) %>" maxlength="256">
+  <button type="submit"><%= escape_html(documentation_t('search.submit')) %></button>
+  <div data-search-suggestions role="region" aria-label="<%= escape_html(documentation_t('search.suggestions')) %>" hidden>
     <p data-search-status role="status"></p>
     <div data-search-preview></div>
   </div>

data/lib/haveapi/views/documentation/search_results.erb

@@ -1,18 +1,18 @@
-<section data-search-results aria-label="Search results">
-  <h2>Search results for <%= escape_html(search[:query]) %></h2>
+<section data-search-results aria-label="<%= escape_html(documentation_t('search.results')) %>">
+  <h2><%= escape_html(documentation_t('search.results_for', query: search[:query])) %></h2>
   <p data-search-status role="status">
     <% if search[:results].empty? %>
-      No matches. Try another resource, action or parameter name.
+      <%= escape_html(documentation_t('browser.search_empty')) %>
     <% elsif search[:more] %>
-      Showing <%= search[:results].length %> results. More matches are available; refine your search.
+      <%= escape_html(documentation_t('browser.search_more', count: search[:results].length)) %>
     <% else %>
-      <%= search[:results].length %> <%= search[:results].length == 1 ? 'result' : 'results' %>.
+      <%= escape_html(documentation_t(search[:results].length == 1 ? 'browser.search_one' : 'browser.search_count', count: search[:results].length)) %>
     <% end %>
   </p>
   <ol>
     <% search[:results].each do |result| %>
       <li>
-        <a href="<%= escape_html(documentation_search_result_url(result)) %>"><%= escape_html(result[:kind].to_s.capitalize) %>: <code><%= escape_html(documentation_search_result_title(result)) %></code></a>
+        <a href="<%= escape_html(documentation_search_result_url(result)) %>"><%= escape_html(documentation_t("browser.#{result[:kind]}")) %>: <code><%= escape_html(documentation_search_result_title(result)) %></code></a>
         <% documentation_search_result_context(result).each do |context| %><span><%= escape_html(context) %></span><% end %>
       </li>
     <% end %>

data/lib/haveapi/views/index.erb

@@ -1,10 +1,10 @@
-<h1>API versions</h1>
+<h1><%= escape_html(documentation_t('labels.api_versions')) %></h1>
 <ul>
   <% @api[:versions].each do |v, info| %>
     <% next if v == :default %>
     <li>
-      <a href="<%= escape_html(url(info[:help], false)) %>">Version <%= escape_html(v) %></a>
-      <%= '(default)' if v == @api[:default_version] %>
+      <a href="<%= escape_html(url(info[:help], false)) %>"><%= escape_html(documentation_t('version.label', version: v)) %></a>
+      <%= escape_html(documentation_t('version.default')) if v == @api[:default_version] %>
     </li>
   <% end %>
 </ul>