Experience Using Github and Asciidoc
Total Page:16
File Type:pdf, Size:1020Kb
Load more
Recommended publications
-
Trackdown: Collaborative Writing and Editing of R Markdown (Or Sweave
Package ‘trackdown’ August 6, 2021 Title Collaborative Writing and Editing of R Markdown (or Sweave) Documents in Google Drive Version 1.0.0 Description Collaborative writing and editing of R Markdown (or Sweave) documents. The lo- cal .Rmd (or .Rnw) is uploaded as a plain-text file to Google Drive. By taking advan- tage of the easily readable Markdown (or LaTeX) syntax and the well-known online interface of- fered by Google Docs, collaborators can easily contribute to the writing and editing process. Af- ter integrating all authors’ contributions, the final document can be downloaded and rendered lo- cally. Depends R (>= 3.5) License GPL-3 Encoding UTF-8 Imports cli (>= 3.0.0), googledrive (> 1.0.1), rmarkdown Suggests covr, devtools, gargle, knitr, pagedown, sodium, testthat (>= 3.0.0), vcr Config/testthat/edition 3 RoxygenNote 7.1.1 VignetteBuilder knitr URL https://github.com/claudiozandonella/trackdown/, https://claudiozandonella.github.io/trackdown/ BugReports https://github.com/claudiozandonella/trackdown/issues NeedsCompilation no Author Emily Kothe [aut] (<https://orcid.org/0000-0003-1210-0554>), Claudio Zandonella Callegher [aut, cre] (<https://orcid.org/0000-0001-7721-6318>), Filippo Gambarota [aut] (<https://orcid.org/0000-0002-6666-1747>), Janosch Linkersdörfer [aut] (<https://orcid.org/0000-0002-1577-1233>), Mathew Ling [aut] (<https://orcid.org/0000-0002-0940-2538>) Maintainer Claudio Zandonella Callegher <[email protected]> Repository CRAN Date/Publication 2021-08-06 18:20:02 UTC 1 2 trackdown-package R topics documented: trackdown-package . .2 download_file . .4 render_file . .4 update_file . .5 upload_file . .6 Index 8 trackdown-package trackdown - R package for improving collaborative writing Description The trackdown package offers a simple solution for collaborative writing and editing of R Mark- down (or Sweave) documents. -
Asciispec Userguide Table of Contents
AsciiSpec Userguide Table of Contents ..................................................................................................................................................................... iv 1. Document Structure ........................................................................................................................................... 1 1.1. Sections .............................................................................................................................................. 1 1.1.1. Styling Sections ........................................................................................................................... 1 2. Blocks ........................................................................................................................................................... 2 2.1. Titles & attributes ................................................................................................................................... 2 2.2. Delimiters ............................................................................................................................................. 3 2.3. Admonition Blocks .................................................................................................................................. 3 2.4. Nesting Blocks ...................................................................................................................................... 4 2.5. Block Macro ........................................................................................................................................ -
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. -
Assignment of Master's Thesis
ASSIGNMENT OF MASTER’S THESIS Title: Git-based Wiki System Student: Bc. Jaroslav Šmolík Supervisor: Ing. Jakub Jirůtka Study Programme: Informatics Study Branch: Web and Software Engineering Department: Department of Software Engineering Validity: Until the end of summer semester 2018/19 Instructions The goal of this thesis is to create a wiki system suitable for community (software) projects, focused on technically oriented users. The system must meet the following requirements: • All data is stored in a Git repository. • System provides access control. • System supports AsciiDoc and Markdown, it is extensible for other markup languages. • Full-featured user access via Git and CLI is provided. • System includes a web interface for wiki browsing and management. Its editor works with raw markup and offers syntax highlighting, live preview and interactive UI for selected elements (e.g. image insertion). Proceed in the following manner: 1. Compare and analyse the most popular F/OSS wiki systems with regard to the given criteria. 2. Design the system, perform usability testing. 3. Implement the system in JavaScript. Source code must be reasonably documented and covered with automatic tests. 4. Create a user manual and deployment instructions. References Will be provided by the supervisor. Ing. Michal Valenta, Ph.D. doc. RNDr. Ing. Marcel Jiřina, Ph.D. Head of Department Dean Prague January 3, 2018 Czech Technical University in Prague Faculty of Information Technology Department of Software Engineering Master’s thesis Git-based Wiki System Bc. Jaroslav Šmolík Supervisor: Ing. Jakub Jirůtka 10th May 2018 Acknowledgements I would like to thank my supervisor Ing. Jakub Jirutka for his everlasting interest in the thesis, his punctual constructive feedback and for guiding me, when I found myself in the need for the words of wisdom and experience. -
Spacetime Characterization of Real-Time Collaborative Editing Gabriele D’Angelo, Angelo Di Iorio, Stefano Zacchiroli
Spacetime Characterization of Real-Time Collaborative Editing Gabriele d’Angelo, Angelo Di Iorio, Stefano Zacchiroli To cite this version: Gabriele d’Angelo, Angelo Di Iorio, Stefano Zacchiroli. Spacetime Characterization of Real-Time Collaborative Editing. Proceedings of the ACM on Human-Computer Interaction , Association for Computing Machinery (ACM), 2018, CSCW, 2, pp.1-19. 10.1145/3274310. hal-01882069 HAL Id: hal-01882069 https://hal.inria.fr/hal-01882069 Submitted on 26 Sep 2018 HAL is a multi-disciplinary open access L’archive ouverte pluridisciplinaire HAL, est archive for the deposit and dissemination of sci- destinée au dépôt et à la diffusion de documents entific research documents, whether they are pub- scientifiques de niveau recherche, publiés ou non, lished or not. The documents may come from émanant des établissements d’enseignement et de teaching and research institutions in France or recherche français ou étrangers, des laboratoires abroad, or from public or private research centers. publics ou privés. 41 Spacetime Characterization of Real-Time Collaborative Editing GABRIELE D’ANGELO, Dept. of Computer Science and Engineering, University of Bologna, Italy ANGELO DI IORIO, Dept. of Computer Science and Engineering, University of Bologna, Italy STEFANO ZACCHIROLI, IRIF, University Paris Diderot & Inria, France Real-Time Collaborative Editing (RTCE) is a popular way of instrumenting cooperative work on documents, in particular on the Web. Little is known in the literature yet about RTCE usage patterns in the real world. In this paper we study how a popular RTCE editor (Etherpad) is used in the wild, digging into the edit histories of a large collection of documents (about 14 000 pads), retrieved from one of the most popular public instances of the platform, hosted by the Wikimedia Foundation. -
Asciidoc Asciidoc
2021/07/26 14:42 (UTC) 1/4 Asciidoc Asciidoc Introduction Keeping notes is an integral part of using any Linux distribution. Keeping them in plain text allows one to use them from a console during initial setup; using a consistent markup for plain text adds to the readability of the notes. asciidoc is one of the tools that provide such a consistent markup. Source highlighting, for those who prefer it, can add to the readability of the text file. asciidoc can produce HTML files, an added bonus as it allows to interlink notes and makes browsing them with lynx more effective. It can also work in tandem with man2html to provide HTML access to all installed man pages on the fly. For an interesting read about asciidoc see Living the Future of Technical Writing. Helper Packages and Files Asciidoctor Consider installing Asciidoctor. Dblatex To convert asciidoc files to PDF, install dblatex from SlackBuilds.org. See documentation, PDF. Source-highlight To highlight source listings, install source-highlight from SlackBuilds.org. See online manual. This: [source,bash] --------------------------------------------------------------------------- #!/bin/bash export LANG=en_US.UTF-8 --------------------------------------------------------------------------- renders as (this is DokuWiki's GeSHi highlighting, but gives the general idea): #!/bin/bash export LANG=en_US.UTF-8 SlackDocs - https://docs.slackware.com/ Last update: 2019/02/21 10:36 (UTC) howtos:software:asciidoc https://docs.slackware.com/howtos:software:asciidoc Vim Syntax Highlighter If asciidoc.vim is not available locally, download. Otherwise: $ mkdir -p $HOME/.vim/syntax $ cp /usr/share/vim/vimVERSION/syntax/asciidoc.vim $HOME/.vim/syntax/ and see Appendix E. Vim Syntax Highlighter. -
Devopsuse: Community-Driven Continuous Innovation of Web Information Infrastructures
DevOpsUse: Community-Driven Continuous Innovation of Web Information Infrastructures Von der Fakultät für Mathematik, Informatik und Naturwissenschaften der Rheinisch-Westfälischen Technischen Hochschule Aachen zur Erlangung des akademischen Grades eines Doktors der Naturwissenschaften genehmigte Dissertation vorgelegt von Diplom-Medieninformatiker István Koren aus Budapest, Ungarn Berichter: Universitätsprofessor Dr. rer. pol. Matthias Jarke Universitätsprofessor Dr.-Ing. Günther Schuh Privatdozent Dr. rer. nat. Ralf Klamma Tag der mündlichen Prüfung: 8. Mai 2020 Diese Dissertation ist auf den Internetseiten der Universitätsbibliothek online verfügbar. ii Abstract Since its invention in 1989, the only reliable factor on the Web has been its continuous change and diffusion into more and more application areas. The evolution was shaped by an interplay of new technologies on the one hand, and innovative application ideas from communities on the other. At a technological scale, alternation between vastly distributed and centralized architectures can be observed. The current challenges caused by the ongoing digital transformation are changing workplace settings and the adoption of the Internet of Things in industrial use cases, as for example in the context of Industry 4.0. On the Web, new technologies and device types sprawl together with new communication protocols and revised application programming interfaces (APIs). This inhibits the demanded rapid innovation cycles and creates a disruptive and unstable environment in which the requirements of endless communities must be met. Information systems infrastructure, while only partially visible and thus hard to grasp, has a strong influence on user practices. Therefore, the aim of this thesis is to stabilize the dichotomies apparent in the Web by means of an agile information systems development methodology. -
More Than Writing Text: Multiplicity in Collaborative Academic Writing
More Than Writing Text: Multiplicity in Collaborative Academic Writing Ida Larsen-Ledet Ph.D. Thesis Department of Computer Science Aarhus University Denmark More Than Writing Text: Multiplicity in Collaborative Academic Writing A Thesis Presented to the Faculty of Natural Sciences of Aarhus University in Partial Fulfillment of the Requirements for the Ph.D. Degree. by Ida Larsen-Ledet November 2, 2020 Abstract This thesis explores collaborative academic writing with a focus on how it is medi- ated by multiple technologies. The thesis presents findings from two empirical stud- ies with university students and researchers: The first combined semi-structured interviews with visualizations of document editing activity to explore transitions through co-writers’ artifact ecologies along with co-writers’ motivations for per- forming these transitions. The second study was a three-stage co-design workshop series that progressed from dialog through ideation to exploration of a prototype for a shared editor that was based on the participants’ proposed features and designs. The contribution from the second study to this thesis is the analysis of participants’ viewpoints and ideas. The analyses of these findings contribute a characterization of co-writers’ practical and social motivations for using multiple tools in their collaborations, and the chal- lenges this poses for sharing and adressing the work. Multiplicity is also addressed in terms of co-writers bringing multiple and diverse needs and preferences into the writing, and how these may be approached in efforts to design and improve support for collaborative writing. Additionally, the notion of text function is introduced to describe the text’s role as a mediator of the writing. -
Note Taking with Asciidoctor
Note taking with Asciidoctor Jens Getreu Revision History Revision 2.7 5.11.2016 JG Table of Contents 1. How students take notes ..................................................................... 3 1.1. The lesson starts ......................................................................... 3 1.2. Taking notes about a file ............................................................ 5 2. Create a new note ............................................................................... 7 2.1. Invoking the script ...................................................................... 7 2.2. Directory as parameter ............................................................... 8 2.3. No parameter .............................................................................. 9 2.4. Filename as parameter ............................................................. 10 3. Editing notes ...................................................................................... 13 3.1. Syntax ....................................................................................... 13 3.2. Example .................................................................................... 13 4. Viewing notes ..................................................................................... 15 4.1. Syntax ....................................................................................... 15 4.2. Example .................................................................................... 15 5. Asciidoc title-filename sync .............................................................. -
Asciidoc and Asciidoctor
Firebird Docwriting Guide Paul Vinkenoog, Mark Rotteveel Version 2.2, 23 May 2020 Table of Contents Table of Contents General . 4 1. Introduction . 5 1.1. Purpose of this guide . 5 1.2. Assumed knowledge . 5 1.3. Topics discussed in this guide . 5 2. Where the docmakers meet. 7 2.1. The subproject homepage . 7 2.2. The firebird-docs list . 7 3. Picking a subject. 8 4. Preparing to write: make an outline! . 9 5. Language and style . 10 5.1. Language . 10 5.2. Style . 10 5.2.1. Docwriter’s block . 11 6. Copyright issues . 12 6.1. Your copyright and the PDL. 12 6.1.1. How to apply the PDL to your work. 12 6.1.2. Including a Document History . 13 6.1.3. A copyright notice at the start . 14 6.1.4. Attaching the entire Public Documentation License . 14 6.1.5. Translator’s notices . 15 6.1.6. Translating the PDL . 15 6.2. Using material written by others . 15 6.2.1. Borland InterBase manuals . 16 6.2.2. PostgreSQL docs . 16 7. Adding your document to the firebird-documentation repository . 17 7.1. Asking for commit rights . 17 7.2. Dos and don’ts if you have received commit rights. 17 7.3. Committing your work . 18 8. Publishing your document on the Firebird website . 20 8.1. Naming the PDF file. 20 8.1.1. Naming DocBook generated PDF files . 20 8.2. Uploading the documentation . 21 8.3. Updating the Firebird Documentation Index . 22 AsciiDoc and Asciidoctor . -
De-Risking Government Technology: Federal Agency Field Guide
De-risking Government Technology Federal Agency Field Guide September 2020 2 DE-RISKING GOVERNMENT TECHNOLOGY Acknowledgements Numerous contributors across GSA made this work possible. We’d like to thank: Project Team Mark Hopson Randy Hart Waldo Jaquith Igor Korenfeld Vicki McFadden Rebecca Refoy Alicia Rouault With Support From Christine Bath, 18F Design Heather Battaglia, 18F Engineering Kristina Britt, TTS outreach Ron Bronson, 18F Design Will Cahoe, 10x Ryan Johnson, 18F Design Nico Papafil, 10x Steven Reilly, 18F Engineering Dahianna Salazar Foreman, TTS outreach 18F Writing Lab Office of Strategic Communications Office of General Counsel TTS Front Office TTS Communications 4 DE-RISKING GOVERNMENT TECHNOLOGY 5 TABLE OF CONTENTS 01 Introduction 6 03 Deciding what to buy 60 About the editors 7 Conduct Modern Market Research 61 Structure of this handbook 8 Use the Agile contract format to procure Agile software 75 development services Basic principles of modern software design 9 Use time and material contract types for custom Agile software 83 development services 02 Planning 20 Evaluate contractor proposals based on industry best practices 89 Assign dedicated and empowered product owners to lead 21 development efforts 04 Doing the work 102 Involve end users early and often in software development efforts 24 Host an effective post-award kick-off meeting to energize 103 Consider tradeoffs in build-or-buy decisions, taking all factors 26 folks for the work to come into consideration Oversee Agile projects by measuring end user outcomes -
Use of Github As a Platform for Open Collaboration on Text Documents Justin Longo Tanya M
Use of GitHub as a Platform for Open Collaboration on Text Documents Justin Longo Tanya M. Kelley University of Regina Arizona State University Johnson-Shoyama Graduate School of Public Policy School of Public Affairs 3737 Wascana Parkway 411 N. Central Avenue, Suite 400 Regina, SK, Canada S4S 0A2 Phoenix AZ 85004-0687 306-585-5460 602-496-0457 [email protected] [email protected] ABSTRACT provides a platform for social collaboration on non-code artifacts. Recently, researchers are paying attention to the use of the As the uses and users of GitHub move beyond its core community software development and code-hosting web service GitHub for of developers, the present and potential impact on fields such as other collaborative purposes, including a class of activity referred social knowledge creation, open science, open collaboration and to as document, text, or prose collaboration. These alternative uses open governance warrants consideration of the conditions under of GitHub as a platform for sharing non-code artifacts represent which GitHub can facilitate collaboration in non-code domains. an important modification in the practice of open collaboration. Other open access platforms for collaboration certainly exist, We survey cases where GitHub has been used to facilitate including wikis, synchronous co-editing platforms like Google collaboration on non-code outputs, identify its strengths and docs, and centralized file sharing repositories like SharePoint. weaknesses when used in this mode, and propose conditions for However, GitHub includes unique features such as built-in social successful collaborations on co-created text documents. networking functions [6], back-end data capture and reporting [3], and principles of distributed version control and openness by Categories and Subject Descriptors virtue of the underlying Git architecture.