MoodleDocs：スタイルガイド

Moodleドキュメントヘルプ


アイテムの場所を記述する

  • サイト管理設定は、たとえば、サイト管理の[サイトポリシー]の[最大アップロードファイルサイズ]の設定と呼ばれることがあります。
  • Boostテーマには、ナビゲーション用の引き出しと歯車メニューがあります。クリーンテーマでは、「コース管理」があります。
  • 3.2では、通知メニューとメッセージメニューを含むメニューバーがあります。

例：

  • ナビゲーションパネルの評定
  • 参加者ページの歯車メニューからのグループ
  • コースページの歯車メニューの[その他...]リンクから[新しいバッジを追加]
  • ユーザーメニューのメッセージ

カテゴリー

カテゴリはドキュメントページのインデックスです。

  • 次のように入力してページをカテゴリに追加できます。 
     [[カテゴリ：カテゴリ名]]
    、 例えば
     [[カテゴリ：サイト管理]]
    ページ下部にあります。多くのテンプレートは、テンプレートを使用して自動的にページを分類します。例えば、 
     [[Template：Forum]]
    ページをカテゴリ：フォーラムに分類します。
  • カテゴリにリンクするには、次のようにコロンを追加する必要があります 。 
     [[：カテゴリ：FAQ]]
    これはCategory：FAQとして表示されます。
  • カテゴリはすべてのMoodleドキュメントカテゴリを一覧表示します。これはツールボックスの特別ページのリンクにあります。
  • MediaWikiでのカテゴリとそれらがどのように働くかについてのさらなる情報は、 Wikipedia：Categorizationを参照してください。

スクリーンショット

  • スクリーンショットでドキュメントを説明することをお勧めします。公式のMoodleデモサイト 、または標準テーマのいずれかを使用している他のサイトまたはコースを使用し、スクリーンショットができるだけ小さいことを確認してください。
  • スクリーンショットはGIF、JPEGまたはPNG形式で、72ppiの解像度、最大幅は800ピクセルです。
  • スクリーンショットに合わせるには、Webブラウザの[表示]> [文字サイズ]メニューで、Webページの文字サイズを小さくします。
  • スクリーンショットは、ツールボックスの[ ファイルのアップロード]リンクを使用してアップロードできます 。
  • 混乱を避けるため、スクリーンショットにわかりやすい名前を付けてください。
  • スクリーンショットを記事に含めるには、フォームのリンクを使用します。 
     [[File：Screenshot.png | thumb | alt text]]
    。
  • スクリーンショットにボーダー、透かし、ドロップシャドウなどの効果を適用しないでください。これにより、他のユーザーが時間の経過と共にスクリーンショットを追加または置換しても、記事に対する一貫した外観を維持することができます。
  • 以下の手順に従うことで、多くのMoodleドキュメンテーションページで使用されているマウントオレンジスクールの外観を複製することができます 。
  • 画像の配置や画像の説明の追加については、 Wikipediaの画像チュートリアルを参照してください 。

テンプレート

  • MediaWikiでは、テンプレートは他のページに挿入できるページです。たとえば、このページのMoodleドキュメントヘルプブロックはテンプレートです。
  • 次のように入力してテンプレートをページに追加できます。 
     {{名}}
    Template： Nameの場合（テンプレート名は大文字と小文字が区別されます）。
  • すべてのページ（テンプレート名前空間）はすべてのMoodle Docsテンプレートを一覧表示します。
  • 詳細についてはMediaWikiテンプレートのヘルプを参照してください。

Moodle Docsの編集タグ

  • 削除 - 削除が必要なページが見つかった場合は、次のように入力します。 
     {{削除}}
    ページ上部にあります。必要に応じてページのコメントを使用して、削除の理由を述べます。
  • 更新 - 機能は各Moodleバージョンで増加します。更新が必要なページが見つかった場合は、次のように入力します。 
     {{更新}}
    ページ上部にあります。
  • スタブ - 開発者とMoodleドキュメント管理者は、新しいページを追加することができます。 
     {{スタブ}}
    一番上にタグを付け、コンテンツを追加する際に助けを求めます。
  • 編集サマリーを使用して、さらに編集が必要であることを伝えることもできます。たとえば、ページ履歴には次のように表示されることがあります。

PHPシンタックスハイライト

  • PHPの構文を強調するには、コードをタグで囲みます。 
 <code php> ...ここにPHPコードがいくつかあります... </code>

それは次のようにレンダリングされます。 

 <？php
require_once （ dirname （ __ FILE__ ） 。 '/../../config.php' ） ;

$ cmid = required_param （ 'cmid' 、 0 、 PARAM_INT ） ;
if （ ！ $ cm = get_coursemodule_from_id （ 'quiz' 、 $ id ） ） {
    print_error （ 'invalidcoursemodule' ） ;
}
...
  • 長いコード例では、次のように行番号を追加することさえできます。 
 <code php n> ...ここにたくさんのPHPコードがあります... </code>

それは次のようにレンダリングされます。 

 <？php
require_once （ dirname （ __ FILE__ ） 。 '/../../config.php' ） ;

$ cmid = required_param （ 'cmid' 、 0 、 PARAM_INT ） ;
if （ ！ $ cm = get_coursemodule_from_id （ 'quiz' 、 $ id ） ） {
    print_error （ 'invalidcoursemodule' ） ;
}
...
  • ただし、行番号を付けると、コード例のコピーと貼り付けが面倒になります。
  • GeSHi（Generic Syntax Highlighter）フィルタを使ったコードシンタックスハイライトに関するドキュメントも参照してください。

CSSシンタックスハイライト

  • CSSの構文を強調するには、コードをタグで囲みます。 
 <code css> ...ここにCSSコードがいくつかあります。</code>
  • 例： 
 .que .info .grade { display ： none ; }
" https://docs.moodle.org/35/en/index.php?title=MoodleDocs:Style_guide&oldid=130322 "より作成