作文ツールの詳細

作文ツールの詳細

作文ツールを使用すると、アプリ内で直接テキストを校正したり、書き直したり、変換したりできます。アプリに合わせて作文ツールをカスタマイズするための高度なテクニックを学びましょう。いくつかのフォーマットオプションを紹介し、リッチテキストの編集でそれらがどのように機能するかについて説明します。カスタムテキストエンジンを使用している場合は、作文ツール体験全体をシームレスに統合し、テキストビューから直接編集できるようにする方法を説明します。

関連する章
- 0:00 - イントロダクション
- 0:46 - 新機能
- 2:21 - ネイティブテキストビューのカスタマイズ
- 4:00 - リッチテキストのフォーマッティング
- 7:41 - カスタムテキストエンジン
- 16:58 - 次のステップ
リソース
関連ビデオ

WWDC24
- Writing Toolsの導入
「Dive Deeper into Writing Tools」へようこそ Dong Yuanですテキスト入力と国際化を担当しています去年は作文ツールの概要とアプリへの統合方法を紹介しましたこのセッションではより高度なトピックについて解説しますまずは作文ツールの新機能です次にネイティブテキストビューでの作文ツールの使用体験のカスタマイズ方法
リッチテキストのシームレスな処理方法と
カスタムのテキストエンジンを使う場合に作文ツールの全機能を統合する方法などを紹介しますさっそく始めましょう作文ツールを使うと文章の書き直し、校正、要約をテキストビュー内で直接実行できます今年作文ツールには多くの新機能が追加されました ChatGPTの統合により書きたいテーマのコンテンツを生成できるほか簡単なプロンプトで画像も作成できます
visionOSでも利用可能になりましたメールやメモでも独自のアプリでもほぼあらゆる場所で機能します
iOS、iPadOS、macOS 26の新機能として書き直しによる変更を記述した後フォローアップリクエストを入力できます
例えば温かみのある文体、会話調、元気づける調子などへの変更を指示できます
また作文ツールをショートカットからも実行でき Apple intelligenceを使ってワークフローをレベルアップできます校正、書き直し、要約などのツールを自動化して使用できるようになります
作文ツールをアプリでサポートするための各種APIも追加されました起動用のツールバーボタンや標準メニュー項目を使用できるほかリッチテキストのプレゼンテーションインテントを返すよう指示したりカスタムテキストエンジンに強力なコーディネータを統合したりできます結果オプションとコーディネータの APIについては後で詳しく説明します
次はシステムが提供する作文ツールのネイティブテキストビューをカスタマイズする方法を説明します
基本事項については昨年のビデオで解説していますネイティブテキストビューについては作文ツールのサポートが無償提供されますライフサイクルメソッドを利用して同期の一時停止などの操作に応答できますテキストビューをカスタマイズして作文ツールの動作の一部／すべてを使えます書き直しを適用しない範囲も指定できますまた結果オプションでリッチテキスト、リスト、表のサポートを管理できますなお昨年のセッションの時は結果オプションは AllowedInputOptionsという名前でしたが意味が明確になるよう WritingToolsResultOptionsに変更されました
作文ツールはテキスト選択時に使用できますがメモアプリやメールアプリなどテキストの多いアプリではツールバーボタンの追加を検討しましょう
UIKitではUIBarButtonItem AppKitではNSToolbarItemを使用します
コンテキストメニューには作文ツールの項目が自動的に挿入されますカスタムメニューを実装済みの場合や作文ツールの項目を移動したい場合は automaticallyInsertsWritingToolsItemsを falseに設定し writingToolsItemsAPIで標準項目を取得します今年はメニューの校正、書き直し、要約の各オプションを更新しました APIを使用することで更新をすべて無料で入手できます
次はフォーマットについての説明です
アプリには様々なテキストビューがあり Finderの検索フィールドなど一部のビューはリッチテキストをサポートしません TextEditなどのテキストビューではサポートされます
メモアプリなどのビューではセマンティクススタイルをサポートし見出しや小見出しブロック引用など様々なセマンティックスタイルを段落に指定できます例えばメモアプリでは作文ツールの結果表示にネイティブのメモ、見出し、表、リストを利用できますテキストビューがサポートするテキストの種類は WritingToolsResultOptionsで指定しますプレーンテキストビューの場合は plainTextの結果オプションを使用します従来通り作文ツールはテキストビューとの通信に NSAttributedStringを使用しますが内部の属性はすべて無視して問題ありません TextEditなどでのリッチテキストには richTextの結果オプションを使用しますテキストフィールドでリストや表がサポートされるかに応じて listかtableのオプションを使用できますまた作文ツールでは属性文字列に太字や斜体などの表示属性を追加できます
メモなどセマンティクス形式に対する特別なサポートが可能なアプリでは richTextオプションとともに新しい presentationIntentオプションを使えます作文ツールはNSAttributedStringとプレゼンテーションインテントを使用してテキストビューと通信します
表示属性とプレゼンテーションインテントの違いは何でしょうか
TextEditの例では作文ツールは太字や斜体などの表示属性を使用してリッチテキストを作成し属性文字列をテキストビューに送信しますこれらの属性はフォントの具体的なサイズなどのスタイル情報のみを提供しセマンティックスタイル情報を含みません一方メモアプリは見出しなどのセマンティクススタイルをフルに活用します作文ツールは先ほどと同じテキストを下に生成しましたがここでは代わりに属性文字列にプレゼンテーションインテントを追加しますするとメモはそのインテントを内部のセマンティックスタイルに変換できますこの例では見出しの部分は具体的なフォント属性のない見出しインテントです
なおプレゼンテーションインテントが結果オプションで指定されていても作文ツールは属性文字列に表示属性を追加できます一部のスタイルはプレゼンテーションインテントで表現できるからですこの例では作文ツールは強調のプレゼンテーションインテントと取り消し線の表示属性の両方を使って「crucial and deleted」のテキストを表示しています
まとめるとプレゼンテーションインテントのモードではスタイルの指定に可能な限りプレゼンテーションインテントを使いますリスト、表、コードブロックなどの要素を指定できます
表示属性も使用できますがその対象は下線や上付き／下付き文字などです最後にプレゼンテーションインテントにはデフォルトのスタイルがありませんアプリにおいてプレゼンテーションインテントを表示属性や独自の内部スタイルに変換する必要があります
作文ツールにテキストのセマンティクスをよりよく理解させるために presentationIntentオプションを導入したらテキストビューの requestsContextsメソッドを上書きしプレゼンテーションインテントを含むコンテキストを可能な限り提供します
最後に完全にカスタムのテキストエンジンを使用する場合にも対応できます
お使いのテキストエンジンが次に挙げる一般的な文字編集プロトコルを採用している場合作文ツールの基本的な機能は無料です対象のプロトコルは iOSでは UITextInteractionまたは UITextSelectionDisplayInteractionと UIEditMenuInteractionです macOSでは NSServicesMenuRequestorをビューで採用する必要がありますこれによりテキストビューで作文ツールを使用しサービスメニューで機能をサポートできるようになります基本的な導入方法については WWDC24のセッションをご覧ください
より高度な手順を実施して作文ツールのフル機能を利用することもできますこの方法ではインプレースでのテキストの書き直し、アニメーションの表示、校正による変更のインライン表示などが可能になります WritingToolsCoordinator APIはカスタムテキストエンジン用の新機能です
このAPIはビューと作文ツールとのインタラクションを管理します
ビューにコーディネータをアタッチし作文ツールコーディネータのデリゲートメソッドを実装するためのデリゲートを作成しますデリゲートは作文ツールの処理に対するコンテキストの提供、変更の統合、アニメーションで使用するプレビューオブジェクトの提供、作文ツールが校正マークを描画するための座標の提供、状態の変化への応答などを実行しますこれらの機能の使用方法を簡単なデモで見てみましょう
これは TextKit 2で構築したカスタムテキストエンジンですご覧の通り NSTextInputClientや NSServicesMenuRequestorなどの一般的なテキスト編集プロトコルを実装済みです
アプリをビルドし実行すると作文ツールの基本機能が無料でサポートされます結果はすべてパネルに表示されます書き直しを行ったり
結果による置換やコピーを行ったりできます
では作文ツールの機能のフルサポートを実装しましょう
DocumentViewで作文ツールのセッション中に必要になるインスタンスプロパティを追加します NSWritingToolsCoordinatorオブジェクトを初期化し
デリゲートをselfに設定して
NSViewに割り当てます initでconfigureWritingToolsを呼び出すことも必要です
当然ながら DocumentViewが NSWritingToolsCoordinator.Delegateに準拠していないというエラーが出ます
DocumentViewのExtentionにすべてのデリゲートメソッドを実装するファイルをドラッグしますこれによりコンテキストの提供、
テキストの置換と選択、校正用のバウンディングボックスの表示、
アニメーションのプレビューの生成などが行われるようになります
アプリをビルドして実行しましょう
テキストの書き直しを行うと
アニメーションが表示され変更内容をテキストビューで直接確認できます
校正を行うと作文ツールによって下線が追加されます
個々の提案をクリックして変更内容を確認することもできます
次にこれらの各手順について詳しく説明します
最初にコーディネータを作成しビューにアタッチします WritingToolsCoordinatorは UIKitのUIインタラクションであり他のUIインタラクションと同様に UIViewにアタッチします AppKitではこれはNSViewのインスタンスプロパティですコーディネータを準備できたら作文ツールの動作と結果オプションについて任意のものを設定できます
次はデリゲートメソッドですまず作文ツールには現在のテキストのコンテキストが必要ですコンテキストは NSAttributedStringとして扱われる一連のテキストと選択箇所で構成されます attributedStringには少なくとも現在のテキストの選択箇所を含める必要があります選択箇所の前後の段落を含めることもできますこれにより作文ツールが対象テキストの前後の文脈をより理解できるようになります context.attributedStringに基づいて範囲を現在の選択箇所として設定します何も選択しない場合ドキュメント全体をコンテキストとして返し範囲をカーソルの位置に設定しますこうすることで作文ツールはユーザーが何も選択しない場合ドキュメント全体を対象に処理を行えるようになりますこれがコンテキストを提供する方法ですこれはAppKitでの例ですがこのデモで特段の断りがない限り UIWritingToolsCoordinatorも NSWritingToolsCoordinatorも同様に使用できますデリゲートメソッドは非同期です大きいテキストビューでは基となるテキストストレージの処理に時間がかかるためです関数の本文で scopeパラメータに基づいてテキストと範囲を準備します多くの場合コンテキストは1つ返すだけで十分です複数のテキストストレージのテキストを同時に選択できる高度なテキストビューの場合コーディネータは複数のコンテキストもサポートします
ビューのテキストを評価した後作文ツールは変更の提案をデリゲートオブジェクトに渡しますこのテキスト置換のデリゲートメソッドは変更内容をビューのテキストストレージに統合します作文ツールはこのメソッドを個々の変更箇所に対して呼び出しますまたコンテキストオブジェクトが同じ異なる範囲の値に対して複数回呼び出すこともできます処理が完了すると作文ツールは選択したテキスト範囲の更新をデリゲートに指示できます
作文ツールによる処理中にテキストのアニメーションを表示するためにコーディネータは範囲内のテキストのプレビュー画像をリクエストします
テキストビューはプレビューとして透明な背景でレンダリングしたテキストを返しますアニメーションの表示中作文ツールはテキスト自体ではなく提供されたプレビュー画像に視覚エフェクトを適用します macOSではこの処理にデリゲートメソッドを2つ使用します 1つ目のデリゲートメソッドは配列を受け取ります範囲全体に対し 1つ以上のプレビューを返す必要がありますアニメーションをより滑らかにするには 1行ごとに1つプレビューを返します
iOSでは UIKitでNSTextPreviewではなく UITargetedPreviewを使用します使用するデリゲートメソッドは1つのみです
作文ツールはアニメーションを実際に実行する前後に prepareForメソッドと finishメソッドを呼び出しますアニメーションの準備としてテキストフィールドで特定範囲のテキストを非表示にしますアニメーションが終了したら非表示にした範囲のテキストを再表示します
校正では作文ツールは変更されたテキスト範囲に下線を表示しますまた範囲内のテキストに対するクリックイベントへの応答としてインラインの校正ポップアップを表示します
校正マークを表示するためにコーディネータは各範囲の基になるベジェ曲線を返すようデリゲートに指示します作文ツールはクリックやタップのイベントへの応答でも境界ベジェ曲線を必要とします
最後に状態の変化に応答するためのオプションとして writingToolsCoordinator: willChangeToState:completion: メソッドを使用できますテキストフィールドの実装に応じて併合の取り消し、同期の停止、編集の禁止なども実行できます逆に外部の変更についてコーディネータに通知する必要もあります updateRange:withTextを使用して作文ツールの動作を最新のテキストと同期させますまた updateForReflowedTextを使用してビューのレイアウトの変更を作文ツールに通知しますこのメソッドを呼び出すと作文ツールは新しいプレビューや校正マークなどのレイアウトに依存する情報をリクエストします
以上作文ツールのフル機能を強力なカスタムテキストエンジンと統合する方法を紹介しましたまた以前にサンプルコードで示したプロジェクトもリリースしましたサンプルコードと作文ツールのコーディネータに関する完全版ドキュメントで詳細をご覧ください
本セッションの内容は以上です次のステップとして作文ツールの新機能を試してみてください変更を記述した後のフォローアップ調整などや Vision Proやショートカットアプリでの作文ツール機能を利用できます
テキストが多いアプリにはツールバーボタンを追加しましょう
様々なフォーマットオプションを試して見出し、小見出し、コードブロックなどのセマンティックスタイルの読み書きをサポートしましょう
強力なテキストエンジンを使用している場合作文ツールのフル機能を活用してさらにエンジンを強化しましょう
昨年の「Get started with Writing Tools」ビデオとサンプルコードもぜひご覧くださいページ下部にリンクがありますサンプルコードでは作文ツールのコーディネータの機能を確認できますご視聴ありがとうございました

