richText.js•4.6 kB
// src/server/tools/documentation/richText.js
/**
* リッチテキストフィールドのドキュメントを取得する関数
* @returns {string} ドキュメント文字列
*/
export function getRichTextDocumentation() {
return `
# リッチエディタフィールド(RICH_TEXT)の仕様
## 概要
書式付きテキストを入力するフィールドです。太字、斜体、下線、リスト、表などの書式を設定できます。マニュアル、詳細な説明文、書式付きの議事録など、リッチなテキストコンテンツを扱うのに適しています。
## 主要なプロパティ
1. \`defaultValue\`: 初期値(HTML形式の文字列、省略可)
- HTML形式で書式付きテキストを指定できます
- 空の場合は空白のエディタが表示されます
## リッチエディタの特徴
- WYSIWYGエディタとして表示されます(What You See Is What You Get)
- 以下の書式設定が可能です:
- テキストの装飾(太字、斜体、下線、取り消し線、文字色、背景色)
- 段落の書式(見出し、引用、整列)
- リスト(番号付き、箇条書き)
- 表の挿入と編集
- リンクの挿入
- 画像の挿入(アップロード機能付き)
- 入力されたデータはHTML形式で保存されます
- 複数行テキスト(MULTI_LINE_TEXT)より高度な書式設定が可能です
## 使用例
### 基本的なリッチテキストフィールド
\`\`\`json
{
"type": "RICH_TEXT",
"code": "description",
"label": "詳細説明",
"required": true,
"defaultValue": ""
}
\`\`\`
### 初期値を設定したリッチテキストフィールド
\`\`\`json
{
"type": "RICH_TEXT",
"code": "product_details",
"label": "商品詳細",
"defaultValue": "<h2>商品の特徴</h2><p>ここに<strong>商品の特徴</strong>を入力してください。</p><h2>仕様</h2><ul><li>サイズ:</li><li>重量:</li><li>素材:</li></ul>"
}
\`\`\`
### テンプレート付きリッチテキストフィールド
\`\`\`json
{
"type": "RICH_TEXT",
"code": "meeting_minutes",
"label": "議事録",
"defaultValue": "<h2>会議概要</h2><p>日時:</p><p>場所:</p><p>参加者:</p><h2>議題</h2><ol><li></li></ol><h2>決定事項</h2><ul><li></li></ul><h2>次回アクション</h2><table border='1' style='width:100%'><tr><th>担当者</th><th>タスク</th><th>期限</th></tr><tr><td></td><td></td><td></td></tr></table>"
}
\`\`\`
## 応用例
### マニュアル作成
製品マニュアルや手順書などの作成に使用できます:
\`\`\`json
{
"type": "RICH_TEXT",
"code": "manual",
"label": "操作マニュアル",
"defaultValue": "<h1>操作マニュアル</h1><h2>1. はじめに</h2><p>このマニュアルでは、製品の基本的な操作方法について説明します。</p><h2>2. 使用前の準備</h2><p>使用前に以下の準備を行ってください:</p><ol><li>電源の確認</li><li>接続の確認</li></ol>"
}
\`\`\`
### 画像付きコンテンツ
画像を含むコンテンツを作成できます(画像は別途アップロードが必要):
\`\`\`json
{
"type": "RICH_TEXT",
"code": "news_article",
"label": "ニュース記事",
"defaultValue": "<h1>新製品発表</h1><p>当社は新製品「〇〇〇」を発表しました。</p><p>[ここに画像を挿入]</p><p>主な特徴は以下の通りです:</p><ul><li>高性能</li><li>省エネルギー</li><li>コンパクト設計</li></ul>"
}
\`\`\`
## 注意事項
1. defaultValueはHTML形式の文字列で指定します
2. リッチエディタフィールドは、kintoneの画面上でWYSIWYGエディタとして表示されます
3. 入力されたデータはHTML形式で保存されます
4. 画像を挿入する場合は、別途ファイルのアップロードが必要です
5. HTMLタグの一部は制限されている場合があります(セキュリティ上の理由から)
6. リッチテキストの内容を検索する場合、HTMLタグは検索対象外となります
7. モバイル端末では、編集機能が制限される場合があります
## 関連情報
- 単純なテキスト入力の場合は、SINGLE_LINE_TEXT(1行)またはMULTI_LINE_TEXT(複数行)フィールドを使用してください
- 画像のみをアップロードする場合は、FILEフィールドを使用してください
- リッチテキストの内容は、印刷用レイアウトやメール通知などにも使用できます
`;
}