Skip to content

Commit 9a7c04a

Browse files
committed
updating docs for v3.5.0
1 parent 7fc4ae9 commit 9a7c04a

File tree

3 files changed

+29
-2
lines changed

3 files changed

+29
-2
lines changed

_includes/head.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@
1818
ga('send', 'pageview');
1919
</script>
2020
<script src="https://cdn.polyfill.io/v2/polyfill.min.js"></script>
21-
<script type="application/javascript" src="https://cdn.jsdelivr.net/npm/hanzi-writer@3.2/dist/hanzi-writer.min.js"></script>
21+
<script type="application/javascript" src="https://cdn.jsdelivr.net/npm/hanzi-writer@3.5/dist/hanzi-writer.min.js"></script>
2222
</head>

cn/docs.html

+18
Original file line numberDiff line numberDiff line change
@@ -1004,6 +1004,12 @@ <h4>新建 HanziWriter(element, options)</h4>
10041004
<li><code>showHintAfterMisses:</code> 整数, 默认 3
10051005
中风高亮提示之前的未命中数被给予用户。 设置为 false 以禁用。 创建测验时也可以设置此项。
10061006
</li>
1007+
<li><code>markStrokeCorrectAfterMisses:</code> integer, default disabled. The number of misses before forcing the stroke
1008+
to be marked correct. This can also be set when creating a quiz.</li>
1009+
<li><code>quizStartStrokeNum:</code> integer, default 0. This can be set to start the quiz at a stroke other than the
1010+
first stroke. This can also be set when creating a quiz.</li>
1011+
<li><code>acceptBackwardsStrokes:</code> boolean, default false. Allow stroke to be drawn backwards during quizzing.
1012+
This can also be set when creating a quiz.</li>
10071013
<li><code>highlightOnComplete:</code> 布尔值, 默认 true。
10081014
控制当用户完成绘制整个字符时,测验是否会短暂突出显示字符。 创建测验时也可以设置此项。
10091015
</li>
@@ -1222,6 +1228,12 @@ <h4>writer.quiz(options)</h4>
12221228
设置 false 禁用。
12231229
这也可以在创建编写器实例时设置。
12241230
</li>
1231+
<li><code>markStrokeCorrectAfterMisses:</code> integer, default disabled. The number of misses before forcing the stroke
1232+
to be marked correct.</li>
1233+
<li><code>quizStartStrokeNum:</code> integer, default 0. This can be set to start the quiz at a stroke other than the
1234+
first stroke.</li>
1235+
<li><code>acceptBackwardsStrokes:</code> boolean, default false. Allow stroke to be drawn backwards during quizzing.
1236+
</li>
12251237
<li><code>leniency:</code> 浮点数, 默认 1.0。
12261238
这可以设置为使笔划分级或多或少地宽松。 越接近于0,测验的评分就越严格。
12271239
</li>
@@ -1296,6 +1308,12 @@ <h4>HanziWriter.create(element, character, options)</h4>
12961308
<li><code>showHintAfterMisses:</code> 整数, 默认 3。
12971309
中风高亮提示之前的未命中数被给予用户。 设置为 false 以禁用。 创建测验时也可以设置此项。
12981310
</li>
1311+
<li><code>markStrokeCorrectAfterMisses:</code> integer, default disabled. The number of misses before forcing the stroke
1312+
to be marked correct. This can also be set when creating a quiz.</li>
1313+
<li><code>quizStartStrokeNum:</code> integer, default 0. This can be set to start the quiz at a stroke other than the
1314+
first stroke. This can also be set when creating a quiz.</li>
1315+
<li><code>acceptBackwardsStrokes:</code> boolean, default false. Allow stroke to be drawn backwards during quizzing.
1316+
This can also be set when creating a quiz.</li>
12991317
<li><code>highlightOnComplete:</code> 布尔值, 默认 true。
13001318
控制当用户完成绘制整个角色时,测验是否会短暂突出显示角色。 创建测验时也可以设置此项。
13011319
</li>

docs.html

