Compare commits

...

21 Commits

Author SHA1 Message Date
依瑪貓
f60fb8076a Advanced to version 4.2. 2021-02-04 15:28:52 +08:00
依瑪貓
185fb11730 Revised the reStructuredText to be more readable. 2021-02-04 15:26:28 +08:00
依瑪貓
394c82d69e Added .gitattributes. 2021-02-01 16:33:39 +08:00
依瑪貓
52cd391da9 Revised the text in README. 2020-11-19 10:12:57 +08:00
依瑪貓
c904e6ff69 Revised the URL in README. 2020-11-19 09:58:15 +08:00
af7bec28bf Rewrote README in English. 2020-11-18 22:36:59 +08:00
依瑪貓
2a590279c5 Added the GitHub and Sphinx link to README and index.rst. 2020-11-18 10:21:51 +08:00
依瑪貓
bdd53e80e1 Added README. 2020-11-18 10:02:35 +08:00
依瑪貓
2c793ede34 Added the LICENSE file. 2020-11-18 09:49:43 +08:00
依瑪貓
c108d81d71 Moved the source files to an independent source directory. 2020-11-18 09:24:08 +08:00
f530323603 Changed tabs to spaces in index.rst. 2020-11-18 07:36:04 +08:00
92979cd2ec Fixed the distribution file version in index.rst. 2020-11-18 07:35:20 +08:00
28aef0277b Removed the odp directory from .gitignore. 2020-11-18 00:59:14 +08:00
7635161352 Advanced to version 4.1. 2020-11-18 00:54:28 +08:00
a1d3d578ea Revised the URL and the copyright. 2020-11-18 00:54:15 +08:00
915fdb9573 Updated the configuration and make files from Sphinx 1.4.9 to Sphinx 3.3.1. 2020-11-17 23:54:42 +08:00
6d5496e4ec Added the local deployment script to .gitignore. 2020-11-17 23:22:28 +08:00
依瑪貓
09a9568a1d Replaced the HTTP url to HTTPS in the documentation. 2020-11-16 16:51:59 +08:00
依瑪貓
73493ddb9d Fixed the contact information. 2020-11-16 14:35:37 +08:00
依瑪貓
834a4e77f9 Added .gitignore. 2020-11-16 14:35:28 +08:00
依瑪貓
498b37e65e Updated to LimeSurvey 4. 2020-06-03 15:32:19 +08:00
394 changed files with 1645 additions and 1998 deletions

1
.gitattributes vendored Normal file
View File

@ -0,0 +1 @@
*.rst linguist-detectable

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
build
.idea
make_all_sync

View File

@ -1,28 +0,0 @@
進入系統
========
由校務行政入口網登入後,即可由中間「應用系統」區,找到「問卷調查平台」
進入。
.. figure:: images/02-iportal.png
:alt: 校務行政入口網
:scale: 60%
校務行政資訊入口網
進入後,從左邊「建立一個新問卷」點進去,就可以建立新問卷了。
.. figure:: images/02-start-02.png
:alt: LimeSurvey 登入後畫面
:scale: 60%
LimeSurvey 登入後畫面
如果之前沒有建立任何問卷,系統會提醒您建立新問卷。
.. figure:: images/02-start-01.png
:alt: 第一次登入 LimeSurvey 提醒建立新問卷
:scale: 60%
第一次登入 LimeSurvey 提醒建立新問卷

View File

@ -1,29 +0,0 @@
修改範例題組名稱
################
在問卷編輯頁面上點選左側欄上方的「Structure」在左側欄顯示問卷架構
。點選左側欄的預設範例題組「My First Question Group」進入題組頁面。
.. figure:: images/03-02-01-edit-group-01.png
:alt: 從左側欄的問卷架構,選擇要編輯的題組
:scale: 60%
從左側欄的問卷架構,選擇要編輯的題組
在題組頁面中,按上方的「 :index:`編輯目前題組 <pair: 題組; 編輯>`
編輯。
.. figure:: images/03-02-01-edit-group-02.png
:alt: 題組頁面,按「編輯目前題組」編輯
:scale: 60%
題組頁面,按「編輯目前題組」編輯
在標題處填上「壹、基本資料」,然後按右上角的「儲存並關閉」。你也可以在
描述的欄位裡,撰寫一些說明。
.. figure:: images/03-02-01-edit-group-03.png
:alt: 題組編輯畫面
:scale: 60%
題組編輯畫面

View File

