Merge pull request #218 from freee/develop

RELEASE Ver. 202403.1 (202403-29)

.github/workflows/lint.yaml

@@ -12,6 +12,7 @@ jobs:
       uses: actions/checkout@v3
       with:
         fetch-depth: 0
+        submodules: true
     - name: Set up Node.js
       uses: actions/setup-node@v3
       with:
@@ -59,6 +60,8 @@ jobs:
     steps:
     - name: Checkout files
       uses: actions/checkout@v3
+      with:
+        submodules: true
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
@@ -67,17 +70,14 @@ jobs:
       run: python -m pip install --upgrade pip
     - name: Install required modules
       run: python -m pip install -r requirements.txt --upgrade
-    - name: Install sphinx-lint
-      run: python -m pip install --upgrade sphinx-lint
     - name: Build HTML
       env:
         BASE_URL: https://a11y-guidelines.freee.co.jp/
         TZ: JST-9
-      run: |
-        make sphinx_options="-W" clean html
+      run: make sphinx_options="-W" clean html
     - name: Check for unreferenced include files
       run: make check-includes
     - name: Run sphinx-lint
       run: |
-        sphinx-lint ./ja/source/**/*.rst
-        sphinx-lint ./en/source/**/*.rst
+        sphinx-lint --enable all --disable line-too-long ./ja/source
+        sphinx-lint --enable all --disable line-too-long ./en/source

.github/workflows/release.yml

@@ -20,6 +20,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
 
     - uses: actions/setup-python@v4
       with:
@@ -50,6 +51,7 @@ jobs:
     - name: Build HTML of all releases, with gtag.js, and OGP tags
       env:
         GTM_ID: ${{ secrets.GTM_ID }}
+        TZ: Asia/Tokyo
       run: |
         make BASE_URL=https://a11y-guidelines.freee.co.jp/ sphinx_options="-A gtm_id=${GTM_ID}" clean html
         cp -r ./ja/build/html/* ${GITHUB_WORKSPACE}/upload
@@ -67,6 +69,7 @@ jobs:
           echo "Processing ${_tag}..." ; \
           if [ ! -d ${GITHUB_WORKSPACE}/upload/archive/${_tag} ] ; then \
             git checkout ${_tag} ; \
+            git submodule update --init --recursive ; \
             if [ ! -f ./build.mk ]; then
               build_procedure=0 ; \
             else \
@@ -90,6 +93,7 @@ jobs:
             fi ; \
             make clean ; \
             git checkout ${current_commit} ; \
+            git submodule update --init --recursive ; \
           fi ; \
         done
 
@@ -99,6 +103,8 @@ jobs:
       run: aws s3 sync --delete ${GITHUB_WORKSPACE}/upload/ s3://${AWS_BUCKET}/ --quiet
 
     - name: Prepare the HTML Archive
+      env:
+        TZ: Asia/Tokyo
       run: |
         make BASE_URL=/ clean html
         mv ./ja/build/html ./freee-a11y-guidelines-${TAG}
@@ -129,6 +135,8 @@ jobs:
         echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
 
     - uses: actions/checkout@v4
+      with:
+        submodules: true
 
     - uses: actions/setup-python@v4
       with:
@@ -153,6 +161,7 @@ jobs:
       env:
         GTM_ID: ${{ secrets.GTM_ID }}
         BASE_URL: https://a11y-guidelines.freee.co.jp/current/
+        TZ: Asia/Tokyo
       run: |
         make sphinx_options="-A gtm_id=${GTM_ID} -t current" clean html
         cp -r ./data/json/schemas ./ja/build/html

.gitignore

@@ -1,9 +1,9 @@
-html/*
-node_modules/*
-.vscode/*
-*/build/*
-*/source/inc/*
-*/source/faq/*
+node_modules/
+.vscode/
+build/
+*/source/inc/
+*/source/faq/
 .DS_Store
-*/incfiles.mk
+incfiles.mk
 __pycache__/
+*:Zone.Identifier

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/axe-core"]
+	path = vendor/axe-core
+	url = https://github.com/dequelabs/axe-core

.lintstagedrc.mjs

@@ -4,4 +4,5 @@ export default {
   'data/yaml/gl/**/*.yaml': (files) => files.map((file) => `ajv validate --spec=draft2020 -s data/json/schemas/guideline.json -r data/json/schemas/common.json -d ${file}`),
   'data/yaml/checks/**/*.yaml': (files) => files.map((file) => `ajv validate --spec=draft2020 -s data/json/schemas/check.json -r data/json/schemas/common.json -d ${file}`),
   'data/yaml/faq/**/*.yaml': (files) => files.map((file) => `ajv validate --spec=draft2020 -s data/json/schemas/faq.json -r data/json/schemas/common.json -d ${file}`),
+  '(ja|en)/**/*.rst': 'sphinx-lint --enable all --disable line-too-long',
 }

