mii/AzooKeyKanaKanjiConverter
1
0
Fork 0
mirror of https://github.com/mii443/AzooKeyKanaKanjiConverter.git synced 2025-08-22 15:05:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs examples

Browse Source
This commit is contained in:
Miwa
2025-06-04 10:22:30 +09:00
parent 8de2b49974
commit a26f2f31a5
2 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Docs/learning_data.md
View File

@ -17,11 +17,16 @@ AzooKeyKanaKanjiConverter では、ユーザが変換候補を選択した結果
`ConvertRequestOptions` の `memoryDirectoryURL` に書き込み可能なディレクトリを指定してください。通常はアプリの書類フォルダなどを指定します。英語用と日本語用など、キーボードのターゲットごとに学習データを分けたい場合は、言語ごとに別のディレクトリを指定してください。
```swift
let documents = FileManager.default
.urls(for: .documentDirectory, in: .userDomainMask)
.first!
let options = ConvertRequestOptions.withDefaultDictionary(
requireJapanesePrediction: true,
requireEnglishPrediction: true,
keyboardLanguage: .ja_JP,
learningType: .temporary,
memoryDirectoryURL: .documentsDirectory,
sharedContainerURL: .documentsDirectory
memoryDirectoryURL: documents,
sharedContainerURL: documents
)
```

15
README.md
View File

@ -58,6 +58,9 @@ print(results.mainResults.first!.text) // azooKeyは新時代のキーボード
`ConvertRequestOptions`は変換リクエストに必要な設定値です。例えば以下のように設定します。
```swift
let documents = FileManager.default
.urls(for: .documentDirectory, in: .userDomainMask)
.first!
let options = ConvertRequestOptions.withDefaultDictionary(
// 日本語予測変換
requireJapanesePrediction: true,
@ -68,9 +71,9 @@ let options = ConvertRequestOptions.withDefaultDictionary(
// 学習タイプ
learningType: .nothing,
// 学習データを保存するディレクトリのURL（書類フォルダを指定）
memoryDirectoryURL: .documentsDirectory,
memoryDirectoryURL: documents,
// ユーザ辞書データのあるディレクトリのURL（書類フォルダを指定）
sharedContainerURL: .documentsDirectory,
sharedContainerURL: documents,
// メタデータ
metadata: .init(versionString: "You App Version X")
)
@ -138,6 +141,10 @@ AzooKeyKanaKanjiConverterのデフォルト辞書として[azooKey_dictionary_st
// デフォルト辞書を含まない変換モジュールを指定
import KanaKanjiConverterModule
let documents = FileManager.default
.urls(for: .documentDirectory, in: .userDomainMask)
.first!
let options = ConvertRequestOptions(
// 日本語予測変換
requireJapanesePrediction: true,
@ -151,9 +158,9 @@ let options = ConvertRequestOptions(
// 辞書データのURL（先ほど追加した辞書リソースを指定）
dictionaryResourceURL: Bundle.main.bundleURL.appending(path: "Dictionary", directoryHint: .isDirectory),
// 学習データを保存するディレクトリのURL（書類フォルダを指定）
memoryDirectoryURL: .documentsDirectory,
memoryDirectoryURL: documents,
// ユーザ辞書データのあるディレクトリのURL（書類フォルダを指定）
sharedContainerURL: .documentsDirectory,
sharedContainerURL: documents,
// メタデータ
metadata: .init(versionString: "You App Version X")
)