@ -1,27 +0,0 @@
第二個問題:日期
################
接著要問填答者的出生年月日。
在新增問卷問題的編輯頁面上編號填上「q02」問題填上
「2.請選擇您的出生年月日。」題型選擇「其他類型問題」裏的
:index:`日期時間 <題型; 日期>` 」,開啟「必須回應」,
然後按「儲存」。
.. figure:: images/03-02-04-date-01.png
:alt: 問題二:日期問題
:scale: 60%
問題二:日期問題
.. figure:: images/03-02-04-date-02.png
:alt: 選擇日期題型
:scale: 60%
選擇日期題型
.. figure:: images/03-02-04-date-03.png
:alt: 日期問題預覽
:scale: 60%
日期問題預覽

View File

@ -1,103 +0,0 @@
第三個問題:單選
################
第三個問題我們要問填答者的年級。
:index:`單選 <題型; 單選>` 是最常見的題型之一,用在
:index:`類別變數 <變數; 類別>` ,可以使用「列表(下拉式)」或
「列表(單選)」。
一般學生從大一到大四。不過延畢有可能大五或大六,醫學系會到大七、大八、
大九。我們提供大一到大四,四個選項,並且多一個「其他」選項讓使用者自己
填寫。
在新增問卷問題的編輯頁面上編號填上「q03」問題填上
「3.請選擇您的年級。」題型選擇「單選問題」裏的「列表(單選)」,開啟
「選項『其他』」和「必須回應」。
.. figure:: images/03-02-05-single-01.png
:alt: 問題三:單選問題
:scale: 60%
問題三:單選問題
.. figure:: images/03-02-05-single-02.png
:alt: 選擇單選題型
:scale: 60%
選擇單選題型
往下拉找到「邏輯」展開,點按開啟「『其他:』必填的評論」。答題選擇其他
時,必須填上幾年級。
.. figure:: images/03-02-05-single-03.png
:alt: 展開「邏輯」設定
:scale: 60%
展開「邏輯」設定
.. figure:: images/03-02-05-single-04.png
:alt: 開啟單選題「『其他:』必填的評論」
:scale: 60%
開啟單選題「『其他:』必填的評論」
按右上角「儲存」。
建好問題後,會提醒你還沒輸入選項:
「You need to add answer options to this question」。可以直接點選
「You need to add answer options to this question」進入也可由上方
「編輯答案選項」進入,輸入選項。
.. figure:: images/03-02-05-single-05.png
:alt: 建好單選題後,輸入選項
:scale: 60%
建好單選題後,輸入選項
可以一筆一筆輸入。每輸完一筆選項,按右邊的加號,新增一個選項。
.. figure:: images/03-02-05-single-06.png
:alt: 一筆一筆輸入選項
:scale: 60%
一筆一筆輸入選項
或是由下方「快速增加」一次輸入所有選項。
.. figure:: images/03-02-05-single-07.png
:alt: 按「快速增加」一次輸入所有選項
:scale: 60%
按「快速增加」一次輸入所有選項
快速增加選項時,請一行填寫一個選項。可以由剪貼簿複製貼上。我們輸入一年
級到四年級,共四行::
一年級
二年級
三年級
四年級
全部選項填寫完後,按下方的「替換」使用我們填寫的選項。(如果按「增加」
,會加在現有選項後面。)
.. figure:: images/03-02-05-single-08.png
:alt: 一次輸入所有選項
:scale: 60%
一次輸入所有選項
完成後按「儲存並關閉」。
.. figure:: images/03-02-05-single-09.png
:alt: 填寫完選項後儲存關閉
:scale: 60%
填寫完選項後儲存關閉
.. figure:: images/03-02-05-single-11.png
:alt: 單選問題預覽
:scale: 60%
單選問題預覽

View File

@ -1,52 +0,0 @@
第四個問題:數值
################
接下來我們要問填答者每天回家後唸書多久,瞭解學生下課後,還付出多少時間
唸書。
:index:`數值 <題型; 數值>` 是另一種常見的題型,用在
:index:`連續變數 <變數; 連續>` 上。
唸書時間最少0小時沒唸書最多扣掉上課和睡覺時間只會有十幾個小時
。為方便起見我們當作最多24小時。
我們也可以用024共25個選項的單選欄位。不過有人會有3.5、2.25小時等等非
整數,所以我們還是使用數值欄位。
在新增問卷問題的編輯頁面上編號填上「q04」問題填上
「4.請問您每天放學後唸書幾個小時?」題型選擇「其他類型問題」裏的
「數值輸入」,題組選「貳、課後評量」,開啟「必須回應」。
.. figure:: images/03-03-01-number-01.png
:alt: 問題四:數值題目
:scale: 60%
問題四:數值題目
.. figure:: images/03-03-01-number-02.png
:alt: 選擇數值題型
:scale: 60%
選擇數值題型
往下拉找到「輸入」展開。每天最多24小時最少0小時為免填錯可以限制
輸入值的範圍。請在最小值填上0最大值填上24。因為可能會有3.5小時,不開
啟「只能整數」。最後回到右上角按「儲存」。
.. figure:: images/03-03-01-number-03.png
:alt: 展開「輸入」設定
:scale: 60%
展開「輸入」設定
.. figure:: images/03-03-01-number-04.png
:alt: 限制數值填答範圍
:scale: 60%
限制數值填答範圍
.. figure:: images/03-03-01-number-05.png
:alt: 數值題目預覽
:scale: 60%
數值題目預覽

