用 Pelican 寫中文文章

換行變成了空格

我是龜毛人，原始碼的行數不超過 80 個字元是基本，最多也不能超過 100，所以很長的一個段落會用多行表示：

我是龜毛人，原始碼的行數不超過 80 個字元是基本，最多也不能超過 100，
所以很長的一個段落會用多行表示：

reStructuredText 和 Markdown 都會保留這個換行字元到轉換後的 HTML 中：

<p>我是龜毛人，原始碼的行數不超過 80 個字元是基本，最多也不能超過 100，
所以很長的一個段落會用多行表示：</p>

而瀏覽器在遇到這樣的換行字元時會將他轉換為空格，因為 Spec 就是這樣規定：

An HTML user agent should treat end of line in any of its variations as a word space in all contexts except preformatted text.

這件事在英文很合理，但到了中文就不合理了，因為我們不會用空格把文字隔開。於是乎，上面的例子瀏覽器會顯示為：

我是龜毛人，原始檔的行數不超過 80 個字元是基本，100 則是最大值， 所以很長的一個段落會用多行表示：

注意到「所以」前面多了一個空格。如果你習慣很好，只有在使用標點符號之後才會換行，那看起來影響不大。但如果換行是介於兩個中文字之間，那就會 像這樣在文字間出現詭異的空格。

Inline Markup 的空格

不像 Markdown，reStructuredText 要求必須用空格 （或其他類似功能的字元）將 Inline Markup 與其他的文字區隔開來：

This is **inline markup** bold.

這樣的空格會被保留到 HTML：

<p>This is <strong>inline markup</strong> bold.</p>

跟上面提到的一樣，這空格在英文沒差，中文就不行了。不過江湖在走，Workaround 要有，最簡單的方法是自己用 \ 來「跳脫」這個空格：

This is\ **inline markup**\ bold.

但每次都要手動加入這反斜線實在有點麻煩。如果這空格能自己消失，那該有多好。

Bonus：中英文間的空格

有研究顯示，打字的時候不喜歡在中文和英文之間加空格的人，感情路都走得很辛苦，有七成的比例會在 34 歲的時候跟自己不愛的人結婚，而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。 —— vinta/pangu.js

…這種空格我個人是覺得還可以接受啦，不過如果 Pelican 能自動幫我加上這些空格，那我就不用擔心未來會跟不愛的人結婚了。寫程式真是份偉大的工作。

Pelican Plugin 的運作方式

Pelican 定義了各種「信號」（Signal），代表了從原始碼到最後生出 HTML 的各個階段。你可以將自己寫的 Python 函式註冊到這些信號上，Pelican 就會在那些信號對應的階段發生時呼叫你的函式，並將當下的狀態或處理的物件傳進這個函式，讓你的函式能夠調整 Pelican 的行為。細節和信號列表請參考 Pelican Plugin Document 。

前面提到了 cjk-auto-spacing ，理所當然拿他來參考一下。它處理的方式是使用信號 content_object_init 來取得 content_object 物件，而這個物件的 _content 屬性存放了從 reStructuredText 及 Markdown 原始碼轉換而來的 HTML ，以 str 儲存。我們可以根據需求來調整這個 HTML，調整完後再 assign 回 _content ，Pelican 就會用這份新的 HTML 繼續之後的工作。

舉例來說，如果我們想把 HTML 裡的所有 <p> Tag 換成 <foo> ，可以很快的用 Regular Expression 來達成：

import re

from pelican import signals


def process(content):
    new_content = re.sub(r'<(/)?p>', r'<\1foo>', content._content)
    content._content = new_content


def register():
    signals.content_object_init.connect(process)

Pelican 規定每個 Plugin 都必須要有 register 函式，目的在指定你需要哪些信號以及他們要觸發的函式。