:: wikihub-wikiwiki

Wikihub (wikihub.org) の使い方

Wikihub は，Git や Subversion にて文書を管理したいコマンドライン大好きなプログラマーさんたちが，文書を自分にあったやり方で更新しつつ，バージョン管理しつつ，でもウェブでも見たい，という欲張りな要望をかかえているだろうと勝手に判断し作成された，バージョン管理連携wikiインターフェイスです．

現在クローズドベータとして運営中．

この文書のオリジナルもGithubをリポジトリとした，wikihub上で管理されています．

• http://github.com/sotarok/wikihub-wiki/tree/master

この文書もGithubをリポジトリとした，wikihub上で管理してみました.

• http://github.com/snoozer05/wikihub-wiki/tree/master

ログイン/ユーザ登録

OpenIDのみ対応しています．

現在クローズドベータなので，使ってみたい方は，twitter にて，@sotarok までお声がけください．DMにて Closed beta register key を送ります．

Wiki閲覧のほうは，どなたでも閲覧できます．

Wikiの登録

Wiki の登録には，2つの情報が必要です．

• Wikiの名前 (英数字 と - または _ の組み合わせ)
• Wiki リポジトリのURL
  • これは，現在，以下の2つのみ対応しています．
    • httpプロトコルでアクセス可能な SubversionまたはGitリポジトリ
    • gitプロトコルでアクセス可能はGitリポジトリ

例えば，

git://github.com/sotarok/wikihub-wiki.git

などです．

対象のファイル

Wikihub上に表示されるファイルは，拡張子が .txt となったファイルまたは README ファイルのどちらかです．

また，指定されたWikiのトップは，指定したリポジトリの README ファイルを表示します．

URL とファイルの対応

簡単のため，

• Wikihub： http://wikihub.org/wiki/wikihub-wiki
• リポジトリ：http://github.com/sotarok/wikihub-wiki/tree/master (リポジトリのルートを，REPOSITORY_ROOTとします)

を用いて解説します．

Wikihub の文書トップ

• http://wikihub.org/wiki/wikihub-wiki
  • リポジトリ上の REPOSITORY_ROOT/README ファイルが整形されて表示される
• http://wikihub.org/wiki/wikihub-wiki/hoge
  • リポジトリ上の REPOSITORY_ROOT/hoge.txt ファイルが整形されて表示される
• http://wikihub.org/wiki/wikihub-wiki/hoge/fuga
  • リポジトリ上の REPOSITORY_ROOT/hoge/fuga.txt ファイルが整形されて表示される

といった具合です．

Wikiの更新

Wikiの更新は，リポジトリの更新にHookして Ping URL にアクセスしてください．

Githubで管理された文書なら設定は簡単です．

1. リポジトリの Admin へアクセスする
2. Service Hooksへアクセス
3. Post-Receive URLsへ，http://wikihub.org/ping/%wikiname% などとURLを入力して追加する
   • ここでいう %wikiname% は，Wikihub上に作成した Wikiの名前になります

送信されたPingは順次処理されます．最大1分ほどのタイムラグがあります．気長にお待ちください．

Subversion を使っている場合は少し面倒で，リポジトリのあるサーバで，コミットフックを設定しなければいけません．Post Commit Hook で Ping URL にアクセスするようにしてください．

'''大切なこと'''なのでもう一度書きます。

Wikiの更新は，リポジトリの更新にHookして Ping URL にアクセスしてください．

Githubで管理された文書なら設定は簡単です．

1. リポジトリの Admin へアクセスする
2. Service Hooksへアクセス
3. Post-Receive URLsへ，http://wikihub.org/ping/%wikiname% などとURLを入力して追加する
   • ここでいう %wikiname% は，Wikihub上に作成した Wikiの名前になります

送信されたPingは順次処理されます．最大1分ほどのタイムラグがあります．気長にお待ちください．

Subversion を使っている場合は少し面倒で，リポジトリのあるサーバで，コミットフックを設定しなければいけません．Post Commit Hook で Ping URL にアクセスするようにしてください．

Wikiの整形

Wiki文書スタイルは現在，はてな記法のみをサポートしています．

• ref. はてな記法一覧

バグ・不具合など

sotarokまでどうぞ：

• http://twitter.com/sotarok

問い合わせ

sotarokまでどうぞ：

• http://twitter.com/sotarok
• sotaro.k /at/ gmail.com

感想

sotarok++