11:46 - Attach a coordinator to the view (UIKit)

// Attach a coordinator to the view
// UIKit

func configureWritingTools() {
    guard UIWritingToolsCoordinator.isWritingToolsAvailable else { return }

    let coordinator = UIWritingToolsCoordinator(delegate: self)
    addInteraction(coordinator)
}

12:02 - Attach a coordinator to the view (AppKit)

// Attach a coordinator to the view
// AppKit

func configureWritingTools() {
    guard NSWritingToolsCoordinator.isWritingToolsAvailable else { return }
       
    let coordinator = NSWritingToolsCoordinator(delegate: self)

    coordinator.preferredBehavior = .complete
    coordinator.preferredResultOptions = [.richText, .list]
    writingToolsCoordinator = coordinator
}

13:06 - Prepare the context

// Prepare the context

func writingToolsCoordinator(_ writingToolsCoordinator: NSWritingToolsCoordinator,
        requestsContextsFor scope: NSWritingToolsCoordinator.ContextScope,
        completion: @escaping ([NSWritingToolsCoordinator.Context]) -> Void) {

    var contexts = [NSWritingToolsCoordinator.Context]()
                
    switch scope {
    case .userSelection:
        let context = getContextObjectForSelection()
        contexts.append(context)
        break
        // other cases…
    }
        
    // Save references to the contexts for later delegate calls.
    storeContexts(contexts)
    completion(contexts)
}

