Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

コンテンツの追加と編集

Drupal の「Basic Page」コンテンツタイプを使用して、使い方ガイドや API リファレンスドキュメントのような、API に関するドキュメントをデベロッパサービスポータルに追加し、ビデオ、スクリーンキャスト、コードダウンロードのようなコンテンツを含めます。 

メモ: デベロッパは、アプリを使用して、API 製品 (product) 内のリソースにアクセスします。一般に、デベロッパは、デベロッパポータルを使用して、それらのアプリを追加します。ドキュメントに、デベロッパポータルを通じてアプリを追加するための手順が含まれることを確認してください。アプリを追加するための手順を、開始点として使用できます。この手順では、デフォルトのデベロッパポータルを通じてアプリを追加する方法について説明しています。

ドキュメントページは、いくつかの初期エントリが、「はじめに」や「チュートリアル」のようなさまざまなカテゴリに整理された状態でセットアップされています。このページは、編集するための開始点です。このようにして、独自のコンテンツエントリを追加し、希望する方法でそれらのエントリを整理できます。

ドキュメントホームページの追加

デフォルトでは、ドキュメントホームページはデベロッパポータルの<siteURL>/documentationにあります。デベロッパポータルのデフォルトのホームページでは、ホームページ上部のボックス内にこのページへのリンクが含まれています。

デベロッパポータルメニューのメインメニューで、このページへのドキュメントリンクを追加することもできます。

ただし、デフォルトでは、ドキュメントホームページは存在しません。このため、デベロッパポータルの適切な URL に新しいページを作成する必要があります。

ドキュメントホームページをデベロッパポータルに追加するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Content」>「Add content」>「Basic page」の順に選択します。
  3. ドキュメントのタイトル (「ドキュメントホーム」など) と、最初のページのコンテンツを入力します。
  4. 「Edit summary」 をクリックして、サマリを追加します。
  5. Body」セクションの下の「Menu settings」 項目をクリックします。
  6. 「Provide a menu link」を選択し、リンクのタイトルを追加し、「Parent Item」の「<Main menu>」 を選択します。
    ドキュメントホームページのメインメニューへのリンクが追加されます。
  7. 「Body」セクションの下の「URL path settings」項目をクリックします。
  8. 「Generate automatic URL alias」 を選択解除し、URL エイリアスを documentation に設定します。
    デフォルトでは、ページの URL は<siteURL>/content/pageNameです。URL エイリアスを設定することで、ページの明示的な URL を (この場合、<siteURL>/documentation に) 設定できます。
  9. ページを保存します。
    これで、メニューバーにページへのリンクが表示され、ホームページ上のボックス内のリンクが機能するようになりました。
    管理者には、「View」や「Edit」のようなコンテンツ管理ボタンも表示されます。管理者以外には、これらは表示されません。

子ページをドキュメントに追加する

子ページをドキュメントに追加するときは、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Content」>「Add content」>「Basic page」の順に選択します。
  3. ページのタイトルとコンテンツを入力します。
  4. 「Edit summary」 をクリックして、サマリを追加します。
  5. Body」セクションの下の「Menu settings」項目をクリックします。
  6. 「Provide a menu link」 を選択し、リンクのタイトルを追加し、ドキュメントホームページのメニュー項目を選択します。



    ドキュメントホームページのメインメニューの子として、現在のページが追加されます。
  7. これで、ドキュメントホームページのメニューにページへのリンクが表示されるようになりました。

ドキュメントページの編集

ページを編集するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. デベロッパポータル内のページに移動します。
    Drupal の管理メニューで「Content」 をクリックして、すべてのページを一覧表示し、ページを選択することもできます。
  3. ページ上の「Edit」タブを選択します。


     
  4. 「Body」セクションの下の「Text Format」ドロップダウンメニューで「Full HTML」または「Filtered HTML」を選択して、ビジュアルエディタを開きます。
    エディタにページのコンテンツが表示されます。
  5. 必要に応じて、ページを編集します。

  6. 「Save」をクリックします。

任意のドキュメントページを表示する

ドキュメントのコンテンツを表示するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Content」を選択します。
  3. 表示するドキュメントを選択します。

ページの順序を変更する

ドキュメントホームページのメニューで、ページの順序と入れ子レベルを変更できます。

