Revised the reStructuredText to be more readable.

2021-02-04 15:26:28 +08:00
parent 394c82d69e
commit 185fb11730
5 changed files with 55 additions and 34 deletions
--- a/README.rst
+++ b/README.rst
@@ -1,15 +1,29 @@
 Learning LimeSurvey
 ===================

-*«Learning LimeSurvey»* is a Chinese `LimeSurvey <https://www.limesurvey.org/>`_ tutorial.  It features `project-based learning (PBL) <https://en.wikipedia.org/wiki/Project-based_learning>`_:  By creating a simple yet practical survey, it walks through the frequently-used features of LimeSurvey.  It is written in `reStructuredText <https://docutils.sourceforge.io/rst.html>`_ with `Sphinx <https://www.sphinx-doc.org/>`_ extension.
+*«Learning LimeSurvey»* is a Chinese LimeSurvey_ tutorial.  It
+features `project-based learning`_:  By creating a simple yet
+practical survey, it walks through the frequently-used features of
+LimeSurvey.  It is written in reStructuredText_ with Sphinx_
+extension.

-*«Learning LimeSurvey»* is written by `imacat <imacat@mail.imacat.idv.tw>`_.  Read the `tutorial (Chinese) <https://limesurvey.imacat.idv.tw/learning/>`_ online, or check the `GitHub source project <https://github.com/imacat/learning-limesurvey>`_.
+*«Learning LimeSurvey»* is written by imacat_.  Read the tutorial_
+(Chinese) online, or check the `GitHub source documents`_.
+
+.. _LimeSurvey: https://www.limesurvey.org
+.. _project-based learning: https://en.wikipedia.org/wiki/Project-based_learning
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
+.. _Sphinx: https://www.sphinx-doc.org
+.. _imacat: imacat@mail.imacat.idv.tw
+.. _tutorial: https://limesurvey.imacat.idv.tw/learning/
+.. _GitHub source documents: https://github.com/imacat/learning-limesurvey


 HTML, PDF, and Other Formats
 ----------------------------

-This tutorial can be converted into various formats.  To do so, you need to install Sphinx first.  On Debian/Ubuntu::
+This tutorial can be converted into various formats.  To do so, you
+need to install Sphinx first.  On Debian/Ubuntu::

  # sudo apt install python-sphinx

@@ -25,7 +39,8 @@ After installation, run::

  # make help

-to see the available conversion commands.  For example, to generate HTML, PDF, ePUB, manpage, and Texinfo documents respectively::
+to see the available conversion commands.  For example, to generate
+HTML, PDF, ePUB, manpage, and Texinfo documents respectively::

  # make html
  # make latexpdf
@@ -33,6 +48,10 @@ to see the available conversion commands.  For example, to generate HTML, PDF, e
  # make man
  # make texinfo

-Copyright |copy| 2017-2020 imacat, 2017-2018 National Taiwan Normal University, 2020 Steps Inc.  This work is licensed under a `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0/>`_.
+Copyright |copy| 2017-2021 imacat, 2017-2018 National Taiwan Normal
+University, 2020-2021 Steps Inc.  This work is licensed under a
+`Creative Commons Attribution 4.0 International License`_.
+
+.. _Creative Commons Attribution 4.0 International License: http://creativecommons.org/licenses/by/4.0/

 .. |copy| unicode:: 0xA9 .. copyright sign
--- a/source/01-intro.rst
+++ b/source/01-intro.rst
@@ -5,10 +5,12 @@ LimeSurvey簡介
 LimeSurvey簡介
 --------------

-`LimeSurvey <https://www.limesurvey.org/>`_ 是開源自由軟體的問卷調查
+LimeSurvey_ 是開源自由軟體的問卷調查
 系統。自2003年初版至今，歷經17年82個語言的全球使用者開發使用，安全穩定，
 是最受歡迎的開源問卷調查系統。

+.. _LimeSurvey: https://www.limesurvey.org
+

 與其他問卷調查平台比較
 ----------------------
--- a/source/04-03-01-participants.rst
+++ b/source/04-03-01-participants.rst
@@ -63,10 +63,12 @@ CSV檔欄位如下：

    選「建立」「CSV檔案」從CSV檔匯入參與者名單

-可以參閱 `參與者CSV檔的範例 <https://limesurvey.imacat.idv.tw/learning/participants-example.csv>`_ 。
+可以參閱 `參與者CSV檔的範例`_ 。

 .. figure:: images/04-03-01-participants-08.png
    :alt: 參與者CSV檔範例
    :scale: 48%

    參與者CSV檔範例
+
+.. _參與者CSV檔的範例: https://limesurvey.imacat.idv.tw/learning/participants-example.csv
--- a/source/conf.py
+++ b/source/conf.py
@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------

 project = 'LimeSurvey學習手冊'
-copyright = '2017-2020, 依瑪貓, 2017-2018, 國立臺灣師範大學, 2020, 智新資通'
+copyright = '2017-2021, 依瑪貓, 2017-2018, 國立臺灣師範大學, 2020-2021, 智新資通'
 author = '依瑪貓, 智新資通'

 # The full version, including alpha/beta/rc tags
