Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
uga-rosa committed Dec 27, 2023
1 parent 01a5f87 commit 5f1f855
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/skkeleton.jax
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,14 @@ g:skkeleton#state *g:skkeleton#state*
"henkan" 変換
"escape" escapeした際

*skkeleton#update_database()*
skkeleton#update_database({path} [, {encoding} [, {force}]])

データベースを手動で更新します。
- {path} 辞書のパス
- {encoding} 辞書のエンコード。省略するか空文字列だと自動で判別します
- {force} 辞書に更新がなくても強制的にデータベースを更新します

------------------------------------------------------------------------------
CONFIG *skkeleton-config*

Expand Down Expand Up @@ -343,6 +351,17 @@ userJisyo *skkeleton-config-userJisyo*
ユーザー辞書のパス
JavaScriptの制約によりエンコーディングはUTF-8限定になります。

databasePath *skkeleton-config-databasePath*
(デフォルト "")
データベースの保存先パスです。
空文字列でないときに有効になり、Deno KV を使って辞書をデータベース化し
ます。データベースの構築には通常の読み込みよりも時間がかかりますが、デ
ータベースはローカルなファイルに保存されるため、次回以降の起動は高速に
なります。大きな辞書で特に有効です。
データベースの構築は skkeleton の起動時に自動で行われます。mtime が以
前と変更された辞書のデータベースは更新します。手動で行うには
|skkeleton#update_database()| を使ってください。

------------------------------------------------------------------------------
*skkeleton#register_kanatable()*
skkeleton#register_kanatable({tableName}, {table} [, {create}])
Expand Down

0 comments on commit 5f1f855

Please sign in to comment.