Develop and Download Open Source Software

Browse CVS Repository

Annotation of /malonnote/README

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


Revision 1.7 - (hide annotations) (download)
Tue Sep 20 23:21:09 2005 UTC (18 years, 6 months ago) by maloninc
Branch: MAIN
CVS Tags: rel_1_3, dev_1_4-0001, dev_1_4-0003, dev_1_4-0002, dev_1_4-0005, dev_1_4-0006
Changes since 1.6: +24 -1 lines
modify README

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

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