howmm - sunchane/documentation GitHub Wiki

howmm

HOWM Android 版本 howmm 教學手冊

這是筆記寫作 APP。 功能:

  • 使用純文字資料檔案
  • 強大的搜尋功能
  • 筆記間互相連結
  • 顯示提醒
  • 俱備直式及橫式排版
  • “新增筆記” 畫面可以直接被呼叫

我打算製作安卓版本的 howm,Emacs 使用者的筆記寫作軟體。 howmm 並沒有完整的 howm 功能,但是總是適合我自己。

編寫筆記

當您第一次啟動 Howmm,沒有任何筆記,所以主視窗什麼也沒顯示。 點選 “+” 按鈕並且編寫新的筆記。

您可以編寫任何格式的筆記因為 howmm 的檔案格式為簡單的純文字。 並且,howmm 對待開頭為 “=” 的行為標題 (titles)。 所以如果您要編寫筆記的標題,使用上述的格式是個不錯的選擇。 標題行可以放置在筆記中的任何位置,而且可能不只一個標題 (換句話說,您可以在單一筆記檔案中編寫數個筆記)。 當您編寫完成後,點選 “✓” 按鈕,筆記就完成存檔。 有些手機配備 qwerty 鍵盤的話,以下的快速鍵可以在主畫面中使用。 這些快速鍵可以在偏好設定中修改。

  • Ctrl+Z 復原
  • Ctrl+D 插入日期時間用於提醒 (請看下面)
  • Ctrl+T 插入目前時間及日期
  • Ctrl+S 存檔並離開

閱讀筆記

於主畫面中,標題的列表顯示於 上/左 側。點選標題即顯示內容,長點選可以編輯它。 請注意如果筆記沒顯示標題,頂部那行會顯示在列表中,如果筆記標題多行,所有文字行皆會顯示。 如果您於程式畫面頂部點選 “顯示全部” 按鈕,howmm 顯示所有筆記的列表。 這個畫面中,您還可以使用進階的工具設定時間範圍並且排序。

搜尋筆記

如果您程式畫面上方點選 “放大鏡” 顯示輸入表單並且輸入文字, 將會讓筆記列表只顯示包含這個文字的筆記。 當您輸入多行文字,每一行都是使用 AND 搜尋 (常見於搜尋引擎)。 您依然可以使用進階的時間範圍及排序設定搜尋。

新增連結

前往連結 (Goto Link)

如果您在筆記輸入 “>>>” 緊接著文字,howmm 對待此稱之為 “前往連結”。 例如,筆記中包含 “>>> Abyssinian”,這個單字在閱讀模式中變成可以點選。 點選這個單字,您可以得到包含 “Abyssinian” 的所有筆記列表。 此外,註記 “>>> 檔案名稱” 可讓您打開檔案 (意圖)。 您可以連結到非文本的檔案,例如圖檔。

來自連結 (Come-from Link)

如果您輸入 “<<<” 緊接著文字,howmm 自動新增一個連結提供給其他筆記。 舉例來說,當您編寫筆記包含 “<<< Munchkin”,其他筆記的閱讀模式中,這個單字變成可以點選。 點選這個單字後,您會得到包含 “Munchkin” 所有筆記的列表,而這個來源筆記也會置頂。 因此,筆記內容包含特定單字的敘述 “<<< word”,工作原理類似維基百科。 這種連結稱之為 “來自連結”。

編寫提醒

任何筆記中,每一行包含下面幾種格式,會當作提醒處理並且於主畫面中顯示。 [日期及時間](標識符){引數} 敘述 範例: [2/23/2012]@ 會議 [3/15/2012 10:00]@3 國際論壇 [5/11/2012]-7 買書 “鄉下的貓” [4/5/2012 17:00]! 手稿期限 日期時間之後的 ‘@’, ‘!’, 以及 ‘-’ 為提醒類型的*標識符*。 標識符之後為引數。*提醒*必須至於此行的開頭。 一個筆記可以包含數個提醒,並且這行以外的內容不影響提醒的作用。 日期時間格式預設以您手機設定為主。也可以根據您的喜好設定 “日期時間格式”:’y’ 代表年,’M’ 代表月,以及 ‘d’ 代表日。 例如,如果您設定 “MM-dd-yyyy”,表達式像 [02-23-2012] 會被認定為時間。 (事實上,能被 Java SimpleDateFormat 認定的格式)。

預約 (Appointments)

提醒類型使用 ‘@’ 標識符當成一個預約。 在主畫面顯示為,預約時間接近時會漸漸向上移動。 超過這個時間,將不會再顯示。 引數定義預約到期時的持續時間。 上面第 2 個範例代表預約開始於五月十五。 持續 3 天並且持續顯示到五月十七號。預設引數為 1。

期限 (Deadlines)

提醒類型使用 ‘!’ 標識符當成一個期限。 跟預約不同的是,*期限*在到期天數之前不會於列表中顯示,並且到期後繼續顯示。 也就是說,*到期*不會自動消失。 *引數*定義何時將*期限*向上移動。例如,下面代表*期限*於七月二十日開始顯示。 六月二十九日前從列表底部顯示,之後漸漸向上移動,並且最後於七月二十日時顯示於頂部。 引數預設為 7 天。

[7/20/2012 17:00]!20 困難文本編寫

備忘錄 (Memorandums)

