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

こちらでは，ドキュメンテーションにあたって，特に Wiki 特有の事情に関わることを記します．

ページの作成

新しいページをつくる

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:" とすると、学外から読めなくできます。

ページの編集

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

見出し

HelpOnHeadlines = 前後の空白に気をつけてください。

= Level 1 =
== Level 2 ==
=== Level 3 ===
...

強制改行

HelpOnMacros 強制改行は，マクロとして実現されます．

いろはにほへと<<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
2. その2

言葉の定義

言葉の定義には、こちらを使いましょう。

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

Δt

相対的に微少量と見なせる時間のこと。

Naben

折に触れて開催されるイベント。また、そこで振舞われる料理。

書体をかえる

リンクの作成

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

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

Home トップページ http://www.uec.ac.jp/ 電気通信大学