Pandoc User's Guide
Total Page:16
File Type:pdf, Size:1020Kb
Load more
Recommended publications
-
The Types, Roles, and Practices of Documentation in Data Analytics Open Source Software Libraries
Computer Supported Cooperative Work (CSCW) https://doi.org/10.1007/s10606-018-9333-1 © The Author(s) 2018 The Types, Roles, and Practices of Documentation in Data Analytics Open Source Software Libraries A Collaborative Ethnography of Documentation Work R. Stuart Geiger1 , Nelle Varoquaux1,2 , Charlotte Mazel-Cabasse1 & Chris Holdgraf1,3 1Berkeley Institute for Data Science, University of California, Berkeley, 190 Doe Library, Berkeley, CA, 94730, USA (E-mail: [email protected]); 2Department of Statistics, Berkeley Institute for Data Science, University of California, Berkeley, Berkeley, CA, USA; 3Berkeley Institute for Data Science, Helen Wills Neuroscience Institute, University of California, Berkeley, Berkeley, CA, USA Abstract. Computational research and data analytics increasingly relies on complex ecosystems of open source software (OSS) “libraries” – curated collections of reusable code that programmers import to perform a specific task. Software documentation for these libraries is crucial in helping programmers/analysts know what libraries are available and how to use them. Yet documentation for open source software libraries is widely considered low-quality. This article is a collaboration between CSCW researchers and contributors to data analytics OSS libraries, based on ethnographic fieldwork and qualitative interviews. We examine several issues around the formats, practices, and challenges around documentation in these largely volunteer-based projects. There are many dif- ferent kinds and formats of documentation that exist around such libraries, which play a variety of educational, promotional, and organizational roles. The work behind documentation is similarly multifaceted, including writing, reviewing, maintaining, and organizing documentation. Different aspects of documentation work require contributors to have different sets of skills and overcome various social and technical barriers. -
Miktex Manual Revision 2.0 (Miktex 2.0) December 2000
MiKTEX Manual Revision 2.0 (MiKTEX 2.0) December 2000 Christian Schenk <[email protected]> Copyright c 2000 Christian Schenk Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the con- ditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another lan- guage, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation. Chapter 1: What is MiKTEX? 1 1 What is MiKTEX? 1.1 MiKTEX Features MiKTEX is a TEX distribution for Windows (95/98/NT/2000). Its main features include: • Native Windows implementation with support for long file names. • On-the-fly generation of missing fonts. • TDS (TEX directory structure) compliant. • Open Source. • Advanced TEX compiler features: -TEX can insert source file information (aka source specials) into the DVI file. This feature improves Editor/Previewer interaction. -TEX is able to read compressed (gzipped) input files. - The input encoding can be changed via TCX tables. • Previewer features: - Supports graphics (PostScript, BMP, WMF, TPIC, . .) - Supports colored text (through color specials) - Supports PostScript fonts - Supports TrueType fonts - Understands HyperTEX(html:) specials - Understands source (src:) specials - Customizable magnifying glasses • MiKTEX is network friendly: - integrates into a heterogeneous TEX environment - supports UNC file names - supports multiple TEXMF directory trees - uses a file name database for efficient file access - Setup Wizard can be run unattended The MiKTEX distribution consists of the following components: • TEX: The traditional TEX compiler. -
Tugboat, Volume 33 (2012), No. 1 53 TEX on Windows: Miktex Or TEX Live? Joseph Wright on Windows, There Are Two Actively-Develop
TUGboat, Volume 33 (2012), No. 1 53 TEX on Windows: MiKTEX or TEX Live? A reminder that MiKTEX and TEX Live are not the only choices. W32TEX (Kakuto, 2012) is popular Joseph Wright in the far east. As well as being a TEX system in On Windows, there are two actively-developed free its own right, it is the source of the Windows binar- TEX systems with similar coverage: MiKTEX (Schenk, ies for TEX Live, and TEX Live acquires more CJK 2011) and TEX Live (TEX Users Group, 2011). The support from it every year. For users focussed on good news is that there is a lot of similarity between ConTEXt, ConTEXt standalone (Pragma ADE, 2012) the two systems, so for most users both systems is probably the best way to go (it uses the W32TEX are equally usable, and (LA)TEX documents are port- binaries on Windows). There are also the commer- able between them. However, there are differences cial options, for example BaKoMa TEX (BaKoMa and depending on what you need these might be Soft., 2011) or PCTEX (Personal TEX, Inc., 2011). important. However, for most users it comes down to a choice between the ‘big two’. • The default settings install everything for TEX Live, but only a minimal set of packages for References MiKT X. MiKT X will then install extra pack- E E BaKoMa Soft. “BaKoMa T X 9.77”. ages ‘on the fly’, while T X Live does not (there E E http://www.bakoma-tex.com/, 2011. is a package to do that in TEX Live, but it is aimed at GNU/Linux users). -
The Gsemthesis Class∗
The gsemthesis class∗ Emmanuel Rousseaux [email protected] February 9, 2015 Abstract This article introduces the gsemthesis class for LATEX. The gsemthesis class is a PhD thesis template for the Geneva School of Economics and Management (GSEM), University of Geneva, Switzerland. The class provides utilities to easily set up the cover page, the front matter pages, the pages headers, etc. with respect to the official guidelines of the GSEM Faculty for writing PhD dissertations. This class is released under the LaTeX Project Public License version 1.3c. ∗This document corresponds to gsemthesis v0.9.4, dated 2015/02/09. 1 Contents 1 Introduction3 2 Usage 3 2.1 Requirements..................................3 2.2 Getting started.................................3 2.3 Configuring your editor to store files in UTF-8...............4 2.4 Writing the dissertation in French......................4 2.5 Configuring and printing the cover page...................4 2.6 Configuring and printing the front matter pages...............4 2.7 Introduction and conclusion..........................5 2.8 Bibliography..................................5 2.8.1 Configure TeXstudio to run biber...................5 2.8.2 Configure Texmaker to run biber...................5 2.8.3 Configure Rstudio/knitr to run biber.................5 2.8.4 Basic commands............................6 2.8.5 Using you own bibliography management configuration......6 2.9 Draft mode...................................6 2.10 Miscellaneous..................................6 3 Minimal working example7 4 Implementation8 4.1 Document properties..............................8 4.2 Colors......................................8 4.3 Graphics.....................................8 4.4 Link management................................9 4.5 Maths......................................9 4.6 Page headers management...........................9 4.7 Bibliography management........................... 10 4.8 Cover page.................................. -
What I Wish I Knew When Learning Haskell
What I Wish I Knew When Learning Haskell Stephen Diehl 2 Version This is the fifth major draft of this document since 2009. All versions of this text are freely available onmywebsite: 1. HTML Version http://dev.stephendiehl.com/hask/index.html 2. PDF Version http://dev.stephendiehl.com/hask/tutorial.pdf 3. EPUB Version http://dev.stephendiehl.com/hask/tutorial.epub 4. Kindle Version http://dev.stephendiehl.com/hask/tutorial.mobi Pull requests are always accepted for fixes and additional content. The only way this document will stayupto date and accurate through the kindness of readers like you and community patches and pull requests on Github. https://github.com/sdiehl/wiwinwlh Publish Date: March 3, 2020 Git Commit: 77482103ff953a8f189a050c4271919846a56612 Author This text is authored by Stephen Diehl. 1. Web: www.stephendiehl.com 2. Twitter: https://twitter.com/smdiehl 3. Github: https://github.com/sdiehl Special thanks to Erik Aker for copyediting assistance. Copyright © 20092020 Stephen Diehl This code included in the text is dedicated to the public domain. You can copy, modify, distribute and perform thecode, even for commercial purposes, all without asking permission. You may distribute this text in its full form freely, but may not reauthor or sublicense this work. Any reproductions of major portions of the text must include attribution. The software is provided ”as is”, without warranty of any kind, express or implied, including But not limitedtothe warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authorsor copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, Arising from, out of or in connection with the software or the use or other dealings in the software. -
Not All Patterns, but Enough
Not All Patterns, But Enough Neil Mitchell, Colin Runciman York University Catch An Example • Is the following code safe?* risers :: Ord α→[α] → [[α]] risers [] = [] risers [x] = [[x]] risers (x:y:etc) = if x ≤ y then (x:s) : ss else [x] : (s : ss) where s:ss = risers (y : etc) > risers “Haskell” = [“Has”,“k”,“ell”] * Only people who haven’t seen this example in the paper! Using Catch > catch risers.hs Incomplete pattern on line 6 Program is safe • Catch is the associated implementation • Catch has proven the program is safe • Without any annotations The Pattern-Matching problem • Will a program crash when run? • May call error directly: error “doh!” • May call error indirectly: head [] • Partial pattern match: case False of True → 1 • GHC can warn on partial patterns • Catch conservatively checks a program will not crash at runtime • Even in the presence of partial patterns How Catch works First convert Haskell to first-order Core, using Yhc and Firstify Checker Exact Operates on first-order (ignoring laziness) Core language 3 constraint operators Constraint Language Conservative Describes a (possibly infinite) set of values Can replace constraint language Checker Terms • A constraint describes a set of values • x is a (:)-constructed value • A precondition is a constraint on arguments • In head x, x must be (:)-constructed • An entailment is a constraint on arguments to ensure a constraint on the result • If x is (:)-constructed, null x is False Checker Types • Opaque constraint type • data Constraint = … • Does an expression satisfy -
Haddock User Guide I
Haddock User Guide i Haddock User Guide Haddock User Guide ii Copyright © 2004 Simon Marlow Haddock User Guide iii COLLABORATORS TITLE : Haddock User Guide ACTION NAME DATE SIGNATURE WRITTEN BY Simon Marlow 2004-08-02 REVISION HISTORY NUMBER DATE DESCRIPTION NAME Haddock User Guide iv Contents 1 Introduction 1 1.1 Obtaining Haddock . .1 1.2 License . .2 1.3 Acknowledgements . .2 2 Invoking Haddock 3 2.1 Using literate or pre-processed source . .6 3 Documentation and Markup 7 3.1 Documenting a top-level declaration . .7 3.2 Documenting parts of a declaration . .8 3.2.1 Class methods . .8 3.2.2 Constructors and record fields . .8 3.2.3 Function arguments . .9 3.3 The module description . .9 3.4 Controlling the documentation structure . .9 3.4.1 Re-exporting an entire module . 10 3.4.2 Omitting the export list . 10 3.5 Named chunks of documentation . 11 3.6 Hyperlinking and re-exported entities . 11 3.7 Module Attributes . 12 3.8 Markup . 12 3.8.1 Paragraphs . 12 3.8.2 Special characters . 12 3.8.3 Character references . 13 3.8.4 Code Blocks . 13 3.8.5 Hyperlinked Identifiers . 13 3.8.6 Emphasis and Monospaced text . 13 3.8.7 Linking to modules . 14 3.8.8 Itemized and Enumerated lists . 14 3.8.9 Definition lists . 14 3.8.10 URLs . 14 3.8.11 Anchors . 14 Haddock User Guide v 4 Index 15 Abstract This document describes Haddock version 2.6.1, a Haskell documentation tool. Haddock User Guide 1 / 15 Chapter 1 Introduction This is Haddock, a tool for automatically generating documentation from annotated Haskell source code. -
A User's Guide to the Lout Document Formatting System
A User’s Guide to the Lout Document Formatting System Jeffrey H. Kingston Version 3.40 June 2013 Copyright 1991, 2013 Jeffrey H. Kingston, School of Information Technologies, The University of Sydney 2006, Australia. ISBN 0 86758 9515. Preface This User’s Guide brings together in one document everything needed for the day-to-day use of Version 3 of the Lout document formatting system. There are three other documents describing Lout: the Expert’s Guide [5], which you need if you want to add new features to Lout; a journal paper on the design and implementation of Lout [3]; and a set of overhead transparencies [4]that cover much the same ground as this Guide. These documents are all distributed with the software. Lout is distributed free of charge under the GNU Public License. The primary source is ftp://ftp.it.usyd.edu.au/jeff/lout containing a gzipped tar file of the current version, and various other things including a PostScript version of this guide. The distribution contains source code, libraries,documentation, license, and installation instructions. A mailing list has been set up for discussion of all topics related to Lout. To subscribe (or unsubscribe), visit http://lists.nongnu.org/mailman/listinfo/lout-users After subscribing, to post an item send email to [email protected]; it will be forwarded to all subscribers via email. There is also a web site at http://savannah.nongnu.org/projects/lout. Lout began in 1984 as a research project into the design of a high-level language for document formatting. -
Luametatex Reference Manual
LuaMetaTEX Reference Manual February 2021 Version 2.08.16 LuaMetaTEX Reference Manual copyright : LuaTEX development team :CONTEXT development team more info : www.luatex.org : contextgarden.net version : February 20, 2021 Contents Introduction 11 1 The internals 15 2 Differences with LUATEX 19 3 The original engines 25 3.1 The merged engines 25 3.1.1 The rationale 25 3.1.2 Changes from TEX 3.1415926... 25 3.1.3 Changes from 휀-TEX 2.2 26 3.1.4 Changes from PDFTEX 1.40 27 3.1.5 Changes from ALEPH RC4 28 3.1.6 Changes from standard WEB2C 28 3.2 Implementation notes 29 3.2.1 Memory allocation 29 3.2.2 Sparse arrays 29 3.2.3 Simple single-character csnames 29 3.2.4 Binary file reading 29 3.2.5 Tabs and spaces 30 3.2.6 Logging 30 3.2.7 Parsing 30 4 Using LUAMETATEX 33 4.1 Initialization 33 4.1.1 LUAMETATEX as a LUA interpreter 33 4.1.2 Other commandline processing 33 4.2 LUA behaviour 35 4.2.1 The LUA version 35 4.2.2 Locales 35 4.3 LUA modules 35 4.4 Testing 36 5 Basic TEX enhancements 37 5.1 Introduction 37 5.1.1 Primitive behaviour 37 5.1.2 Version information 37 5.2 UNICODE text support 38 5.2.1 Extended ranges 38 5.2.2 \Uchar 39 5.2.3 Extended tables 39 1 5.3 Attributes 41 5.3.1 Nodes 41 5.3.2 Attribute registers 42 5.3.3 Box attributes 42 5.4 LUA related primitives 44 5.4.1 \directlua 44 5.4.2 \luaescapestring 45 5.4.3 \luafunction, \luafunctioncall and \luadef 45 5.4.4 \luabytecode and \luabytecodecall 46 5.5 Catcode tables 47 5.5.1 Catcodes 47 5.5.2 \catcodetable 47 5.5.3 \initcatcodetable 47 5.5.4 \savecatcodetable 48 5.6 Tokens, commands -
GNU Texinfo Reference Card @Contents Print a Complete Table of Contents
GNU Texinfo Reference Card @contents Print a complete table of contents. Has no effect in Cross references (for Texinfo version 6.8) Info, which uses menus instead. Within the Info system http://www.gnu.org/software/texinfo/ Nodes @xref {node, [entry] , [node-title] , [info-file] , [manual] } Makes @node name Begin a new node. a reference that starts with ‘See’ in a printed manual. Follow Texinfo document skeleton command with punctuation. Only the first argument is @top title Mark the topmost @node in the file, which must be mandatory. Texinfo source files are plain text; standard extensions are defined on the line immediately preceding @top. The title is @pxref {node, [entry] , [node-title] , [info-file] , [manual] } Like ‘.texinfo’, ‘.texi’, and ‘.txi’. A Texinfo file must begin with formatted as a chapter-level heading. The entire top node, @xref, but starts with ‘see’ instead of ‘See’, and must be used lines like this: including the @node and @top lines, are normally enclosed with @ifnottex ... @end ifnottex. inside parentheses. \input texinfo @ref {node, [entry] , [node-title] , [info-file] , [manual] } Like @xref, @settitle name-of-manual @anchor {name} Define name as the current location, for use as a cross-reference target. but produces only the bare reference without ‘See’ or ‘see’; must ... be followed by a punctuation mark. the contents of the Texinfo document, ending with: @novalidate Suppress validation of node references and omit @bye creation of auxiliary files with T X. Use before @setfilename. @xrefautomaticsectiontitle on|off By default, use the section E title instead of the node name in cross references. Texinfo @-commands Chapter structuring Outside of Info Beginning a Texinfo document @lowersections Change subsequent chapters to sections, sections @url {url, [displayed-text] , [replacement] } Make a hyperlink to subsections, and so on. -
Haskhol: a Haskell Hosted Domain Specific Language for Higher-Order
HaskHOL: A Haskell Hosted Domain Specific Language for Higher-Order Logic Theorem Proving BY c 2011 Evan Christopher Austin Submitted to the graduate degree program in Electrical Engineering & Computer Science and the Graduate Faculty of the University of Kansas in partial fulfillment of the requirements for the degree of Master of Science. Chairperson Dr. Perry Alexander Dr. Andy Gill Dr. Arvin Agah Date Defended: July 26, 2011 The Thesis Committee for Evan Christopher Austin certifies that this is the approved version of the following thesis: HaskHOL: A Haskell Hosted Domain Specific Language for Higher-Order Logic Theorem Proving Chairperson Dr. Perry Alexander Date Approved: July 26, 2011 ii Abstract HaskHOL is an implementation of a HOL theorem proving capability in Haskell. Motivated by a need to integrate theorem proving capabilities into a Haskell-based tool suite, HaskHOL began as a simple port of HOL Light to Haskell. However, Haskell's laziness, immutable data, and monadic extensions both complicate an implementation and enable a new feature class. This thesis describes HaskHOL, its motivation and implementation. Its use to implement a primitive, interactive theorem prover is explored and its performance is evaluated using a collection of intuitionistically valid problems. iii Acknowledgements Dr. Perry Alexander has served as a constant inspiration, mentor, and friend since very early in my college career. His guidance and the myriad of opportunities he has afforded me have kindled a passion for formal methods research that I can honestly say I would not have had otherwise. Dr. Andy Gill was the first professor I had at KU who challenged me to go above and beyond what was required for a course. -
A Comparative Study of Methods for Bibliographies 290 Tugboat, Volume 32 (2011), No
TUGboat, Volume 32 (2011), No. 3 289 A comparative study of methods the features of these successive bibliography proces- for bibliographies sors. Finally, a synthesis is given in Section 3. As mentioned above, the present article only covers bib- Jean-Michel Hufflen liography processors used in conjunction with LATEX, Abstract it is complemented by [25] about bibliography proces- sors used in conjunction with ConTEXt [11], another First, we recall the successive steps of the task per- format built out of TEX. Reading this article only formed by a bibliography processor such as BibTEX. requires basic knowledge about LATEX and BibTEX. Then we sketch a brief history of the successive meth- Of course, the short descriptions we give hereafter ods and fashions of processing the bibliographies of do not aim to replace the complete documentation of (LA)T X documents. In particular, we show what is E the corresponding tools. Readers interested in typo- new in the LAT X 2 packages natbib, jurabib, and E " graphical conventions for bibliographies can consult biblatex. The problems unsolved or with difficult [4, Ch. 10] and [7, Ch. 15 & 16]. implementations are listed, and we show how other processors like Biber or Ml T X can help. Bib E 1 Tasks of a bibliography processor Keywords Bibliographies, bibliography proces- sors, bibliography styles, Tib, BibTEX, MlBibTEX, In this section, we summarise the tasks to be per- Biber, natbib package, jurabib package, biblatex pack- formed by a bibliography processor such as BibTEX. age, sorting bibliographies, updating bibliography Along the way, we give the terminology used through- database files.