Makefile

@@ -1,5 +1,5 @@
 BUILD_PROCEDURE_VERSION = 1
-SUBDIRS = ja en
+SUBDIRS?= ja en
 
 export ROOTDIR = $(CURDIR)
 export SPHINXBUILD   ?= sphinx-build
@@ -16,18 +16,5 @@ $(ALL_PREDEFINED_TARGETS):
 		$(MAKE) -C $$dir $@ || exit 1; \
 	done
 
-# $(SUBDIRS):
-# 	@target="$(MAKECMDGOALS)"; \
-# 	for subdir_target in $(ALL_PREDEFINED_TARGETS); do \
-# 		if [ "$$target" = "$$subdir_target" ]; then \
-# 			echo "Running make $$target in subdirectory $@"; \
-# 			$(MAKE) -C $@ $$target || exit 1; \
-# 			break; \
-# 		fi; \
-# 	done
-
-# %: $(SUBDIRS)
-# 	@:
-
 build-procedure-version:
 	@echo $(BUILD_PROCEDURE_VERSION)

README.md

@@ -1,8 +1,8 @@
 # freee Accessibility Guidelines
 
-freee株式会社が作成しているアクセシビリティー・ガイドラインのリポジトリーです。現在作成中で、随時更新する予定です。
+フリー株式会社が作成しているアクセシビリティー・ガイドラインのリポジトリーです。現在作成中で、随時更新する予定です。
 
