-
-
Notifications
You must be signed in to change notification settings - Fork 216
rST 特殊語法注意事項
RockLeon edited this page Dec 30, 2023
·
4 revisions
在翻譯字串中的 rst 特殊語法 (e.g. :mod:`os`
) 旁有時會需要空格才能正常建置,但當不想在網頁 (html) 上顯示空格時就會需要用到雙斜線 \\
。
以 參閱 :mod:`os` 模組
為例:
PO 譯文寫法 | html 頁面上的長相 | 備註 |
---|---|---|
參閱 :mod:`os` 模組 |
參閱 os 模組 | 這是正常寫法,os 部分變成超連結 |
參閱:mod:`os` 模組 |
build failed | sphinx 認不出特殊語法 |
參閱:mod:`os`模組 |
build failed | sphinx 認不出特殊語法 |
參閱 :mod:`os`模組 |
build failed | sphinx 認不出特殊語法 |
參閱\\ :mod:`os` 模組 |
參閱os 模組 | build 成功(因為前有 \\ ),但顯示上中英文間應要有空格 |
有時候特殊語法是可能 render 出中文字的
PO 譯文寫法 | html 頁面上的長相 | 備註 |
---|---|---|
一個 :term:`file object`。 |
一個 file object。 |
file object 部分變成超連結 |
一個\\ :term:`檔案物件 <file object>`。 |
一個檔案物件。 |
檔案物件 部分變成超連結,且不希望中文字間有空白 |
參考 `wiki 文章 <https://wiki.com/...>`_\\ 中 |
參考 wiki 文章中 | 特殊語法後不希望有空白 ,故加上 \\
|