Login
Immutable PageDiscussionInfoAttachments
Diff for "HowToWriteWiki"

MMA
Differences between revisions 13 and 14
Revision 13 as of 2010-12-17 17:32:26
Size: 7805
Editor: chmod
Comment:
Revision 14 as of 2010-12-17 17:36:48
Size: 4280
Editor: chmod
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
こちらでは,ドキュメンテーションにあたって,特に Wiki 特有の事情に関わることを記します. こちらでは,ドキュメンテーションにあたって,特に Wiki 特有の事情に関わることを記します.<<BR>>
編集については,[[HowToWriteWiki2]]に分割されました.
Line 93: Line 94:


= ページの編集 =
ページの編集について記します。
詳細については [[HelpOnEditing]] を参照してください.

== 見出し ==
[[HelpOnHeadlines]] ''='' 前後の空白に気をつけてください。
{{{
= Level 1 =
== Level 2 ==
=== Level 3 ===
...
}}}

== 強制改行 ==
[[HelpOnMacros]] 強制改行は,マクロとして実現されます.
{{{
いろはにほへと<<BR>>ちりぬるをわか<<BR>>よたれそつねな
}}}
いろはにほへと<<BR>>ちりぬるをわか<<BR>>よたれそつねな

ただし,強制改行は''好ましくありません''.''空白行をはさむ''と段落として認識されるので,それに従って構造的な文章を記述するよう心がけてください.

== 箇条書き ==
[[HelpOnLists]] ''*'' 前後の空白に気をつけてください。
=== 箇条書き ===
{{{
 * その1
 * その2
  * その2-1
   * その2-1-1
  * その2-2
}}}
 * その1
 * その2
  * その2-1
   * その2-1-1
  * その2-2

{{{
 1. その1
 1. その2
}}}
 1. その1
 1. その2

=== 言葉の定義 ===
言葉の定義には、こちらを使いましょう。
{{{
 Δt:: 相対的に微少量と見なせる時間のこと。
 die Nabe:: 折に触れて開催されるイベント。また、そこで振舞われる料理。
}}}

 Δt:: 相対的に微少量と見なせる時間のこと。
 Naben:: 折に触れて開催されるイベント。また、そこで振舞われる料理。

== 書体をかえる ==
||<rowbgcolor="#ffffcc" width="50%">表記||表示例||
|| `''斜体''` || ''斜体'' ||
|| `'''太字'''` || '''太字''' ||
|| {{{`モノスペース`}}} || `モノスペース` ||
|| `{{{モノスペース2}}}` || {{{モノスペース2}}} ||
|| `__下線__` || __下線__ ||
|| `^スーパー^スクリプト`|| ^スーパー^スクリプト||
|| `,,サブ,,スクリプト` || ,,サブ,,スクリプト ||
|| `~-小さく-~` || ~-小さく-~ ||
|| `~+大きく+~` || ~+大きく+~ ||
|| `--ストローク--` || --ストローク-- ||

== リンクの作成 ==
[[HelpOnLinking]] リンクの作成方法を示します.<<BR>>
''WikiName'' と呼ばれる名前(2単語以上を,空白なしで,語頭を大文字にしてつないだもの.)は,''自動でリンク''されます.<<BR>>
それ以外は,以下のようにしてください.