-このガイドラインの作成の経緯などについて詳しくは、[ガイドラインのイントロダクション](https://a11y-guidelines.freee.co.jp/intro/index.html)と、[freee Developers Blogの記事](https://developers.freee.co.jp/entry/a11y-guidelines-202004.0)をご覧ください。
+このガイドラインの作成の経緯などについて詳しくは、[ガイドラインのイントロダクション](https://a11y-guidelines.freee.co.jp/intro/index.html)と、[freee Developers Hubの記事](https://developers.freee.co.jp/entry/a11y-guidelines-202004.0)をご覧ください。
 
 ## 最新ファイルの入手
 
@@ -22,9 +22,9 @@ freee株式会社が作成しているアクセシビリティー・ガイドラ
 ## ライセンス
 
 ![クリエイティブ・コモンズ・ライセンス](https://i.creativecommons.org/l/by/4.0/88x31.png)
-「freeeアクセシビリティー・ガイドライン」は、freee株式会社が作成したもので、[クリエイティブ・コモンズ 表示 4.0 国際 ライセンス](https://creativecommons.org/licenses/by/4.0/)で提供されています。
+「freeeアクセシビリティー・ガイドライン」は、フリー株式会社が作成したもので、[クリエイティブ・コモンズ 表示 4.0 国際 ライセンス](https://creativecommons.org/licenses/by/4.0/)で提供されています。
 
-Copyright © 2020-2023, freee株式会社
+Copyright © 2020-2024, フリー株式会社
 
 ## 更新履歴
 

build.mk

@@ -22,31 +22,31 @@ help:
 
 .PHONY: help incfiles clean Makefile $(SPHINX_PREDEFINED_TARGETS)
 
-incfiles.mk: $(wildcard $(rootdir)/data/yaml/gl/*/*.yaml $(rootdir)/data/yaml/checks/*/*.yaml $(rootdir)/data/yaml/faq/**/*.yaml)
-	@if [ ! -f incfiles.mk ]; then \
-		${YAML2RST}; \
-	else \
-		${YAML2RST} incfiles.mk; \
-	fi
+incfiles.mk:
+	@${YAML2RST} incfiles.mk 
 
-incfiles:| $(SOURCEDIR)/inc
+incfiles:| $(SOURCEDIR)/inc $(SOURCEDIR)/faq
 
-ifneq ($(filter $(MAKECMDGOALS),$(ALL_PREDEFINED_TARGETS)),)
 include incfiles.mk
-endif
 
 #
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-$(SPHINX_PREDEFINED_TARGETS): incfiles.mk incfiles Makefile
+$(SPHINX_PREDEFINED_TARGETS): incfiles.mk incfiles Makefile $(BUILDDIR)/.all-rst $(ALL_RST_FILES)
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+$(BUILDDIR)/.all-rst:
+	@$(YAML2RST)
+	@mkdir -p $(BUILDDIR)
+	@touch $@
+
 clean:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	@$(RM) -rf $(SOURCEDIR)/inc $(SOURCEDIR)/faq incfiles.mk
 
-$(SOURCEDIR)/inc:
+$(SOURCEDIR)/inc $(SOURCEDIR)/faq:
 	@$(YAML2RST)
+	@touch $(BUILDDIR)/.all-rst
 
 check-includes:
 	@for file in $(ALL_INC_FILES); do \

data/json/faq-tags.json

@@ -32,6 +32,10 @@
         "ja": "Android TalkBack",
         "en": "Android TalkBack"
     },
+    "target-size": {
+        "ja": "ターゲット・サイズ",
+        "en": "Target Size"
+    },
     "misc": {
         "ja": "その他",
         "en": "Miscellaneous"

data/json/schemas/faq.json

@@ -68,6 +68,14 @@
       "items": {
         "type": "string"
       }
+    },
+    "faqs": {
+      "description": "related FAQ entry if any",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "string"
+      }
     }
   },
   "additionalProperties": false,

data/yaml/checks/design/0032.yaml

@@ -22,7 +22,7 @@ check:
        *  画面右下の「新規作成」ボタンを押してください
   en: |-
     Descriptions are not based solely on one characteristic such as shape, color, size, visual position, direction, or sound, but use multiple elements for explanations.
-   
+
     Example:
 
     Expressions to avoid

data/yaml/checks/design/0391.yaml

@@ -12,4 +12,4 @@ check:
   en: |-
     *  Icons are accompanied by text labels that represent their role or the state they indicate. Or,
     *  If text labels cannot be displayed, the difference in the meaning of icons is not represented solely by color differences but also by differences in shape (motif) or size. And,
-    *  The value of the `alt` attribute, which makes the role or meaning understandable, is explicitly specified in the design documentation.
+    *  The value of the ``alt`` attribute, which makes the role or meaning understandable, is explicitly specified in the design documentation.

data/yaml/checks/product/0111.yaml

@@ -10,7 +10,7 @@ check:
     *  マウス・ポインターを移動させることなく、マウスオーバーで表示されたコンテンツを非表示にできる。（ESCキーで消える、など）
     *  マウスオーバー状態ではなくなった場合、ユーザーが非表示にする操作を行った場合、内容が無効になった場合にのみ、マウスオーバーで表示されたコンテンツを非表示にする。
   en: |-
-    All content displayed on hover meets all of the following 
+    All content displayed on hover meets all of the following
 
     *  Content displayed on hover can be hidden without moving the mouse pointer. (ESC key to make it disappear, etc.)
     *  Hide content displayed on hover only when it is no longer in hover state, when the user performs an action to hide it, or when the content is no longer valid.

data/yaml/checks/product/0201.yaml

@@ -39,6 +39,6 @@ procedures:
         *  TabキーやShift+Tabキーの押下でフォーカスが抜け出せない場合に、矢印キーやEscキーなど、簡単なキー操作でフォーカスを当該箇所から外すことができる。
       en: |-
         Use the Tab key to sequentially move the focus from the top of the page and confirm the following:
-        
+
         *  Pressing the Tab key or Shift+Tab key does not cause a situation where the focus cannot escape from a specific location, or
         *  If the focus cannot escape by pressing the Tab key or Shift+Tab key, it is possible to remove the focus from the corresponding location with simple key operations such as the arrow keys or the Esc key.

data/yaml/checks/product/0441.yaml

@@ -21,34 +21,34 @@ procedures:
     technique:
       ja: |-
         「 :ref:`axe-rule-image-alt` 」という問題が出ないことを確認する。
-      
+
         ただし、画像に何かしらの代替テキストが入っていれば問題として検知されないため、適切ではない代替テキストの検出をすることはできません。
       en: |-
         Confirm that the issue :ref:`axe-rule-image-alt` is not reported.
-      
+
         Note that this issue is not reported if any alternative text is specified for the image, and it is not possible to detect if the alternative text is inappropriate.
   - tool: nvda
     technique:
       ja: |-
         *  以下の操作をしたとき、画像に関する簡潔な読み上げがされることを確認する。
-        
+
            -  ブラウズ・モードで矢印キーを操作して当該箇所を読み上げさせたとき
            -  その画像がリンクなど、フォーカスを受け取るものの場合、 :kbd:`Tab` / :kbd:`Shift + Tab` キーの操作でフォーカスされたとき
-        
+
         *  詳細な説明が必要な画像の場合、以下のいずれかを満たしていることを確認する。
-        
+
            -  当該画像の直前または直後に詳細な説明があり、ブラウズ・モードでの矢印キーの操作で読み上げさせることができる
            -  ブラウズ・モードで矢印キーを操作して当該画像を読み上げさせたとき、詳細な説明が読み上げられる
 
         *  いずれの場合も、説明が画像の内容を適切に表していることを確認する。
       en: |-
         *  Confirm that a brief description of the image is announced when performing the following:
-        
+
            -  When reading the part with the image using arrow keys in browse mode
            -  When the image receives focus with :kbd:`Tab` / :kbd:`Shift + Tab` key operation, for focusable images, such as  links.
-        
+
         *  Confirm that one of the following is true for images that require detailed description
-        
+
            -  Detailed description is placed immediately before or after the image, and it is announced when using arrow keys in browse mode.
            -  Detailed description is announced when reading the image using arrow keys in browse mode.
 
@@ -60,22 +60,22 @@ procedures:
     technique:
       ja: |-
         *  以下の操作をしたとき、画像に関する簡潔な読み上げがされることを確認する。
-        
+
            -  :kbd:`VO` キーと左右矢印キーによるVoiceOverカーソルの操作で当該箇所を読み上げさせたとき
            -  その画像がリンクなど、フォーカスを受け取るものの場合、 :kbd:`Tab` / :kbd:`Shift + Tab` キーの操作でフォーカスされたとき
-        
+
         *  詳細な説明が必要な画像の場合、以下のいずれかを満たしていることを確認する。
-        
+
            -  当該画像の直前または直後に詳細な説明があり、 :kbd:`VO` キーと左右矢印キーによるVoiceOverカーソルの操作で読み上げさせることができる
            -  :kbd:`VO` キーと左右矢印キーによるVoiceOverカーソルの操作で当該画像を読み上げさせたとき、詳細な説明が読み上げられる
 
         *  いずれの場合も、説明が画像の内容を適切に表していることを確認する。
       en: |-
         *  Confirm that a brief description of the image is announced when performing the following:
-        
+
            -  When reading the part with the image using the :kbd:`VO` key and the left/right arrow keys to operate the VoiceOver cursor.
            -  When the image receives focus with :kbd:`Tab` / :kbd:`Shift + Tab` key operation, for focusable images, such as  links.
-          
+
         *  Confirm that one of the following is true for images that require detailed description
 
            -  Detailed description is placed immediately before or after the image, and it is announced when using the :kbd:`VO` key and the left/right arrow keys to operate the VoiceOver cursor.

data/yaml/checks/product/0561.yaml

@@ -70,7 +70,7 @@ procedures:
       ja: |-
         ローター・ジェスチャーで「見出し」を選んだ上で、1本指の下および上方向のフリックですべての見出しに到達できることを確認する。
       en: |-
-        Confirm that all the headings can be reached by one-finger up/down flicks after choosing `headings` by the rotor gesture.
+        Confirm that all the headings can be reached by one-finger up/down flicks after choosing "headings" by the rotor gesture.
     note:
       ja: |-
         参考： :ref:`exp-sr-iosvo-one-finger-vertical-flick`
@@ -81,7 +81,7 @@ procedures:
       ja: |-
         読み上げコントロールの設定で「見出し」を選んだ上で、1本指の下および上方向のフリックですべての見出しに到達できることを確認する。
       en: |-
-        Confirm that all the headings can be reached by one-finger up/down flicks after choosing `headings` for reading controls.
+        Confirm that all the headings can be reached by one-finger up/down flicks after choosing "headings" for reading controls.
     note:
       ja: |-
         参考： :ref:`exp-sr-androidtb-one-finger-vertical-flick`

data/yaml/checks/product/0922.yaml

@@ -21,11 +21,11 @@ procedures:
     technique:
       ja: |-
         ブラウズ・モードで上下矢印キーを用いて日付、時刻、数値などを読み上げさせて、以下のすべてを満たしていることを確認する。
-        
+
         *  当該箇所の読み上げに用いられる音声は、他の箇所を読み上げさせたときの音声と同じ種類の音声である
         *  当該箇所の読み上げが、そのページやアプリケーションで用いられている言語において自然なものになっている（例：日本語が用いられている場合に、「1月1日」を「ジャニュアリー ファースト」などと読み上げない）
       en: |-
         Confirm that all of the following are met when reading date, time, number, etc. using up/down arrow keys in browse mode.
-        
+
         *  The voice used to read the part is the same as the voice used to read other parts.
         *  The speech output of the part is natural and in line with the language used on the page or in the application.  (eg. "Jan 1" would not be read as "1月1日" if the primary language of the page is English.)