DOCSLIB.ORG

(2017), No. 2 Using Markdown Inside TEX Documents Vít Novotný

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
(2017), No. 2 Using Markdown Inside TEX Documents Vít Novotný 214 TUGboat, Volume 38 (2017), No. 2 Using Markdown inside TEX documents Vít Novotný Abstract Markdown is a lightweight markup language that makes it easy to write structurally simple documents using a clean and straightforward syntax. Although various tools for rendering Markdown documents via TEX exist, they tend to be built on top of TEX rather than in TEX. This paper briefly presents existing tools and introduces a macro package for plain-based TEX for- mats that takes a different approach. By making it possible to put snippets of Markdown-formatted text into arbitrary TEX documents and exposing TEX macros that control the rendering of Markdown elements, the package provides a convenient way of introducing Markdown into existing TEX workflows. 1 Introduction TEX is a fine tool for typesetting many kinds of documents. It may, however, not always be the best language for writing them. Markup languages based on SGML and XML make it possible for an author to focus on the content of their documents without having to worry about the error messages produced by commands and unforeseen macro pack- age interactions. The resulting documents can then be transformed not only to various TEX formats, but also to other output formats that bear no relation to the TEX world. When preparing structurally simple documents, however, SGML and XML with their bulky syntax may feel too heavy-handed. For these kinds of docu- ments, lightweight markup languages that exchange raw expressive power for clean and simple syntax are often the best choice. In this paper, I will focus on the lightweight markup language of Markdown [2]. Although the language of Markdown was origi- nally envisioned as an HTML preprocessor, its syntax is agnostic to the output format, which makes Mark- down useful as a general document markup language. Tools that provide conversion from Markdown to various TEX formats are therefore readily available. One of the better-known free open-source programs that enable conversion from Markdown to TEX is Pandoc [4]. Dubbed a Swiss Army Knife by its author, Pandoc enables the conversion between an impressive number of markup languages (e.g. LATEX, ConTEXt, HTML, XML Docbook) and output for- mats (e.g. ODF, OOXML, or PDF). The tool has already been reviewed in TUGboat by Massimiliano Dominici [1]. Vít Novotný TUGboat, Volume 38 (2017), No. 2 215 Pandoc is a powerful multi-target publishing As a result, users are limited in their ability to use software and its ability to perform lossy conversions TEX inside their Markdown documents, but there is (such as from LATEX to HTML) makes it extremely still plenty of rope left for halts, crashes, and external useful for document manipulation in general. How- command execution. ever, if our sole goal is to use Markdown markup Another inconvenience of Pandoc is its lack of inside TEX documents, Pandoc displays several weak- integration with the TEX distributions. TEX docu- nesses. ments without external dependencies and written The ability to redefine the correspondence be- in stable formats such as plain TEX require virtu- tween Markdown elements in the input and TEX ally no maintenance. The use of external assets and macros in the output is limited. Processing the fol- actively developed formats such as ConTEXt will re- lowing Markdown document: quire some attention each time there is a major TEX - Single underlines/asterisks denote _emphasis_. distribution release. Software outside TEX distribu- - Double them for **strong emphasis**. tions such as Pandoc throws more variables into the - The *two* __may be__ _freely *mixed*_. mix, since different versions may produce different in Pandoc v1.17.2 using the command pandoc -f output even if the TEX distribution stays the same. Besides the trickier maintenance, Pandoc’s absence markdown -t latex produces the following LATEX document: from TEX distributions also means that it is unavail- able in major TEX services such as the collaborative \begin{itemize}\tightlist text editors at http://www.sharelatex.com/ and \item Single underlines/asterisks denote http://www.overleaf.com/. \emph{emphasis}. \item Double them for \textbf{strong emphasis}. Other major tools for rendering Markdown, such \item The \emph{two} \textbf{may be} as MultiMarkdown, were reviewed and found to be \emph{freely \emph{mixed}}. plagued by similar design choices. With this knowl- \end{itemize} edge, I decided to prepare a macro package for render- ing Markdown inside T X that would take a different While it is possible to redefine the produced LATEX E macros in theory, altering base macros such as \item approach. The goals were: or \textbf may break the document in subtle ways. • to make it easy to specify how individual Mark- The output is also not fixed and may vary between down elements should be rendered, different versions of Pandoc. • to provide sandboxing capabilities, and Another desirable feature is sandboxing. Mark- • to make sure that the package required nothing down is a static markup language without program- more than what was present in standard TEX ming capabilities and may be used by ordinary users distributions. without much training. If Markdown documents 2 The markdown.tex package are submitted to a system and then automatically typeset using TEX, then these documents should cer- 2.1 Architectural overview tainly not be able to crash or halt the compilation, The block diagram in figure 1 summarizes the high- or to execute external programs using the \write18 level structure of the package. Working from the command and similar mechanisms. Pandoc does not bottom of the diagram upwards, I will now describe offer much in these regards, since it permits TEX the individual layers. macros in the input Markdown documents. There The translation from Markdown to TEX is done exist complex rules for deciding whether or not an by the Lunamark Lua library [3]. The library was occurrence of a TEX special character should be kept modified, so that it would not depend on external or removed; the following document: libraries and so that it would produce an intermediate This {will} 2^n \begin{get} r~moved and \this plain TEX representation of the input Markdown {won’t} \begin{equation}2^n\end{equation}$2^n$. document. This means that instead of Pandoc’s TEX when converted with Pandoc becomes: representation (repeated here from the previous page for ease of reference), This \{will\} 2\^{}n \textbackslash{}begin\{% get\}r\textasciitilde{}moved and \this{won’t} \begin{itemize}\tightlist \begin{equation}2^n\end{equation} \(2^n\). \item Single underlines/asterisks denote \emph{emphasis}. Apparently, the aim is to enable the use of mathemat- \item Double them for \textbf{strong emphasis}. ics and simple TEX macros while retaining baseline \item The \emph{two} \textbf{may be} compatibility with standard Markdown documents \emph{freely \emph{mixed}}. that may contain portions resembling plain TEX. \end{itemize} Using Markdown inside TEX documents 216 TUGboat, Volume 38 (2017), No. 2 2.2 Usage examples User code This section contains examples for markdown.tex (ver- sion 2.5.3). These should give an idea of the capabil- ities of the package. The examples are in LATEX for ConTEXt layer LATEX layer ease of exposition. As noted in the previous section, the LATEX layer of the package is reasonably thin and the examples can therefore be easily adapted for the plain TEX and ConTEXt layers. For brevity, Plain TEX layer the examples will contain only the body of a LATEX document assuming the following preamble: \documentclass{article} Lua layer \usepackage{markdown,graphicx} To typeset the examples, you can use the lualatex or Figure 1: A block diagram of the package pdflatex -shell-escape commands. For further information, see the package documentation [5]. the library will produce the following representation: Sandboxing disables hybrid markup and is en- abled by default. As a result, the following example: \markdownRendererUlBeginTight \markdownRendererUlItem \begin{markdown} Single underlines/asterisks denote $\sqrt{x^2 + y^2}$ \markdownRendererEmphasis{emphasis}. \end{markdown} \markdownRendererUlItemEnd will produce $\sqrt{x^2 + y^2}$. To enable the use \markdownRendererUlItem of hybrid markup, the hybrid option needs to be Double them for specified. The following example: \markdownRendererStrongEmphasis{strong emphasis}. \begin{markdown*}{hybrid} \markdownRendererUlItemEnd $\sqrt{x^2 + y^2}$ \markdownRendererUlItem \end{markdown*} The \markdownRendererEmphasis{two} will produce px2 + y2 as expected. You may also \markdownRendererStrongEmphasis{may be} create a partial sandbox; the following example en- \markdownRendererEmphasis{freely ables the use of non-breaking spaces: \markdownRendererEmphasis{mixed}}. \begin{markdown*}{renderers={tilde=~}} \markdownRendererUlItemEnd Bartel~Leendert van~der~Waerden \markdownRendererUlEndTight \end{markdown*} This representation has two useful properties: it With hybrid markup, using underscores and works with any T X format that uses the same spe- E backticks may produce unexpected results. That is cials as plain T X does and it represents the logical E because Markdown uses underscores for emphasis structure of the input Markdown document in terms and backticks for inline verbatim text, whereas LAT X of macros that can be freely redefined by the user. E uses underscores for math subscripts and backticks The plain T X layer exposes the capabilities E for opening quotation marks. Preceding characters of the Lua library as T X macros and provides de- E with a backslash disables their special meaning in fault definitions for the \markdownRendererhNamei Markdown, as the following example shows: macros from the intermediary representation. Macro package developers are encouraged to redefine the \begin{markdown*}{hybrid} \markdownRendererhNameiPrototype macros that \‘\‘This is a quote with $a\_{subscript}$.’’ \end{markdown*} correspond to the default definitions. When the LuaTEX engine is used, the Lua library is accessed di- This, however, makes the text difficult to both read rectly. Otherwise, the shell escape (\write18) mech- and write. Alternatively, you can disable backticks anism is used (see [5, sec.
Load more