View File

@ -1,83 +0,0 @@
第五個問題:多重數值
####################
接下來我們想瞭解學生周間每天上網時間。
:index:`多重數值 <題型; 多重數值>`」欄位和「數值」欄位很像,不過可
以輸入一系列的數字,適合用在一系列同性質的數字上,例如周間每天上網時數
、每天唸書時數、每天支出…等等。
每天的上網時間最少0小時最多24小時同樣可以容許小數點。
在新增問卷問題的編輯頁面上編號填上「q05」問題填上
「5.過去七天每天上網幾小時?」題型選擇「其他類型問題」裏的
「多重數值輸入」,題組選「貳、課後評量」,開啟「必須回應」。
.. figure:: images/03-03-02-multi-numbers-01.png
:alt: 問題五:多重數值題目
:scale: 60%
問題五:多重數值題目
.. figure:: images/03-03-02-multi-numbers-02.png
:alt: 選擇多重數值題型
:scale: 60%
選擇多重數值題型
往下拉找到「輸入」展開。請在最小值填上0最大值填上24。因為可能會有
3.5小時,不開啟「只能整數」。最後按「儲存」。
.. figure:: images/03-03-02-multi-numbers-03.png
:alt: 展開「輸入」設定
:scale: 60%
展開「輸入」設定
.. figure:: images/03-03-02-multi-numbers-04.png
:alt: 限制數值填答範圍
:scale: 60%
限制數值填答範圍
建好問題後,會提醒你還沒輸入子問題:
「You need to add subquestions to this question」。可以直接點選
「You need to add subquestions to this question」進入也可由上方
「編輯子問題」進入,輸入子問題。
.. figure:: images/03-03-02-multi-numbers-05.png
:alt: 建好多重數值題型後,輸入子問題
:scale: 60%
建好多重數值題型後,輸入子問題
子問題畫面和單選選項畫面一樣。我們點「快速增加」進入。輸入星期一到星期
日,共七行::
星期一
星期二
星期三
星期四
星期五
星期六
星期日
然後按「替換」。按右上方「儲存並關閉」。
.. figure:: images/03-03-02-multi-numbers-06.png
:alt: 按「快速增加」一次輸入所有子問題
:scale: 60%
按「快速增加」一次輸入所有子問題
.. figure:: images/03-03-02-multi-numbers-07.png
:alt: 輸入所有子問題
:scale: 60%
輸入所有子問題
.. figure:: images/03-03-02-multi-numbers-08.png
:alt: 多重數值題目預覽
:scale: 60%
多重數值題目預覽

View File

@ -1,61 +0,0 @@
第七個問題:排序
################
我們想知道學生對課程專題的喜好順序。
:index:`排序欄位 <題型; 排序>` 有很多種用途,可以用來詢問態度喜好的順
序,也可用在社會網路分析中,詢問人際親疏的順序。
在新增問卷問題的編輯頁面上編號填上「q07」問題填上
「7.請依序選擇您喜歡的單元。」題型選擇「其他類型問題」裏的「排序」,
題組選「貳、課後評量」,開啟「必須回應」,然後按「儲存」。
.. figure:: images/03-03-04-order-01.png
:alt: 問題七:排序題目
:scale: 60%
問題七:排序題目
.. figure:: images/03-03-04-order-02.png
:alt: 選擇排序題型
:scale: 60%
選擇排序題型
建立問題後,按「編輯答案選項」輸入各課程單元。
.. figure:: images/03-03-04-order-03.png
:alt: 建好排序題型後,輸入排序項目
:scale: 60%
建好排序題型後,輸入排序項目
加上下列課程單元::
小豆芽觀察日記
閃爍的星星
我家附近的神明
爺爺奶奶的故事
神奇機器人
.. figure:: images/03-03-04-order-04.png
:alt: 輸入所有排序項目
:scale: 60%
輸入所有排序項目
.. figure:: images/03-03-04-order-05.png
:alt: 排序題目預覽
:scale: 60%
排序題目預覽
左邊是現有的課程單元,右邊是排序的結果。依偏好順序,用滑鼠在左邊的課程
單元點兩下,或用滑鼠拖拉到右邊,就可以加到右邊的排序結果中。也可以用滑
鼠拖拉,調整各個課程單元的順序。
.. figure:: images/03-03-04-order-06.png
:alt: 用滑鼠拖拉調整順序
:scale: 60%
用滑鼠拖拉調整順序

