回到首頁過去文章最新消息FAQ相關討論 | 關於我們

Emacs Wiki 簡易使用指南


黃俊傑

前言

Emacs Wiki 是一個可以簡單快速建立筆記或是資料的工具,而且做出來的 wiki 文件可以轉換成數種不同的文件格式,比如說:html, texinfo, latex 等等, 是一個方便的小工具。在這篇文章中,我將會簡介 Emacs Wiki 的安裝與使用, 讓各位有一個簡單的概念,可以開始快樂的使用 Emacs Wiki!

安裝

也許你之前使用 Emacs 從來都沒有安裝過任何軟體,但是因為 Emacs Wiki 並 不是 GNU Emacs 內建的軟體,所以你必須要自行安裝 Emacs Wiki, 所以,我們 就開始來安裝吧。

首先你需要下載這個檔案: http://www.mwolson.org/static/dist/emacs-wiki-latest.tar.gz 存在一個目錄下,比如說: ~/elisp, 然後打開終端機, 執行以下的命令:

cd ~/elisp
tar zxvf emacs-wiki-latest.tar.gz

這會解開成 emacs-wiki 子目錄, 同時你要編輯 .emacs 檔案(通常放置在你的 家目錄下, 所以是 ~/.emacs):

(add-to-list 'load-path "~/elisp/emacs-wiki")
(load "emacs-wiki")

存檔起來,重開 Emacs, 你就把 Emacs Wiki 安裝完成了。

設定

在實際使用之前,你還必須要作一些小設定才能夠符合你的意思, 這時候需要使用到 customization 這一個套件,請在 Emacs 鍵入:

M-x customize-group emacs-wiki

畫面上會列出一堆設定,但是初期你只需要設定以下幾個項目:

Emacs Wiki Directories
這是你要放置 Wiki 檔案的位置,只要檔案在這個 目錄之下,一律都會用 Emacs Wiki Mode 來開啟,放在其他地方的檔案需要你 手動進入 Emacs Wiki Mode.
Emacs Wiki Default Page
這是指你的 Wiki 首頁檔名, 所有其他的檔案都從 這裡開始。
Emacs Wiki Publish->Emacs Wiki Publishing Directory
這個目錄會放置你 轉換成 html 之後或是其他格式會放置的地方。
Emacs Wiki Publish->Emacs Wiki Coding Map
加入 Coding system: chinese-big5, String: big5; 這樣才會將中文 Big5 的文章也轉成 content-type: big5 的 html 網頁,如此網頁瀏覽器才能開啟就看到中文。

透過 Customization 設定的方法是這樣的,我舉 Emacs Wiki Directories 為例說明, 已經會的人請直接跳到下一節「使用」。 看到 Emacs Wiki Directories 右邊的按鈕(標註 "Show"),就按下去,這時候會有其他內容在下一行之後跑出來, 而此按鈕變成 "Hide", 然後你應該會看到有一個按鈕是 "INS", 按下去會變成 "INS" "DEL" Directory: 請在 Directory: 之後的反白區域輸入你的目錄名稱,比如說 "~/Wiki" 如果你要放很多個目錄,請繼續插入新的目錄,如果你已經輸入完成, 那麼你要把這個設定存起來,儲存的方式就是按 "State" 這個按鈕, 按下去之後會出現一連串的目錄選項,其中有兩項是 "Set for Current Session" 以及 "Save for Future Sessions", 我通常兩個都選一次,因為前者是設定目前的值, 後者是把設定儲存起來,以後開啟 Emacs 就會使用你剛剛設定的值。

使用

好,終於可以開始編輯 Emacs Wiki 檔案了,982;果你編輯的檔案不是放置在剛剛 設定的 Emacs Wiki Directories 之一的話,請手動進入 Emacs Wiki Mode, 方 法就是 M-x emacs-wiki-mode, 如果你編輯的檔案是在那些目錄之一,Emacs Wiki Mode 會自動開啟,所以我們現在開啟一個檔案,比如說:

C-x C-f ~/Wiki/WelcomePage

如果順利的話,你應該會在模式列(mode line, 亦即視窗最下方倒數第二行反白 之處)右邊看到(Wiki) 或是 (Wiki[default]) 的字樣,這就表示你成功進入 Emacs Wiki Mode.

使用的方法我簡介一下, 介紹的方法是以水平分隔線分隔不同的功能分類, 在每一個功能分類中先有一個內縮的區塊顯示使用者需要輸入的 wiki 碼, 然後是一個向左對齊的區塊展示 wiki 碼轉換成 html 格式之後的效果。


文章標題

 * 標題 1 ** 標題 2 *** 標題 3 

標題 1

標題 2

標題 3


 水平分隔線 ---- 

水平分隔腺


上面這一條是水平分隔線的效果


文字語氣變化

 *加強語氣* *Emphasize*

**特別加強語氣** **Strong emphasize**

***超級加強語氣*** ***Very strong emphasize***

_加底線_

=單純文字,不作任何 wiki 的解釋=

<verbatim>單純文字,不作任何 wiki 的解釋</verbatim>

加強語氣 Emphasize

特別加強語氣 Strong emphasize

超級加強語氣 Very strong emphasize

加底線

單純文字,不作任何 wiki 的解釋

單純文字,不作任何 wiki 的解釋


項目列表

 - 無編號列表 - 無編號列表 - 無編號列表 - 無編號列表

1. 編號列表 1. 編號列表 1. 編號列表 1. 編號列表

項目 :: 項目說明

項目 :: 項目說明

  • 無編號列表
  • 無編號列表
  • 無編號列表
  • 無編號列表

  1. 編號列表
  2. 編號列表
  3. 編號列表
  4. 編號列表

項目
項目說明
項目
項目說明


引言

引言可以用 <verse></verse> 包起來。

這是別人的引言


段落

段落的分隔是依靠插入一行空白行來達成。


註腳

我 們在 Emacs Wiki Mode[1] 使用註腳的時候, 需要自己編號, 但也可以利用 footnote-mode[2] 來達成, 使用 footnote-mode 的方法往後再跟讀者說明。 在註腳中,編號與說明說字只要有空白隔開即可, 以空白行來分隔不同的註腳。 內文與註腳中間會有一條水平分隔線分隔。 內文段落與註腳可以不用空白行分隔。 Footnotes: [1] Emacs Wiki Mode, http://repose.cx/emacs/wiki

[2] footnote-mode, 一個 Emacs 內建的註腳管理次要模式

我們在 Emacs Wiki Mode1 使用註腳的時候, 需要自己編號, 但也可以利用 footnote-mode2 來達成, 使用 footnote-mode 的方法往後再跟讀者說明。 在註腳中,編號與說明說字只要有空白隔開即可, 以空白行來分隔不同的註腳。 內文與註腳中間會有一條水平分隔線分隔。 內文段落與註腳可以不用空白行分隔。


[1] Emacs Wiki Mode, http://repose.cx/emacs/wiki

[2] footnote-mode, 一個 Emacs 內建的註腳管理次要模式


表格

 兩個直條字元 || 表示這是分隔標題列 一個直條字元 | 表示這是內文 這還是內文 | 這是內文 三個直條字元 ||| 表示這是 footer 列 

兩個直條字元表示這是分隔標題列
一個直條字元表示這是內文
這還是內文這是內文
三個直條字元表示這是 footer 列


Wiki 名稱

每一個 Wiki 檔案名稱都是兩個以上的英文字, 並且每一個英文字的首字大寫, 在 Wiki 的文章中只要是這樣的格式(稱為 CamelCase), 就是一個連結到另一個檔案的 Wiki 名稱。 如果你有這樣的英文字(例如 OpenStep), 但是卻不是 Wiki 名稱, 你可以在該字的前面加上 <nop>, 或是前後加上 "=" "=", 讓他沒有 Wiki 的特殊意義。

轉換至 HTML

如果你要轉換到 html, 可以直接利用 Emacs Wiki 的 publish 功能,只要下 C-c C-p, 然後你將會在剛剛設定的 ~/WebWiki 目錄裡面看到你的檔案, 名稱都是 Wiki名稱.html

結語

Emacs Wiki 模式讓我們能夠快速的撰寫簡潔美觀的網頁,同時也可以直接在 Emacs 裡面觀看與瀏覽原本的 Emacs Wiki 文字,使得 Emacs Wiki 也成為 Emacs outline-mode 之外製作大綱的另一個選擇。