DOCSLIB.ORG

CS410: Documentation

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
CS410: Documentation CS410: Documentation W. Michael Petullo University of Wisconsin–La Crosse As of March 15, 2021 Documentation: FOSS Project Discussion ◮ What project did you select? ◮ What led you to select your project? Did you use any resources or websites to learn of entry-level work? ◮ How does the community surrounding your project seem to communicate? ◮ Have you talked to any members of your project’s community? How? ◮ What do you hope to contribute to your project? ◮ Did you encounter any surprises when you tried to build your project? ◮ What are you worried about? Documentation: README/README.md (Simple) ◮ Text remains the most basic documentation format ◮ There exist a number of markdown (a play on markup) syntax ◮ Markdown is lightweight and legible both as source and rendered === Underline for heading level one (or precede with #) --- Underline for heading level two (or precede with ##) **bold** Indicate text should be bold *bold* Indicate text should be italic > block quote Indicate block quote Pandoc will transform mark- * list item Bullet list item down into other formats, e.g., 1. list item Numbered list item pandoc -f markdown strict -t html f.md ‘code‘ Treat as programming code [link name](link URL) Insert link to external document Documentation: troff/man (Consistent) Legacy format used for manual pages .TH indicates title, date, and version .SH starts a section, such as NAME or SYNOPSIS .SS starts a subsection, such as Options .TP builds a name/value list, here used to indicate a list of options \fB sets the type to boldface \fI sets the type to italic \fR sets the type to Roman, which will cause it to be rendered differently than other text \fP restores the current font to the preceding font groff -Tascii -man hello.1 or man ./hello.1 Documentation: HTML (Accessible) HyperText Markup Language is the markup language of the web. <p>paragraph of text</p> <br/> <a href="http://www.flyn.org">text</a> Augmented by Cascading Style Sheets. 1 body { 2 background−color: blue; 3 } Sometimes generated dynamically in browser by JavaScript from server. Documentation: LATEX(Beautiful) Lecture notes in Flight Dynamics (Italian) \ documentclass { article } \ title {The Art of Computer Programming} \ author { Donald E. Knuth} \ begin {document} \ maketitle Hello , TEX world! \ end {document} Manage you document and team using Git! © Agostino De Marco Documentation: Doxygen and so on (Inline with Code) /∗! \ mainpage Index Page ∗ ◮ ∗ \ section intro s e c I n t r o Follow convention when writing ∗ comments, and Doxygen will extract ∗ This is the introduction. documentation ∗ ◮ Doxygen example: ∗ \ section install sec Install ∗ https://dbus.freedesktop.org/ doc/api/html/index.html ∗ \ subsection step1 1: ... ∗ ◮ Similar tools: gtk-doc (uses GObject ∗ etc ... introspection), Sphinx (Python) ∗/ Documentation: Assignments Graded Homework Aquinas troff due next Tuesday Reading Read Bernstein documents before Thursday; see if you can find details on the Internet about “crypto wars” and some of the things Bernstein mentions; you do not need to read all of the supporting communication between Bernstein and the US layers, but you should glance at some of it https://www.flyn.org/courses/cs410-2021-spring/schedule.
Load more

Recommended publications
  • Markdown Markup Languages What Is Markdown? Symbol
    Markdown What is Markdown? ● Markdown is a lightweight markup language with plain text formatting syntax. Péter Jeszenszky – See: https://en.wikipedia.org/wiki/Markdown Faculty of Informatics, University of Debrecen [email protected] Last modified: October 4, 2019 3 Markup Languages Symbol ● Markup languages are computer languages for annotating ● Dustin Curtis. The Markdown Mark. text. https://dcurt.is/the-markdown-mark – They allow the association of metadata with parts of text in a https://github.com/dcurtis/markdown-mark clearly distinguishable way. ● Examples: – TeX, LaTeX https://www.latex-project.org/ – Markdown https://daringfireball.net/projects/markdown/ – troff (man pages) https://www.gnu.org/software/groff/ – XML https://www.w3.org/XML/ – Wikitext https://en.wikipedia.org/wiki/Help:Wikitext 2 4 Characteristics Usage (2) ● An easy-to-read and easy-to-write plain text ● Collaboration platforms and tools: format that. – GitHub https://github.com/ ● Can be converted to various output formats ● See: Writing on GitHub (e.g., HTML). https://help.github.com/en/categories/writing-on-github – Trello https://trello.com/ ● Specifically targeted at non-technical users. ● See: How To Format Your Text in Trello ● The syntax is mostly inspired by the format of https://help.trello.com/article/821-using-markdown-in-trell o plain text email. 5 7 Usage (1) Usage (3) ● Markdown is widely used on the web for ● Blogging platforms and content management entering text. systems: – ● The main application areas include: Ghost https://ghost.org/
    [Show full text]
  • Using NROFF and TROFF
    Using NROFF and TROFF Part Number: 800-1755-10 Revision A, of 9 May 1988 UNIX is a registered trademark of AT&T. SunOS is a trademark of Sun Microsystems, Inc. Sun Workstation is a registered trademark of Sun Microsystems, Inc. Material in this manual comes from a number of sources: NrofflTroff User's Manual, Joseph F. Ossanna, Bell Laboratories, Murray Hill, New Jersey; A Troff Tutorial, Brian W. Kernighan, Bell Laboratories, Murray Hill, New Jersey; Typ­ ing Documents on the UNIXSystem: Using the -ms Macros with Troff and Nroff, M. E. Lesk, Bell Laboratories, Murray Hill, New Jersey; A Guide to Preparing Documents with -ms, M. E. Lesk, Bell Laboratories, Murray Hill, New Jersey; Document Formatting on UNIXUsing the -ms Macros, Joel Kies, University of California, Berkeley, California; Writing Papers with Nroff Using -me, Eric P. Allman, University of California, Berkeley; and Introducing the UNIXSystem, Henry McGilton, Rachel Morgan, McGraw-Hill Book Company, 1983. These materials are gratefully acknowledged. Copyright © 1987, 1988 by Sun Microsystems, Inc. This publication is protected by Federal Copyright Law, with all rights reserved. No part of this publication may be reproduced, stored in a retrieval system, translated, transcribed, or transmitted, in any form, or by any means manual, electric, electronic, electro-magnetic, mechanical, chemical, optical, or other­ wise, without prior explicit written permission from Sun Microsystems. Contents Chapter 1 Introduction . 1.1. nrof f andtrof f . Text Formatting Versus Word Processing TheEvolutionof nr of f andt ro f f Preprocessors and Postprocessors 1.2. tr of f, Typesetters, and Special-Purpose Formatters ............ 1.3.
    [Show full text]
  • Deployment of XML for Office Documents in Organizations
    JYVÄSKYLÄ LICENTIATE THESES IN COMPUTING 16 Eliisa Jauhiainen DeployPent of XML for OfÀFe DoFXPents in Organizations JYVÄSKYLÄ LICENTIATE THESES IN COMPUTING 16 Eliisa Jauhiainen Deployment of XML for Office Documents in Organizations UNIVERSITY OF JYVÄSKYLÄ JYVÄSKYLÄ 2014 Deployment of XML for Office Documents in Organizations JYVÄSKYLÄ LICENTIATE THESES IN COMPUTING 16 Eliisa Jauhiainen Deployment of XML for Office Documents in Organizations UNIVERSITY OF JYVÄSKYLÄ JYVÄSKYLÄ 2014 Editor Mauri Leppänen Department of Computer Science and Information Systems, University of Jyväskylä URN:ISBN:978-951-39-5600-4 ISBN 978-951-39-5600-4 (PDF) ISBN 978-951-39-5599-1 (nid.) ISSN 1795-9713 Copyright © 2014, by University of Jyväskylä Jyväskylä University Printing House, Jyväskylä 2014 ABSTRACT Jauhiainen, Eliisa Deployment of XML for office documents in organizations Jyväskylä: University of Jyväskylä, 201, 63 p. (+ four included articles) (-\YlVN\Ol/LFHQWLDWH7KHVHVLQ&RPSXWLQJ ISSN) ,6%1 (nid.), 978-951-39-5600-4 (PDF) Licentiate Thesis Majority of the content in organizations is stored as documents. Structured documents, like XML documents, allow the structure definitions, document instances, and layout specifications to be handled as separate entities. This is an important feature to realize from a document management point of view. A class of similar documents with the same structure constitutes a document type. The documents are built from components that are logical units of information within the context of the document type. Office documents are typically authored using word-processing software, they are relatively short in length, and intended for human consumption. The development of open office standards brought XML to organizations’ office en- vironments and changed the capabilities of using document content in ways that were previously impossible or difficult.
    [Show full text]
  • Looking to the Future by JOHN BALDWIN
    1 of 3 Looking to the Future BY JOHN BALDWIN FreeBSD’s 13.0 release delivers new features to users and refines the workflow for new contri- butions. FreeBSD contributors have been busy fixing bugs and adding new features since 12.0’s release in December of 2018. In addition, FreeBSD developers have refined their vision to focus on FreeBSD’s future users. An abbreviated list of some of the changes in 13.0 is given below. A more detailed list can be found in the release notes. Shifting Tools Not all of the changes in the FreeBSD Project over the last two years have taken the form of patches. Some of the largest changes have been made in the tools used to contribute to FreeBSD. The first major change is that FreeBSD has switched from Subversion to Git for storing source code, documentation, and ports. Git is widely used in the software industry and is more familiar to new contribu- tors than Subversion. Git’s distributed nature also more easily facilitates contributions from individuals who are Not all of the changes in the not committers. FreeBSD had been providing Git mir- rors of the Subversion repositories for several years, and FreeBSD Project over the last many developers had used Git to manage in-progress patches. The Git mirrors have now become the offi- two years have taken the form cial repositories and changes are now pushed directly of patches. to Git instead of Subversion. FreeBSD 13.0 is the first release whose sources are only available via Git rather than Subversion.
    [Show full text]
  • Interface Specification – Archive Content Services
    gSPECIFICATION REV. 484-0200155 F5 NCR Corporation Image & Payment Systems 50 Northland Road Unit 100 Waterloo, Ontario N2V1 N3 PROGRAM: ImageMark Archive 5.1 TITLE: Interface Specification – Archive Content Services DATE: December 7, 2016 RELEASE: Draft SOURCE ORGANIZATION: Solutions Architecture Prepared By: Peter Robinson, Solutions Architecture Date Approved By: Judy Sandison, Manager, Solutions Architecture Date Copyright © 2016 by NCR Corporation, Duluth, Georgia, USA. All rights reserved. SPECIFICATION REV. 484-0200155 F5 NCR Corporation Image & Payment Systems 50 Northland Road Unit 100 Waterloo, Ontario N2V1 N3 PROGRAM: ImageMark Archive 5.1 TITLE: Interface Specification – Archive Content Services DATE: December 7, 2016 RELEASE: Draft SOURCE ORGANIZATION: Solutions Architecture Copyright © 2016 by NCR Corporation, Duluth, Ohio, USA. All rights reserved. ImageMark Archive 4.01 484-0200155, Rev F13 Interface Specification – Archive Content Services Page 3 of 62 CHANGE SHEET Rev Date Section Description of Change By A 06/13/2003 All Initial Release – 53DR25561 Peter Robinson B 09/03/2003 All Change Release – 53DR25690 Peter Robinson C 11/30/2003 All Change Release – 53DR25905 Peter Robinson D 10/28/2004 All Change Release – 53DR26456 Peter Robinson E 02/16/2005 All Change Release – 53DR24994 F1 06/01/2005 Peter Robinson F All Change Rev.F is a copy of draft Rev.Fn Peter Robinson F All Released on 53DRnnnnn Peter Robinson F2 03/28/2006 6.2 Added error codes for Fill element F3 09/22/2014 All Updated 5.1 Release Information Saurabh Patel F4 10/17/2016 6, 7, 12 New sections Anjali Phatak F5 11/18/2016 13 New section - FAQs Anjali Phatak NCR Corporation December 7, 2016 ImageMark Archive 4.01 484-0200155, Rev F13 Interface Specification – Archive Content Services Page 4 of 62 TABLE OF CONTENTS 1.
    [Show full text]
  • 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.
    [Show full text]
  • Triroff, an Adaptation of the Device-Independent Troff for Formatting Tri-Directional Text
    ELECTRONIC PUBLISHING, VOL . 2(3), 119±142 (OCTOBER 1989) triroff, an adaptation of the device-independent troff for formatting tri-directional text ( K9J+ דניאל ברי) 69K ) AND DANIEL BERRY זאב בקר) ZEEV BECKER 9 T Computer Science Department Technion , Haifa 32000 N , Israel X SUMMARY This paper describes a system for formatting documents consisting of text written in languages printed in three different directions, left-to-right, right-to-left, and top-to-bottom. For example, this paper is such a document because it contains text written in English, Hebrew, Japanese, and Chinese. The system assumes that the input is in the order in which the text is read aloud, and it produces output in which each language is printed in its own correct direction, but for which a human cognizant of the reading conventions will reproduce the input order. The system consists of three major pieces of software: Ossana and Kernighan's ditroff for formatting text consisting of only left-to-right or unidirectional text, Buchman and Berry's ffortid for rearranging right-to-left language text occurring in ditroff output to be printed from right to left, and a new program bditroff for rearranging top-to- bottom text occurring in ditroff output to be printed from top to bottom. Below are translations of this English language abstract, except for this paragraph, into Hebrew, Japanese, and Chinese. The latter two are each printed twice, once in a modern left- to-right style, and once in a more traditional top-to-bottom style. The software described in this paper was used to format and typeset this paper.
    [Show full text]
  • Unix Programmer's Manual
    There is no warranty of merchantability nor any warranty of fitness for a particu!ar purpose nor any other warranty, either expressed or imp!ied, a’s to the accuracy of the enclosed m~=:crials or a~ Io ~helr ,~.ui~::~::.j!it’/ for ~ny p~rficu~ar pur~.~o~e. ~".-~--, ....-.re: " n~ I T~ ~hone Laaorator es 8ssumg$ no rO, p::::nS,-,,.:~:y ~or their use by the recipient. Furln=,, [: ’ La:::.c:,:e?o:,os ~:’urnes no ob~ja~tjon ~o furnish 6ny a~o,~,,..n~e at ~ny k:nd v,,hetsoever, or to furnish any additional jnformstjcn or documenta’tjon. UNIX PROGRAMMER’S MANUAL F~ifth ~ K. Thompson D. M. Ritchie June, 1974 Copyright:.©d972, 1973, 1974 Bell Telephone:Laboratories, Incorporated Copyright © 1972, 1973, 1974 Bell Telephone Laboratories, Incorporated This manual was set by a Graphic Systems photo- typesetter driven by the troff formatting program operating under the UNIX system. The text of the manual was prepared using the ed text editor. PREFACE to the Fifth Edition . The number of UNIX installations is now above 50, and many more are expected. None of these has exactly the same complement of hardware or software. Therefore, at any particular installa- tion, it is quite possible that this manual will give inappropriate information. The authors are grateful to L. L. Cherry, L. A. Dimino, R. C. Haight, S. C. Johnson, B. W. Ker- nighan, M. E. Lesk, and E. N. Pinson for their contributions to the system software, and to L. E. McMahon for software and for his contributions to this manual.
    [Show full text]
  • Lilypond Informations Générales
    LilyPond Le syst`eme de notation musicale Informations g´en´erales Equipe´ de d´eveloppement de LilyPond Copyright ⃝c 2009–2020 par les auteurs. This file documents the LilyPond website. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections. A copy of the license is included in the section entitled “GNU Free Documentation License”. Pour LilyPond version 2.21.82 1 LilyPond ... la notation musicale pour tous LilyPond est un logiciel de gravure musicale, destin´e`aproduire des partitions de qualit´e optimale. Ce projet apporte `al’´edition musicale informatis´ee l’esth´etique typographique de la gravure traditionnelle. LilyPond est un logiciel libre rattach´eau projet GNU (https://gnu. org). Plus sur LilyPond dans notre [Introduction], page 3, ! La beaut´epar l’exemple LilyPond est un outil `ala fois puissant et flexible qui se charge de graver toutes sortes de partitions, qu’il s’agisse de musique classique (comme cet exemple de J.S. Bach), notation complexe, musique ancienne, musique moderne, tablature, musique vocale, feuille de chant, applications p´edagogiques, grands projets, sortie personnalis´ee ainsi que des diagrammes de Schenker. Venez puiser l’inspiration dans notre galerie [Exemples], page 6, 2 Actualit´es ⟨undefined⟩ [News], page ⟨undefined⟩, ⟨undefined⟩ [News], page ⟨undefined⟩, ⟨undefined⟩ [News], page ⟨undefined⟩, [Actualit´es], page 103, i Table des mati`eres
    [Show full text]
  • Lilypond Allgemeine Information
    LilyPond Das Notensatzsystem Allgemeine Information Das LilyPond-Entwicklungsteam Copyright ⃝c 2009–2020 by the authors. Diese Datei dokumentiert den Internetauftritt von LilyPond. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections. A copy of the license is included in the section entitled “GNU Free Documentation License”. F¨ur LilyPond Version 2.22.1 1 LilyPond ... Notensatz f¨ur Jedermann LilyPond ist ein Notensatzsystem. Das erkl¨arte Ziel ist es, Notendruck in bestm¨oglicher Qua- lit¨atzu erstellen. Mit dem Programm wird es m¨oglich, die Asthetik¨ handgestochenen traditio- nellen Notensatzes mit computergesetzten Noten zu erreichen. LilyPond ist Freie Software und Teil des GNU-Projekts (https://gnu.org). Lesen Sie mehr in der [Einleitung], Seite 3! Sch¨oner Notensatz LilyPond ist ein sehr m¨achtiges und flexibles Werkzeug, das Notensatz unterschiedlichster Art handhaben kann: zum Beispiel klassische Musik (wie in diesem Beispiel von J. S. Bach), komplexe Notation, Alte Musik, moderne Musik, Tabulatur, Vokalmusik, Popmusik, Unterrichts- materialien, große Orchesterpartituren, individuelle L¨osungen und sogar Schenker-Graphen. Sehen Sie sich unsere [Beispiele], Seite 6, an und lassen sich inspirieren! 2 Neuigkeiten ⟨undefined⟩ [News], Seite ⟨undefined⟩, ⟨undefined⟩ [News], Seite ⟨undefined⟩, ⟨undefined⟩ [News], Seite ⟨undefined⟩, i Inhaltsverzeichnis Einleitung..................................................
    [Show full text]
  • Markup 101: Markup Basics Cynthia Zender, SAS Institute, Inc., Cary, NC
    Paper TU12 Markup 101: Markup Basics Cynthia Zender, SAS Institute, Inc., Cary, NC ABSTRACT Do you want to know what this "Markup" buzz is all about? Does it surprise you to know that the concept of "marking up" text for computers has been around since 1969? So what's all the excitement about? And what does SAS have to do with it? INTRODUCTION This paper provides an introduction to the concept of markup through concrete examples. The types of markup files which the author will discuss include: HTML, RTF, comma-delimited, tab-delimited, SYLK, WML, troff, LaTeX, Docbook, SGML and, yes, XML. We will compare the development of markup specifications with the development of WYSIWYG tools using a timeline of milestone development events. By the end of the presentation, you'll not only understand what the buzz is all about, you'll also understand how SAS can produce markup files and what kind of markup is possible. You will also receive a checklist of questions to ask at your company to help you figure out where to go next with markup and SAS. WHAT IS MARKUP? The concept of "markup" is as simple as a teacher with a red pencil "marking up" a student's paper or a copyeditor "marking up" page proofs with editing symbols. The key to making "markup" work is that the person marking up the content and the person processing the marked up content have both agreed on what the markup symbols mean. For example, "stet" written in the margin of a document means that something previously stricken out should be allowed to stay in the document.
    [Show full text]
  • Electronic Document Preparation Pocket Primer
    Electronic Document Preparation Pocket Primer Vít Novotný December 4, 2018 Creative Commons Attribution 3.0 Unported (cc by 3.0) Contents Introduction 1 1 Writing 3 1.1 Text Processing 4 1.1.1 Character Encoding 4 1.1.2 Text Input 12 1.1.3 Text Editors 13 1.1.4 Interactive Document Preparation Systems 13 1.1.5 Regular Expressions 14 1.2 Version Control 17 2 Markup 21 2.1 Meta Markup Languages 22 2.1.1 The General Markup Language 22 2.1.2 The Extensible Markup Language 23 2.2 Markup on the World Wide Web 28 2.2.1 The Hypertext Markup Language 28 2.2.2 The Extensible Hypertext Markup Language 29 2.2.3 The Semantic Web and Linked Data 31 2.3 Document Preparation Systems 32 2.3.1 Batch-oriented Systems 35 2.3.2 Interactive Systems 36 2.4 Lightweight Markup Languages 39 3 Design 41 3.1 Fonts 41 3.2 Structural Elements 42 3.2.1 Paragraphs and Stanzas 42 iv CONTENTS 3.2.2 Headings 45 3.2.3 Tables and Lists 46 3.2.4 Notes 46 3.2.5 Quotations 47 3.3 Page Layout 48 3.4 Color 48 3.4.1 Theory 48 3.4.2 Schemes 51 Bibliography 53 Acronyms 61 Index 65 Introduction With the advent of the digital age, typesetting has become available to virtually anyone equipped with a personal computer. Beautiful text documents can now be crafted using free and consumer-grade software, which often obviates the need for the involvement of a professional designer and typesetter.
    [Show full text]