編集のすすめ

Top > 編集のすすめ

PukiWiki 書式入門と共にここのWikiでの編集ルールを書いているページです。PukiWiki 書式について詳しく知りたい場合はFormatRule や org:PukiWiki/1.4/Manual/Plugin、また Pukiwiki本家FAQ を参照してください。

Table of Contents

ページの新規作成、編集、削除方法 Edit

ページを新規に作成する際は左の新しいページを作成メニューをクリックしてください。

ページを編集する際はそのページを開いた後、上の編集タブをクリックしてください。内容をすべて消して保存すると、そのページを削除することができます。

また、見出し中にあるえんぴつマークのアイコンをクリックしてパラグラフ単位(このWikiでは大見出しから大見出し、小見出しから小見出しまで)で編集できます。

ページをリネームする際には左のページ名の変更メニューをクリックしてください。 添付したファイルや差分なども一緒についてきてくれます。

ノートのすすめ Edit

上にノートタブがあります。そのページで Wikipedia のように本文に関する議論を行います。

できれば、本文編集後、名前と変更内容のサマリをそのページにコメント投稿しておいてください。これによって時間も残ります。 PukiWiki にユーザーアカウント管理機能があれば、ログイン後編集してもらうだけで、そのようなログを自動で残せるのですが・・・。

ノートページは、最近更新ページの一覧にはでません。最近更新ノートを参照してください。

新規作成のすすめ Edit

ページ名のすすめ Edit

ページを新規作成する場合は、階層化を利用するようにしてください。 例えば

ls

とだけのページ名ではなく、UNIX/コマンドに出るように

UNIX/コマンド/ファイル管理/ls

のように階層化を利用したページ名にしてください。

また、ページ名の末尾に : がついたページは一覧、最新の何件、更新履歴には表示されない、隠れファイルとなります*1。 draft を書くときに使うとよいでしょう。例えば

UNIX/コマンド/ファイル管理/test:

のように。きちんとしたページ名を考えるのはできあがってからでもよいと思います。

ちなみに、ページ名には

,

を入れない方が後腐れがないです。プラグインにページ名を渡すたびに " (ダブルクォーテーション)で挟まなければいけなくなったりします。

新規作成の際にとりこまれるテンプレートの説明 Edit

ページを作成するとテンプレートが用意されているのに気付くと思います。 基本的にはそのテンプレートに従って書いてください。

テンプレートで使用されているプラグインを説明しておきます。
Source:UNIX/コマンド/template

TITLE:

タイトルを設定できます。 これがページ参照中のページタイトルや、一覧で表示される文字列になります。

TITLE:コマンド名 - コマンドの概要

のように記入してください。

#navi

#navi(上の階層名)

とすることで

Prev                   UNIX/コマンド               Next

のようなリンクが上につきます。そのままで大丈夫(なはず)です。

#contentsx

これを書いておくと各見出し(行頭に*,**,***で記述)へのリンクリストを作成してくれます。 見出しがない場合は意味はありませんが、書いておきましょう。

文章はこれを挟んで、

ページの軽い説明
#contentsx
本文

のように書くとよいと思います。

RIGHT:written by s1XXXXXX.

RIGHT:written by s1XXXXXX.

には自分の学籍番号を書いて、「私が書いた!」ということを主張しておくと良いと思います。

編集のすすめ Edit

よく使うであろう機能の簡単な説明です。 このWikiはいくらか改造してあるので、その説明もしてあります。

見出し Edit

行頭に * を置くことによって見出しを作れます。*, **, *** の順で小さい見出しになります。

**見出し

のようにすると上のものと同じものがでます。

PukiWikiソースをみると、見出しの脇に [#z99ad3a0] のようなものが付いていると思います。 これはアンカーと呼ばれるものでページ保存時に自動的に生成される設定にしています。 自分で付ける必要はありませんし、消さないでください(また自動生成されるだけです)。

整形済みテキスト(pre タグ) Edit

行頭に半角空白を書くと整形ずみテキスト(<pre>タグではさまれる) になります。 コマンドラインを表現するときはそれを使ってください。

% ls

のように。このようになります。

すべての行の先頭にスペースを入れるのはわずらわしいと思うので、

#pre{{{
...
}}}

