Merge pull request #72 from TakayukiMatsuo/jp_ssh_boot

Author: cconlon

Custom-wolfSSL-theme-JA.patch

@@ -0,0 +1,40 @@
+diff --git a/material/base.html b/material/base.html
+index be0a8c88e..1c1380746 100644
+--- a/material/base.html
++++ b/material/base.html
+@@ -67,6 +67,15 @@
+       {% include "partials/integrations/analytics.html" %}
+     {% endblock %}
+     {% block extrahead %}{% endblock %}
++    <!-- Global site tag (gtag.js) - Google Analytics -->
++     <script async src="https://www.googletagmanager.com/gtag/js?id=UA-64826966-1"></script>
++     <script>
++       window.dataLayer = window.dataLayer || [];
++       function gtag(){dataLayer.push(arguments);}
++       gtag('js', new Date());
++     
++       gtag('config', 'UA-64826966-1');
++     </script>
+   </head>
+   {% set direction = config.theme.direction or lang.t('direction') %}
+   {% if config.theme.palette %}
+diff --git a/material/partials/header.html b/material/partials/header.html
+index 4872af867..6b3573812 100644
+--- a/material/partials/header.html
++++ b/material/partials/header.html
+@@ -66,6 +66,15 @@
+         </div>
+       </div>
+     {% endif %}
++     <div class="md-ellipsis-nav" style="font-size:120%;">
++            <a href="https://www.wolfssl.jp/">ホーム</a>
++            <a href="https://www.wolfssl.jp/products/">製品</a>
++            <a href="https://www.wolfssl.jp/download/">ダウンロード</a>
++            <a href="https://www.wolfssl.jp/license/">ライセンス</a>
++            <a href="https://www.wolfssl.jp/docs/">ドキュメント</a>
++            <a href="https://www.wolfssl.jp/contact/">ご質問</a>
++      </div>
++
+     {% if "search" in config["plugins"] %}
+       <label class="md-header__button md-icon" for="__search">
+         {% include ".icons/material/magnify.svg" %}

README.md

@@ -64,3 +64,32 @@ To run a local HTML server (HTML is built to a temporary area for this):
 ```sh
 make serve
 ```
+
+## Localization
+
+By default, the built output documentation is in English. If you assign a language code to the DOC_LANG variable and call 'make' with it, the output will be localized in that specified language. As of now (end of 2022), the only supported language code is 'JA', which means 'Japanese'. Not all wolfSSL products documentation supports localization. 'make' with DOC_LANG variable for unsupported products is ignored and output in English.
+
+```sh
+make DOC_LANG=JA
+```
+
+### Pre-requisites
+
+For localization to work, the build environment must have the correct fonts installed for the specified language.
+
+#### Japanese font
+'Noto Sans CJK JP' font is used for Japanese localization. You can get the font files from the following Github repository:
+https://github.com/googlefonts/noto-cjk/tree/main/Sans/OTF/Japanese
+
+You can download the seven `NotoSansCJKjp-xxx.otf` files from there and put them into `/usr/local/share/fonts`. You may need 'sudo' for the operation. After coping font files, you need to update font cache by calling:
+
+```sh
+sudo fc-cache -fv
+```
+Then you can confirm the font cache includes the installed font files by 'fc-list'.
+
+```sh
+fc-list | grep NotoSansCJKjp
+```
+You will get the list of installed font files.
+

common/common.am

@@ -2,6 +2,18 @@
 
 HTML = html/
 
+ifeq ($(DOC_LANG),JA)
+    PATCH  = ../Custom-wolfSSL-theme-JA.patch
+    SRC    = src-ja
+    MKDOC  = mkdocs-ja.yml
+	CJK    = --variable CJKmainfont="Noto Sans CJK JP"
+else
+    PATCH  = ../Custom-wolfSSL-theme.patch
+    SRC    = src
+    MKDOC  = mkdocs.yml
+	CJK    =
+endif
+
 .PHONY: builddir
 builddir:
 	@mkdir -p build/pdf
@@ -10,8 +22,8 @@ builddir:
 .PHONY: html-setup
 html-setup:
 	@git submodule update --init