View File

@ -1,62 +0,0 @@
第九個問題:本校生的學號
########################
如果是台師大的學生,請同學填上學號。
在新增問卷問題的編輯頁面上編號填上「q09」問題填上
「9.請填上您的學號。」題型選擇「開放性問題」裏的
:index:`自由短文 <題型; 單行文字>` 」,題組選「參、其他」,開啟
「必須回應」,然後按「儲存」。
.. figure:: images/03-04-02-id-01.png
:alt: 問題九:本校生的學號
:scale: 60%
問題九:本校生的學號
.. figure:: images/03-04-02-id-02.png
:alt: 選擇自由短文題型
:scale: 60%
選擇自由短文題型
按上方「Set conditions」設定問題的條件。
.. figure:: images/03-04-02-id-03.png
:alt: 按上方「Set conditions」設定問題條件。
:scale: 60%
按上方「Set conditions」設定問題條件。
接著往下拉到頁面下方「增加條件」的地方,問題選剛剛的第八題
「q08: 8.您是不是台師大學生」答案選「Y(是)」,然後按下「增加條件」。
.. figure:: images/03-04-02-id-04.png
:alt: 加上問題的條件
:scale: 60%
加上問題的條件
回到頁面上方,剛剛設的條件已經加上去了:
q08: 8.您是不是台師大學生 等於 是(Y)
我們按上方的「關閉」。
.. figure:: images/03-04-02-id-05.png
:alt: 設好的問題條件
:scale: 60%
設好的問題條件
回到問題的頁面可以看到問題的「Relevance equation:」已經設為:
((q08.NAOK == "Y"))
問題的條件設定好了。
.. figure:: images/03-04-02-id-06.png
:alt: 問題的條件
:scale: 60%
問題的條件

View File

@ -1,70 +0,0 @@
第十、十一個問題:外校生的校系
##############################
如果是外校生,請同學填上學校和科系。
在新增問卷問題的編輯頁面上編號填上「q10」問題填上
「10.請填上您就讀的學校。」題型選擇「開放性問題」裏的
:index:`自由短文 <題型; 單行文字>` 」,題組選「參、其他」,開啟
「必須回應」,然後按「儲存」。
.. figure:: images/03-04-03-school-01.png
:alt: 問題十:外校生的就讀學校
:scale: 60%
問題十:外校生的就讀學校
接著按上方「Set conditions」設定問題的條件。在設定問題條件的頁面上
下拉到頁面下方「增加條件」的地方,問題選剛剛的第八題
「q08: 8.您是不是台師大學生」答案選「N(否)」,然後按下「增加條件」。
.. figure:: images/03-04-03-school-02.png
:alt: 加上外校生就讀學校問題的條件
:scale: 60%
加上外校生就讀學校問題的條件
回到頁面上方,剛剛設的條件已經加上去了:
q08: 8.您是不是台師大學生 等於 否(N)
我們按上方的「關閉」。
.. figure:: images/03-04-03-school-03.png
:alt: 設好的外校生就讀學校問題條件
:scale: 60%
設好的外校生就讀學校問題條件
再一次在新增問卷問題的編輯頁面上編號填上「q11」問題填上
「11.請填上您就讀的科系。」題型選擇「開放性問題」裏的
:index:`自由短文 <題型; 單行文字>` 」,題組選「參、其他」,開啟
「必須回應」,然後按「儲存」。
.. figure:: images/03-04-03-school-04.png
:alt: 問題十一:外校生的就讀科系
:scale: 60%
問題十一:外校生的就讀科系
接著按上方「Set conditions」設定問題的條件。在設定問題條件的頁面上
下拉到頁面下方「增加條件」的地方,問題選剛剛的第八題
「q08: 8.您是不是台師大學生」答案選「N(否)」,然後按下「增加條件」。
.. figure:: images/03-04-03-school-05.png
:alt: 加上外校生就讀科系問題的條件
:scale: 60%
加上外校生就讀科系問題的條件
回到頁面上方,剛剛設的條件已經加上去了:
q08: 8.您是不是台師大學生 等於 否(N)
我們按上方的「關閉」。
.. figure:: images/03-04-03-school-06.png
:alt: 設好的外校生就讀科系問題條件
:scale: 60%
設好的外校生就讀科系問題條件

