Merge pull request #80 from tiqwab/listlevelvalidator

Add doc of ListLevelValidator for redpen-cc/redpen#765
redpen-cc · Apr 4, 2017 · 8275ad6 · 8275ad6
2 parents cf10c77 + 127408f
commit 8275ad6
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 0 deletions.
diff --git a/en/validator.adoc b/en/validator.adoc
@@ -842,3 +842,33 @@ In the above sample, the same sentences are used in succession. This is a human
 ==== Supported languages
 
 SuccessiveSentence works for any languages.
+
+[[list-level]]
+=== ListLevel
+
+ListLevel checks the level of list items. This validator generates errors when input sections contain list items nested too deeply.
+
+[[properties-list-leve]]
+==== Properties
+
+[options="header"]
+|====
+|Property        |Default Value  |Description
+|``max_level``   |5              |The maximum level of list items
+|====
+
+The following example generates an error at the six list item if ``max_level`` is five.
+
+----
+* one
+** two
+*** three
+**** four
+***** five
+****** six
+----
+
+[[supported-languages-list-level]]
+==== Supported languages
+
+ListLevel works for any languages.
diff --git a/ja/validator_ja.adoc b/ja/validator_ja.adoc
@@ -883,3 +883,33 @@ SuccessiveSentence は同一の文が二回連続で使用されるとエラー
 ==== 対象言語
 
 日本語のみサポートしています。
+
+[[list-level]]
+=== ListLevel
+
+ListLevel は入力文書内に含まれるリスト項目の階層を検査します。 リスト項目の階層が指定された最大値よりも深い場合、エラーを出力します。
+
+[[properties-list-level]]
+==== Properties
+
+[options="header"]
+|====
+|プロパティ      |デフォルト     |解説
+|``max_level``   |5              |リスト項目の最大深度
+|====
+
+例えば ``max_level`` を 5 に設定して以下の入力を与えた場合、六番目のリスト項目に対しエラーが出力されます。
+
+----
+* one
+** two
+*** three
+**** four
+***** five
+****** six
+----
+
+[[supported-languages-list-level]]
+==== 対応言語
+
+どの言語にも対応しています。