13:48 - Respond to text changes from Writing Tools and update selected range

// Respond to text changes from Writing Tools

func writingToolsCoordinator(_ writingToolsCoordinator: NSWritingToolsCoordinator,
        replace range: NSRange,
        in context: NSWritingToolsCoordinator.Context,
        proposedText replacementText: NSAttributedString,
        reason: NSWritingToolsCoordinator.TextReplacementReason,
        animationParameters: NSWritingToolsCoordinator.AnimationParameters?,
        completion: @escaping (NSAttributedString?) -> Void) {
}

// Update selected range

func writingToolsCoordinator(_ writingToolsCoordinator: NSWritingToolsCoordinator,
        select ranges: [NSValue],
        in context: NSWritingToolsCoordinator.Context,
        completion: @escaping () -> Void) {
}

14:41 - Generate preview for animation (AppKit)

// Generate preview for animation (macOS)

func writingToolsCoordinator(_ writingToolsCoordinator: NSWritingToolsCoordinator,
        requestsPreviewFor textAnimation: NSWritingToolsCoordinator.TextAnimation,
        of range: NSRange,
        in context: NSWritingToolsCoordinator.Context,
        completion: @escaping ([NSTextPreview]?) -> Void) {
}
    
func writingToolsCoordinator(_ writingToolsCoordinator: NSWritingToolsCoordinator,
        requestsPreviewFor rect: NSRect,
        in context: NSWritingToolsCoordinator.Context,
        completion: @escaping (NSTextPreview?) -> Void) {
}

