Merge 3428ece702 into c455f960ca

.github/workflows/build.yml

@@ -25,95 +25,94 @@ jobs:
       - name: Test code snippets
         run: mdbook test
 
-  # TODO: Activate when first translation is available
-  # i18n-helpers:
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Checkout
-  #       uses: actions/checkout@v3
-
-  #     - name: Install Gettext
-  #       run: sudo apt install gettext
-
-  #     - name: Setup Rust cache
-  #       uses: ./.github/workflows/setup-rust-cache
-
-  #     - name: Install mdbook
-  #       uses: ./.github/workflows/install-mdbook
-
-  #     - name: Generate po/messages.pot
-  #       run: mdbook build -d po
-  #       env:
-  #         MDBOOK_OUTPUT: '{"xgettext": {"pot-file": "messages.pot"}}'
-
-  #     - name: Test messages.pot
-  #       run: msgfmt --statistics -o /dev/null po/messages.pot
-
-  #     - name: Expand includes without translation
-  #       run: mdbook build -d expanded
-  #       env:
-  #         MDBOOK_OUTPUT: '{"markdown": {}}'
-
-  #     - name: Expand includes with no-op translation
-  #       run: mdbook build -d no-op
-  #       env:
-  #         MDBOOK_OUTPUT: '{"markdown": {}}'
-  #         MDBOOK_PREPROCESSOR__GETTEXT__PO_FILE: po/messages.pot
-
-  #     - name: Compare no translation to no-op translation
-  #       run: diff --color=always --unified --recursive expanded no-op
-
-  # find-translations:
-  #   runs-on: ubuntu-latest
-  #   outputs:
-  #     languages: ${{ steps.find-translations.outputs.languages }}
-  #   steps:
-  #     - name: Checkout
-  #       uses: actions/checkout@v3
-
-  #     - name: Find translations
-  #       id: find-translations
-  #       shell: python
-  #       run: |
-  #         import os, json, pathlib
-  #         languages = [p.stem for p in pathlib.Path("po").iterdir() if p.suffix == ".po"]
-  #         github_output = open(os.environ["GITHUB_OUTPUT"], "a")
-  #         github_output.write("languages=")
-  #         json.dump(sorted(languages), github_output)
-
-  # translations:
-  #   runs-on: ubuntu-latest
-  #   needs:
-  #     - find-translations
-  #   strategy:
-  #     matrix:
-  #       language: ${{ fromJSON(needs.find-translations.outputs.languages) }}
-  #   env:
-  #     MDBOOK_BOOK__LANGUAGE: ${{ matrix.language }}
-  #   steps:
-  #     - name: Checkout
-  #       uses: actions/checkout@v3
-
-  #     - name: Install Gettext
-  #       run: sudo apt install gettext
-
-  #     - name: Setup Rust cache
-  #       uses: ./.github/workflows/setup-rust-cache
-
-  #     - name: Install mdbook
-  #       uses: ./.github/workflows/install-mdbook
-
-  #     - name: Test ${{ matrix.language }} translation
-  #       run: msgfmt --statistics -o /dev/null po/${{ matrix.language }}.po
-
-  #     - name: Build book with ${{ matrix.language }} translation
-  #       run: mdbook build
-
-  #     - name: Upload ${{ matrix.language }} translation
-  #       uses: actions/upload-artifact@v3
-  #       with:
-  #         name: rust-design-patterns-${{ matrix.language }}
-  #         path: book/
-
-  #     - name: Test code snippets with ${{ matrix.language }} translation
-  #       run: mdbook test
+  i18n-helpers:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Gettext
+        run: sudo apt install gettext
+
+      - name: Setup Rust cache
+        uses: ./.github/workflows/setup-rust-cache
+
+      - name: Install mdbook
+        uses: ./.github/workflows/install-mdbook
+
+      - name: Generate po/messages.pot
+        run: mdbook build -d po
+        env:
+          MDBOOK_OUTPUT: '{"xgettext": {"pot-file": "messages.pot"}}'
+
+      - name: Test messages.pot
+        run: msgfmt --statistics -o /dev/null po/messages.pot
+
+      - name: Expand includes without translation
+        run: mdbook build -d expanded
+        env:
+          MDBOOK_OUTPUT: '{"markdown": {}}'
+
+      - name: Expand includes with no-op translation
+        run: mdbook build -d no-op
+        env:
+          MDBOOK_OUTPUT: '{"markdown": {}}'
+          MDBOOK_PREPROCESSOR__GETTEXT__PO_FILE: po/messages.pot
+
+      - name: Compare no translation to no-op translation
+        run: diff --color=always --unified --recursive expanded no-op
+
+  find-translations:
+    runs-on: ubuntu-latest
+    outputs:
+      languages: ${{ steps.find-translations.outputs.languages }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Find translations
+        id: find-translations
+        shell: python
+        run: |
+          import os, json, pathlib
+          languages = [p.stem for p in pathlib.Path("po").iterdir() if p.suffix == ".po"]
+          github_output = open(os.environ["GITHUB_OUTPUT"], "a")
+          github_output.write("languages=")
+          json.dump(sorted(languages), github_output)
+
+  translations:
+    runs-on: ubuntu-latest
+    needs:
+      - find-translations
+    strategy:
+      matrix:
+        language: ${{ fromJSON(needs.find-translations.outputs.languages) }}
+    env:
+      MDBOOK_BOOK__LANGUAGE: ${{ matrix.language }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Gettext
+        run: sudo apt install gettext
+
+      - name: Setup Rust cache
+        uses: ./.github/workflows/setup-rust-cache
+
+      - name: Install mdbook
+        uses: ./.github/workflows/install-mdbook
+
+      - name: Test ${{ matrix.language }} translation
+        run: msgfmt --statistics -o /dev/null po/${{ matrix.language }}.po
+
+      - name: Build book with ${{ matrix.language }} translation
+        run: mdbook build
+
+      - name: Upload ${{ matrix.language }} translation
+        uses: actions/upload-artifact@v3
+        with:
+          name: rust-design-patterns-${{ matrix.language }}
+          path: book/
+
+      - name: Test code snippets with ${{ matrix.language }} translation
+        run: mdbook test

.github/workflows/publish.yml

@@ -2,7 +2,12 @@ name: Deploy mdBook sites to GH Pages
 
 on:
   push:
-    branches: ["main"]
+    # TODO: Change before merge into main
+    # branches: ["main"]
+    branches:
+      - main
+      - translation-de
+
   workflow_dispatch:
 
 permissions:
@@ -19,9 +24,12 @@ env:
   CARGO_TERM_COLOR: always
   # TODO: Update the language picker in index.hbs to link new languages.
   # TODO: As long as https://github.com/google/mdbook-i18n-helpers/issues/12 is not implemented, yet.
-  # TODO: Activate when first translation is available
   # These are the languages in addition to 'en', which is the main language
-  # LANGUAGES: xx
+  # de linked, due to being partly reviewed
+  # es not linked, due to being mostly unreviewed
+  # it not linked, due to being mostly unreviewed
+  # pt-BR not linked, due to being mostly unreviewed
+  LANGUAGES: de es it pt-BR
 
 jobs:
   publish:
@@ -42,16 +50,15 @@ jobs:
       - name: Build course in English
         run: mdbook build -d book
 
-      # TODO: Activate when first translation is available
-      # - name: Build all translations
-      #   run: |
-      #     for po_lang in ${{ env.LANGUAGES }}; do
-      #         echo "::group::Building $po_lang translation"
-      #         MDBOOK_BOOK__LANGUAGE=$po_lang \
-      #         MDBOOK_OUTPUT__HTML__SITE_URL=/patterns/$po_lang/ \
-      #         mdbook build -d book/$po_lang
-      #         echo "::endgroup::"
-      #     done
+      - name: Build all translations
+        run: |
+          for po_lang in ${{ env.LANGUAGES }}; do
+              echo "::group::Building $po_lang translation"
+              MDBOOK_BOOK__LANGUAGE=$po_lang \
+              MDBOOK_OUTPUT__HTML__SITE_URL=/patterns/$po_lang/ \
+              mdbook build -d book/$po_lang
+              echo "::endgroup::"
+          done
 
       - name: Setup Pages
         id: pages

.gitignore

@@ -1,3 +1,4 @@
 # Generated output of mdbook
 /book
 .DS_Store
+po/*.mo

language-picker.css

@@ -1,6 +1,6 @@
 #language-list {
   left: auto;
-  right: 10px;
+  right: 9em;
 }
 
 #language-list a {

theme/index.hbs

@@ -1,5 +1,6 @@
 <!DOCTYPE HTML>
 <html lang="{{ language }}" class="sidebar-visible no-js {{ default_theme }}">
+
 <head>
     <!-- Book generated using mdBook -->
     <meta charset="UTF-8">
@@ -49,9 +50,11 @@
 
     {{#if mathjax_support}}
     <!-- MathJax -->
-        <script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+    <script async
+        src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
     {{/if}}
 </head>
+
 <body>
     <!-- Provide site root to javascript -->
     <script>
@@ -113,10 +116,12 @@
             <div id="menu-bar-hover-placeholder"></div>
             <div id="menu-bar" class="menu-bar sticky bordered">
                 <div class="left-buttons">
-                        <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
+                    <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents"
+                        aria-label="Toggle Table of Contents" aria-controls="sidebar">
                         <i class="fa fa-bars"></i>
                     </button>
-                        <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
+                    <button id="theme-toggle" class="icon-button" type="button" title="Change theme"
+                        aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
                         <i class="fa fa-paint-brush"></i>
                     </button>
                     <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
@@ -127,7 +132,9 @@
                         <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
                     </ul>
                     {{#if search_enabled}}
-                        <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
+                    <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)"
+                        aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S"
+                        aria-controls="searchbar">
                         <i class="fa fa-search"></i>
                     </button>
                     {{/if}}
@@ -136,16 +143,20 @@
                 <h1 class="menu-title">{{ book_title }}</h1>
 
                 <div class="right-buttons">
-                        <button id="language-toggle" class="icon-button" type="button"
-                                title="Change language" aria-label="Change language"
-                                aria-haspopup="true" aria-expanded="false"
+                    <button id="language-toggle" class="icon-button" type="button" title="Change language"
+                        aria-label="Change language" aria-haspopup="true" aria-expanded="false"
                         aria-controls="language-list">
                         <i class="fa fa-globe"></i>
                     </button>
                     <ul id="language-list" class="theme-popup" aria-label="Languages" role="menu">
                         <li role="none"><button role="menuitem" class="theme">
                                 <a id="en">English</a>
-                          </button></li>
+                            </button>
+                        </li>
+                        <li role="none"><button role="menuitem" class="theme">
+                                <a id="de">Deutsch</a>
+                            </button>
+                        </li>
                         {{!-- <li role="none"><button role="menuitem" class="theme">
                                 <a id="pt-BR">Brazilian Portuguese</a>
                             </button></li>
@@ -211,7 +222,8 @@
             {{#if search_enabled}}
             <div id="search-wrapper" class="hidden">
                 <form id="searchbar-outer" class="searchbar-outer">
-                        <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
+                    <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..."
+                        aria-controls="searchresults-outer" aria-describedby="searchresults-header">
                 </form>
                 <div id="searchresults-outer" class="searchresults-outer hidden">
                     <div id="searchresults-header" class="searchresults-header"></div>
@@ -238,13 +250,15 @@
                 <nav class="nav-wrapper" aria-label="Page navigation">
                     <!-- Mobile navigation buttons -->
                     {{#previous}}
-                            <a rel="prev" href="{{ path_to_root }}{{link}}" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                    <a rel="prev" href="{{ path_to_root }}{{link}}" class="mobile-nav-chapters previous"
+                        title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                         <i class="fa fa-angle-left"></i>
                     </a>
                     {{/previous}}
 
                     {{#next}}
-                            <a rel="next" href="{{ path_to_root }}{{link}}" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                    <a rel="next" href="{{ path_to_root }}{{link}}" class="mobile-nav-chapters next"
+                        title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
                     {{/next}}
@@ -256,13 +270,15 @@
 
         <nav class="nav-wide-wrapper" aria-label="Page navigation">
             {{#previous}}
-                    <a rel="prev" href="{{ path_to_root }}{{link}}" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+            <a rel="prev" href="{{ path_to_root }}{{link}}" class="nav-chapters previous" title="Previous chapter"
+                aria-label="Previous chapter" aria-keyshortcuts="Left">
                 <i class="fa fa-angle-left"></i>
             </a>
             {{/previous}}
 
             {{#next}}
-                    <a rel="next" href="{{ path_to_root }}{{link}}" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+            <a rel="next" href="{{ path_to_root }}{{link}}" class="nav-chapters next" title="Next chapter"
+                aria-label="Next chapter" aria-keyshortcuts="Right">
                 <i class="fa fa-angle-right"></i>
             </a>
             {{/next}}
@@ -297,8 +313,10 @@
             // make sure we don't activate google analytics if the developer is
             // inspecting the book locally...
             if (localAddrs.indexOf(document.location.hostname) === -1) {
-                (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-                (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+                (function (i, s, o, g, r, a, m) {
+                    i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
+                        (i[r].q = i[r].q || []).push(arguments)
+                    }, i[r].l = 1 * new Date(); a = s.createElement(o),
                         m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
                 })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');
 
@@ -362,4 +380,5 @@
     {{/if}}
 
 </body>
+
 </html>