1. Homepage
  2. Exchange
  3. アセットのパブリッシュ

  4. アセットの説明

アセットの説明

アセットのポータルを編集したり、その名前、アイコン、説明、タグ、カテゴリ、カスタム項目を変更したり、コンテンツが含まれるポータルページを追加したりできます。各ページの最大文字数はマークダウン形式で 1,024,000 文字です。

アセットのすべてのバージョンは、同じ名前、アイコン、説明、そして計算された平均評価を持ちます。

アセットの各マイナーバージョンは、自身のタグ、カテゴリ、カスタム項目、そして契約条件のページ (省略可能) などのコンテンツページを持ちます。

Exchange で、アセットリストを開き、アセットを選択します。Exchange には、アセットポータルが表示されます。

アセットポータル情報を編集する

アセットアイコン、名前、説明、連絡先名、連絡先メールを変更できます。

  1. アセットポータルで [編集] ペンアイコンをクリックします。

  2. アイコンを変更するには、[編集] ペンアイコンをクリックし、画像ファイルを選択して、​[Open (開く)]​ をクリックします。

  3. アセットポータル名を変更するには、新しいアセットポータル名を入力します。

  4. 説明を変更するには、新しいアセットの説明を ​[Description (説明)]​ 項目に入力します。

  5. 連絡先名または連絡先メールを変更するには、新しい連絡先名および連絡先メールを対応する項目に入力します。

  6. 変更をキャンセルするには、​[X]​ アイコンをクリックします。

  7. 変更を保存するには、​チェック​アイコンをクリックします。

2019 年 8 月リリース前では、アセットの各バージョンに異なる名前またはアイコンを設定できます。2019 年 8 月リリース後では、更新されたアセット情報がアセットのすべてのバージョンに適用されます。

カテゴリを追加および削除する

アセットを検索するときに、カテゴリを使用して検索結果を絞り込むことができます。

  1. アセットの詳細ペインで、​[Add categories (カテゴリを追加)]​ をクリックします。アセットのカテゴリがすでに追加されている場合、​[Categories (カテゴリ)]​ をクリックします。

  2. [Add category (カテゴリを追加)]​ をクリックし、カテゴリのリストから選択します。

  3. [Add value (値を追加)]​ をクリックし、値のリストから選択します。

  4. カテゴリを削除するには、ゴミ箱アイコンをクリックします。

  5. カテゴリから値を削除するには、値テキストの ​[X]​ をクリックします。

アセットタグを追加および削除する

アセットを検索するときに、タグを使用して検索結果を絞り込むことができます。タグには小文字のみを使用でき、大文字のタグは小文字に変換されます。特殊文字を使用できます。

  1. アセットの詳細ペインで、​[Add tags (タグを追加)]​ をクリックします。アセットのタグがすでに追加されている場合、​[Tags (タグ)]​ をクリックします。

  2. [Add a tag (タグを追加)]​ をクリックし、タグのリストから選択します。

  3. キーボードの Enter キーまたは Return キーを押します。

  4. タグを削除するには、​[Tags (タグ)]​ をクリックし、タグテキストの横にある ​[X]​ をクリックします。

アセットポータルドキュメントを編集する

アセットのドキュメントは変更できます。

  1. [Edit documentation (ドキュメントを編集)]​ を選択します。

  2. 新しいポータルコンテンツを入力します。

  3. エディターでは、テキストの外観を変更したり、コードサンプル、ブロック引用、水平線を挿入したりできます。

  4. 下記のように画像や動画を追加します。

  5. メインページを作成したら、​[Save (保存)]​ を選択してドラフトとして保存するか、​[Publish (パブリッシュ)]​ をクリックします。ドラフトの編集と保存はパブリッシュ前に何度でも行えます。ドラフトは、パブリッシュするまで他のユーザーには表示されません。

  6. 下記のようにセカンダリページや契約条件を追加します。

  7. すべてのページを編集して保存したら、​[Publish (パブリッシュ)]​ をクリックしてポータルをパブリッシュします。

  8. これで、アセットポータルが組織内の全員に表示されます。

画像を追加する

画像をコピーして Exchange ページに直接貼り付けることができます。

  1. [Edit documentation (ドキュメントを編集)]​ をクリックします。

  2. [Visual (ビジュアル)]​ を選択します。

  3. 画像がコンピューターにある場合、その画像を Exchange ページにドラッグするか、コピーして Exchange ページに貼り付けます。

    画像が Web サーバーにある場合、画像をコピーして Exchange ページに貼り付けます。

または、エディターで画像アイコンを選択し、Web で使用可能なイラストへの URL を提供することもできます。

[Markdown (マークダウン)]​ タブで、次の構文を使用して Web で提供される画像を参照します。