--- a/source/index.rst
+++ b/source/index.rst
@@ -6,46 +6,44 @@
 LimeSurvey學習手冊
 ====================================

-版權所有 |copy| 2017-2020 依瑪貓， 2017-2018 國立臺灣師範大學， 2020 智新資通。
+版權所有 |copy| 2017-2021 依瑪貓， 2017-2018 國立臺灣師範大學， 2020-2021
+智新資通。

-「LimeSurvey學習手冊」由
-`依瑪貓 <imacat@mail.imacat.idv.tw>`_ 撰寫，採用
-`創用 CC 姓名標示 4.0 授權條款 <https://creativecommons.org/licenses/by/4.0/>`_
+「LimeSurvey學習手冊」由 `依瑪貓`_ 撰寫，採用 `創用 CC 姓名標示 4.0 授權條款`_
 授權。

 本學習手冊以一個常用的問卷調查範例，帶領學習者一步步操作，熟悉使用
 LimeSurvey的常用功能。全部研讀完畢約需兩小時。您也可以直
 接跳到您有興趣的章節，不需要依序閱讀。

-本學習手冊有
-`線上版學習手冊 <https://limesurvey.imacat.idv.tw/learning/>`_
-，也提供雙面印刷的
-`PDF版學習手冊 <https://limesurvey.imacat.idv.tw/learning/learning-limesurvey.pdf>`_
-，及適合手機平板閱讀的
-`EPUB學習手冊電子書 <https://limesurvey.imacat.idv.tw/learning/learning-limesurvey.epub>`_
-可供下載，並有
-`參與者名單CSV檔範例 <https://limesurvey.imacat.idv.tw/learning/participants-example.csv>`_
-可下載參考。本學習手冊以
-`Sphinx/reStructuredText <https://www.sphinx-doc.org/>`_
-撰寫，歡迎參閱
-`GitHub上的開源專案 <https://github.com/imacat/learning-limesurvey>`_ ，或下載
-`原始檔 <https://limesurvey.imacat.idv.tw/learning/learning-limesurvey-4.1.zip>`_
-。另外有
-`本學習手冊上的範例問卷 <https://limesurvey.imacat.idv.tw/index.php/161873>`_
+本學習手冊有 `線上版學習手冊`_ ，也提供雙面印刷的 `PDF版學習手冊`_ ，及適合手
+機平板閱讀的 `EPUB學習手冊電子書`_ 可供下載，並有 `參與者名單CSV檔範例`_ 可下
+載參考。本學習手冊以 `Sphinx/reStructuredText`_ 撰寫，歡迎參閱
+`GitHub上的開源專案`_ ，或下載 `原始檔`_ 。另外有 `本學習手冊上的範例問卷`_
 ，歡迎參閱。

-更多LimeSurvey的進階功能，請參閱
-`LimeSurvey官方線上說明 <https://manual.limesurvey.org/>`_ 。
+更多LimeSurvey的進階功能，請參閱 `LimeSurvey官方線上說明`_ 。

-註：舊版LimeSurvey 3，請參閱
-`舊版LimeSurvey 3學習手冊 <https://limesurvey.imacat.idv.tw/learning/v3/>`_ ；
-舊版LimeSurvey 2，請參閱
-`舊版LimeSurvey 2學習手冊 <https://limesurvey.imacat.idv.tw/learning/v2/>`_ 。
+註：舊版LimeSurvey 3，請參閱 `舊版LimeSurvey 3學習手冊`_ ； 舊版LimeSurvey
+2，請參閱 `舊版LimeSurvey 2學習手冊`_ 。
+
+.. _依瑪貓: imacat@mail.imacat.idv.tw
+.. _創用 CC 姓名標示 4.0 授權條款: https://creativecommons.org/licenses/by/4.0/
+.. _線上版學習手冊: https://limesurvey.imacat.idv.tw/learning/
+.. _PDF版學習手冊: https://limesurvey.imacat.idv.tw/learning/learning-limesurvey.pdf
+.. _EPUB學習手冊電子書: https://limesurvey.imacat.idv.tw/learning/learning-limesurvey.epub
+.. _參與者名單CSV檔範例: https://limesurvey.imacat.idv.tw/learning/participants-example.csv
+.. _Sphinx/reStructuredText: https://www.sphinx-doc.org
+.. _GitHub上的開源專案: https://github.com/imacat/learning-limesurvey
+.. _原始檔: https://limesurvey.imacat.idv.tw/learning/learning-limesurvey-4.1.zip
+.. _本學習手冊上的範例問卷: https://limesurvey.imacat.idv.tw/161873
+.. _LimeSurvey官方線上說明: https://manual.limesurvey.org
+.. _舊版LimeSurvey 3學習手冊: https://limesurvey.imacat.idv.tw/learning/v3/
+.. _舊版LimeSurvey 2學習手冊: https://limesurvey.imacat.idv.tw/learning/v2/

 .. toctree::
    :caption: 目錄
    :maxdepth: 3
-
    01-intro
    02-enter
    03-create