proseとインラインモデル

モデルを流れの中に置けるリッチテキスト

設定がない場合、proseフィールドはテキストだけを受け付けます。見出し、太字と斜体、リンク、リスト、引用、コードです。置けるものはallowedTypesに列挙します。対象は、自分のインラインモデルと、組み込みの画像、動画、ファイル、リファレンス、ジオポイントの各タイプです。リストにないものを含む書き込みは拒否され、エラーにはその項目が示されます。

入力テキストをオフにすると、フィールドにはモデルだけが入り、チームが置いた順に積み重なります。

読み取りで返るもの

保存される値は、順序付きのフラットな項目のリストです。各項目はテキストの一節か、置かれたモデルのいずれかで、編集しても変わらない安定したキーを持ちます。読み取りでは、型付きの項目がインラインフラグメントで選択でき、HTML、Markdown、JSON形式も得られます。HTMLとMarkdownにはテキストだけが含まれるため、置かれたモデルを表示するレンダラーは項目を読み取ります。

インラインモデル

インラインモデルには、独自のレコードがありません。そのキーが、任意のモデルに追加できるフィールドタイプになり、チームはヒーローバナーやお客様の声のカードのような構造化フォームとして入力します。インラインモデルは互いにネストでき、proseに置かれたものが独自のproseフィールドを持つこともできます。インラインモデルにフィールドを追加すると、そのモデルが埋め込まれているすべての場所に反映されます。

リスト

1つのlistフィールドは、項目タイプを宣言した順序付きの配列です。項目タイプは、組み込みタイプ、リファレンス、インラインモデルのいずれかで、インラインモデルの場合は各項目がそのモデルの構造化された値になります。リストの書き込みには、set、push、pull、splice、removeWhereを使います。

翻訳とバリアント

proseは翻訳可能です。バリアントは、proseの1つのエントリまたはリストの1つの項目を置き換えられるため、ドキュメントを複製せずに、段落を1つだけオーディエンスごとに変えられます。