97
views
0
recommends
+1 Recommend
2 collections
    1
    shares
      • Record: found
      • Abstract: found
      • Article: found
      Is Open Access

      Formatting Open Science: agilely creating multiple document formats for academic manuscripts with Pandoc Scholar

      research-article
        1 , 2 ,
      PeerJ Computer Science
      PeerJ Inc.
      Open science, Markdown, Latex, Publishing, Typesetting, Document formats

      Read this article at

      ScienceOpenPublisher
      Bookmark
          There is no author summary for this article yet. Authors can add summaries to their articles on ScienceOpen to make them more accessible to a non-specialist audience.

          Abstract

          The timely publication of scientific results is essential for dynamic advances in science. The ubiquitous availability of computers which are connected to a global network made the rapid and low-cost distribution of information through electronic channels possible. New concepts, such as Open Access publishing and preprint servers are currently changing the traditional print media business towards a community-driven peer production. However, the cost of scientific literature generation, which is either charged to readers, authors or sponsors, is still high. The main active participants in the authoring and evaluation of scientific manuscripts are volunteers, and the cost for online publishing infrastructure is close to negligible. A major time and cost factor is the formatting of manuscripts in the production stage. In this article we demonstrate the feasibility of writing scientific manuscripts in plain markdown (MD) text files, which can be easily converted into common publication formats, such as PDF, HTML or EPUB, using Pandoc. The simple syntax of Markdown assures the long-term readability of raw files and the development of software and workflows. We show the implementation of typical elements of scientific manuscripts—formulas, tables, code blocks and citations—and present tools for editing, collaborative writing and version control. We give an example on how to prepare a manuscript with distinct output formats, a DOCX file for submission to a journal, and a LATEX/PDF version for deposition as a PeerJ preprint. Further, we implemented new features for supporting ‘semantic web’ applications, such as the ‘journal article tag suite’—JATS, and the ‘citation typing ontology’—CiTO standard. Reducing the work spent on manuscript formatting translates directly to time and cost savings for writers, publishers, readers and sponsors. Therefore, the adoption of the MD format contributes to the agile production of open science literature. Pandoc Scholar is freely available from https://github.com/pandoc-scholar.

          Related collections

          Most cited references37

          • Record: found
          • Abstract: not found
          • Article: not found

          Open access: The true cost of science publishing.

            Bookmark
            • Record: found
            • Abstract: not found
            • Article: not found

            ORCID: a system to uniquely identify researchers

              Bookmark
              • Record: found
              • Abstract: found
              • Article: found
              Is Open Access

              Software citation principles

              Software is a critical part of modern research and yet there is little support across the scholarly ecosystem for its acknowledgement and citation. Inspired by the activities of the FORCE11 working group focused on data citation, this document summarizes the recommendations of the FORCE11 Software Citation Working Group and its activities between June 2015 and April 2016. Based on a review of existing community practices, the goal of the working group was to produce a consolidated set of citation principles that may encourage broad adoption of a consistent policy for software citation across disciplines and venues. Our work is presented here as a set of software citation principles, a discussion of the motivations for developing the principles, reviews of existing community practice, and a discussion of the requirements these principles would place upon different stakeholders. Working examples and possible technical solutions for how these principles can be implemented will be discussed in a separate paper.
                Bookmark

                Author and article information

                Contributors
                Journal
                peerj-cs
                peerj-cs
                PeerJ Comput. Sci.
                PeerJ Computer Science
                PeerJ Comput. Sci.
                PeerJ Inc. (San Francisco, USA )
                2376-5992
                8 May 2017
                : 3
                : e112
                Affiliations
                [1 ]Pandoc Development Team , Berlin, Germany
                [2 ]Department of Biotechnology and Biochemistry, CINVESTAV Unidad Irapuato , Mexico
                Article
                cs-112
                10.7717/peerj-cs.112
                29d2f301-7441-41f9-afca-5e9f8346a564
                ©2017 Krewinkel and Winkler

                This is an open access article distributed under the terms of the Creative Commons Attribution License, which permits unrestricted use, distribution, reproduction and adaptation in any medium and for any purpose provided that it is properly attributed. For attribution, the original author(s), title, publication source (PeerJ Computer Science) and either DOI or URL of the article must be cited.

                History
                : 19 December 2016
                : 3 April 2017
                Funding
                Funded by: Consejo Nacional de Ciencia y Tecnología (CONACyT)
                Funded by: FRONTERAS 2015-2/814
                Funded by: Centro de Investigación y de Estudios Avanzados del Instituto Politécnico Nacional (CINVESTAV)
                The work was funded by the Consejo Nacional de Ciencia y Tecnología (CONACyT) Mexico, with the grant FRONTERAS 2015-2/814 and by institutional funding of the Centro de Investigación y de Estudios Avanzados del Instituto Politécnico Nacional (CINVESTAV). The funders had no role in study design, data collection and analysis, decision to publish, or preparation of the manuscript.
                Categories
                Human–Computer Interaction
                Computer Education
                Computer Networks and Communications
                Digital Libraries
                World Wide Web and Web Science

                Computer science
                Document formats,Latex,Publishing,Typesetting,Open science,Markdown
                Computer science
                Document formats, Latex, Publishing, Typesetting, Open science, Markdown

                Comments

                Excellent, clearly-written backgrounder on the rationale for authoring in open text formats (eg Markdown) and relying on Pandoc to handle layout (typesetting), rendering of citations and document metadata.

                2018-06-22 13:28 UTC
                +1

                Comment on this article