View File

@ -1,23 +0,0 @@
第十二個問題:自由長答
######################
問卷最後我們請填答者給我們課程的建議,告訴我們問卷沒有問到的感想。
課程建議題型使用「 :index:`自由長答 <題型; 多行文字>` 」。填答者不一定
非給建議不可,不是必答。自由長答的內文可以做質性分析。
在新增問卷問題的編輯頁面上編號填上「q12」問題填上
「12.您若有對課程的任何建議,請告訴我們。」題型選擇「開放性問題」裏的
「自由長答」,題組選「參、其他」,不要開啟「必須回應」,然後按「儲存」。
.. figure:: images/03-04-04-comment-01.png
:alt: 問題十二:自由長答題
:scale: 60%
問題十二:自由長答題
.. figure:: images/03-04-04-comment-02.png
:alt: 選擇自由長答題型
:scale: 60%
選擇自由長答題型

View File

@ -1,35 +0,0 @@
預覽問卷的條件邏輯
##################
題組三的跳題設定好了。我們 :index:`預覽一下題組三 <預覽; 題組>`,看問
卷有沒有正確跳題。
按一下上方的「Preview question group」預覽題組。
.. figure:: images/03-04-05-preview-01.png
:alt: 按下「Preview question group」預覽題組
:scale: 60%
按下「Preview question group」預覽題組
.. figure:: images/03-04-05-preview-02.png
:alt: 題組預覽
:scale: 60%
題組預覽
第八題選「是」(本校生),才會出現第九題詢問本校生的學號。
.. figure:: images/03-04-05-preview-03.png
:alt: 第八題選「是」(本校生),接到第九題詢問本校生學號
:scale: 60%
第八題選「是」(本校生),接到第九題詢問本校生的學號
第八題選「否」(外校生),才會出現第十題、第十一題詢問外校生的校系。
.. figure:: images/03-04-05-preview-04.png
:alt: 第八題選「否」(本校生),接到第十題、第十一題詢問外校生校系
:scale: 60%
第八題選「否」(本校生),接到第十題、第十一題詢問外校生校系

View File

@ -1,73 +0,0 @@
填答者名單
##########
建立封閉式問卷後,下一步要建立填答者名單。從問卷左側欄「設定」分頁下,
「問卷參與者」進入後,點選上方選單「顯示參與者」。
.. figure:: images/04-03-01-participants-01.png
:alt: 左側欄「設定」裏的「問卷參與者」
:scale: 60%
左側欄「設定」裏的「問卷參與者」
.. figure:: images/04-03-01-participants-02.png
:alt: 點選「顯示參與者」
:scale: 60%
點選「顯示參與者」
目前名單還是空的。從左上角按下「建立」,可以增添新的填答者。
.. figure:: images/04-03-01-participants-03.png
:alt: 點選「建立」加上新的填答者
:scale: 60%
點選「建立」加上新的填答者
選按「加入參與者」,就可以一筆一筆輸入填答者資料。
.. figure:: images/04-03-01-participants-04.png
:alt: 選「建立」「加入參與者」輸入填答者資料
:scale: 60%
選「建立」「加入參與者」輸入填答者資料
填上First name、Last name和郵件信箱按右上角「儲存」
即可。Token :index:`邀請碼 <邀請碼; 填寫>` )可留白,系統自動產生亂
數邀請碼。也可以使用身份證字號、學號等對方容易記憶的邀請碼,
只要不重複即可。
.. figure:: images/04-03-01-participants-05.png
:alt: 輸入填答者資料
:scale: 60%
輸入填答者資料
選按「CSV檔案」可從CSV檔整批匯入填答者名單。
.. figure:: images/04-03-01-participants-06.png
:alt: 選「建立」「CSV檔案」從CSV檔匯入填答者名單
:scale: 60%
選「建立」「CSV檔案」從CSV檔匯入填答者名單
CSV檔欄位如下
- firstname
- lastname
- email郵件信箱
- 選填token邀請碼
.. figure:: images/04-03-01-participants-07.png
:alt: 選「建立」「CSV檔案」從CSV檔匯入填答者名單
:scale: 60%
選「建立」「CSV檔案」從CSV檔匯入填答者名單
可以參閱 `填答者CSV檔的範例 <http://limesurvey.iro.ntnu.edu.tw/learning/participants-example.csv>`_
.. figure:: images/04-03-01-participants-08.png
:alt: 填答者CSV檔範例
:scale: 60%
填答者CSV檔範例