ドキュメントホームのメニューでページを並べ替えるには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、 「Structure」>「Menus」>「Main menu」の順に選択します。
  3. Each item in the menu has an icon to the left of its name. If you do not see the icons, click Hide row weights.
  4. To move an item, click and drag the icon to move it to a new location.
    Dragging an item with child items also moves the children.


     
  5. 「Save Configuration」をクリックします。

フッターページの編集

ポータルのフッターには、Twitter、Facebook、LinkedIn を表す 3 つのソーシャルアイコンと、次の URL が設定されているリンクが含まれています。

  • Privacy Policy: URL <siteURL>/privacy-policy
  • Terms & Use: URL <siteURL>/terms-use
  • Contact ページ: URL <siteURL>/contact-us

これらのページを編集して、独自のコンテンツを追加します。

これらのページが存在しない場合は、ページを作成します。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Content」>「Add content」>「Basic page」の順に選択します。
  3. ドキュメントのタイトル (「プライバシポリシー」など) と、ページのコンテンツを入力します。
  4. 「Edit summary」 をクリックして、サマリを追加します。
  5. 「Body」セクションの下の「URL path settings」項目をクリックします。
  6. 「Generate automatic URL alias」を選択し、URL エイリアスを privacy-policy に設定します。
    デフォルトでは、ページの URL は<siteURL>/content/pageNameです。URL エイリアスを設定することで、ページの明示的な URL を (この場合、<siteURL>/privacy-policy に) 設定できます。
  7. ページを保存します。
  8. Terms & Use ページと Contact ページについて、このプロセスを繰り返します。 

Privacy Policy、Terms of Use、Contact Us ページのような、デベロッパポータル内のフッターページのコンテンツを編集するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. フッター内のページのリンクをクリックして、ページに移動します。例えば、「Privacy Policy」 リンクをクリックします。
  3. ページ内の「Edit」タブをクリックして、エディタを開きます。
  4. 必要に応じて、Privacy Policy ページのコンテンツを変更します。
  5. 「Save」をクリックします。 
  6. Terms & Use ページと Contact ページについて、このプロセスを繰り返します。

Twitter、Facebook、LinkedIn アイコンのような、デベロッパポータル内のソーシャルアイコンを編集するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Structure」>「Blocks」の順に選択します。
  3. 「Site-wide Default Footer」ブロックが表示されるまで、Blocks ページを下へスクロールします。
  4. 「Site-wide Default Footer」ブロックに対応する「configure」リンクを選択します。
  5. 「Custom Content」領域で、ソーシャルアイコンを右クリックし、ポップアップメニューの「Edit Link」を選択します。または、アイコンを「Custom Content」領域から削除して、取り除きます。
  6. 「Save block」を選択して、変更を保存します。

JavaScript をポータルページに追加する

JavaScript を任意のポータルページに追加できます。JavaScript を追加する最も簡単な方法は、ページを編集し、次の手順に従うことです。

  1. 「Text Format」として「Full HTML」を選択します。
  2. 「Source」 ボタンを選択して、ページの HTML ソースコードを編集します。
  3. JavaScript をページに追加します。例えば、ページが読み込まれたときにアラートボックスをポップアップ表示するには、次のコードを追加します。

    <script language="JavaScript">
        alert('Welcome to my page!');
    </script>

「Full HTML」テキストフォーマットは、ページ上で許可する HTML タグを制限するように構成できます。例えば、<script> タグの使用を禁止するように構成できます。「Full HTML」テキストフォーマットの設定を指定するには、Drupal の管理メニューで、「Configuration」>「Content authoring」>「Text formats」>「Full HTML」の順に選択します。「Limit allowed HTML tags」チェックボックスがオンの場合は、ページの「Filter processing order」領域で許可する HTML タグをオンにします。

JavaScript の使用に関するいくつかの考慮事項

  • JavaScript ファイルを参照する場合は、ノードのソースコードでは参照しないでください。ノードのソースコードでは、静的なリンクが作成されるためです。代わりに、PHP コードを使用して動的なリンクを作成できます。このようにすると、JavaScript ファイルの場所が変わった場合に、そのファイルを参照しているすべてのポータルページを更新しなくて済みます。
  • JavaScript ファイルを含める場合は、ポータルテーマに追加してください。ファイルが Drupal モジュールの一部の場合は、モジュールに追加してください。
  • Drupal では、Drupal の drupal_add_js 関数を使用して JavaScript を追加することもできます。詳細については、https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7 を参照してください。

