Develop and Download Open Source Software

Browse CVS Repository

Contents of /malonnote/README.txt

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


Revision 1.10 - (show annotations) (download)
Fri Dec 30 12:04:35 2005 UTC (18 years, 2 months ago) by maloninc
Branch: MAIN
CVS Tags: rel_1_7_1, dev_1_6-0005
Changes since 1.9: +9 -8 lines
File MIME type: text/plain
modify readme

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

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