TiddlyWiki helper tools
Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
script
test
.gitignore
History.txt
Manifest.txt
PostInstall.txt
README.rdoc
Rakefile

README.rdoc

tidtools

github.com/ongaeshi/tidtools

tidtoolsは、TiddlyWikiをより使いやすくするためのコマンドラインツール群です。Wiki内の検索等、様々なツールが用意されています。RubyGem経由で簡単にインストール可能です。

INSTALL:

通常のgemインストールと同様です。

gem install tidtools

DESCRIPTION:

インストールすると以下のツールが使えるようになります。

tiddler2texts

TiddlyWikiをTiddlerごとのテキストファイルに分割

tidgrep

TiddlyWikiファイルをgrep検索

twgrep

TiddlyWiki内のつぶやき形式のテキストを検索

一緒に、TiddlyWikiを扱うためのライブラリもインストールされます

Tiddler2texts

TiddlyWikiをTiddlerごとのテキストファイルに分割

Tiddle

TiddlyWiki形式のファイルから、Tiddleの配列を取得出来る

Tweet

つぶやき形式のテキストを扱う

SETUP:

よく使うTiddlyWikiファイルが決まっているのであれば、 環境変数 TIDDLYWIKI_PATHS を設定しておくと便利です。

.bashrcで設定するなら以下のようになります

# tidtoolsがデフォルトで検索するパス
export TIDDLYWIKI_PATHS="/Users/ongaeshi/memo.html"

';'を区切り文字として、複数のTiddlyWikiを検索対象に指定することも出来ます。

# ';'を区切り文字にすると、複数のTiddlyWikiを検索対象に指定出来ます
export TIDDLYWIKI_PATHS="/Users/ongaeshi/memo.html;/Users/ongaeshi/work.html"

FIRST_STEP:

環境変数を指定しておけば、ファイルの場所を指定しなくても簡単に検索が出来ます。

% tidgrep tidtools # tidtoolsと書いてあるテキストを探す
SiteSubtitle:1:tidtools実験用のダミーメモ
Tweet - 4:16:ノートのWindowsマシンだとスムーズにtidtoolsのインストールが出来た。
Tweet - 4:24:tidtools、まだバグがあるよ。
Tweet - 4:50:tidtools0.0.4 - twgrepを追加
.
.

環境変数を設定していなくても、-fオプションを指定すれば検索出来ます。

% tidgrep -f /Users/ongaeshi/memo.html tidtools # -fで検索対象を指定(ここでも;区切りが使える)
SiteSubtitle:1:tidtools実験用のダミーメモ
Tweet - 4:16:ノートのWindowsマシンだとスムーズにtidtoolsのインストールが出来た。
Tweet - 4:24:tidtools、まだバグがあるよ。
Tweet - 4:50:tidtools0.0.4 - twgrepを追加
.
.

twgrepはtidgrepの特殊版で、つぶやき形式という特殊な形式で書かれたテキスト専用の検索ツールです。

つぶやき形式とは、私が勝手に作ったTiddlyWikiでつぶやきっぽいテキストを書くための整形ルールです。 '—-'で区切りを表現し、区切りの前に日時を入れます。 また“Tweet - New”のように、TiddleのタイトルにTweetという文字列を含みます。

私は月が変わるごとに新しいTiddleを作ることにしていて、“Tweet - New”, “Tweet - 5”, “Tweet - 4”のようにTiddleを作っています。

# つぶやき形式の例
# このつぶやきは "Tweet - 4" というTiddleに保存されている

おやすみー、結局こんなに遅くなった
~~@@color(gray):2010/04/06 2:28@@~~
----
リリース失敗・・・、tidtools0.0.5を再リリース
~~@@color(gray):2010/04/06 1:21@@~~
----
tidtools0.0.4をリリース
~~@@color(gray):2010/04/06 22:03@@~~
----
おはよう
~~@@color(gray):2010/04/06 08:30@@~~
----

twgrepはこんな感じで使います。

% twgrep tidtools # tidtoolsという文字を含むつぶやきを検索
--- Tweet - New --------------------
リリース失敗・・・、tidtools0.0.5を再リリース
~~@@color(gray):2010/04/06 1:21@@~~
----
tidtools0.0.4をリリース
~~@@color(gray):2010/04/06 22:03@@~~
----

tiddler2textsはTiddlyWikiをTiddlerごとのテキストファイルに分割します。

# output_dir/に出力
$ tiddler2texts /path/to/tiddlywiki.html output_dir

以下のようなスクリプトを書けば、複数のTiddlyWikiをまとめてテキストに変換することが可能です。

require 'rubygems'
require 'tidtools/tiddler2texts'

if __FILE__ == $0
  Tidtools::Tiddler2texts.output('/path/to/memo1.html', 'memo1')
  Tidtools::Tiddler2texts.output('/path/to/memo2.html', 'memo2')
end

より詳しい使い方は各コマンドのヘルプを見て下さい。

LINKS:

github

ソースコード等

Rubygems

gemの置き場所

Twitter

このツール専用のTwitterアカウントです

blog

開発者のブログです、他のことも書きますがご容赦下さい

LICENSE:

MIT License