本文源自 「學(xué)術(shù)論文寫(xiě)作新武器:Markdown」 系列專欄:
目錄
1. 寫(xiě)在前面
對(duì)于搞學(xué)術(shù)的人來(lái)說(shuō),「寫(xiě)論文」是吃飯的本事。一般來(lái)說(shuō),大家(人文社科領(lǐng)域)都會(huì)有自己的寫(xiě)作模板,這個(gè)模板通常是 Word 格式,除了論文的基本套路之外,里面還包含了各個(gè)標(biāo)題、摘要、圖表等的樣式信息。不少經(jīng)濟(jì)學(xué)實(shí)證研究者的論文寫(xiě)作流程是這樣的:先通過(guò) Stata 等計(jì)量工具以圖、表的形式輸出結(jié)果,粘貼到模板(DOCX)文件中,完成實(shí)證部分;再在模板文件的基礎(chǔ)上「增刪改查」,完成論文其余部分的撰寫(xiě)。內(nèi)容寫(xiě)完之后,就是對(duì)各種樣式的「無(wú)限」調(diào)整了。下一篇論文同樣復(fù)制上面的流程,一遍又一遍。 論文的寫(xiě)作過(guò)程已經(jīng)著實(shí)令人頭疼,一篇篇文章格式的調(diào)整更是無(wú)比麻煩(好吧,一篇都沒(méi)寫(xiě)出來(lái)過(guò)????)。論文寫(xiě)作我們不能自動(dòng)化,格式調(diào)整的自動(dòng)化還做不到嗎? 接下來(lái)就要請(qǐng)出今天的主角 —— Markdown + Pandoc 。二者配合「食用」助你實(shí)現(xiàn) Markdown 寫(xiě)文、Pandoc 一行命令批量格式轉(zhuǎn)換的效果,這回再有一百篇 Markdown 文章也能同一個(gè)樣式轉(zhuǎn)成 Word 或 PDF 了。 一篇學(xué)術(shù)論文的格式通常涉及標(biāo)題、摘要、作者信息、正文、圖片(圖注和編號(hào))、表格(表注和編號(hào))、腳注、數(shù)學(xué)公式、參考文獻(xiàn)、畢業(yè)論文還會(huì)有目錄、附錄等。為做演示,我七拼八湊了一篇、力求長(zhǎng)相似經(jīng)濟(jì)學(xué)實(shí)證論文的 Markdown 文章(內(nèi)容莫深究)????
pandoc -F pandoc-crossref --citeproc ` 注:這里的反點(diǎn)號(hào)起到折行的作用,可不寫(xiě),那樣就會(huì)呈現(xiàn)在同一行上。 上面的 Pandoc 語(yǔ)法是本文轉(zhuǎn)換流程的完整命令。這能實(shí)現(xiàn)何種效果呢?往下看???? 怎么樣?還不錯(cuò)是嘛。這行命令具體啥意思、還需要哪些準(zhǔn)備工作?別急,我們一步步來(lái)????! 2. 什么是 Markdown又到了這個(gè)老生常談的問(wèn)題了。自從遇到了 Markdown,感覺(jué)寫(xiě)作明顯輕快了不少,也常常安利,奈何號(hào)召力有限,身邊真正去用的還真不多????。既然要用 Markdown 寫(xiě)學(xué)術(shù)論文,首先你得先弄明白什么是 Markdown。 計(jì)算機(jī)常見(jiàn)的文件格式主要分為兩種:純文本文件(Plain Text)和二進(jìn)制文件(Binary File)。 最直觀來(lái)看,純文本文件可以直接用「記事本」打開(kāi),如常見(jiàn)的代碼文件( 不過(guò),對(duì)純文本文件(如 MD)進(jìn)行「版本控制」要比二進(jìn)制文件(如 DOCX)容易的多。版本控制是一種記錄一個(gè)或若干文件內(nèi)容變化,以便將來(lái)查閱特定版本修訂情況的系統(tǒng)。進(jìn)行版本控制不僅有利于「版本回退」、更會(huì)讓你了解內(nèi)容發(fā)生了什么樣的變化,同時(shí)在文件備份、團(tuán)隊(duì)協(xié)同方面的作用更明顯。 除此之外,也正是由于純文本文件僅顯示字符的特性,使其具有占用內(nèi)存小、打開(kāi)速度快等優(yōu)點(diǎn),在計(jì)算機(jī)世界被廣泛使用。也因此出現(xiàn)了各種各樣的 標(biāo)記語(yǔ)言(Mark-Up Language),以使純文本文件更加易讀。 Markdown 便是眾多標(biāo)記語(yǔ)言中的一員。它允許人們使用易讀易寫(xiě)的 「純文本格式」 編寫(xiě)文檔,然后轉(zhuǎn)換成有效的 HTML 格式。由于 Markdown 輕量化、易讀寫(xiě)的特性,以及對(duì)于圖片、圖表、數(shù)學(xué)公式的良好支持,目前 Markdown 已被廣泛應(yīng)用于各大網(wǎng)站和幫助文檔的撰寫(xiě)中。其基本語(yǔ)法相當(dāng)簡(jiǎn)單,十分鐘即可快速上手,不了解的童鞋建議直接看看下面的介紹????
3. 為什么選擇 Markdown除了上面介紹的語(yǔ)法簡(jiǎn)單、容易上手、可進(jìn)行版本控制等優(yōu)點(diǎn)之外,我們?cè)谒伎肌笧槭裁催x擇 Markdown」時(shí),更應(yīng)該想想「為什么不」選擇其他編輯器?比如,Word、LaTeX。 從剛接觸電腦那會(huì)兒,我們便與 Microsoft Word 「不期而遇」。憑借其廣泛的流行性,Word 毫無(wú)疑問(wèn)成為大多數(shù)人日常學(xué)習(xí)工作中使用頻率最高的軟件之一。那為什么不選擇 Word 呢? 「流行不代表好用」。即使使用頻率高,我們也深受其苦。Word 的「內(nèi)容和格式分離」設(shè)計(jì)使得我們很容易不自覺(jué)地調(diào)整文章格式、打斷寫(xiě)作的連貫性?;蛟S用 Word 寫(xiě)幾頁(yè)的文檔或許還能忍受,但是幾十、上百頁(yè)的畢業(yè)論文都用 Word 完成,不是我們先受不了,恐怕 Word 也會(huì)先「罷工」。 「易分心」和「易崩潰」的雙重疊加足以促使我「不得不」選擇新工具。 LaTeX 作為極專業(yè)的排版軟件,為什么不選擇它呢? 原因也正在于它「引以為傲」的優(yōu)點(diǎn) ——— 過(guò)于專業(yè)、學(xué)習(xí)曲線太陡峭。當(dāng)然,除了 LaTeX 上手難度高的因素外,目前國(guó)內(nèi)人文社科領(lǐng)域尚未形成使用 LaTeX 的氛圍是更重要的原因。當(dāng)下該領(lǐng)域絕大多數(shù)期刊對(duì)審稿稿件的格式要求以 Word 和 PDF 為主,提供 LaTeX 模板的期刊極少。在個(gè)人寫(xiě)作中,優(yōu)雅的 LaTeX 帶給自己「沉浸」的體驗(yàn);不過(guò)一旦放到團(tuán)隊(duì)協(xié)作的模式中,怕是會(huì)用 LaTeX 的也沒(méi)幾個(gè),交流成本將大幅提高。 您也可以掃碼查看連享會(huì) Markdown 倉(cāng)庫(kù),獲取更多資源:
4. 編輯器 —— VScode確定了語(yǔ)法,還需要一個(gè)寫(xiě)作載體——編輯器。我在這期 推文 中介紹了 馬克飛象、StackEdit、Editor 等幾個(gè)在線 Markdown 編輯器和兩個(gè)本地編輯器(均可全平臺(tái)使用)—— Typora 和 Visual Studio code。 如果你沒(méi)有插入?yún)⒖嘉墨I(xiàn)的需求,Typora 應(yīng)該是極佳的選擇。但對(duì)于學(xué)術(shù)研究者而言,使用文獻(xiàn)管理軟件(這里僅以 Zotero 為例)插入引文是常事,那更推薦能與 Zotero 聯(lián)動(dòng)的 VScode 來(lái)解決這一學(xué)術(shù)論文寫(xiě)作的棘手問(wèn)題。不過(guò)如果你使用的是 macOS 系統(tǒng),Typora(或其他 Markdown 編輯器)也不錯(cuò),因?yàn)榇钆?ZotHero(一個(gè) Alfred Workflow)可實(shí)現(xiàn)全局搜索 Zotero 數(shù)據(jù)庫(kù)并快速?gòu)?fù)制引文??紤]到全平臺(tái)性,本文僅以 VScode 為例。 關(guān)于 VScode,可以在其 官網(wǎng) 下載;或使用「包管理器」一鍵安裝 軟件初始界面默認(rèn)語(yǔ)言為英文,需要的話,可以在擴(kuò)展市場(chǎng)搜索安裝 中文漢化擴(kuò)展。除此之外,雖然 VScode 原生支持 Markdown,但是想要獲得更地道的體驗(yàn),還是得安裝幾個(gè) Markdown 插件,實(shí)現(xiàn)實(shí)時(shí)預(yù)覽、快捷操作等更優(yōu)質(zhì)的體驗(yàn)。
5. 格式轉(zhuǎn)換:Pandoc到這里,Markdown 部分就介紹差不多了,其準(zhǔn)備工作也基本完成了。或許你也對(duì)簡(jiǎn)單易用的 Markdown 感興趣了。那么問(wèn)題來(lái)了。我們寫(xiě)好的論文需要傳給不使用 Markdown 的老師同學(xué)們查看、批閱或者交給期刊編輯們審閱,那 Markdown 格式的文件轉(zhuǎn)換為 Word 或 PDF 格式就輪到另一員大將出馬了,它就是 —— Pandoc,專為各種文本文件「換馬甲」。 5.1 Pandoc 是什么Pandoc 是加州大學(xué)伯克利分校哲學(xué)系教授 John MacFarlane 于 2006 年使用 Haskell 語(yǔ)言編寫(xiě)的一款跨平臺(tái)、自由開(kāi)源及命令行界面的標(biāo)記語(yǔ)言轉(zhuǎn)換工具。由于支持的格式眾多,Pandoc 也被譽(yù)為文本轉(zhuǎn)換界的「瑞士軍刀」。點(diǎn)擊 這里 你將會(huì)看到那張著名 Pandoc 支持的文件格式圖。 5.2 下載安裝進(jìn)入 Pandoc 官網(wǎng),按需選擇對(duì)應(yīng)的版本,點(diǎn)擊下載安裝即可。除了下載安裝包的形式外,更推薦使用「包管理器」一鍵安裝。
安裝成功后,可在 ** CMD 或 PowerShell 等命令行窗口** 輸入 之后我們使用 Pandoc 的所有操作都基于命令行進(jìn)行。 5.3 基本使用好了,我們先和這個(gè)「百變魔王」簡(jiǎn)單過(guò)下招兒。
Pandoc 可自動(dòng)根據(jù)文件名后綴判斷文件類型,所以上述命令可簡(jiǎn)化為: pandoc 輸入文件名 -o 輸出文件名 看到了嗎?「一行代碼」便能實(shí)現(xiàn)巨多種文件格式的快速轉(zhuǎn)換,這僅是 Pandoc 的基本功能,若想實(shí)現(xiàn)更炫酷的玩法,還得接著往下看~~來(lái)個(gè)實(shí)際場(chǎng)景試試:轉(zhuǎn)換下我文章開(kāi)頭說(shuō)的「七拼八湊」的學(xué)術(shù)論文~
這是最簡(jiǎn)單的、不加任何修飾的 Markdown 轉(zhuǎn) Word,效果怎樣呢? 嗯,還可、不過(guò)并不美觀。最需要調(diào)整應(yīng)該是各個(gè)標(biāo)題的顏色、顯示位置、大?。ó?dāng)然,表注、交叉引用編號(hào)、參考文獻(xiàn)等進(jìn)階樣式需要特殊語(yǔ)法)。如果僅是格式轉(zhuǎn)換,到這兒或許可以了。但是想要符合學(xué)術(shù)論文寫(xiě)作的需求,還得再做進(jìn)一步修改。 到這里,或許你即將被勸退????,說(shuō)好的用 Markdown 寫(xiě)論文,到這里還僅在準(zhǔn)備階段?!莫慌,為了讓大家對(duì)整個(gè)流程有更深的理解,我用不少篇幅介紹了背景知識(shí),相信我,接著看下期,好戲來(lái)了!你會(huì)發(fā)現(xiàn)有 Pandoc 加持的 Markdown,戰(zhàn)斗力早不可同日而語(yǔ)。
6. 參考資料
7. 相關(guān)推文
|
|
來(lái)自: liyu_sun > 《論文學(xué)習(xí)》