メインコンテンツまでスキップ

ライブラリファイル

このページでは DictePro のアプリケーションのライブラリのフォーマットについて記述します。

ライブラリファイルとは​

ライブラリファイルとは、ディクテーションの学習に使う英文とその和訳をセットにした設定ファイルのことです。

ディレクトリとファイル名​

設定画面の「ライブラリディレクトリ」で設定されたディレクトリの下に置かれたファイルのうち、ファイル名が .dictepro.yaml で終わるファイルが、ライブラリファイルとして読み込まれます。

たとえば下記のファイル名は、ライブラリのファイルとして正しいファイル名です。

  • my-important-sentences.dictepro.yaml
  • eiken.dictepro.yaml

ファイルのフォーマット​

ライブラリファイルは、下記のような仕様を満たした YAML ファイルです。

title: ライブラリのタイトル
description: ライブラリの説明
sentence_infos:
  - id: 文のID1
    text: 英語の文章1
    translation: 英文の和訳1
  - id: 文のID2
    text: 英語の文章2
    translation: 英文の和訳2
  # ...

注意事項​

ファイル名と文のID​

DictePro は学習の履歴を管理する際、ファイル名と文のIDをキーにしています。

そのため、同じファイルのなかで文のIDが重複しないようにしてください。 また、学習中にファイル内の文のIDを変更すると、学習の履歴が正しく集計できなくなります。

制限事項​

ファイルには下記の制限があります。

  • sentence_infos の要素は 100 以下