Developements in the preparation of technical documentation: Lightweight markup languages
DOI:
https://doi.org/10.3145/thinkepi.2019.e13f03Keywords:
Lightweight markup language, MarkDown, ReStructuredText, Technical documentation.Abstract
Lightweight markup languages have been consolidated as the lingua franca for the preparation of technical documents. Their foundations and history are revised, as well as the main languages and documentation generators.
References
Bias-Plata, Alejandro; í‘eco-García, Ramón P. (2017). "TEIdown: Uso de Markdown extendido para el marcado automático de documentos TEI". Revista de humanidades digitales, n. 1, pp. 57-75. http://revistas.uned.es/index.php/RHD/article/view/16683/16586
Brandl, George (2007-2019). Sphinx. Python documentation generator. http://www.sphinx-doc.org
Christie, Tom (2014). MkDocs. Project documentation with MarkDown. https://www.mkdocs.org
Di-Castro, Joe (2011). "Comparativa de lenguajes de marcado ligero". Joe di Castro, 2 abril. https://joedicastro.com/comparativa-de-lenguajes-de-marcado-ligero.html
Fouh, Eric; Karavirta, Ville; Breakiron, Daniel A.; Hamouda, Sally; Hall, Simin; Naps, Thomas; Shaffer, Clifford A. (2014). "Design and architecture of an interactive eTextbook - The OpenDSA system". Science of computer programming, v. 88, pp. 22-40. https://doi.org/10.1016/J.SCICO.2013.11.040
García-Tovar, Javier (2016). "Sphinx como herramienta para documentar proyectos técnicos". Técnica industrial, n. 315, pp. 48-52. http://www.tecnicaindustrial.es/TIFrontal/a-7789-sphinx-herramienta-documentar-proyectos-tecnicos.aspx
Gentle, Anne (2017). Docs like code. https://www.docslikecode.com
Goodger, David (2012). An introduction to reStructuredText. http://docutils.sourceforge.net/docs/ref/rst/introduction.html#history
Gruber, John (2004). "Introducing Markdown". Daring fireball, 15 marzo.
https://daringfireball.net/2004/03/introducing_markdown
Holscher, Eric (2016). "An introduction to Sphinx and Read the Docs for Technical Writers". Surfing in Kansas, 1 julio. http://www.ericholscher.com/blog/2016/jul/1/sphinx-and-rtd-for-writers/
Krewinkel, Albert; Winkler, Robert (2017). "Formatting open science: Agilely creating multiple document formats for academic manuscripts with Pandoc Scholar". PeerJ computer science, n. 3, e112. https://doi.org/10.7717/peerj-cs.112
Mullen, Lincoln (2012). "Pandoc converts all your (text) documents". The chronicle of higher education. Blogs: ProfHacker, 23 febrero. https://www.chronicle.com/blogs/profhacker/pandoc-converts-all-your-text-documents/38700
Ovadia, Steven (2014). "Markdown for librarians and academics". Behavioral & social sciences librarian, v. 33, n. 2, pp. 120-124. https://doi.org/10.1080/01639269.2014.904696
Phillips, Lee (2017). "Technical writing with Pandoc and Panflute". Linux journal, n. 281, pp. 90-107. https://lee-phillips.org/panflute-gnuplot
Rackham, Stuart (2013). AsciiDoc. Text based document generation. http://www.methods.co.nz/asciidoc/index.html
Swartz, Aaron (2002-2011). Html2text (the asciinator). http://www.aaronsw.com/2002/html2text
Textile Language Development Team (2003-2019). Textile markup language. https://textile-lang.com
Voegler, Jens; Bornschein, Jens; Weber, Gerhard (2014). "Markdown - A simple syntax for transcription of accessible study materials". Computers helping people with special needs. En: ICCHP 2014, pp. 545-548. https://doi.org/10.1007/978-3-319-08596-8_85
Willems, Karen (2019). "Jupyter notebook tutorial: The definitive guide". DataCamp, 9 enero. https://www.datacamp.com/community/tutorials/tutorial-jupyter-notebook
Downloads
Downloads
Published
How to Cite
Dimensions