のようにすることでも実現できるようにしてあります。 また、

#pre(soft){{{
...
}}}

のようにした場合、整形中にリンクを貼ったり顔文字を使用したりすることができます。 例↓

hard

[[ls]] 整形済みテキスト

soft

ls 整形済みテキスト

整形済みテキストを記述する際、通常の PukiWiki サイトでは一行が長すぎると横スクロールがでてしまったりありがたくない表示になりますが、 この Wiki サイトではスタイルシートを改良して IE, Mozilla, Opera の際は横スクロールがでないように頑張っています。 なので一行の長さを気にすることなく貼り付けてしまってかまいません。

改行 Edit

編集中の改行は基本的に無視されます。

強制的に改行する場合は、行末に

~

を使用します。

ちなみに、PukiWikiソース内で2回改行を行い行間を空けた場合は、HTML 的にも <p> タグの終了になり表示的には行間が空きます。

リンク Edit

リンクは

[[ページ名]]

のようにして貼ります。ページ名とリンク名を変えたい場合は

[[リンク名>ページ名]]

のようにします。PukiWiki ではこのリンク名の部分をエイリアスと呼びます。 URL リンクを貼りたい場合は直接

http://...

のように書きます。このときリンク名を変えたい場合は同様に

[[リンク名>http://....]]

のようにします。

またこの Wiki では実際は ls という名のページはありませんが、UNIX/コマンド/ファイル管理/ls というページがあり、このような場合に自動的に lsUNIX/コマンド/ファイル管理/lsリダイレクトさせる AutoBaseAlias と呼ばれる機能が有効になっています。これにより UNIX/コマンド/ファイル管理/ls に対し

[[ls]]

という短縮ページ名でのリンクも可能ですし、http://technique.sonots.com/?ls という短縮URLで飛ぶこともできます。

さらにこのWikiでは 2 バイト以上の単語でマッチするページ名がある場合は

[[]]

がなくても勝手にリンクされるようにしてあります。さきほどの AutoBaseAlias 機能に対しても有効なので

ls

と書くだけで、ls にリンクされます。 ですが、意図的にリンクを貼る必要があると感じられる文脈ではできるだけ [[]] を使用してください。

テーブル Edit

テーブルは

|~th1|~th2|
|td1|td2|

のように書きます。

th1th2
td1td2
|~

のようにした部分は <th> タグになります。

  • テーブル中で改行をしたい場合は &br; を使用します。
  • また | を表示したい場合は &#x7c; を使用します。覚えにくいので &bar; でも可能なようにしました。
  • 空要素を作る場合は &nbsp; または &br; を書いておくとそれなりの表示になります。このWikiではスタイルシートの設定により空欄でも同様の表示になるようにしたので気にしなくても大丈夫です。

その他 colspan や rowspan などその他もろもろの機能についてはヘルプの方を参照してください。

添付ファイル、画像の貼り付け Edit

画像を貼り付けるにはまず、上のメニューの添付から画像ファイルをアップロードします。その後、アップロードしたページ内に

&ref(ファイル名);

のように書き込めば表示することができます。 画像の場合は画像が開かれます。他のファイルの場合はリンクが作られます。

画像ファイルを表示せずに、リンクだけ貼る場合は、

&ref(画像ファイル名,noimg);

のようにします。

&ref(画像ファイル名,80x80);

&ref(画像ファイル名,20%);

のようにして表示サイズを指定することもできます。 この % 指定は HTML で指定するような表示領域に対する % ではなく、 純粋に画像ファイルの大きさに対する % 指定になるので便利です。


*1 本来のPukiWikiでは先頭に : でこの効果がでますが、このWikiでは改造して先頭でも、末尾でも可能なようにしています。先頭に : の場合はせっかく用意しておいた template を使えなくなってしまうので、末尾のほうがグッドかと思います。
xrea