壊れたリンクがないかどうかの確認

コンテンツに壊れたリンクがないかどうかを確認することをお勧めします。デフォルトでは、デベロッパポータルは、さまざまなタイプのページに壊れたリンクがないかどうかを確認するようにセットアップされています。例えば、基本ページ、記事、ブログエントリ、フォーラムトピックでリンクが確認されます。

ページの種類をリンク確認に追加したり、リンク確認から削除したりするには、次の手順に従います。

  1. In the Drupal administration menu, select Modules and ensure that the Link Checker module is enabled.
  2. In the Drupal administration menu select Configuration > Content authoring > Link checker.
  3. Configure the content types that you want to be scanned for broken links.

検索の構成

デベロッパポータルには、Apache Solr で実装されている組み込みの検索エンジンが用意されています。これは、Apache Lucene 検索ライブラリを使用します。これは、サイト自体の検索エンジンです。これには、ユーザーはすべてのポータルページの右上隅にある検索ボックスを使用してアクセスします。

Google のような外部検索エンジンも、ポータルのインデックスを作成することがあります。デベロッパポータルでは、外部検索エンジンがポータルのインデックスを作成できるようにするかどうかを制御できます。

Apache Solr の構成

インデックスを作成するコンテンツタイプを制御したり、インデックス作成を強制したり、追加の構成タスクを実行したりするように Apache Solr を構成できます。

Apache Solr を構成するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Configuration」>「Search and metadata」>「Apache Solr search」の順に選択します。
  3. このページを使用して、Apache Solr を構成します。

Google のインデックス作成を無効にする

コンテンツのインデックスを作成し、検索エンジンから使用できるようにすることもお勧めします。デフォルトでは、コンテンツは Google インデクサによってインデックスが作成されます。ただし、Google のインデックス作成を無効にするかどうかを選ぶこともできます。デベロッパポータルが公の使用への準備が整っておらず、コンテンツを公に検索できないようにしたい場合は、このようにすることができます。

Google のインデックス作成を無効にするには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Modules」 を選択します。
  3. 「Meta tags」セクションを選択して、セクションを展開します。
  4. 「Meta tags」 チェックボックスをオフにします。
  5. 「Save configuration」 をクリックします。
  6. Drupal の管理メニューで、「Configuration」>「Search and metadata」>「Metatag」の順に選択します。
  7. 「Global type」として「Override」操作を選択します。
  8. 「Advanced」セクションをクリックして開きます。

  9. 「Prevent search engines from indexing this page.」のチェックボックスをオンにします。
  10. 「Save」をクリックします。 

Global ページの「Advanced」セクションには、他の検索エンジン関連オプションもあります。例えば、検索エンジンからページ上のリンクをたどれないようにするチェックボックスをオンにすることもできます。必要に応じて、これらのチェックボックスの 1 つ以上をオンにします。

アプリの登録方法を文書化する

ドキュメントに、デベロッパがデベロッパポータルを通じてアプリを登録する方法についての手順が含まれることは重要です。次の手順を開始点として使用できます。この手順では、デフォルトのデベロッパポータルを通じてアプリを登録する方法について説明しています。

デベロッパがポータル上でアプリを登録する方法を構成するには、「アプリ登録の構成」を参照してください。アプリ登録プロセスを変更する場合は、それに応じて次の手順例を変更してください。

デフォルトのデベロッパポータルを通じてアプリを登録するには、次の手順に従います。

  1. ログインメニューのユーザー名の下の「My apps」を選択します。 
  2. 「Add a new app」アイコンをクリックします。

    アプリを追加するアイコン

  3. 「Add app」ページに、適切な値を入力します。
    App name アプリの一意のアプリ名を指定します。
    Callback URL

    必要に応じて、OAuth 呼び出しの戻り先のコールバック URL を指定します。

    デフォルトでは、API で OAuth を使用しなくてもこの値は必須です。API で OAuth を使用しない場合は、my.site.com のようなダミー値を入力してください。

    Product 1 つ以上の API 製品を選択します
  4. 「Create App」をクリックしてアプリを登録し、アプリの API キーを生成します。

Help or comments?