Wiki作成ルール - 【discontinue development 】SetucoCMS Wiki - 【discontinue development 】SetucoCMS

Wiki作成ルール

このページはSetucoCMSでのWiki作成ルールを記述したページです。

Wikiにページを作成する際は、誰が見てもわかりやすいように書いてください。

文章について

語尾を統一する

文章は「ですます調」、箇条書きの場合は「～する・である調」という風に統一してください。

句読点の統一

通常の文章には「。」を付ける。箇条書きには「。」を付けないでください。

半角、全角の統一

アルファベットや数字は、半角・全角を統一してください。

【例】

誤：ＯＫ、１、１２３４
正：OK、1、1234

見出しについて

HTMLでの<h1>～<h6>タグのように見出しを付けてください。

= ページのタイトル
<h1>にあたるもの。Wikiのページのタイトルにつけてください。 このページでの「Wiki作成ルール」に当たります。

== 見出し
<h2>にあたるもの。
このページでは「文章について」や「その他」に当たります。

=== 小見出し
<h3>にあたるもの。
このページでの「語尾を統一する」や「見出しについて」に当たります。

名称について

サービスやシステムの名称をWikiに書く際には正しい名称かどうか確認してください。
間違った名称を書くのは失礼なので気を付けてください。

【例】

誤：sourceforge.jp、Sourceforge
正：SourceForge.JP

誤：github、Github
正：GitHub

誤：ウィキ、wiki、WIKI
正：Wiki(SourceForge.JP内のWikiの場合)

そのほかに、各MLは以下の呼び方で統一してください。
「SetucoCMS-public」「SetucoCMS-private」「電設部ML」

Wiki文法について

リンクについて

Wikiでは[ ]で囲うことでリンクを貼ることができます。
詳しくはWiki文法の解説ページをご覧ください。

URL:http://sourceforge.jp/projects/docs/wiki/WikiSyntax#h2-.E3.83.AA.E3.83.B3.E3.82.AF

Wiki文法無効化について

Wikiでは、[ ]で囲った文字にリンクが貼られます。また、アルファベット単語を以下のように書くとリンクが貼られます。

大文字1字+小文字+大文字１字+小文字

【例】
リンクになる
GitHub、SourceForge、ZendFramework、SetucoSetuo

リンクにならない
Yahoo、Google、freeML、SetucoZ

このリンクを無効にしたい場合には「!」を使います。
そのほかにもWiki文法を無効にしたいときにその直前で「!」をつけることによって無効にすることができます。

【例】
!GitHub
!SourceForge

ソースコードの記述について

Wiki内にソースコードを記述する際には以下のようにして下さい。

プログラムのはじめに 「{{{ code 言語名」、終わりに「}}}」と書いてください。

また、詳しいことは以下のサイトをご覧ください。
「Wiki文法　code」
URL:http://sourceforge.jp/projects/docs/wiki/WikiBlockProcessor#h2-code

【例】

---

 {{{ code html
<h1>SetucoCMSプロジェクト</h1>
<p>SetucoCMSは日本電子専門学校のOBが中心となって活動しているプロジェクトです。</p>
 }}}

---

【実際の表示】

---

 　<h1>SetucoCMSプロジェクト</h1>
   <p>SetucoCMSは日本電子専門学校のOBが中心となって活動しているプロジェクトです。</p>

---

その他

表示例について

ソースコードなどの記述例を書く際には以下のように書いてください。

【例】

記述例など

ページ概要について

ページタイトルの下にはページの概要を書いてください。 このページでは「このページはSetucoCMSでのWikiルールを記述したページです。」となっています。
わかりやすい簡潔な文章が好ましいです。