​![代替テキスト](http://www.example.com/image/png.png)​

2019 年 5 月より前にアップロードされた画像は認証せずにアクセスできます。2019 年 5 月以降にアップロードされた画像には認証が必要です。2019 年 5 月より前にアップロードされた画像への未認証のアクセスを無効化するには、その画像をダウンロードし、削除した後に再度アップロードしてください。

セカンダリページを追加する

アセットポータルにページを追加できます。

  1. [Edit documentation (ドキュメントを編集)]​ を選択します。

  2. 左側のナビゲーションバーで、​[Add New Page (新規ページを追加)]​ をクリックします。

  3. キーボードの Enter キーまたは Return キーを押してページを作成します。必要に応じてページをいくつでも作成できます。

  4. ページを削除するには、​[Delete Page (ページを削除)]​ をクリックします。

  5. Exchange ポータルで、​[Add Content Pages (コンテンツページを追加)]​ をクリックします。

  6. ページに説明を追加します。セカンダリページでは、メインページと同じオプションがサポートされています。

  7. 新しいページのドラフトを保存するには、​[Save (保存)]​ をクリックします。セカンダリページが左側のナビゲーションバーにリストされます。

  8. ドラフトを編集するには、左側のナビゲーションバーのリストからページの名前を選択し、​[Edit (編集)]​ をクリックします。

  9. 編集をキャンセルするには、​[Cancel (キャンセル)]​ をクリックします。

  10. すべてのページを編集して保存したら、パブリッシュするページごとに ​[Publish (パブリッシュ)]​ をクリックします。

[Editing draft (ドラフト編集)]​ モードでは、ページ名をクリックして左側のナビゲーションバーでページを上下にドラッグすることで、ページを並び替えることができます。

ページ名はすべて検証されます。

  • ページ名の長さは 1 ～ 128 文字までにする必要があります。

  • ページ名に予約済みの名前 ​home​ は使用できません。

  • ページ名に既存のページ名は使用できません。

  • ページ名に次の文字は使用できません: @ ​* ​+ ​/ ​_ ​\​。

  • ページ名を​.​で始めることはできません。

必須ページ ​[Home (ホーム)]​ には URL ​pages/home​ があり、省略可能なページ ​[Terms and conditions (契約条件)]​ には URL ​pages/.terms​ があります。

他の新しいページの場合、3 つの英数字、ハイフン、3 つ以上の英数字以上のページ ID (例: pages/1a2-b3c/Formats​) が含まれる URL が Exchange によって設定されます。ページ名を ​Formats​ から ​Formatting​ に変更すると、URL が ​pages/1a2-b3c/Formatting​ に代わり、古い URL は自動的に新しい URL にリダイレクトされます。

2022 年 10 月 31 日の更新より前に作成されたページでは、ページ ID のない URL (例: pages/Messages​) になります。ページ名を ​Messages​ から ​Messaging​ に変更すると、URL が新しい形式の ​pages/de4-56f/Messaging​ に代わり、古い URL は自動的に新しい URL にリダイレクトされます。

Anypoint CLI との後方互換性を確保するために、新しい形式の URL の各ページには、古い形式の URL (例: pages/Pagename​) から新しい URL (例: pages/78g-h9i/Pagename​) への自動リダイレクトが設定されます。

別のページへのリンクには、​[the page about messaging](pages/de4-56f/Messaging)​ のように、角括弧内にリンクテキスト、括弧内に URL が含まれます。

契約条件を指定する

契約条件は API アセットでのみ追加できます。ユーザーは API アクセス権を要求するときに契約条件に同意するように求められます。

  1. アセットを選択し、​[Edit documentation (ドキュメントを編集)]​ をクリックします。

  2. 左側のナビゲーションバーで、​[Add Terms and Conditions (契約条件を追加)]​ をクリックします。

  3. エディターを使用して、このアセットの契約条件を指定します。

  4. 契約条件ページをドラフトとして保存するには、​[Save (保存)]​ をクリックします。

  5. 契約条件ページを削除するには、​[Delete Page (ページを削除)]​ をクリックします。

  6. 契約条件ページをパブリッシュするには、​[Publish (パブリッシュ)]​ をクリックします。

API グループ

API グループのいずれかの API に契約条件ページがある場合、API グループの契約条件ページは削除できず、基礎となる API の契約条件が表示されます。

必要に応じて、API グループの契約条件ページに契約条件を追加できます。

エディターに関する注意

  • リンクコントロールを使用するには、テキストを入力してテキストを選択し、リンクコントロールをクリックしてリンク URL を指定する。

  • 編集中に Exchange セッションがタイムアウトした場合、ページのすべてのテキストを選択して クリップボードにコピーする。再度ログインした後に、コンテンツをページに貼り付けてドラフトを保存できます。タイムアウトが発生すると、保存されていないコンテンツは消去されます。

  • 文字を押したままにして国際文字にアクセス可能。

  • 多数のアセットの説明を編集する場合、アセットをクリックして Exchange から開く代わりに、アセットを右クリックして [Open Link in New Window (新しいウィンドウでリンクを開く)] をクリックし、新しいブラウザーウィンドウでアセットを開く。それ以外の場合、アセットをパブリッシュしたら、コントロールは検索条件/検索リストの先頭に戻ります。

  • キーボードショートカット (ビジュアルエディターとマークダウンエディターで動作): 太字: ctrl-b/cmd-b、斜体: ctrl-i/cmd-i、ヘッダー: ctrl-d/cmd-d、ブロック引用: ctrl-e/cmd-e、コードブロック: ctrl-j/cmd-j、段落番号: ctrl-o/cmd-o、箇条書き: ctrl-u/cmd-u、リンクを挿入: ctrl-k/cmd-k。

マークダウンに関する注意

  • Anypoint Exchange は GitHub マークダウンを使用する。

  • ページごとのマークダウン文字の上限は 1,024,000 文字です。

  • マークダウンでは、div、button、a、ul、ol、table、p、span、pre、code などの基本的な HTML 5 コード要素がサポートされる。

  • リンクの挿入: [MuleSoft.com](http://www.mulesoft.com)​ または:

    [MuleSoft.com][1]

[1]: https://mulesoft.com

  • YouTube 動画の挿入: ​![linkname](https://www.youtube.com/embed/YOUR_YOUTUBE_ID_HERE)​
    例: ​![](https://www.youtube.com/embed/K3tuHUZ1J04)​

  • 構文の強調表示の使用:

    ```javascript
const myBool = true;
const myNumber = 5;
const myString = "abc";
```