View File

@ -1,37 +0,0 @@
封閉式問卷
----------
:index:`封閉式問卷 <問卷; 封閉式>` ,需要有填答者名單,適用於施測者握
有特定填答者名單時。如:
- 教學實驗後,實驗組與對照組的學生。
- 由校友資料庫取得名單的畢業生。
- 管理學院所有專兼任教師。
- …等等。
封閉式問卷需要額外設定填答者名單。名單上的填答者,需有
:index:`邀請碼 <邀請碼>` 才可填答。每個填答者的邀請碼各自不同。
啟用問卷後,詢問是否要封閉式問卷時,按左下角的「切換至封閉問卷模式」
即可。
.. figure:: images/04-03-close-01.png
:alt: 選擇封閉式問卷
:scale: 60%
選擇封閉式問卷
詢問是否要開新空白填答者名單時,請點選左下角
「Initialise participant table」。
.. figure:: images/04-03-close-02.png
:alt: 開新空白填答者名單
:scale: 60%
開新空白填答者名單
.. toctree::
04-03-01-participants
04-03-02-messages

396
LICENSE Normal file
View File

@ -0,0 +1,396 @@
Attribution 4.0 International
=======================================================================
Creative Commons Corporation ("Creative Commons") is not a law firm and
does not provide legal services or legal advice. Distribution of
Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
information available on an "as-is" basis. Creative Commons gives no
warranties regarding its licenses, any material licensed under their
terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
fullest extent possible.
Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and
conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright
and certain other rights specified in the public license below. The
following considerations are for informational purposes only, are not
exhaustive, and do not form part of our licenses.
Considerations for licensors: Our public licenses are
intended for use by those authorized to give the public
permission to use material in ways otherwise restricted by
copyright and certain other rights. Our licenses are
irrevocable. Licensors should read and understand the terms
and conditions of the license they choose before applying it.
Licensors should also secure all rights necessary before
applying our licenses so that the public can reuse the
material as expected. Licensors should clearly mark any
material not subject to the license. This includes other CC-
licensed material, or material used under an exception or
limitation to copyright. More considerations for licensors:
wiki.creativecommons.org/Considerations_for_licensors
Considerations for the public: By using one of our public
licenses, a licensor grants the public permission to use the
licensed material under specified terms and conditions. If
the licensor's permission is not necessary for any reason--for
example, because of any applicable exception or limitation to
copyright--then that use is not regulated by the license. Our
licenses grant only permissions under copyright and certain
other rights that a licensor has authority to grant. Use of
the licensed material may still be restricted for other
reasons, including because others have copyright or other
rights in the material. A licensor may make special requests,
such as asking that all changes be marked or described.
Although not required by our licenses, you are encouraged to
respect those requests where reasonable. More considerations
for the public:
wiki.creativecommons.org/Considerations_for_licensees
=======================================================================
Creative Commons Attribution 4.0 International Public License
By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution 4.0 International Public License ("Public License"). To the
extent this Public License may be interpreted as a contract, You are
granted the Licensed Rights in consideration of Your acceptance of
these terms and conditions, and the Licensor grants You such rights in
consideration of benefits the Licensor receives from making the
Licensed Material available under these terms and conditions.
Section 1 -- Definitions.
a. Adapted Material means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material
and in which the Licensed Material is translated, altered,
arranged, transformed, or otherwise modified in a manner requiring
permission under the Copyright and Similar Rights held by the
Licensor. For purposes of this Public License, where the Licensed
Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.
c. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.
d. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.
e. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.
f. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.
g. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.
h. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.
i. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.
j. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.
k. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.
Section 2 -- Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License,
the Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to
exercise the Licensed Rights in the Licensed Material to:
a. reproduce and Share the Licensed Material, in whole or
in part; and
b. produce, reproduce, and Share Adapted Material.
2. Exceptions and Limitations. For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public
License does not apply, and You do not need to comply with
its terms and conditions.
3. Term. The term of this Public License is specified in Section
6(a).
4. Media and formats; technical modifications allowed. The
Licensor authorizes You to exercise the Licensed Rights in
all media and formats whether now known or hereafter created,
and to make technical modifications necessary to do so. The
Licensor waives and/or agrees not to assert any right or
authority to forbid You from making technical modifications
necessary to exercise the Licensed Rights, including
technical modifications necessary to circumvent Effective
Technological Measures. For purposes of this Public License,
simply making modifications authorized by this Section 2(a)
(4) never produces Adapted Material.
5. Downstream recipients.
a. Offer from the Licensor -- Licensed Material. Every
recipient of the Licensed Material automatically
receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this
Public License.
b. No downstream restrictions. You may not offer or impose
any additional or different terms or conditions on, or
apply any Effective Technological Measures to, the
Licensed Material if doing so restricts exercise of the
Licensed Rights by any recipient of the Licensed
Material.
6. No endorsement. Nothing in this Public License constitutes or
may be construed as permission to assert or imply that You
are, or that Your use of the Licensed Material is, connected
with, or sponsored, endorsed, or granted official status by,
the Licensor or others designated to receive attribution as
provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not
licensed under this Public License, nor are publicity,
privacy, and/or other similar personality rights; however, to
the extent possible, the Licensor waives and/or agrees not to
assert any such rights held by the Licensor to the limited
extent necessary to allow You to exercise the Licensed
Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this
Public License.
3. To the extent possible, the Licensor waives any right to
collect royalties from You for the exercise of the Licensed
Rights, whether directly or through a collecting society
under any voluntary or waivable statutory or compulsory
licensing scheme. In all other cases the Licensor expressly
reserves any right to collect such royalties.
Section 3 -- License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the
following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified
form), You must:
a. retain the following if it is supplied by the Licensor
with the Licensed Material:
i. identification of the creator(s) of the Licensed
Material and any others designated to receive
attribution, in any reasonable manner requested by
the Licensor (including by pseudonym if
designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of
warranties;
v. a URI or hyperlink to the Licensed Material to the
extent reasonably practicable;
b. indicate if You modified the Licensed Material and
retain an indication of any previous modifications; and
c. indicate the Licensed Material is licensed under this
Public License, and include the text of, or the URI or
hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any
reasonable manner based on the medium, means, and context in
which You Share the Licensed Material. For example, it may be
reasonable to satisfy the conditions by providing a URI or
hyperlink to a resource that includes the required
information.
3. If requested by the Licensor, You must remove any of the
information required by Section 3(a)(1)(A) to the extent
reasonably practicable.
4. If You Share Adapted Material You produce, the Adapter's
License You apply must not prevent recipients of the Adapted
Material from complying with this Public License.
Section 4 -- Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database;
b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material; and
c. You must comply with the conditions in Section 3(a) if You Share
all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent
possible, most closely approximates an absolute disclaimer and
waiver of all liability.
Section 6 -- Term and Termination.
a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
this Public License, then Your rights under this Public License
terminate automatically.
b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided
it is cured within 30 days of Your discovery of the
violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any
right the Licensor may have to seek remedies for Your violations
of this Public License.
c. For the avoidance of doubt, the Licensor may also offer the
Licensed Material under separate terms or conditions or stop
distributing the Licensed Material at any time; however, doing so
will not terminate this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.
Section 7 -- Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different
terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and
independent of the terms and conditions of this Public License.
Section 8 -- Interpretation.
a. For the avoidance of doubt, this Public License does not, and
shall not be interpreted to, reduce, limit, restrict, or impose
conditions on any use of the Licensed Material that could lawfully
be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.
c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.
d. Nothing in this Public License constitutes or may be interpreted
as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
processes of any jurisdiction or authority.
=======================================================================
Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
will be considered the “Licensor.” The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
creativecommons.org/policies, Creative Commons does not authorize the
use of the trademark "Creative Commons" or any other trademark or logo
of Creative Commons without its prior written consent including,
without limitation, in connection with any unauthorized modifications
to any of its public licenses or any other arrangements,
understandings, or agreements concerning use of licensed material. For
the avoidance of doubt, this paragraph does not form part of the
public licenses.
Creative Commons may be contacted at creativecommons.org.

248
Makefile
View File

@ -1,240 +1,20 @@
# Makefile for Sphinx documentation
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# My local extension
PROJNAME = learning-limesurvey
PROJVER = 3.0
.PHONY: help
# Put it first so that "make" without argument is like "make help".
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " epub3 to make an epub3"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " dummy to check syntax errors of document sources"
@echo " dist to create a document source distribution"
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
.PHONY: help Makefile
.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/LimeSurvey.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LimeSurvey.qhc"
.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/LimeSurvey"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/LimeSurvey"
@echo "# devhelp"
.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
.PHONY: epub3
epub3:
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
@echo
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
patch -p 1 < $(PROJNAME).tex.patch
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
patch -p 1 < $(PROJNAME).tex.patch
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
.PHONY: dummy
dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."
dist:
rm -rf $(BUILDDIR)/dist
mkdir $(BUILDDIR)/dist $(BUILDDIR)/dist/$(PROJNAME)-$(PROJVER)
cp -fpR *.rst images Makefile make.bat conf.py $(PROJNAME).tex.patch participants-example.csv $(BUILDDIR)/dist/$(PROJNAME)-$(PROJVER)/
cd $(BUILDDIR)/dist && zip -r $(PROJNAME)-$(PROJVER).zip $(PROJNAME)-$(PROJVER) && cd ../..
@echo
@echo "Build finished. The distribution is in _build/dist."
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

57
README.rst Normal file
View File

@ -0,0 +1,57 @@
Learning LimeSurvey
===================
*«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_. 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::
# sudo apt install python-sphinx
Or, on Red Hat/Fedora/CentOS::
# sudo yum install python-sphinx
Or use ``pip``::
# pip install sphinx
After installation, run::
# make help
to see the available conversion commands. For example, to generate
HTML, PDF, ePUB, manpage, and Texinfo documents respectively::
# make html
# make latexpdf
# make epub
# make man
# make texinfo
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

430
conf.py
View File

@ -1,430 +0,0 @@
# -*- coding: utf-8 -*-
#
# 台師大問卷調查平台LimeSurvey學習手冊 documentation build configuration file, created by
# sphinx-quickstart on Wed Nov 15 15:39:50 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'台師大問卷調查平台LimeSurvey學習手冊'
copyright = u'2017-2018, 楊士青'
author = u'楊士青 <imacat@ntnu.edu.tw>'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'3.0'
# The full version, including alpha/beta/rc tags.
release = u'3.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'zh_TW'
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
#
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
# html_title = u'台師大問卷調查平台LimeSurvey學習手冊 v3.0'
# A shorter title for the navigation bar. Default is the same as html_title.
#
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}
# If false, no module index is generated.
#
# html_domain_indices = True
# If false, no index is generated.
#
# html_use_index = True
# If true, the index is split into individual pages for each letter.
#
# html_split_index = False
# If true, links to the reST sources are added to the pages.
#
html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'LimeSurveydoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
'preamble':u"""
\\usepackage{xeCJK}
\\setCJKmainfont{AR PL UMing TW}
\\setCJKsansfont{AR PL UKai TW}
""",
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
'figure_align': 'H',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'learning-limesurvey.tex', u'台師大問卷調查平台LimeSurvey學習手冊',
u'楊士青', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#
# latex_use_parts = False
# If true, show page references after internal links.
#
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#
latex_appendices = ['apx-01-copy', 'apx-02-ab-testing']
# It false, will not define \strong, \code, itleref, \crossref ... but only
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
# packages.
#
# latex_keep_old_macro_names = True
# If false, no module index is generated.
#
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'learning-limesurvey', u'台師大問卷調查平台LimeSurvey學習手冊',
[author], 1)
]
# If true, show URL addresses after external links.
#
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'learning-limesurvey', u'台師大問卷調查平台LimeSurvey學習手冊',
author, 'Learning LimeSurvey', u'台師大問卷調查平台LimeSurvey學習手冊',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []
# If false, no module index is generated.
#
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright
# The basename for the epub file. It defaults to the project name.
# epub_basename = project
epub_basename = 'learning-limesurvey'
# The HTML theme for the epub output. Since the default themes are not
# optimized for small screen space, using the same theme for HTML and epub
# output is usually not wise. This defaults to 'epub', a theme designed to save
# visual space.
#
# epub_theme = 'epub'
# The language of the text. It defaults to the language option
# or 'en' if the language is not set.
#
# epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
# epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
#
# epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#
# epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#
# epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#
# epub_pre_files = []
# HTML files that should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#
# epub_post_files = []
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# The depth of the table of contents in toc.ncx.
#
# epub_tocdepth = 3
# Allow duplicate toc entries.
#
# epub_tocdup = True
# Choose between 'default' and 'includehidden'.
#
# epub_tocscope = 'default'
# Fix unsupported image types using the Pillow.
#
# epub_fix_images = False
# Scale large images.
#
# epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# epub_show_urls = 'inline'
# If false, no index is generated.
#
# epub_use_index = True

Binary file not shown.

Before

Width:  |  Height:  |  Size: 374 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 146 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 129 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 123 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 146 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 106 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 106 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 145 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 145 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 141 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 132 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 119 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 193 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

Some files were not shown because too many files have changed in this diff Show More