Recommended publications
  • Markdown: Syntax
    Markdown Syntax | Fall 2021-22 Markdown: Syntax ● Overview ❍ Philosophy ❍ Inline HTML ❍ Automatic Escaping for Special Characters ● Block Elements ❍ Paragraphs and Line Breaks ❍ Headers ❍ Blockquotes ❍ Lists ❍ Code Blocks ❍ Horizontal Rules ● Span Elements ❍ Links ❍ Emphasis ❍ Code ❍ Images ● Miscellaneous ❍ Backslash Escapes ❍ Automatic Links Overview Philosophy Markdown is intended to be as easy-to-read and easy-to-write as is feasible. Readability, however, is emphasized above all else. A Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions. While Markdown's syntax has been influenced by several existing text-to-HTML filters -- including Setext, atx, Textile, reStructuredText, Grutatext, and EtText -- the single biggest source of inspiration for Markdown's syntax is the format of plain text email. To this end, Markdown's syntax is comprised entirely of punctuation characters, which punctuation characters have been carefully chosen so as to look like what they mean. E.g., asterisks around a word actually look like *emphasis*. Markdown lists look like, well, lists. Even blockquotes look like quoted passages of text, assuming you've ever used email. Inline HTML Markdown's syntax is intended for one purpose: to be used as a format for writing for the web. Markdown is not a replacement for HTML, or even close to it. Its syntax is very small, corresponding only to a very small subset of HTML tags. The idea is not to create a syntax that makes it easier to insert HTML tags. In my opinion, HTML tags are already easy to insert.
    [Show full text]
  • Tinn-R Team Has a New Member Working on the Source Code: Wel- Come Huashan Chen
    Editus eBook Series Editus eBooks is a series of electronic books aimed at students and re- searchers of arts and sciences in general. Tinn-R Editor (2010 1. ed. Rmetrics) Tinn-R Editor - GUI forR Language and Environment (2014 2. ed. Editus) José Cláudio Faria Philippe Grosjean Enio Galinkin Jelihovschi Ricardo Pietrobon Philipe Silva Farias Universidade Estadual de Santa Cruz GOVERNO DO ESTADO DA BAHIA JAQUES WAGNER - GOVERNADOR SECRETARIA DE EDUCAÇÃO OSVALDO BARRETO FILHO - SECRETÁRIO UNIVERSIDADE ESTADUAL DE SANTA CRUZ ADÉLIA MARIA CARVALHO DE MELO PINHEIRO - REITORA EVANDRO SENA FREIRE - VICE-REITOR DIRETORA DA EDITUS RITA VIRGINIA ALVES SANTOS ARGOLLO Conselho Editorial: Rita Virginia Alves Santos Argollo – Presidente Andréa de Azevedo Morégula André Luiz Rosa Ribeiro Adriana dos Santos Reis Lemos Dorival de Freitas Evandro Sena Freire Francisco Mendes Costa José Montival Alencar Junior Lurdes Bertol Rocha Maria Laura de Oliveira Gomes Marileide dos Santos de Oliveira Raimunda Alves Moreira de Assis Roseanne Montargil Rocha Silvia Maria Santos Carvalho Copyright©2015 by JOSÉ CLÁUDIO FARIA PHILIPPE GROSJEAN ENIO GALINKIN JELIHOVSCHI RICARDO PIETROBON PHILIPE SILVA FARIAS Direitos desta edição reservados à EDITUS - EDITORA DA UESC A reprodução não autorizada desta publicação, por qualquer meio, seja total ou parcial, constitui violação da Lei nº 9.610/98. Depósito legal na Biblioteca Nacional, conforme Lei nº 10.994, de 14 de dezembro de 2004. CAPA Carolina Sartório Faria REVISÃO Amek Traduções Dados Internacionais de Catalogação na Publicação (CIP) T591 Tinn-R Editor – GUI for R Language and Environment / José Cláudio Faria [et al.]. – 2. ed. – Ilhéus, BA : Editus, 2015. xvii, 279 p. ; pdf Texto em inglês.
    [Show full text]
  • Why Scholars Should Write in Markdown
    A Why scholars should write in Markdown Stuart M. Shieber With few exceptions, scholars would be better off writing their papers in a lightweight markup format called Markdown, rather than using a word-processing program like Microsoft Word. This post explains why, and reveals a hidden agenda as well.1 MICROSOFT WORD IS NOT APPROPRIATE FOR SCHOLARLY ARTICLE PRODUCTION Before turning to lightweight markup, I review the problems with Microsoft Word as the lingua franca for producing scholarly articles. This ground has been heavily covered. (Here’s a recent example.) The problems include: Substantial learning curve. Microsoft Word is a complicated program that is difficult to use well. Appearance versus structure. Word-processing programs like Word conflate composition with typesetting. They work by having you specify how a document should look, not how it is structured. A classic example is section headings. In a typical markup language, you specify that something is a heading by marking it as a heading. In a word-processing program you might specify that something is a heading by increasing the font size and making it bold. Yes, Word has “paragraph styles”, and some people sometimes use them more or less properly, if you can figure out how. But most people don’t, or don’t do so consistently, and the resultant chaos has been well documented. It has led to a whole industry of people who specialize in massaging Word files into some semblance of consistency. Backwards compatibility. Word-processing program file formats have a tendency to change. Word itself has gone through multiple incompatible file formats in the last decades, one every couple of years.
    [Show full text]
  • Vnote Documentation Release 1.11.1
    VNote Documentation Release 1.11.1 Le Tan Feb 13, 2019 User Documentation 1 Why VNote 3 1.1 What is VNote..............................................3 1.2 Why Another Markdown Wheel.....................................3 2 Getting Started 5 2.1 Main Interface..............................................5 2.2 Ready To Go...............................................7 3 Build VNote 9 3.1 Get the Source Code of VNote......................................9 3.2 Get Qt 5.9................................................9 3.3 Windows.................................................9 3.4 Linux...................................................9 3.5 MacOS.................................................. 10 4 Notes Management 13 4.1 Notebook................................................. 13 4.2 Folders.................................................. 14 4.3 Notes................................................... 14 5 Snippet 15 5.1 Snippet Management........................................... 15 5.2 Define A Snippet............................................. 16 5.3 Apply A Snippet............................................. 16 5.4 Examples................................................. 16 6 Magic Word 19 6.1 Built-In Magic Words.......................................... 19 6.2 Custom Magic Words.......................................... 20 6.3 Magic Word In Snippet.......................................... 21 7 Template 23 8 Themes and Styles 25 8.1 Themes.................................................. 25 8.2 Editor Styles..............................................
    [Show full text]
  • OASIS Response to NSTC Request for Feedback on Standard Practices
    OASIS RESPONSE TO NSTC REQUEST FOR FEEDBACK ON STANDARDS PRACTICES OASIS (Organization for the Advancement of Structured Information Standards) is pleased to respond to the request from the National Science and Technology Council's Sub-Committee on Standards published at 75 FR 76397 (2010), and extended by 76 FR 3877 (2011), for feedback and observations regarding the effectiveness of Federal agencies' participation in the development and implementation of standards and conformity assessment activities and programs. We have advised our own members about the Federal Register inquiry, in case they wish to respond. Of course, their opinions are their own, and this response does not represent the views of any members, but only the observations of OASIS professional staff. I. RESPONDENT'S BACKGROUND OASIS is one of the largest and oldest global open data standards consortia, founded in 1993 as SGML Open. OASIS has over 5000 active participants representing about 600 member organizations and individual members in over 80 countries. We host widely-used standards in multiple fields including • cybersecurity & access control (such as WS-Security, SAML, XACML, KMIP, DSS & XSPA) [/1], • office documents and smart semantic documents (such as OpenDocument, DITA, DocBook & CMIS) [/2], and • electronic commerce (including SOA and web services, such as BPEL, ebXML, WS-ReliableMessaging & the WS-Transaction standards) [/3] among other areas. Various specific vertical industries also fulfill their open standards requirements by initiating OASIS projects, resulting in mission-specific standards such as • UBL and Business Document Exchange (for e-procurement) [/4], • CAP and EDML (for emergency first-responder notifications) [/5], and • LegalXML (for electronic court filing data)[/6].
    [Show full text]
  • Automated Software System for Checking the Structure and Format of Acm Sig Documents
    AUTOMATED SOFTWARE SYSTEM FOR CHECKING THE STRUCTURE AND FORMAT OF ACM SIG DOCUMENTS A THESIS SUBMITTED TO THE GRADUATE SCHOOL OF APPLIED SCIENCES OF NEAR EAST UNIVERSITY By ARSALAN RAHMAN MIRZA In Partial Fulfillment of the Requirements for The Degree of Master of Science in Software Engineering NICOSIA, 2015 ACKNOWLEDGEMENTS This thesis would not have been possible without the help, support and patience of my principal supervisor, my deepest gratitude goes to Assist. Prof. Dr. Melike Şah Direkoglu, for her constant encouragement and guidance. She has walked me through all the stages of my research and writing thesis. Without her consistent and illuminating instruction, this thesis could not have reached its present from. Above all, my unlimited thanks and heartfelt love would be dedicated to my dearest family for their loyalty and their great confidence in me. I would like to thank my parents for giving me a support, encouragement and constant love have sustained me throughout my life. I would also like to thank the lecturers in software/computer engineering department for giving me the opportunity to be a member in such university and such department. Their help and supervision concerning taking courses were unlimited. Eventually, I would like to thank a man who showed me a document with wrong format, and told me “it will be very good if we have a program for checking the documents”, however I don’t know his name, but he hired me to start my thesis based on this idea. ii To Alan Kurdi To my Nephews Sina & Nima iii ABSTRACT Microsoft office (MS) word is one of the most commonly used software tools for creating documents.
    [Show full text]
  • Markdown-Memo Example Document
    DRAFT: August 28, 2021. Please do not cite without permission. EXAMPLE-DOC-000 markdown-memo example document: make writing easier and more productive Ryan Reece∗ Jane Coauthor† August 28, 2021 This is an example document discussing and demonstrating how to use the markdown- memo package, meant to aid quick development of quality html and pdf documents from simple Markdown markup. Markdown-memo is developed by Ryan Reece at https://github.com/rreece/markdown-memo. Keywords: academic writing, blogging, digital humanities, LaTeX, Markdown, open publishing, open science, productivity, technical writing, typesetting, writing Contents 1 Introduction3 1.1 What this is for . .3 1.2 How it works . .3 2 Getting started4 2.1 Checking-out the template . .4 2.2 Requirements . .4 2.3 Starting a page or section . .5 2.4 Going from there . .5 2.5 Building your document . .6 3 Markdown basics6 3.1 Sections . .7 3.2 Lists . .7 3.3 Blocks . .8 3.4 Fonts . 10 3.5 Links and labels . 10 3.6 Footnotes . 11 4 Bibliographies 12 4.1 Making a bibliography . 12 ∗University of California, Santa Cruz / [email protected] / http://rreece.github.io †Joe University, Joeville / [email protected] / http://jane.joe.edu © 2015-2021 Ryan Reece. Licensed for sharing under CC-BY-4.0. 4.2 Doing citations . 12 5 Mathematical expressions 13 5.1 Typesetting math . 13 5.2 Mathjax . 15 6 Floats, Figures, and Tables 15 6.1 Figures . 15 6.2 Tables . 17 6.3 Table of contents per html page . 19 6.4 Clickmore . 19 6.5 PlotTable .
    [Show full text]
  • Markdown & Github
    Markdown & GitHub CSCI 5828: Foundations of Software Engineering Lecture 3 — 09/01/2015 © Kenneth M. Anderson, 2015 1 Lecture Goals • Present a brief introduction to Markdown and GitHub • Present examples of the types of presentations I want you to create © Kenneth M. Anderson, 2015 2 Purpose: Getting Ready for the Presentations • I’m asking that all presentations this semester be uploaded to GitHub • That means you need to be comfortable with the following technologies • git • Markdown • GitHub • Last Thursday and today, I presented an introduction to git • Now, let’s continue and learn about Markdown and GitHub • I will then bring it all together and show you some example presentations © Kenneth M. Anderson, 2015 3 Markdown • Markdown is a mark-up language created by John Gruber in 2004. • The spec has been available from his website, Daring Fireball, ever since • <http://daringfireball.net/projects/markdown/> • He describes it like this: • Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML). • Thus, “Markdown” is two things: (1) a plain text formatting syntax; and … • The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
    [Show full text]
  • R Markdown Cheat Sheet I
    1. Workflow R Markdown is a format for writing reproducible, dynamic reports with R. Use it to embed R code and results into slideshows, pdfs, html documents, Word files and more. To make a report: R Markdown Cheat Sheet i. Open - Open a file that ii. Write - Write content with the iii. Embed - Embed R code that iv. Render - Replace R code with its output and transform learn more at rmarkdown.rstudio.com uses the .Rmd extension. easy to use R Markdown syntax creates output to include in the report the report into a slideshow, pdf, html or ms Word file. rmarkdown 0.2.50 Updated: 8/14 A report. A report. A report. A report. A plot: A plot: A plot: A plot: Microsoft .Rmd Word ```{r} ```{r} ```{r} = = hist(co2) hist(co2) hist(co2) ``` ``` Reveal.js ``` ioslides, Beamer 2. Open File Start by saving a text file with the extension .Rmd, or open 3. Markdown Next, write your report in plain text. Use markdown syntax to an RStudio Rmd template describe how to format text in the final report. syntax becomes • In the menu bar, click Plain text File ▶ New File ▶ R Markdown… End a line with two spaces to start a new paragraph. *italics* and _italics_ • A window will open. Select the class of output **bold** and __bold__ you would like to make with your .Rmd file superscript^2^ ~~strikethrough~~ • Select the specific type of output to make [link](www.rstudio.com) with the radio buttons (you can change this later) # Header 1 • Click OK ## Header 2 ### Header 3 #### Header 4 ##### Header 5 ###### Header 6 4.
    [Show full text]
  • JSON Application Programming Interface for Discrete Event Simulation Data Exchange
    JSON Application Programming Interface for Discrete Event Simulation data exchange Ioannis Papagiannopoulos Enterprise Research Centre Faculty of Science and Engineering Design and Manufacturing Technology University of Limerick Submitted to the University of Limerick for the degree of Master of Engineering 2015 1. Supervisor: Prof. Cathal Heavey Enterprise Research Centre University of Limerick Ireland ii Abstract This research is conducted as part of a project that has the overall aim to develop an open source discrete event simulation (DES) platform that is expandable, and modular aiming to support the use of DES at multi-levels of manufacturing com- panies. The current work focuses on DES data exchange within this platform. The goal of this thesis is to develop a DES exchange interface between three different modules: (i) ManPy an open source discrete event simulation engine developed in Python on the SimPy library; (ii) A Knowledge Extraction (KE) tool used to populate the ManPy simulation engine from shop-floor data stored within an Enterprise Requirements Planning (ERP) or a Manufacturing Execution System (MES) to allow the potential for real-time simulation. The development of the tool is based on R scripting language, and different Python libraries; (iii) A Graphical User Interface (GUI) developed in JavaScript used to provide an interface in a similar manner to Commercial off-the-shelf (COTS) DES tools. In the literature review the main standards that could be used are reviewed. Based on this review and the requirements above, the data exchange format standard JavaScript Object Notation (JSON) was selected. The proposed solution accom- plishes interoperability between different modules using an open source, expand- able, and easy to adopt and maintain, in an all inclusive JSON file.
    [Show full text]
  • Preparing Teaching Materials for Engineering Disciplines with Markdown
    2nd International Conference on Social Science and Higher Education (ICSSHE 2016) Preparing Teaching Materials for Engineering Disciplines with Markdown Tuoxin Jiang Xueying Liu Faculty of Foreign Languages and Cultures Faculty of Electric Power Engineering Kunming University of Science and Technology Kunming University of Science and Technology Yunnan, PR China Yunnan, PR China [email protected] [email protected] * Lan Tang Faculty of Electric Power Engineering Kunming University of Science and Technology Yunnan, PR China [email protected] Abstract—In the digital age, teachers in engineering inserted into the plain text conveniently. The MD files could be disciplines must pay more attention to the preparation of converted to many different formats, and more suitable to be teaching materials than before. However, their work efficiency is posted on the net. Besides these advantages, anyone could limited by words processing because of the complexity of learn Markdown in ten minutes and master it during the course teaching materials that consist of text, equations, figures, etc. A of practice. 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. II. WHAT MARKDOWN IS Markdown is a lightweight markup language with plain text Keywords—teaching materials, markup language, Markdown, formatting syntax designed so that it can be converted to Pandoc, efficiency HTML and many other formats [2,3]. Markdown usually has two means. One is the syntax; the other is the converting tool. I. INTRODUCTION The key design goal of Markdown is readability. A Markdown- formatted document should be publishable as-is, as plain text, With the development of network technology and the without looking like it’s been marked up with tags or changing of teaching theory, engineering courses in colleges formatting instructions.
    [Show full text]
  • Using Css to Style the Pdf Output
    Oxygen Markdown Support Alex Jitianu, Syncro Soft [email protected] @AlexJitianu © 2020 Syncro Soft SRL. All rights reserved. Oxygen Markdown Support Agenda • Markdown – the markup language • Markdown editing experience in Oxygen • Markdown and DITA working together • Validation and check for completeness (Quality Assurance) Oxygen Markdown Support What is Markdown? • Easy to learn Create a Google account ============ • Minimalistic How to create or set up your **Google Account** on • your mobile phone. Many authoring tools available * From a Home screen, swipe up to access Apps. • Publishing tools * Tap **Settings** > **Accounts** * Tap **Add account** > **Google**. Oxygen Markdown Support Working with Markdown • Templates • Editing and toolbar actions (GitHub Flavored Markdown) • HTML/DITA/XDITA Preview • Export actions • Oxygen XML Web Author Oxygen Markdown Support DITA-Markdown hybrid projects • Main documentation project written in DITA • SME(s) (developers) contribute content in Markdown Oxygen Markdown Support What is DITA? • DITA is an XML-based open standard • Semantic markup • Strong reuse concepts • Restrictions and specializations • Huge ecosystem of publishing choices Oxygen Markdown Support Using specific DITA concepts in Markdown • Metadata • Specialization types • Titles and document structure • Image and key references • https://github.com/jelovirt/dita-ot-markdown/wiki/Syntax- reference Oxygen Markdown Support What is Lightweight DITA? • Lightweight DITA is a proposed standard for expressing simplified DITA
    [Show full text]