「MoodleDocs:スタイルガイド」の版間の差分
提供：MoodleDocs
Mitsuhiro Yoshida (トーク | 投稿記録) |
Toshihiro KITA (トーク | 投稿記録) |
||
| (2人の利用者による、間の12版が非表示) | |||
| 1行目: | 1行目: | ||
{{ | {{ヘルプ}} | ||
==アイテムの場所の説明== | |||
*サイト管理者の設定は、たとえば、サイト管理の 'サイトポリシー' の '最大アップロードファイルサイズ' の設定と呼ばれる場合があります。 | |||
* ブーストテーマには、ナビゲーションドロワーとギアメニューがあります。クラシックテーマには 'コース管理' があります | |||
* 3.2では、通知メニューとメッセージメニューを含むメニューバーがあります | |||
例： | |||
*ナビゲーションドロワーの評定 | |||
*参加者ページの歯車メニューからのグループ | |||
*コースページの歯車メニューのさらに...リンクから '新しいバッジを追加する' | |||
*ユーザメニューのメッセージ | |||
==カテゴリ== | ==カテゴリ== | ||
カテゴリは、ドキュメントページのインデックスです。 | |||
* | *次のように入力すると、ページをカテゴリに追加できます<code><nowiki>[[カテゴリ:カテゴリ 名前]]</nowiki></code> 、 例えば<code><nowiki>[[カテゴリ:サイト管理]]</nowiki></code> 、ページの下部にあります。多くのテンプレートは、たとえば、テンプレートを使用してページを自動的に分類します<code><nowiki>[[テンプレート:フォーラム]]</nowiki></code>ページを[[:カテゴリ:フォーラム]]に分類します。 | ||
:<code><nowiki>[[ | *'''カテゴリへのリンク''' の場合、次のような別のコロンを追加する必要があります：<code><nowiki>[[:カテゴリ:FAQ]]</nowiki></code>は[[:カテゴリ:FAQ]]と表示されます。 | ||
*[[Special: | * [[Special:カテゴリ | カテゴリ]]はすべてのMoodleドキュメントカテゴリを一覧表示します。これは、ツールボックスの特別ページのリンクにあります。 | ||
*カテゴリとMediaWikiでのカテゴリの動作に関する '''詳細情報''' については、[https://en.wikipedia.org/wiki/Wikipedia:Categorization Wikipedia：Categorization]を参照してください。 | |||
==スクリーンショット== | ==スクリーンショット== | ||
*スクリーンショットを使用してドキュメントを説明することをお勧めします。公式[https://sandbox.moodledemo.net/ Moodleデモサイト]、または標準テーマの1つを使用する他のサイトまたはコースを使用し、スクリーンショットができるだけ小さいことを確認してください。 | |||
*スクリーンショットは、GIF、JPEG、またはPNG形式で、解像度は72ppi、最大幅は800pxである必要があります。 | |||
*スクリーンショットにさらに収まるようにするには、Webブラウザの表示 > テキストサイズメニューから、Webページの小さいテキストサイズを選択します。 | |||
*スクリーンショットは、ツールボックス[[Special:アップロード | アップロードファイル]]リンクを使用してアップロードできます。 | |||
*混乱を避けるために、スクリーンショットにわかりやすい名前を付けてください。 | |||
*スクリーンショットを記事に含めるには、フォームのリンクを使用してください<code><nowiki>[[File:Screenshot.png|thumb|alt text]]</nowiki></code>。 | |||
*スクリーンショットに境界線、透かし、ドロップシャドウなどの効果を適用しないでください。これにより、他のユーザがスクリーンショットを追加または置換しながら、記事のルックアンドフィールを一貫して維持できるようになります。 | |||
* [[標準テーマ#Mount_Orange:_example_of_a_customised_More_theme |これらの手順]]に従うことで、多くのMoodleドキュメントページで使用されている[http://school.moodledemo.net/ Mount Orange School]のアピアランスを複製できます。 | |||
*画像の配置と画像のキャプションの追加については、[https://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial Wikipedia Pictureチュートリアル]を参照してください。 | |||
==テンプレート== | |||
* MediaWikiでは、テンプレートは別のページに挿入できるページです。たとえば、このページのMoodleドキュメントヘルプブロックはテンプレートです。 | |||
*テンプレートはTemplate:''名前'' の代わりに次のように入力することでページに追加できます<code><nowiki>{{名前}}</nowiki></code>（テンプレート名では大文字と小文字が区別されます）。 | |||
* [https://docs.moodle.org/en/index.php?title=Special%3AAllpages&from=&namespace=10 All pages（Template namespace）]には、すべてのMoodleドキュメントテンプレートが一覧表示されます。 | |||
*詳細については、[http://meta.wikimedia.org/wiki/Help:Template Media Wiki Templateヘルプ]を参照してください。 | |||
==タグを編集するMoodleドキュメント== | |||
* [[MoodleDocs:削除 | 削除]] - 削除が必要なページを見つけた場合は、ページの上部に<code><nowiki>{{Deletion}}</nowiki></code>と入力します。必要に応じてページのコメントを使用して、削除の理由を述べてください。 | |||
* [[MoodleDocs:更新 | 更新]] - 機能はMoodleのバージョンごとに増加します。更新が必要なページを見つけた場合は、ページの上部に<code><nowiki>{{Update}}</nowiki></code>と入力します。 | |||
* [[:MoodleDocs:スタブ | スタブ]] - 開発者およびMoodleドキュメント管理者は、 <code><nowiki>{{スタブ}}</nowiki></code>タグをページ上部に付けて、コンテンツの追加に関するヘルプをリクエストします。 | |||
* [[ヘルプ:編集#Edit_summary | edit summary]]を使用して、さらに編集する必要があることを伝えることもできます。たとえば、ページ履歴には、"セクションを追加しました。さらに作業が必要です。ページのコメントを参照してください" と表示される場合があります。 | |||
== PHP構文の強調表示== | |||
* PHP構文を強調するには、コードをタグで囲みます。 | |||
<pre><nowiki><code php>... Some PHP code here...</code></nowiki></pre> | |||
これは次のようにレンダリングされます。 | |||
<code php> | |||
<?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> | |||
* | *長いコード例の場合、次のように '''行番号''' 追加することもできます。 | ||
<pre><nowiki><code php n>... A lot of PHP code here...</code></nowiki></pre> | |||
== | これは次のようにレンダリングされます。 | ||
<code php n> | |||
<?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> | |||
*ただし、行番号を付けると、コード例のコピーと貼り付けが煩雑になることに注意してください。 | |||
== CSS構文の強調表示== | |||
* CSS構文を強調するには、コードをタグで囲みます。 | |||
<pre><nowiki><code css>... Some CSS code here...</code></nowiki></pre> | |||
*例： | |||
<code css> | |||
.que .info .grade { display: none; } | |||
</code> | |||
*この例は、[https://docs.moodle.org/38/en/index.php?title=Quiz_FAQ&action=edit 小テストFAQ Docページ]で確認できます。 | |||
* GeSHi（Generic Syntax Highlighter）フィルタを使用する[[コード構文の強調表示]]に関するドキュメントも参照してください。 | |||
[[カテゴリ:MoodleDocs |スタイルガイド]] | |||
[[ | [[en:MoodleDocs:Style guide]] | ||
[[de:Moodle Docs StyleGuide]] | |||
[[es:MoodleDocs:Guía de Estilo]] | |||
[[fr:MoodleDocs:Guide de style]] | |||
[[ja:MoodleDocs:スタイルガイド]] | |||
[[zh:MoodleDocs:风格指引]] | |||
2020年12月16日 (水) 04:12時点における最新版
アイテムの場所の説明
- サイト管理者の設定は、たとえば、サイト管理の 'サイトポリシー' の '最大アップロードファイルサイズ' の設定と呼ばれる場合があります。
- ブーストテーマには、ナビゲーションドロワーとギアメニューがあります。クラシックテーマには 'コース管理' があります
- 3.2では、通知メニューとメッセージメニューを含むメニューバーがあります
例：
- ナビゲーションドロワーの評定
- 参加者ページの歯車メニューからのグループ
- コースページの歯車メニューのさらに...リンクから '新しいバッジを追加する'
- ユーザメニューのメッセージ
カテゴリ
カテゴリは、ドキュメントページのインデックスです。
- 次のように入力すると、ページをカテゴリに追加できます
[[カテゴリ:カテゴリ 名前]]、 例えば[[カテゴリ:サイト管理]]、ページの下部にあります。多くのテンプレートは、たとえば、テンプレートを使用してページを自動的に分類します[[テンプレート:フォーラム]]ページをカテゴリ:フォーラムに分類します。 - カテゴリへのリンク の場合、次のような別のコロンを追加する必要があります：
[[:カテゴリ:FAQ]]はカテゴリ:FAQと表示されます。 - カテゴリはすべてのMoodleドキュメントカテゴリを一覧表示します。これは、ツールボックスの特別ページのリンクにあります。
- カテゴリとMediaWikiでのカテゴリの動作に関する 詳細情報 については、Wikipedia：Categorizationを参照してください。
スクリーンショット
- スクリーンショットを使用してドキュメントを説明することをお勧めします。公式Moodleデモサイト、または標準テーマの1つを使用する他のサイトまたはコースを使用し、スクリーンショットができるだけ小さいことを確認してください。
- スクリーンショットは、GIF、JPEG、またはPNG形式で、解像度は72ppi、最大幅は800pxである必要があります。
- スクリーンショットにさらに収まるようにするには、Webブラウザの表示 > テキストサイズメニューから、Webページの小さいテキストサイズを選択します。
- スクリーンショットは、ツールボックス アップロードファイルリンクを使用してアップロードできます。
- 混乱を避けるために、スクリーンショットにわかりやすい名前を付けてください。
- スクリーンショットを記事に含めるには、フォームのリンクを使用してください
[[File:Screenshot.png|thumb|alt text]]。 - スクリーンショットに境界線、透かし、ドロップシャドウなどの効果を適用しないでください。これにより、他のユーザがスクリーンショットを追加または置換しながら、記事のルックアンドフィールを一貫して維持できるようになります。
- これらの手順に従うことで、多くのMoodleドキュメントページで使用されているMount Orange Schoolのアピアランスを複製できます。
- 画像の配置と画像のキャプションの追加については、Wikipedia Pictureチュートリアルを参照してください。
テンプレート
- MediaWikiでは、テンプレートは別のページに挿入できるページです。たとえば、このページのMoodleドキュメントヘルプブロックはテンプレートです。
- テンプレートはTemplate:名前 の代わりに次のように入力することでページに追加できます
{{名前}}（テンプレート名では大文字と小文字が区別されます）。 - All pages（Template namespace）には、すべてのMoodleドキュメントテンプレートが一覧表示されます。
- 詳細については、Media Wiki Templateヘルプを参照してください。
タグを編集するMoodleドキュメント
- 削除 - 削除が必要なページを見つけた場合は、ページの上部に
{{Deletion}}と入力します。必要に応じてページのコメントを使用して、削除の理由を述べてください。 - 更新 - 機能はMoodleのバージョンごとに増加します。更新が必要なページを見つけた場合は、ページの上部に
{{Update}}と入力します。 - スタブ - 開発者およびMoodleドキュメント管理者は、
{{スタブ}}タグをページ上部に付けて、コンテンツの追加に関するヘルプをリクエストします。 - edit summaryを使用して、さらに編集する必要があることを伝えることもできます。たとえば、ページ履歴には、"セクションを追加しました。さらに作業が必要です。ページのコメントを参照してください" と表示される場合があります。
PHP構文の強調表示
- PHP構文を強調するには、コードをタグで囲みます。
<code php>... Some PHP code here...</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>... A lot of PHP code here...</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');
}
...
- ただし、行番号を付けると、コード例のコピーと貼り付けが煩雑になることに注意してください。
CSS構文の強調表示
- CSS構文を強調するには、コードをタグで囲みます。
<code css>... Some CSS code here...</code>
- 例：
.que .info .grade { display: none; }
- この例は、小テストFAQ Docページで確認できます。
- GeSHi（Generic Syntax Highlighter）フィルタを使用するコード構文の強調表示に関するドキュメントも参照してください。