+10-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ <h2 id="script-loading-link">Loading Hanzi Writer in a script tag</h2>
7676
<p>
7777
The simplest option is to load the Hanzi Writer JS directly from the jsdelivr CDN. Just put the following in the head of your webpage:
7878
{% highlight html %}
79-
<script src="https://cdn.jsdelivr.net/npm/hanzi-writer@3.2/dist/hanzi-writer.min.js"></script>
79+
<script src="https://cdn.jsdelivr.net/npm/hanzi-writer@3.5/dist/hanzi-writer.min.js"></script>
8080
{% endhighlight %}
8181
</p>
8282
<p>
@@ -910,6 +910,9 @@ <h4>new HanziWriter(element, options)</h4>
910910
<li><code>drawingColor:</code> hex string, default '#333'. The color of the lines drawn by users during quizzing.</li>
911911
<li><code>drawingWidth:</code> number, default 4. The width of the lines drawn by users during quizzing in px.</li>
912912
<li><code>showHintAfterMisses:</code> integer, default 3. The number of misses before a stroke highlight hint is given to the user. Set to false to disable. This can also be set when creating a quiz.</li>
913+
<li><code>markStrokeCorrectAfterMisses:</code> integer, default disabled. The number of misses before forcing the stroke to be marked correct. This can also be set when creating a quiz.</li>
914+
<li><code>quizStartStrokeNum:</code> integer, default 0. This can be set to start the quiz at a stroke other than the first stroke. This can also be set when creating a quiz.</li>
915+
<li><code>acceptBackwardsStrokes:</code> boolean, default false. Allow stroke to be drawn backwards during quizzing. This can also be set when creating a quiz.</li>
913916
<li><code>highlightOnComplete:</code> boolean, default true. Controls whether a quiz briefly highlights the character when the user finishes drawing the whole character. This can also be set when creating a quiz.</li>
914917
<li><code>highlightCompleteColor:</code> hex string, default null. The color to use when highlighting the character on complete in quizzes. If not set, <code>highlightColor</code> will be used instead. Only relevant if <code>highlightOnComplete</code> is <code>true</code>.</li>
915918
<li><code>charDataLoader:</code> function. Custom function to load charater data. See the section on <a href="#loading-character-data-link">Loading character data</a> for more info on usage.</li>
@@ -1081,6 +1084,9 @@ <h4>writer.quiz(options)</h4>
10811084
</ul>
10821085
</li>
10831086
<li><code>showHintAfterMisses:</code> integer, default 3. The number of misses before a stroke highlight hint is given to the user. Set to false to disable. This can also be set when creating the writer instance.</li>
1087+
<li><code>markStrokeCorrectAfterMisses:</code> integer, default disabled. The number of misses before forcing the stroke to be marked correct.</li>
1088+
<li><code>quizStartStrokeNum:</code> integer, default 0. This can be set to start the quiz at a stroke other than the first stroke.</li>
1089+
<li><code>acceptBackwardsStrokes:</code> boolean, default false. Allow stroke to be drawn backwards during quizzing.</li>
10841090
<li><code>leniency:</code> float, default 1.0. This can be set to make stroke grading more or less lenient. The closer this is to 0 the more strictly the quiz is graded.</li>
10851091
<li><code>highlightOnComplete:</code> boolean, default true. Controls whether a quiz briefly highlights the character when the user finishes drawing the whole character. This can also be set when creating the writer instance.</li>
10861092
</ul>
@@ -1118,6 +1124,9 @@ <h4>HanziWriter.create(element, character, options)</h4>
11181124
<li><code>drawingColor:</code> hex string, default '#333'. The color of the lines drawn by users during quizzing.</li>
11191125
<li><code>drawingWidth:</code> number, default 4. The width of the lines drawn by users during quizzing in px.</li>
11201126
<li><code>showHintAfterMisses:</code> integer, default 3. The number of misses before a stroke highlight hint is given to the user. Set to false to disable. This can also be set when creating a quiz.</li>
1127+
<li><code>markStrokeCorrectAfterMisses:</code> integer, default disabled. The number of misses before forcing the stroke to be marked correct. This can also be set when creating a quiz.</li>
1128+
<li><code>quizStartStrokeNum:</code> integer, default 0. This can be set to start the quiz at a stroke other than the first stroke. This can also be set when creating a quiz.</li>
1129+
<li><code>acceptBackwardsStrokes:</code> boolean, default false. Allow stroke to be drawn backwards during quizzing. This can also be set when creating a quiz.</li>
11211130
<li><code>highlightOnComplete:</code> boolean, default true. Controls whether a quiz briefly highlights the character when the user finishes drawing the whole character. This can also be set when creating a quiz.</li>
11221131
<li><code>highlightCompleteColor:</code> hex string, default null. The color to use when highlighting the character on complete in quizzes. If not set, <code>highlightColor</code> will be used instead. Only relevant if <code>highlightOnComplete</code> is <code>true</code>.</li>
11231132
<li><code>charDataLoader:</code> function. Custom function to load charater data. See the section on <a href="#loading-character-data-link">Loading character data</a> for more info on usage.</li>

0 commit comments

Comments
 (0)