Debian Codegraph @

texmf-dist/source/latex/nstc-proposal/nstc-proposal.dtx

raw
1 % \iffalse
2 %<cm03|cm302>\NeedsTeXFormat{LaTeX2e}[2023-11-01]
3 %<cm03>\ProvidesClass{nstc-cm03}
4 %<cm302>\ProvidesClass{nstc-cm302}
5 %<cm03|cm302> [2024-11-04 v1.0 NSTC CM03/302 LaTeX 文件格式]
6 %
7 %<*driver>
8 \ProvidesFile{\jobname.dtx}
9 [2024/11/04 v1.0 NSTC CM03/302 LaTeX 文件格式]
10 \documentclass{ltxdoc}
11 \EnableCrossrefs
12 \CodelineIndex
13 \RecordChanges
14 \usepackage{url}
15 \usepackage{graphicx}
16 \usepackage{setspace}
17 \usepackage{pdfpages}
18 \onehalfspacing
19 \usepackage{xltxtra}
20 \usepackage[CJKspace]{xeCJK}
21 \usepackage{titlesec,zhnumber}
22 \renewcommand\labelenumi{(\zhnum{enumi})}
23 \renewcommand\theenumi\labelenumi
24 \setmainfont{bkai00mp.ttf}[AutoFakeBold=2.5]
25 \setCJKmainfont{bkai00mp.ttf}[AutoFakeBold=2.5]
26 \zhnumsetup{style=Traditional}
27 \begin{document}
28 \DocInput{\jobname.dtx}
29 %% \PrintChanges
30 \end{document}
31 %</driver>
32 % \fi
33 %
34 % \changes{v1.0}{2024/11/05}{初始版本}
35 % \GetFileInfo{\jobname.dtx}
36 % \title{\texorpdfstring{\textsf{nstc-proposal} 套件\thanks{GitHub 專案網站:\url{https://github.com/L-TChen/latex-cm03}}}}
37 % \author{陳亮廷}
38 % \date{\zhdate{2024/11/05} \fileversion}
39 % \maketitle
40 % 此套件針對國科會中文專題計劃表 CM03/CM302 的需求,提供中英混排、符合規定的文件格式 |nstc-cm03| 以及 |nstc-cm302|。\footnote{唯獨該格式要求設定 Word 的「單行間距」有歧義:根據 Wikipedia 的說明,Word 97–2010 的單行間距實則為 1.15 倍的行距,之後的版本為 1.08 倍,所以不清楚到底行距實質規定多少。此文件格式行距以 |setspace| 套件設定,肉眼比對約略相等國科會提供的範例。}
41 %
42 % \titleformat{\section}{\bfseries\Large}{\zhnum{section}、}{0em}{}
43 % \section{使用方式}
44 % 本套件提供設定 CM03/302 版面的文件格式以及中文標題名。
45 %
46 %
47 % \subsection{文件格式}
48 % 提供以下兩種格式繼承修改自 \LaTeX 內建之 |article| 文件格式,更改 |\documentclass| 即可使用。
49 %
50 % \DescribeMacro{nstc-cm03}
51 % 適用於表 CM03 研究計劃的文件格式。
52 %
53 % \DescribeMacro{nstc-cm302}
54 % 適用於表 CM302 著作目錄的文件格式。
55 %
56 % \subsection{文件格式選項}
57 %
58 % 兩文件格式皆提供以下選項:
59 %
60 % \DescribeMacro{libertine}
61 % 更換為 Linux Libertine 字型,較適合搭配楷體漢字。
62 %
63 % \DescribeMacro{kaiti}
64 % 更換為 macOS 上內建的常州華文「楷體-繁」字型,該字型具備粗體。
65 %
66 % \DescribeMacro{draft oneside twoside fleqn leqno}
67 % 繼承自 |article| 的選項,作用請參考 \LaTeX 中的說明。若使用 |article| 其他不相容於 CM03/302 的選項,仍可編譯但會產生警告訊息。
68 %
69 %
70 % \subsection{指令} \label{sec:commands}
71 % 本套件可使用 |article| 格式的指令。此套件另提供以下指令生成表 CM03 中的章節及敘述說明。
72 %
73 % \DescribeMacro{\ProposalBackground}
74 % 「研究計畫之背景\quad 請詳述本研究計畫\dots\dots」
75 %
76 % \DescribeMacro{\ProposalMethod}
77 % 「研究方法、進行步驟及執行進度\quad 請分年列述:\dots\dots」
78 %
79 % \DescribeMacro{\ProposalPlan}
80 % 「預期完成之工作項目及成果\quad 請分年列述:\dots\dots」
81 %
82 % \DescribeMacro{\ProposalIntegration}
83 % 「整合型研究計畫說明\quad 如為整合型研究計畫\dots\dots」
84 %
85 % \subsection{預載套件}
86 %
87 % 除 |amsmath| 和 |amsthm| 外,只載入格式設定必要的套件,其他套件請自行載入。
88 % \subsection{範例}
89 % 以下為原始檔範例,此說明最後附有編譯結果。
90 % \subsubsection{CM03 研究計劃}
91 % 下列之範本可產生如國科會提供之範例,並具有 PDF 目錄結構:
92 % \begin{macrocode}
93 %<*proposal.tex>
94 \documentclass[libertine]{nstc-cm03}
95 \usepackage{microtype}
96 \begin{document}
97
98 \ProposalBackground
99 \ProposalMethod
100 \ProposalPlan
101 \ProposalIntegration
102
103 \bibliographystyle{plain}
104 \bibliography{sample}
105 \end{document}
106 %</proposal.tex>
107 % \end{macrocode}
108 %
109 % \subsubsection{CM302 著作目錄}
110 % 著作目錄可用指令 |\nocite{*}| 將 |.bib| 檔內所有文獻引用,如:
111 % \begin{macrocode}
112 %<*bibliography.tex>
113 \documentclass{nstc-cm302}
114 \usepackage[hidelinks]{hyperref}
115 \usepackage{doi}
116 \usepackage{microtype}
117 \begin{document}
118
119 \nocite{*}
120
121 \bibliographystyle{abbrv}
122 \bibliography{sample}
123 \end{document}
124 %</bibliography.tex>
125 % \end{macrocode}
126 %
127 % \section{後記}
128 %
129 % 理工領域學者學術寫作習慣使用英文,專題研究的申請書則仍常用中文,
130 % 此文件格式試圖滿足中英文混排並與申請書其他文件一致協調,另有以下要求:
131 %
132 % \begin{enumerate}
133 % \item 產生之 PDF 檔有相對應的目錄
134 % \item 字型使用需合法
135 % \item 需相容 pdf\LaTeX
136 % \end{enumerate}
137 %
138 % 首先,文章結構中的 |\section| 對應中文標題(如:「研究計畫之背景」),章節編號採中文數字(如:一、二、三 )。而子節(|\subsection|)則假設為英文段落,標題後的文字沒有空行隔開,而是間隔一小空白後直接開始,與中文標題一致。因為用標準的 \LaTeX 命令設定,產生出來的 PDF 檔如用 |hyperref| 套件可產生對應的章節目錄。
139
140 % 國科會 CM03 範例中的章節文字,本套件提供指令如 |\ProposalBackground| (見~\ref{sec:commands}~節)印出,但並不預設產生。除固定顯示「三、研究計畫內容(以中文或英文撰寫)」外,其他節的標題文字可由使用者自行更改。
141 %
142 % 中文字型選擇配合計畫文件其他頁面,將採用標楷體(若作業系統無提供,則用 \TeX 提供的「文鼎 PL 楷體」)。然而標楷體並無設計粗體,加粗僅為軟體模擬,部分留白處太少。而 macOS 內建常州華文設計的「楷體-繁」,該字型同為楷體且有設計相對應的粗體字重,較為美觀清楚。因此針對 macOS 使用者,提供選項 |kaiti| 改採用「楷體-繁」。
143 %
144 % 至於英文字型,台灣研究所論文常搭配同是襯線字的 Times New Roman,依循慣例以同字體的 TeXGyre Termes 作為預設字型。然而 Times 字體收尾尖銳細長,較相似中文的明體。相較之下,同是襯線字的 Linux Libertine 較圓潤與楷體較為一直,因此提供選項 |libertine| 可改為 Linux Libertine 字型。
145 %
146 % 至於 pdf\LaTeX 仍有編譯快速以及 |microtype| 套件支援完整等優點,因此盡力相容 pdf\LaTeX 不要求使用 \XeTeX 編譯中文。但中文選擇受限於 \TeX 的 T1 字型,標楷體因版權無法製成 T1 字型散佈,改採用文鼎公眾授權的「PL 楷體」\footnote{授權聲明在此:\url{https://www.arphic.com.tw/2022/01/21/plfont/}}替代。
147 % \paragraph{致謝} 在此特別感謝柯向上博士\footnote{柯博士的個人網頁:\url{https://josh-hs-ko.github.io}},此套件最初基於他提供的頁面設定所發展。
148 %
149 % \appendix
150 %
151 % \StopEventually{}
152 %
153 % \titleformat{\section}{\bfseries\Large}{附錄\Alph{section}、}{0em}{}
154 % \section{實作}
155 %
156 % 此節提供實作細節的說明,供後人修改參考。
157 %
158 % \subsection{文件格式選項}
159 % \begin{macro}{nstc-cm03.cls/nstc-cm302.cls}
160 % 這兩個文件格式由同一個檔案生成,格式版面皆相同,差別僅在於部分文字。
161 % \begin{macro}{}
162 % 若使用不相容於表 CM03 的 |article| 文件格式的選項,則編譯時會提出警告。
163 % \begin{macrocode}
164 %<*cm03|cm302>
165 \def\cmthree@opterrlong{The option "\CurrentOption" from article.cls is
166 not compatible with the format of cm03.}
167 \newcommand{\cmthree@warning}{\ClassWarning{cm03}{\cmthree@opterrlong}}
168 \newcommand{\cmthree@info}[1]{\ClassInfo{cm03}{#1}}
169 % \end{macrocode}
170 % \end{macro}
171 % \begin{macro}{}
172 % 以下是不相容的選項:
173 % \begin{macrocode}
174 \DeclareOption{titlepage}{\cmthree@warning}
175 \DeclareOption{notitlepage}{\cmthree@warning}
176 \DeclareOption{10pt}{\cmthree@warning}
177 \DeclareOption{11pt}{\cmthree@warning}
178 \DeclareOption{letterpaper}{\cmthree@warning}
179 \DeclareOption{a5paper}{\cmthree@warning}
180 \DeclareOption{b5paper}{\cmthree@warning}
181 \DeclareOption{executivepaper}{\cmthree@warning}
182 \DeclareOption{legalpaper}{\cmthree@warning}
183 \DeclareOption{twocolumn}{\cmthree@warning}
184 \DeclareOption{openright}{\cmthree@warning}
185 % \end{macrocode}
186 % \end{macro}
187 % \begin{macro}{libertine,kaiti}
188 % 額外提供兩個選項 |libertine| 跟 |kaiti| 改變字型:
189 % \begin{macrocode}
190 \DeclareOption{libertine}{\let\@libertine\relax}
191 \DeclareOption{kaiti}{\let\@kaiti\relax}
192 % \end{macrocode}
193 % \end{macro}
194 % \begin{macro}{}
195 % 剩下的選項傳入 |article| 文件格式,並且設定頁面跟字型大小:
196 % \begin{macrocode}
197 \DeclareOption*{\PassOptionsToClass{\CurrentOption}{article}}
198 \ProcessOptions\relax
199 \LoadClass[a4paper,12pt,onecolumn,twoside]{article}
200 \RequirePackage[margin=2cm,bottom=2.4cm]{geometry}
201 \RequirePackage{setspace}
202 \onehalfspacing
203
204 \RequirePackage{iftex,xifthen}
205 \RequirePackage{amsmath,amsthm}
206 % \end{macrocode}
207 % \end{macro}
208 %
209 % \subsection{中文字型處理}
210 % \begin{macro}{}
211 % 根據編譯引擎不同,中文字型設定有所不同。因此先用 |iftex| 套件提供之 |\iftutex| 判斷是否為 \XeTeX 。
212 % \begin{macrocode}
213 \iftutex
214 % \end{macrocode}
215 % \end{macro}
216 % \begin{macro}{}
217 % 若是使用 \XeTeX 編譯,則載入 |xeCJK| 套件處理中文排版。若有選項 |kaiti| 則載入系統字型「楷體-繁(|Kaiti TC|)」:
218 % \begin{macrocode}
219 \RequirePackage[PunctStyle=plain,no-math]{xeCJK}
220 \ifx\@kaiti\relax
221 \setCJKmainfont{Kaiti TC}[BoldFont = *-Bold]
222 \setCJKsansfont{Heiti TC}
223 \cmthree@info{使用楷體作為中文字型}
224 % \end{macrocode}
225 % \end{macro}
226 % \begin{macro}{}
227 % 若無選項 |kaiti|,則優先選擇系統上的標楷體。然而,標楷體有各種版本,名稱也根據現行編碼習慣略作調整。在中文 Windows 以及 macOS 13.2 以前應皆稱為「標楷體(|BiauKai|)」,在 macOS 13.3 之後稱為「標楷體-繁(|BiauKaiTC|)」:
228 % \begin{macrocode}
229 \else
230 \IfFontExistsTF{BiauKai}{
231 \setCJKmainfont{BiauKai}[AutoFakeBold=2.5]
232 \cmthree@info{使用標楷體 (BiauKai) 作為中文字型}
233 }{
234 \IfFontExistsTF{BiauKaiTC}{
235 \setCJKmainfont{BiauKaiTC}[AutoFakeBold=2.5]
236 \cmthree@info{使用標楷體繁 (BiauKaiTC) 作為中文字型}
237 % \end{macrocode}
238 % \end{macro}
239 % \begin{macro}{}
240 % 若無標楷體(|BiauKai| 或 |BiauKaiTC|)則用 |arphic-ttf| 套件的文鼎「PL 楷體」:
241 % \begin{macrocode}
242 }{
243 \setCJKmainfont{bkai00mp.ttf}[AutoFakeBold=2.5]
244 \cmthree@info{使用 AR PL UKai TW 作為中文字型}
245 }}
246 \fi
247 % \end{macrocode}
248 % \end{macro}
249 % \begin{macro}{}
250 % 若使用 \LaTeX 編譯,則載入 |CJKutf8| 套件並使用 |arphic| 套件的文鼎「PL 楷體」,並且設定新的 \LaTeX 環境 |zh| ,可在其中使用中文,同時將文件以 |zh| 環境包覆,
251 % \begin{macrocode}
252 \else
253 \RequirePackage{CJKutf8}
254 \newenvironment{zh}{\begin{CJK*}{UTF8}{bkai}}{\end{CJK*}}
255 \input{c70bkai.fd}
256 \DeclareFontShape{C70}{bkai}{b}{n}{<-> CJKb * bkaiu}{\CJKbold}
257 \AddToHook{begindocument/end}{\begin{zh}}
258 \AddToHook{enddocument}{\end{zh}}
259 \fi
260 % \end{macrocode}
261 % \end{macro}
262 % \subsection{英文字型處理}
263 % \begin{macro}{}
264 % \begin{macrocode}
265 \ifx\@libertine\relax
266 \RequirePackage[tt=false]{libertine}
267 \iftutex
268 \RequirePackage{unicode-math}
269 \setmathfont[Scale=MatchUppercase]{LibertinusMath-Regular.otf}
270 \else
271 \RequirePackage[libertine]{newtxmath}
272 \fi
273 % \end{macrocode}
274 % \end{macro}
275 % \begin{macro}{}
276 % 使用 |newtxtext| 設定英文字型為 \textsf{TeXGyre Termes}。然而,|newtxtext| 會改變 |fontspec| 設定,以至於使用者無法再改字型,而使用者仍可能載入其他設定,所以用 |\defaultfontfeatures{}| 恢復設定:
277 % \begin{macrocode}
278 \else
279 \RequirePackage{newtxtext}
280 \iftutex
281 \defaultfontfeatures{}
282 \fi
283 \RequirePackage{newtxmath}
284 \fi
285 % \end{macrocode}
286 % \end{macro}
287 % \begin{macro}{}
288 % \subsection{頁面文字}
289 % 設定中英文章節格式:
290 % \begin{macrocode}
291 %<cm03>\RequirePackage{zhnumber,titlesec}
292 %<cm03>\titleformat{\section}[runin]%
293 %<cm03> {\bfseries\normalsize}{(\zhnum{section})}{0em}{}
294 %<cm03>\titleformat{\subsection}[runin]%
295 %<cm03> {\bfseries\normalsize}{\thesubsection}{0.5em}{}
296 %<cm03>\titleformat{\subsubsection}[runin]%
297 %<cm03> {\bfseries\normalsize}{\thesubsubsection}{0.5em}{}
298 %
299 % \end{macrocode}
300 % \end{macro}
301 % 設定表 CM03/CM302 首頁標題:
302 % \begin{macro}{}
303 % \begin{macrocode}
304 %<cm302>\def\cmthree@heading{五、著作目錄(建議呈現與計畫相關之著作目錄,頁數以~2~頁為限):}
305 %<cm302>\def\cmthree@footer{表\;CM302}
306 %<cm03>\def\cmthree@heading{三、研究計畫內容(以中文或英文撰寫):}
307 %<cm03>\def\cmthree@footer{表\;CM03}
308 \AddToHook{begindocument/end}{\par%
309 \everypar={{\setbox0=\lastbox}\everypar{}}%
310 \begingroup\large\bfseries\cmthree@heading\endgroup\par}
311
312 % \end{macrocode}
313 % \end{macro}
314 % \begin{macro}{}
315 % 設定頁尾格式:
316 % \begin{macrocode}
317 \RequirePackage{lastpage,fancyhdr}
318 \pagestyle{fancy}
319 \renewcommand{\headrulewidth}{0pt}
320 \fancyhead{}
321 \iftutex
322 \lfoot{\cmthree@footer}
323 \else
324 \lfoot{\begin{zh}\cmthree@footer\end{zh}}
325 \fi
326 \cfoot{}
327 \iftutex
328 \rfoot{共~\pageref{LastPage}~頁%
329 \hspace{1em}第~\thepage~頁}
330 \else
331 \rfoot{\begin{zh}共~\pageref{LastPage}~頁%
332 \hspace{1em}第~\thepage~頁\end{zh}}
333 \fi
334 % \end{macrocode}
335 % \end{macro}
336 % \begin{macro}{}
337 % 設定參考文獻標題,表 CM302 令 |\section| 無作用避免錯誤的留白:
338 % \begin{macrocode}
339 %<cm302>\AddToHook{begindocument/end}{\renewcommand{\section}[2]{}}
340 %<cm03>\AddToHook{begindocument/end}{\renewcommand{\refname}{參考文獻}}
341 % \end{macrocode}
342 % \end{macro}
343 % \begin{macro}{\zhsection}
344 % 中文章節的標題與說明透過 |\zhsection| 設定,接續段落預留 1em 的垂直空間。
345 % \begin{macrocode}
346 %<cm03>\newcommand{\zhsection}[2]{\section{#1}#2\vskip1em}
347 % \end{macrocode}
348 % \end{macro}
349 % \begin{macro}{\ProposalBackground, \ProposalMethod, \ProposalPlan, \ProposalIntegration}
350 % 設定表 CM03 各節標題文字與說明:
351 % \begin{macrocode}
352 %<cm03>\newcommand{\ProposalBackground}{\zhsection{研究計畫之背景}{請詳述本研究計畫所要探討或解決的問題、研究原創性、重要性、預期影響性及國內外有關本計畫之研究情況、重要參考文獻之評述等。如為連續性計畫應說明上年度研究進度。}}
353 %<cm03>\newcommand{\ProposalMethod}{\zhsection{研究方法、進行步驟及執行進度}{請分年列述:1. 本計畫採用之研究方法與原因及其創新性。2. 預計可能遭遇之困難及解決途徑。3. 重要儀器之配合使用情形。4. 如為須赴國外或大陸地區研究,請詳述其必要性以及預期效益等。}}
354 %<cm03>\newcommand{\ProposalPlan}{\zhsection{預期完成之工作項目及成果}{請分年列述:1. 預期完成之工作項目。2. 對於參與之工作人員,預期可獲之訓練。3. 預期完成之研究成果(如實務應用績效、期刊論文、研討會論文、專書、技術報告、專利或技術移轉等質與量之預期成果)。4. 學術研究、國家發展及其他應用方面預期之貢獻。}}
355 %<cm03>\newcommand{\ProposalIntegration}{\zhsection{整合型研究計畫說明}{如為整合型研究計畫請就以上各點分別說明與其他子計畫之相關性。}}
356 %</cm03|cm302>
357 % \end{macrocode}
358 % \end{macro}
359 % \end{macro}
360 % \includepdfmerge[nup=1x2, landscape]{./example/proposal.pdf, ./example/bibliography.pdf}
361 %
362 % \Finale
363