{{{
 * [[Home]]
 * [[Home|トップページ]]
 * [[http://www.uec.ac.jp/]]
 * [[http://www.uec.ac.jp/|電気通信大学]]
}}}
 * [[Home]]
 * [[Home|トップページ]]
 * [[http://www.uec.ac.jp/]]
 * [[http://www.uec.ac.jp/|電気通信大学]]


== コードの貼り付け ==
{{{{
{{{#!highlight Haskell
quicksort' :: Ord a => [a] -> [a]
quicksort' [] = []
quicksort' (x:xs) = quicksort' smaller + [x] + quicksort' larger
    where
        smaller = [a | a <- xs, a < x]
        larger = [a | a <- xs, a >= x]
}}}
}}}}

{{{#!highlight Haskell
quicksort' :: Ord a => [a] -> [a]
quicksort' [] = []
quicksort' (x:xs) = quicksort' smaller + [x] + quicksort' larger
    where
        smaller = [a | a <- xs, a < x]
        larger = [a | a <- xs, a >= x]
}}}
内部的にPygmentsを使用してハイライトされる。よって対応している言語はPygmentsに因る。[[HelpOnParsers#Available_highlight_lexers]], http://pygments.org/languages/

なお、highlightはパーサの一つ。

ドキュメンテーションの方針

こちらでは,ドキュメンテーションにあたって,特に Wiki 特有の事情に関わることを記します.
編集については,HowToWriteWiki2に分割されました.

ページの作成

新しいページをつくる

HelpOnPageCreation によれば,

  • まず,リンクの元となるページを作成

  • そこから,新しいページへのリンクを張る

  • リンク先で「新しいページを作成」をクリック

こうすることで,新しいページがどこからもリンクされていない事態を防げます.

ページの管理

ページの管理について記します。少々長いですが、自分で新しいページを作る際は、以下のことは大体把握してくれると助かります。

古い版をみる

情報(ページ上部、検索ボックスの下)から見られます。

ページを移動・削除する

その他のアクションからページの移動ページの削除を選択してください。

例:

chmod/ThisIsATestPage から ThisIsANewPlace

階層構造をかえるときも、このように特に意識しなくてかまいません。

また、すべての /サブページ の名前も変更しますか? にチェックをいれると、サブページの名前もすべて変えることができます。

アクセス制御

文章へのアクセス制御は、 ACL (Access Control List) というものにより行われます。
以下は、ACLの例です。これは、部員は誰でも編集可能・部室内からは閲覧可能、外部からは読めないページを示します。

#acl Known:admin,read,write,delete,revert Room:read All:

ACLは,文章の先頭に記してください。

ユーザー名

ユーザー名は,登録されたユーザー名が使えます.ユーザー名の一覧は【】を参照してください.

グループ名は,次の物が使えます.

  • Known -- 登録ユーザー(=部員)全員
  • Room -- (ログインしない場合の)部室内からのアクセス
  • Chief -- 部長・副部長
  • Cashier -- 会計
  • All -- すべて

基本的には,会計資料など重要な書類をのぞいて,誰でも編集可能にしてください.

権限

権限を適切に付与することは重要です.

権限は,以下の物が使えます.

  • admin -- acl の制御ができます.これが適切に付与されていないと,誰もACLを変更できなくなります.

  • read, write -- 読み書きができます.
  • delete -- 削除ができます.
  • revert -- 古い版に戻せます.

文法

ACLは,以下のような文法に基づいています。

<ACL> ::= "#acl" " " <controls>

<controls> ::= <control> | <control> " " <controls>
<control> ::= <users> ":" <rights>

<users> ::= <user> | <user> "," <users>
<user> ::= ユーザー名 | グループ名

<rights> ::= "" | <right> | <right> "," <rights>
<right> ::= "admin" | "read" | "write" | "delete" | "revert"

簡単に上の意味を説明しましょう.ACLは,以下のような構造をしています.

#acl ユーザー[,ユーザー,...]:権限[,権限,...] [ユーザー[,ユーザー,...]:権限[,権限,...] ...]

ユーザは、ユーザー名やグループ名などをまとめて記述することができます。ユーザーやグループの一覧は上の節を参照してください。

権限は、おおよそ以下のようになるでしょう。

  • admin,write,read,revert,delete
    • 全ての権限
  • write,read,revert,delete
    • アクセス制御以外の全ての権限
    • Tasks や Discussion などの、誤って外部に公開されては困るページは、こうしてください。

  • read
    • 読み込みのみ。デフォルトで、学外ログインしていないユーザーに対しては、こうなります。

  • (なし)
    • "All:" とすると、学外から読めなくできます。

HowToWriteWiki (last edited 2011-08-09 23:44:09 by chmod)