14:58 - Generate preview for animation (UIKit)

// Generate preview for animation (iOS)

func writingToolsCoordinator(_ writingToolsCoordinator: UIWritingToolsCoordinator,
        requestsPreviewFor textAnimation: UIWritingToolsCoordinator.TextAnimation,
        of range: NSRange,
        in context: UIWritingToolsCoordinator.Context,
        completion: @escaping (UITargetedPreview?) -> Void) {
}

15:08 - Delegate callbacks before and after animation

// Generate preview for animation

func writingToolsCoordinator(
    _ writingToolsCoordinator: NSWritingToolsCoordinator,
    prepareFor textAnimation: NSWritingToolsCoordinator.TextAnimation,
    for range: NSRange,
    in context: NSWritingToolsCoordinator.Context,
    completion: @escaping () -> Void) {

    // Hide the specific range of text from the text view
}

func writingToolsCoordinator(
    _ writingToolsCoordinator: NSWritingToolsCoordinator,
    finish textAnimation: NSWritingToolsCoordinator.TextAnimation,
    for range: NSRange,
    in context: NSWritingToolsCoordinator.Context,
    completion: @escaping () -> Void) {

    // Show the specific range of text again
}

15:39 - Delegate callbacks to show proofreading marks

// Create proofreading marks

func writingToolsCoordinator(_ writingToolsCoordinator: NSWritingToolsCoordinator,
        requestsUnderlinePathsFor range: NSRange,
        in context: NSWritingToolsCoordinator.Context,
        completion: @escaping ([NSBezierPath]) -> Void) {
}

func writingToolsCoordinator(_ writingToolsCoordinator: NSWritingToolsCoordinator,
        requestsBoundingBezierPathsFor range: NSRange,
        in context: NSWritingToolsCoordinator.Context,
        completion: @escaping ([NSBezierPath]) -> Void) {
}

関連する章

リソース

関連ビデオ

WWDC24