Develop and Download Open Source Software

Browse CVS Repository

Contents of /malonnote/README

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.9 - (show annotations) (download)
Thu Oct 13 12:23:19 2005 UTC (18 years, 5 months ago) by maloninc
Branch: MAIN
CVS Tags: dev_1_6-0004, dev_1_6-0003, dev_1_6-0002, dev_1_6-0001
Changes since 1.8: +61 -31 lines
fix README

1
2 *MalonNote
3
4 MalonNote は、ちょっとしたメモをすばやく保存・検索できるようにするアプリケーションです。
5 メモデータはテキストデータで保存されるので MalonNote が気に入らなくなってしまっても
6 情報を流用することができます。
7
8 Wiki を知っている方は「ローカル一人 Wiki」のようなものと思っていただければ良いと思います。
9 Wiki の影響を強く受けていますのでデータ形式もWiki 互換となるようにしました。
10
11
12 *インストール方法
13
14 **Mac の場合
15 mnote.app(あるいはmnote)のアイコンをアプリケーションフォルダにコピーしてください
16
17 **Windows の場合
18 mnote.exeを任意のディレクトリにコピーしてください
19
20 **UNIXの場合
21 mnoteを任意のディレクトリにコピーしてください
22 ただし、gtk2.0がインストールされている必要があります。
23
24 *使い方
25
26
27 **初めて使用する場合
28
29 初めて起動する場合、メモデータを保存するディレクトリを訪ねてきます。
30
31 お好みの空ディレクトリを指定して下さい。
32
33
34
35 **検索
36 1行入力用のテキストボックスに検索文字列を入力して、リターンキーを押すと
37 検索文字列を親として、検索結果がツリー状に表示されます。
38 尚、以下の特殊なキーワードを使用することで全件表示と分類検索が可能です。
39
40 -全件表示
41 「malon-all」とテキストボックスに入力してください
42
43 -分類検索
44 「malon-type:xxxx」とテキストボックスに入力してください。
45 xxxxに分類の行(メモ内のTYPEの行)に含まれる文字を指定してください
46
47 **新しいメモの作成
48 メニューから「New」を選択してください。
49
50 ※機種依存文字(丸数字やローマ数字)を含んでいる場合はエラーメッセージが表示され
51  正常に保存されませんので、再度メモを開いて機種依存文字を取り除いてください
52
53 **メモの修正
54 検索ツリー上から修正したいメモを選択し、メニューから「Edit」を選択してください
55
56 ※機種依存文字(丸数字やローマ数字)を含んでいる場合はエラーメッセージが表示され
57  正常に保存されませんので、再度メモを開いて機種依存文字を取り除いてください
58
59 **メモの削除
60 削除したいメモをツリーから選択し、メニューから「Remove」を選択してください。
61 メモに対応するファイルも一緒に削除されます。
62
63 **検索結果の削除
64 削除したい検索文字列をツリーから選択し、メニューから「Remove」を選択してください。
65 データファイルは削除されません。
66
67
68 **メモの件名修正
69 修正したいメモをツリーから選択し、件名を再度クリックしてください。
70
71
72 **メモの分類
73 メニューから「Group by TYPE」を選択してください。
74 すべてのメモから"TYPE"と書かれた行を解析して、その種類ごとに分類表示します。
75 メモの数が多いと若干時間がかかります。
76
77 **メモディレクトリの追加
78 メニューから「Add memo directory」を選択してください。
79 ディレクトリ選択ダイアログが表示されるので、メモデータが入っているディレクトリ
80 あるいは、これからメモを作成するディレクトリを指定してください。
81 新規にタブが作成されメモディレクトリを切り替えることができます。
82
83 **メモディレクトリの削除
84 メニューから「Remove memo directory」を選択してください。
85 選択されたタブが削除されます。メモデータディレクトリ自体は残ったままになります。
86
87 **検索ツリーの操作
88 「Tree」メニューから以下の機能を選択できます。
89
90 -Expand All
91 すべての検索ツリーを開きます。
92
93 -Collapse All
94 すべての検索ツリーを折りたたみます。
95
96 -Clear All
97 すべての検索ツリーを消去します。(起動時の状態に戻ります)
98
99
100 *メモフォーマット
101
102 基本的にフリーフォーマットですが、最初の4行は
103 以下のフォーマットを崩さないようにしてください。
104
105 :''DATE'':YYYY/MM/DD HH:MI:SS
106
107 :''TYPE'':メモの種別(任意の単語。/で区切ることも可 例:memo/todo/参考)
108 ----
109 本文
110
111 また、Wikiとの互換性を保つため本文には以下のような
112 Wikiテキスト整形フォーマットを推奨します。
113
114 ※Malon Noteでは整形機能があまり実装されていません。
115 以下の内、*, **, http:, ftp:, [[]], {{}}のみが機能します。
116
117 -行頭がスペースで始まると、その行はそまま表示されます。
118 -連続した複数行は連結されます。
119 -空行は段落の区切りとなります。
120 -シングルクォート2個ではさんだ部分は、ボールドになります。
121 -シングルクォート3個ではさんだ部分は、イタリックになります。
122 -アスタリスク(*)を行頭に書くと、大見出しになります。
123 -アスタリスク2個(**)を行頭に書くと小見出しになります。
124 - -を行頭に書くと箇条書きになります。
125 -http://www.maloninc.com/のようなURLは自動的にリンクになります。
126 -file://hoge.txtのようなものも自動的にリンクになります。
127 -[[]]でくくった文字列は他のメモを検索するリンクになります。
128 -{{}}でくくった文字列をファイル名とするファイルを開きます。
129 ただし、ファイルはメモデータディレクトリ上のdocsディレクトリ内にあるものに限定されます。
130 docsディレクトリは必要に応じて自分で作成してください。
131 -行頭がカンマで始まる行は表になります。たとえば
132
133 ,品名,価格
134 ,牛乳,100
135 ,プリン,120
136
137 は以下のような表になります。(ただし、前後に空行を入れてください)
138 +-------+---+
139 |牛乳 |100|
140 +-------+---+
141 |プリン |120|
142 +-------+---+
143
144 **メモの文字コードと改行コードについて
145 メモの文字コードはEUCコードで改行コードはLFになります。
146
147
148 **新規メモフォーマットのカスタマイズ
149 メモディレクトリにnew.templateという名称でファイルを作成することで
150 新規メモのデフォルトフォーマットを定義できます。
151 パッケージに添付のnew.templateはバグ管理に利用できるサンプルとなっています。
152
153
154 *バグの報告
155
156 **メールでの報告
157 バグを発見した場合には以下のメールアドレスまでご連絡ください。
158
159 hiroyuki@maloninc.com
160
161 また、以下の点について記載していただけますと大変助かります。
162
163 -OSの種類とバージョン(例: MacOS X 10.2)
164 -バグの事象を再現させる方法(例:同じ文字で検索を何回か繰り返すと強制終了する)
165
166 以下のファイルを取得できる場合は添付していただけますと非常に助かります。
167 -Windowsであれば、C:\Documents and Settings\All Users\Documents\DrWatson\drwtsn32.log
168 -MacOS Xであれば、/User/あなたのユーザー名/Library/Logs/CrashReporter/mnote.crash.log
169 -UNIXであれば、coreファイル
170
171 **sourceforgeを使える方
172 以下のURLからバグトラッカーへ登録していただけます助かります。
173 http://sourceforge.jp/projects/malonnote/tracker/
174
175
176 *開発者向けの情報
177
178 **GUIライブラリ
179 Macだけではなくて、UNIXやWindowsでも稼動させるためにクロスプラットフォームのGUIライブラリであるwxWidgets(旧名:wxWindows)を
180 使用しています。wxWidgetsについては以下のURLを参照してください。
181
182 -wxWindows本家
183 http://www.wxwindows.org/
184
185 -wxWindows日本語プロジェクト
186 http://wxwindowsjp.sourceforge.jp/
187
188 -wxWidgets でクロスプラットフォーム GUIアプリを作ろう
189 http://namazu.org/~satoru/pub/uu-2004-08/
190 ※このサイトを見て初めてwxWidgesを知りました。高林哲さんに感謝。
191
192 **設計思想
193
194 MalonNoteを構成するオブジェクトはMVC(Model-View-Controller)モデルで
195 作られています。
196 筆者のMVCモデルの理解を以下にまとめます。
197
198 -Model(ロジック)
199 アプリケーションロジックを担当する。
200 ただし、データの表示方法については実装しない。(それはViewの役割)
201
202 -View(表示)
203 Modelの状態を表示する。また、ControllerからModelの状態変更通知を受けた場合には
204 再表示する。
205 ViewはModelの状態を変更するような処理は行わない。(それはControllerの役割)
206
207 -Controller(イベント処理)
208 Viewで発生したイベントに応じてModelの状態を変更し、Viewへ状態変更を通知する。
209
210
211 **各クラスの機能
212
213 -mnModelクラス(Model)
214 メモデータであるWikiファイルやデータの管理と検索結果の管理を行います。
215
216 -mnFrameクラス, mnNotePanelクラス(View)
217 mnFrameクラスはwxNotebookをメンバーに持つクラスで、wxNotebookにタブを追加したり
218 削除することを担当します。
219 mnNotePanelクラスはmnModelの内容(状態)をツリーやテキストボックスに表示します。
220
221 -mnFrameControllerクラス, mnNotePanelController(Controller)
222 mnFrameControllerクラスはmnFrame上で発生したイベントを処理します。
223 mnNotePanelControllerクラスはmnNotePanel上で発生したイベントを処理し、mnModelの状態を変更したり、
224 mnNotePanelへmnModelの状態変更を通知する役割を担います。
225
226
227 *謝辞
228 -wxWidgetsを開発している方に感謝。(www.wxwindows.org)
229 -高林哲さんに感謝。wxWidgetsの記事を書いていなければ、MalonNoteは存在しなかったでしょう。(http://namazu.org/~satoru/)
230 -MASさんに感謝。MASさんの「ひとりWiki」が大変参考になりました。(http://www2u.biglobe.ne.jp/~MAS/index.html)
231 -Hitomiさんに感謝。りんごちゃんのアイコンを生み出してくれました。

Back to OSDN">Back to OSDN
ViewVC Help
Powered by ViewVC 1.1.26