MoodleDocs:寄稿者向けガイドライン
提供: MoodleDocs
Moodleドキュメントへの寄稿を歓迎します。コンテンツ、文法、フォーマットのいずれかで改善できるものを見つけて修正してください!注:ページを編集するには、 ログインが必要です。
はじめに
- すべての寄稿は、 GNU General Public Licenseの下でここにリリースされることに注意してください。
- Moodleのすべてのページには、Moodleドキュメントの対応するページへのリンクがあります。これはmoodle.orgで、管理者の観点からはMoodleデモサイトで確認できます。
- スクリーンショットでドキュメントを説明することをお勧めします。詳細については、スタイルガイドを参照してください。
- 他の貢献者に編集の助けを求める方法については、MoodleDocs:テンプレートを参照してください。
新しいページを作成する
- Moodleに関する追加ドキュメントのページを作成することを歓迎します。新しいページの名前を既存のページの二重括弧
[[New page name]]
の間に入力し、リンクをクリックして新しいページの編集を開始するだけです。または、ブラウザのアドレスバーに次のように入力することもできます:https://docs.moodle.org/en/New_page_name
(つまり、新しいページ名のスペースをアンダースコアに置き換えます) 。- 短い名前を選択し、最初の単語のみを大文字にしてください(「Moodle」という単語など、いくつかの例外があります)。
- スタイルガイドに従ってください。新しいページを分類すると、ユーザが見つけやすくなりますが、重要なことは、ページに適切なコンテンツを配置することです。
- ページタイトルは、ドキュメントの再構成の一部として、ページをリダイレクト/移動することにより、将来変更される可能性があります。
ページのバージョン管理
- 英語(およびドイツ語)のMoodleドキュメントには、1.9以降(たとえば、1.9、2.0、2.1 .. 3.3)のMoodleブランチごとに異なるページがあります。他の言語では、各ページに1つ、2つ、または3つのMoodle Docsバージョン(1.9、2.x、3.xなど)しかありません。
- 現在のMoodleバージョンページと以前のページ(例えば3.3と3.2)を作成/更新/修正するのは慣習です。
- 古いバージョンのページは編集できない場合があります。古い(保護された)ページを編集する必要がある場合は、現在のバージョンのページコメントにメッセージを残してください。
- ページがMoodleリリースに合わせてバージョン管理されている場合、MoodleHQは、以前のリリースのドキュメントを複製することにより、新しいリリースが近づくと新しいページを作成します。
- バージョン管理されたページの例:
言語間のリンク
- 異なる言語のページ間の言語間リンクは、たとえば、英語のMoodleDocsに
[[es:Corresponding page title in Spanish]]
と入力、また Spanish MoodleDocsのカテゴリリンクの下に[[en:Corresponding page title in English]]
と入力することで追加できます。言語間リンクは、「他の言語で」ブロックに自動的に表示されます。
ページのコメント
- 特定のページに関するコメントや短いディスカッションについては、対応するトークページを使用してください(ページのコメントタブをクリックしてください)。 4つのチルド ~~~~ を入力して、トークページの投稿に署名し、日付を記入してください。編集フィールドのツールバーに署名するための便利なボタンもあります:
- ドキュメントに関するより長い議論については、Moodleコミュニティサイトフォーラムのmoodle.orgに投稿してください。
- 署名されていないコメントを見つけた場合は、 {{Unsigned | Username}} のようにTemplate:Unsignedを使用して、( 前のコメントはによって追加されました ユーザ:ユーザ名)
ページ保護
- 目次などの特定のページは編集できないように保護されています。追加のコンテンツやその他の変更を提案するには、ページのコメントを使用してください。