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.6 - (show annotations) (download)
Wed Aug 17 00:51:41 2005 UTC (18 years, 7 months ago) by maloninc
Branch: MAIN
CVS Tags: dev_1_3-0008, dev_1_3-0004, dev_1_3-0005, dev_1_3-0006, dev_1_3-0007, dev_1_3-0001, dev_1_3-0002, dev_1_3-0003, rel-1_1, dev-1_2-0001
Changes since 1.5: +3 -4 lines
*** empty log message ***

1
2 *Malon Note
3
4 MalonNote は、ちょっとしたメモをすばやく保存・検索できるようにするアプリケーションです。
5 メモデータはテキストデータで保存されるので Malon Note が気に入らなくなってしまっても
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 (将来にはdebianのパッケージファイルを作成する予定です。)
24
25 *使い方
26
27
28 **初めて使用する場合
29
30 初めて起動する場合、メモデータを保存するディレクトリを訪ねてきます。
31 お好みの空ディレクトリを指定して下さい。
32
33
34
35 **検索
36 1行入力用のテキストボックスに検索文字列を入力して、リターンキーを押すと
37 検索文字列を親として、検索結果がツリー状に表示されます。
38
39
40 **新しいメモの作成
41 メニューから「New」を選択してください。
42
43
44 **メモの削除
45 削除したいメモをツリーから選択し、メニューから「Remove」を選択してください。
46 メモに対応するファイルも一緒に削除されます。
47
48
49 **検索結果の削除
50 削除したい検索文字列をツリーから選択し、メニューから「Remove」を選択してください。
51 データファイルは削除されません。
52
53
54 **メモの件名修正
55 修正したいメモをツリーから選択し、件名を再度クリックしてください。
56
57
58
59 *メモフォーマット
60
61 基本的にフリーフォーマットですが、最初の4行は
62 以下のフォーマットを崩さないようにしてください。
63
64 :''DATE'':YYYY/MM/DD HH:MI:SS
65
66 :''TYPE'':メモの種別(任意の単語。/で区切ることも可 例:memo/todo/参考)
67 ----
68 本文
69
70 また、Wikiとの互換性を保つため本文には以下のような
71 Wikiテキスト整形フォーマットを推奨します。
72
73 ※Malon Noteでは整形機能があまり実装されていません。
74 以下の内、*, **, http:, ftp:, [[]], {{}}のみが機能します。
75
76 ・連続した複数行は連結されます。
77 ・空行は段落の区切りとなります。
78 ・行頭がスペースで始まると、その行はそまま表示されます。
79 ・シングルクォート2個ではさんだ部分は、ボールドになります。
80 ・シングルクォート3個ではさんだ部分は、イタリックになります。
81 ・アスタリスク(*)を行頭に書くと、大見出しになります。
82 ・アスタリスク2個(**)を行頭に書くと小見出しになります。
83 ・-を行頭に書くと箇条書きになります。
84 http://www.maloninc.com/のようなURLは自動的にリンクになります。
85 file://hoge.txtのようなものも自動的にリンクになります。
86 ・[[]]でくくった文字列は他のメモを検索するリンクになります。
87 ・{{}}でくくった文字列をファイル名とするファイルを開きます。
88 ただし、ファイルはメモデータディレクトリ上のdocsディレクトリ内にあるものに限定されます。
89  docsディレクトリは必要に応じて自分で作成してください。
90
91
92 *TODO
93 -メニューなどの日本語翻訳
94
95
96 *バグの報告
97
98 **メールでの報告
99 バグを発見した場合には以下のメールアドレスまでご連絡ください。
100
101 hiroyuki@maloninc.com
102
103 また、以下の点について記載していただけますと大変助かります。
104
105 ・OSの種類とバージョン(例: MacOS X 10.2)
106 ・バグの事象を再現させる方法(例:同じ文字で検索を何回か繰り返すと強制終了する)
107
108 以下のファイルを取得できる場合は添付していただけますと非常に助かります。
109 ・Windowsであれば、C:\Documents and Settings\All Users\Documents\DrWatson\drwtsn32.log
110 ・MacOS Xであれば、/User/あなたのユーザー名/Library/Logs/CrashReporter/mnote.crash.log
111 ・UNIXであれば、coreファイル
112
113 **sourceforgeを使える方
114 以下のURLからバグトラッカーへ登録していただけます助かります。
115 http://sourceforge.jp/projects/malonnote/tracker/
116
117
118 *開発者向けの情報
119
120 **GUIライブラリ
121 Macだけではなくて、UNIXやWindowsでも稼動させるためにクロスプラットフォームのGUIライブラリであるwxWidgets(旧名:wxWindows)を
122 使用しています。wxWidgetsについては以下のURLを参照してください。
123
124 -wxWindows本家
125 http://www.wxwindows.org/
126
127 -wxWindows日本語プロジェクト
128 http://wxwindowsjp.sourceforge.jp/
129
130 -wxWidgets でクロスプラットフォーム GUIアプリを作ろう
131 http://namazu.org/~satoru/pub/uu-2004-08/
132 ※このサイトを見て初めてwxWidgesを知りました。高林哲さんに感謝。
133
134 **設計思想
135
136 MalonNoteを構成するオブジェクトはMVC(Model-View-Controller)モデルで
137 作られています。
138 筆者のMVCモデルの理解を以下にまとめます。
139
140 -Model(ロジック)
141 アプリケーションロジックを担当する。
142 ただし、データの表示方法については実装しない。(それはViewの役割)
143
144 -View(表示)
145 Modelの状態を表示する。また、ControllerからModelの状態変更通知を受けた場合には
146 再表示する。
147 ViewはModelの状態を変更するような処理は行わない。(それはControllerの役割)
148
149 -Controller(イベント処理)
150 Viewで発生したイベントに応じてModelの状態を変更し、Viewへ状態変更を通知する。
151
152
153 **各クラスの機能
154
155 -mnModelクラス(Model)
156 メモデータであるWikiファイルやデータの管理と検索結果の管理を行います。
157
158 -mnFrameクラス(View)
159 mnModelの内容(状態)を画面(ツリーやテキストボックス)に表示します。
160
161 -mnControllerクラス(Controller)
162 mnFrame上で発生したイベントに応じてmnModelの状態を変更したり、
163 mnFrameへmnModelの状態変更を通知する役割を担います。
164
165
166 *謝辞
167 -wxWidgetsを開発している方に感謝。(www.wxwindows.org)
168 -高林哲さんに感謝。wxWidgetsの記事を書いていただかなければ、MalonNoteは存在しなかったでしょう。(http://namazu.org/~satoru/)
169 -MASさんに感謝。MASさんの「ひとりWiki」が大変参考になりました。(http://www2u.biglobe.ne.jp/~MAS/index.html)
170 -Hitomiさんに感謝。りんごちゃんのアイコンを生み出してくれました。

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