2nd International Conference on Social Science and Higher Education (ICSSHE 2016)
Preparing Teaching Materials for Engineering Disciplines with Markdown
Tuoxin Jiang
Faculty of Foreign Languages and Cultures Kunming University of Science and Technology Yunnan, PR China
Lan Tang*
Xueying Liu
Faculty of Electric Power Engineering Kunming University of Science and Technology
Yunnan, PR China 573409874@qq.com
Faculty of Electric Power Engineering Kunming University of Science and Technology
Yunnan, PR China tanglan@kmust.edu.cn
Abstract—In the digital age, teachers in engineering disciplines must pay more attention to the preparation of teaching materials than before. However, their work efficiency is limited by words processing because of the complexity of teaching materials that consist of text, equations, figures, etc. A method based on the plain text is presented in this paper. The common syntax of Markdown is introduced, two practical MD
editors and a useful tool, Pandoc, are recommended.
Keywords—teaching materials, markup language, Markdown, Pandoc, efficiency
- INTRODUCTION
With the development of network technology and the changing of teaching theory, engineering courses in colleges are beyond lectures, homework and design projects. Students could read teaching materials and watch teaching video to further study via network. Therefore, teachers not only need making preparation for lectures but also supplying lots of learning materials for students, which is one of the indispensable responsibilities of college teachers. Nowadays, “Flipped classroom” becomes more and more popular, which highlights the importance of preparing electronic teaching materials [1]. In China, most of the teachers choose a “WYSWYG” tool as text editor, such as MS word or WPS. When many mathematical symbols and formulas need to be input, it becomes a time-consuming job to type in teaching materials even with the help of a visual plugin. And files with the proprietary format are difficult to be released on the network. Sometimes, students could download files to local computer, but fail to open them because of the differences between reader and original editor. Although a few teachers may utilize LaTeX typing system to make e-documents, which is a good way to solve the problem above mentioned, it has not been widely used in China.
In this paper, Markdown-based text processing was introduced. Both mathematical symbols and figures could be
inserted into the plain text conveniently. The MD files could be converted to many different formats, and more suitable to be posted on the net. Besides these advantages, anyone could learn Markdown in ten minutes and master it during the course of practice.
- WHAT MARKDOWN IS
Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats [2,3]. Markdown usually has two means. One is the syntax; the other is the converting tool. The key design goal of Markdown is readability. A Markdown- formatted document should be publishable as-is, as plain text, without looking like itrsquo;s been marked up with tags or formatting instructions. Therefore, Markdown was first popular in computer society and often used to format readme files, for writing messages in online discussion forums. For example, Markdown is supported by famous WordPress and Github.
There is no clearly defined Markdown standard till now. Many implementations extend Markdown by adding features (such as tables, footnotes, definition lists, mathematics, and Markdown inside HTML blocks) not available in original version [3]. Pandocrsquo;s enhanced version of Markdown is the typical one. Because of these extensions, markdown could be used as a good tool to edit teaching materials.
In this section, a little syntax was introduced at the beginning. As the matter of fact, only by using title mark and list mark could we write general articles without thinking of the format any more.
- Basic symbols
There are three kinds of symbols in Markdown. They are ordinary markers, blanks and special segments markers.
-
- Ordinary markers
There are three ordinary markers, asterisks, pluses and hyphens (*, ,-). These three markers are interchangeable. Of course, keeping consistency in a file is a good habit.
-
- Blanks
Two blanks appeared at the end of a line means return. One or more blank lines are used to separate one paragraph from another.
-
- Special segments markers
In a regular paragraph, you can create code span by wrapping text in backtick quotes (``).To specify an entire block of pre-formatted code; indent every line of the block by 4 spaces or 1 tab.
- Headers
The structure of a paper can be presented by hierarchical headers. Headers in different hierarchies are distinguished with different fonts or word size. Markdown offers two styles of headers: Setext and atx. Setext-style headers forlt;h1gt;andlt;h2gt;are created by “underlining” with equal signs (=) and hyphens (-), respectively. To create an atx-style header, you put 1-6 hash marks (#) at the beginning of the line — the number of hashes equals the resulting HTML header level.
- Lists
Unordered lists use any one of basic symbols as list markers. Ordered lists use regular numbers, followed by periods, as list markers. Nested lists are also supported.
全文共14605字，剩余内容已隐藏，支付完成后下载完整资料
用Markdown编写工程学科教材
Tuoxin Jiang
Faculty of Foreign Languages and Cultures Kunming University of Science and Technology Yunnan, PR China
Xueying Liu
Faculty of Electric Power Engineering Kunming University of Science and Technology
Yunnan, PR China 573409874@qq.com
摘要——在数字时代，工程学科教师必须比以往更加重视教材的编写。 然而，由于由文本，方程，图形等组成的教材的复杂性，它们的工作效率受到文字处理的限制。本文提出了一种基于明文的方法。 介绍Markdown的通用语法，推荐两种实用的MD编辑器和一个有用的工具Pandoc
关键词——教材，标记语言，Markdown，Pandoc，效率
随着网络技术的发展和教学理论的变化，高校工程课程不仅仅是讲课，作业和设计项目。学生可以阅读教材，观看教学视频，通过网络进一步学习。因此，教师不仅需要为讲课做准备，还需要为学生提供大量的学习材料，这是高校教师不可缺少的职责之一。如今，“翻转教室”变得越来越流行，这凸显了准备电子教材的重要性[1]。在中国，大多数教师选择“WYSWYG”工具作为文本编辑器，如MS word或WPS。当需要输入许多数学符号和公式时，即使在可视化插件的帮助下输入教材也变得非常耗时。具有专有格式的文件很难在网络上发布。有时，学生可以将文件下载到本地计算机，但由于读者和原始编辑器之间的差异而无法打开它们。虽然少数教师可能会利用LaTeX打字系统制作电子文档，这是解决上述问题的好方法，但在中国尚未得到广泛应用。
本文介绍了基于Markdown的文本处理。 数学符号和数字可以方便地插入纯文本中。 MD文件可以转换成许多不同的格式，更适合在网上发布。 除了这些优点之外，任何人都可以在十分钟内学习Markdown，并在练习过程中掌握它。
Markdown是一种轻量级标记语言，它使用纯文本格式化语法进行设计，以便将其转换为HTML和许多其他格式[2,3]。减价通常有两种方法。一个是语法;另一个是转换工具。 Markdown的关键设计目标是可读性。 Markdown格式的文档应该可以按照原样发布，不会看起来像标签或格式化指令。因此，Markdown在计算机社会中首次受到欢迎，并且常常用于格式化自述文件，以便在在线讨论论坛中撰写消息。例如，着名的WordPress和Github支持Markdown。
到目前为止，还没有明确定义的Markdown标准。许多实现通过添加原始版本[3]中未提供的功能（如表格，脚注，定义列表，数学和Markdown内部的Markdown）来扩展Markdown。 Pandoc的Markdown增强版是典型的版本。由于这些扩展，减价可以作为编辑教材的好工具。
在本节中，在开始时引入了一点语法。事实上，只有使用标题和列表标记，我们才能写出一般的文章，而不再考虑格式。
Markdown中有三种符号。 它们是普通的标记，空白和特殊段标记。
有三个普通标记，星号，加号和连字符（*， ， - ）。 这三个标记是可以互换的。 当然，保持文件的一致性是一个好习惯。
在一行的末尾出现两个空格意味着返回。 一个或多个空白行用于将一个段落与另一个段落分开。
在常规段落中，您可以通过在反引号引号（``）中包装文本来创建代码段。指定整个预格式化代码块; 用4个空格或1个选项卡缩进块的每一行。
一张纸的结构可以通过分层头来呈现。 不同层次中的标题用不同的字体或字大小来区分。 Markdown提供了两种标题：Setext和atx。 lt;h1gt;和lt;h2gt;的Setext风格标题分别由“下划线”和等号（=）和连字符（ - ）创建。 要创建一个atx风格的头文件，您需要在行的开头放置1-6个散列标记（＃） - 散列数等于生成的HTML标头级别。el
无序列表使用任何一个基本符号作为列表标记。 有序列表使用常规数字，后面使用句点作为列表标记。 嵌套列表也受支持
标有Markdown的文档名称通常以.MD结尾。 它仍然是一个纯文本文件。 因此，几乎所有的文本编辑器都可以用来制作MD文件。 有专门设计的编辑器可以预览带有样式的文件，这些文件可以分为三类：常见的带markdown插件的目标编辑器，在线MD编辑器，特殊。
许多通用文本和代码编辑器（例如Vim，Sublime Text，Eclipse等）都内置Markdown的语法高亮插件，或者作为可选下载提供，这些插件相对太复杂了，除了具有编程背景的用户
在线编辑器和独立编辑器都可以使用并排预览窗口，或者尝试直接以所见即所得的方式呈现代码。 每位编辑都有不同的设计目标，并有自己的角色。 鉴于其跨平台，中文兼容性和可用性，建议使用Cmd Markdown和Haroopad。 要编辑富文本作为教材，它们都可用。
Cmd Markdown由zybuluo.com开发，可用作在线编辑器或离线客户端。 它具有许多功能，使编辑技术文档变得更加容易。 正如作者所说，“我们提供专业工具来记录思想和分享知识。”
Haroopad是一个托管在Github上的开源项目。 其目的是为互联网上的文件制作提供专业的工具。 它是一个跨平台的桌面应用程序。 与Cmd markdown相比，Haroopad的插入菜单中有许多基本的语法项目。 这对新手来说真的很有帮助。
与一般网络文章相比，除了结构清晰，格式好，跨平台兼容等特点外，工科学科教材的特点更为突出。 这些特征是：（1）大量难以输入文件的公式; （2）作为表格，图形和曲线嵌入文件中的各种对象; （3）文件中包含代码或引用的特殊段。 教材是富文本的典型代表。
处理数学公式是“WYSWYG”编辑的瓶颈。 用户不得不在键盘和鼠标之间移动，同时输入方程式，这导致低效率。 单词和公式出现在同一行中会更改行间距，这会破坏文件的格式。 编辑缺陷是网络教学系统无法吸引工程学科教师的原因之一[4]。
本文推荐的Cmd Markdown已经与MathJax集成，MathJax使用MathML，LaTeX和ASCII Math ML标记在Web浏览器中显示数学符号。 因此，作者可以编辑数学公式，而不用关心文件的格式。
一般来说，有两种公式。 一个是内联公式，写在段落中，如
在MD文件中，它们都是数学模式中的一串字符：\int^\infty_{-\infty}\frac{1}{\sqrt{2\pi}}e^{-\frac{(x-\mu)^2}{2\delta^2}}dx=1.
所谓的数学模式是起始字符和结束字符之间的一段文本。 关于开始和结束字符的定义，不同的MD编辑有其自己的选择。 例如，#39;$#39;用作Cmd Markdown的内联数学段的开始和结束，而明确的公式环境由两个“$$”构建。 Haroopad定义的“$$$”用于实现相同的功能。 所以我们必须阅读编辑手册才能获得详细信息。 当然，需要很多耐心来熟悉数学符号标记的任何一组语法。 在上述三种数学标记语言中，由美国数学学会支持的LaTeX的AMS数学包是事实上的标准[5]。 MathType是一种流行的可视化数学编辑器，它甚至提供了一种有用的功能，用于在LaTeX文本和OLE对象之间转换公式格式。 在这种工具的帮助下，掌握AMS数学软件包并不困难。
C.插入数字
在工程学科的教材中，数字是必要的。 Markdown插入数字的语法非常简单。
！[说明]（人物的位置）
当数字存储在图像托管网站时，数字的位置可能是URL。 当该数字存储在本地计算机上时，该位置将替换为具有完整路径的文件名。 通常相对路径更常见。
D.插入链接
在网站上发布的教材通常由多个页面组成，这些页面与链接相关。 使用Markdown将文本中的链接标记为“* [description]（URL）”。 要访问对象页面，请单击描述文本。
E.插入源代码
Markdown起源于计算机学会，为简化和优化页面中的代码提供了新的途径。 首先，源代码必须放入以“...”开始和结束的段中。 基于语言设置，语法高亮由解析器工具实现; 行号也可以添加。 这些功能对教学非常有帮助。 以下是Python编写的函数的一个简单示例。
F.高级建议
这是提高工作效率的有效途径
提高教材的可重用性。 所以富文本应该随着情况的变化而转换成不同的格式。 在课堂上，简单的讲义足以帮助学生关注关键点; 教师可以免费通过幻灯片写作黑板。 教师提供的详细电子教程可以下载为可读和可打印的文件，或者在课后在线浏览。 即使内容可以由学术论文或研究报告分享。 解决方案是通用文档转换器Pandoc，它是您的瑞士军刀[6]。
Pandoc是免费软件，在GPL下发布。任何人都可以从其官方网站下载。 Pandoc是一个用于将一种标记格式转换为另一种格式的Haskell库，也是使用该库的命令行工具。与大多数将Markdown转换为HTML的工具（使用正则表达式替换）相比，Pandoc具有模块化设计：它由一组阅读器组成，它们以给定格式解析文本并生成文档的本机表示，的作家，它将这种本地表示转换为目标格式。它可以读写数十种格式，并且可以扩展。但是，并非所有的谈话都是完美的。 Pandoc增强版Markdown，包括许多重要文档元素的语法，就是边界。 Pandoc尝试保留文档的结构元素，但不会格式化细节。从Pandoc的Markdown到所有格式的转换都渴望完美，从比Pandoc的Markdown更具表现力的格式转换可望成为损失。
当Pandoc用于生产最终产品时，其他辅助工具是必需的。 制作PDF或投影机幻灯片需要安装LaTeX引擎，并假定有些LaTeX软件包可用。 使用外部过滤器Pandoc-citeproc，Pandoc可以自动生成引用文献和多种样式的参考书目。 引用和输出样式的数据库可以从任何参考管理软件中导出。 Pandoc的作者使用不同的默认模板来格式化输出。 并且可以使用--template选项指定自定义模板。 以下是获取最终输出的典型命令行。
Pandoc -s paper.md -t docx -o paper.docx -filter Pandoc-citeproc -bibliography = library。 bib -csl = ieee.csl
Pandoc采用paper.md文件，参考书目的library.bib文件，并使用citeproc和ieee.csl文件格式化参考书目，并创建paper.docx文件。
V.总结
基于Markdown和专业编辑器，快速制作富文本教材而不关心文档格式是绝对有可能的。 并且该文档可以被Pandoc转换成许多流行的格式，例如HTML，PDF，EPUB等。 掌握Markdown对于提高工作效率非常有帮助。
引用
全文共5276字，剩余内容已隐藏，支付完成后下载完整资料
资料编号：[15345]，资料为PDF文档或Word文档，PDF文档可免费转换为Word
-
lt;
-
- 引言
- 什么是MARKDOWN
- 基本字符
- 普通标记
- 空白
- 特殊分段标记
- 头
- 表
- MARKDOWN编辑
- 教学材料的制作技巧。
- 工程学科教材的特点
- 插入数学公式
- Dawson L A P. Motivation and Cognitive Load in the Flipped Classroom: Definition, Rationale and a Call for Research, Higher Education Research amp; Development, vol.34 (1),pp.1-14, 2014.
- MarkDown, http://daringfireball.net/projects/markdown/
- MarkDown, https://en.wikipedia.org/wiki/Markdown.
- Misfeldt M, Sanne A. Formula Editors and Handwriting in Mathematical E-Learning, Teaching Mathematic Online Emergent and Technologies and Methodologies, pp.350-364, 2012.
- George Gratzer, More Math Into LaTeX(5th edition), Springer, 2016
- Pandoc, http://www.Pandoc.org
以上是毕业论文外文翻译，课题毕业论文、任务书、文献综述、开题报告、程序设计、图纸设计等资料可联系客服协助查找。