提醒類型使用 ‘-’ 標識符當成一個備忘錄。 開始時,於此日期時間顯示於列表頂部,接著隨著時間慢慢向下移動。 所以適合當成 “我打算做的事,但是並不強制需要”。 引數定義備忘錄顯示於列表頂部多久時間。 前面第 3 個範例代表五月十一日的備忘錄。 五月十號以前置於列表底部,五月十一日到五月十七時顯示於頂部, 並且之後漸漸向下移動,引數預設為 1。

代辦事項 (Pending items)

提醒類型使用 ‘~’ 標識符當成一個代辦事項,首先,於此日期顯示在列表最上層,然後向下移動, 類似備忘錄。 之後,再次向上移動,並且週期性地向下向上移動。 可以被用在應於時間內完成的項目沒完成。 請注意因為提醒都需要設定日期時間,就算對*代辦事項*本身不重要,都得隨便設個日期時間。 預設引數為 30 天。

移除提醒

提醒可以標示為完成或移除。 打算移除時,主畫面點選提醒列表,接著選擇 “OK”。 請注意這個操作只是*標識符*修改為 ‘.’ 的替代方式,操作完後提醒的敘述依然存在。 如果您想要完全刪除筆記內的提醒,直接編輯這個筆記。 您也可以在閱讀模式中進入編輯模式,也可以長點選主畫面的提醒列表。

桌面小工具 (AppWidgets)

Howmm 可以在 Android 桌面顯示小工具,howmm 主畫面顯示後會更新,就算沒有啟動 howmm 也會每日更新。 桌面小工具是可以縮放的。

特殊格式 (Special formats)

雜湊標籤 (Hashtags)

單字開頭使用雜湊字元 # 代表一個雜湊標籤,像是 Twitter。 當您在 howmm 搜尋雜湊標籤,結果會顯示筆記標題的列表,不是包含雜湊標籤的那行。 Howmm 會紀錄您使用的雜湊標籤,並且列表出使用過的雜湊標籤, 您可以很容易地在主畫面的 “#” 按鈕搜尋雜湊標籤,並且點選雜湊標籤進入編輯模式。

Markdown 格式

Howmm 認識一些 Markdown 語法,並且讓它顯示於閱讀畫面。

  • 星號或連字符代表無排序的列表
  • 照順序的數字代表有排序的列表
    • 巢狀列表可以用空白縮進
  • “>” 及空白為引用區塊
  • 文字用星號或下劃線包圍用於強調
  • 文字用大括號包圍的為原始碼 (等寬字體)
  • 文字區塊夾在 3 個反引號 (“`) 之間的為多行原始碼區塊

請注意目前 *Howmm 不支援 # 為開頭的標題語法*。 圖片也有支援,如果您編寫 “![cat](/sdcard/Pictures/neko.jpg)”, 圖片會被顯示於視窗。 在 Howmm 中,[xxx] 部份不會做任何事。 因為這需要對 markdown 語言的相容性。 如果您覺得輸入完整的圖片路徑很麻煩,您可以使用 “Image” 按鈕 (或選單項) 在您的手機插入圖片。

偏好設定

在主畫面中,可以打開選單項目點選偏好設定視窗。 偏好設定也可以在選項中被清除。如果偏好設定可能讓您的程式崩壞 Howmm 運作不正確。 這種情況,嘗試清除設定並請再次調整。 偏好設定 “Show reminders in the original howm-compatible order” 改變提醒顯示的方式。 主要是提醒時間太過遙遠而不會顯示。

關於資料檔案

請注意 howmm 資料存於簡單的純文字檔。 所以您可以用其他的應用程式編輯, 並且也可以編輯文字檔提供給 howmm 使用。 此外,雖然 howmm 沒有網路分享的功能,您依然可以使用其他的應用程式來同步檔案。 (譯注:例如使用 Syncthing 同步 /storage/emulated/0/Android/data/jp.deadend.noname.howmm/file 至桌上型電腦資料夾。) 另外,howmm 於編輯畫面加入的*來自連結 (come-from)* 及*雜湊標籤*可以被認識, 但是 howmm 外編輯加入的關鍵字就不能被認識。 這種情況,點選 “重新掃描*來自連結*文字”,在偏好設定底部。 類似的情況,外部編輯器新增或移除*提醒*也可能不會在主畫面中顯示。 點選 “重新載入 (Reload)” 按鈕來修正這些錯誤。

快速鍵 (Shortcuts)

您可以在 Android 桌面設定編輯快速鍵。 長按桌面螢幕,然後選擇 “Howmm”。 新增筆記捷徑,並且可以開始編輯筆記。 編輯筆記的捷徑應該是很有用的,例如說,不想要把小的提醒分散到各個檔案中, 或想要把點子考慮放在同一個檔案並且稍後編輯。 “fixed file” 可以在偏好設定中設定。 這個功能也可以在一些*快速啟動 (quick-launcher)*,如果它能處理捷徑。

限制 (Limitations)

許多 howmm 的功能,像是連結及提醒,事實上是使用搜尋技術。 因為如此,howmm 隨著檔案的增加會比較緩慢。 如果程式緩慢到無法忍受,請移除一些不重要的筆記。 對原本 howm 的使用者:howmm 並不完美,也欠缺 howm 一些功能。 例如:

  • 沒有 wiki-style 連結
  • 沒有 “+” 提醒類型
  • 沒有 action-lock
  • 沒有連續顯示模式
⚠️ **GitHub.com Fallback** ⚠️