-	-cd ../mkdocs-material; patch -p1 < ../Custom-wolfSSL-theme.patch --ignore-whitespace -N
-	@cp -a src/* build/html/
+	-cd ../mkdocs-material; patch -p1  < $(PATCH) --ignore-whitespace -N
+	@cp -a $(SRC)/* build/html/
 	@cp ../common/*.png build/html/
 	@cp ../common/*.css build/html/
 	@perl -i -pe 's/    ```/```/g' build/html/*.md
@@ -21,11 +33,11 @@ html-setup:
 .PHONY: html
 html: builddir html-setup html-prep
 	@mkdir -p html
-	@mkdocs build
+	@mkdocs build -f $(MKDOC)
 
 .PHONY: pdf-setup
 pdf-setup: builddir
-	@cp -a src/* build/pdf/
+	@cp -a $(SRC)/* build/pdf/
 	@cp ../common/*.png build/pdf/
 	@perl -i -pe "s/chapter[0-9][0-9].md|appendix[0-9][0-9].md//g" build/pdf/*.md
 	@perl -i -pe "s/\#--/\#/g" build/pdf/*.md
@@ -39,6 +51,7 @@ pdf: pdf-setup pdf-prep
 		--variable mainfont="Noto Sans" \
 		--variable sansfont="Noto Sans" \
 		--variable monofont="Noto Sans Mono" \
+		$(CJK) \
 		--variable papersize=letter \
 		--variable geometry="margin=2.5cm" \
 		--variable version=2.0 \

wolfBoot/Makefile

@@ -12,7 +12,11 @@ SOURCES = chapter01.md \
           chapter07.md \
           chapter08.md 
 
-PDF = wolfBoot-Manual.pdf
+ifeq ($(DOC_LANG),JA)
+    PDF  = wolfBoot-Manual-jp.pdf
+else
+    PDF  = wolfBoot-Manual.pdf
+endif
 
 .PHONY: html-prep
 html-prep:

wolfBoot/mkdocs-ja.yml

@@ -0,0 +1,33 @@
+site_name: wolfBoot マニュアル
+site_url: https://wolfssl.com/
+docs_dir: build/html/
+site_dir: html/
+copyright: wolfSSL Inc. 2022
+nav:
+    - "1. イントロダクション": index.md
+    - "2. wolfBootのビルド": chapter02.md
+    - "3. ターゲット": chapter03.md
+    - "4. ハードウエア抽象化レイヤー": chapter04.md
+    - "5. Flushメモリのパーティション": chapter05.md
+    - "6. wolfBootの機能": chapter06.md
+    - "7. wolfBootの既存プロジェクトへの統合": chapter07.md
+    - "8. トラブルシューティング": chapter08.md
+theme:
+  name: null
+  custom_dir: ../mkdocs-material/material
+  language: en
+  palette:
+    primary: indigo
+    accent: indigo
+  font:
+    text: Roboto
+    code: Roboto Mono
+  icon: "logo.png"
+  logo: logo.png
+  favicon: logo.png
+  feature:
+    tabs: true
+extra_css: [skin.css]
+extra:
+    generator: false
+use_directory_urls: false

wolfBoot/src-ja/chapter01.md

@@ -0,0 +1,57 @@
+
+
+# イントロダクション
+
+
+
+[wolfBoot](https://www.wolfssl.com/products/wolfboot/)は、32ビットマイクロコントローラー向けのポータブルでOSに依存しないセキュアなブートローダーソリューションであり、ファームウェア認証用のwolfCryptに依存して、ファームウェアの更新メカニズムを提供します。
+
+
+ブートローダーと小さなHAL APIの最小限設計により、wolfBootはあらゆるOSまたは裸の金属アプリケーションから完全に独立しており、安全なファームウェア更新メカニズムを提供するために、既存の埋め込みソフトウェアプロジェクトに簡単に移植および統合できます。
+
+
+
+
+**機能**
+
+
+
+-  フラッシュデバイスのマルチスロットパーティション
+
+
+-  ファームウェアイメージの整合性検証
+
+
+-  wolfCryptのデジタル署名アルゴリズム(DSA)を使用したファームウェアイメージの信頼性検証
+
+
+-  最小限のハードウェア抽象化レイヤー(HAL)インターフェースは、さまざまなベンダー/MCUの移植性を促進するためのインターフェース
+
+
+-  セカンダリスロットからプライマリスロットにイメージをコピー/スワップして、ファームウェアの更新操作に同意する
+
+
+-  プライマリスロットでのファームウェアイメージのインプレースチェーンロード
+
+
+-  TPMのサポート
+
+
+-  測定されたブートサポート、ファームウェアイメージハッシュのTPMプラットフォーム構成レジスタ(PCR)への保存
+
+
+
+**コンポーネント**
+
+
+[wolfBoot GitHubリポジトリ](https://github.com/wolfSSL/wolfBoot)には、次のコンポーネントが含まれています。
+
+
+
+-  wolfBoot ブートローダ
+
+
+-  鍵生成とイメージ署名ツール(python 3.xおよびwolfcrypt-py https://github.com/wolfssl/wolfcrypt-pyが必要です)
+
+
+-  非OSのテストアプリケーション