[go: up one dir, main page]
More Web Proxy on the site http://driver.im/ skip to main content
10.1145/3209280.3209537acmconferencesArticle/Chapter ViewAbstractPublication PagesdocengConference Proceedingsconference-collections
research-article

Exploiting patterns and templates for technical documentation

Published: 28 August 2018 Publication History

Abstract

There are several domains in which the documents are made of reusable pieces. Template languages have been widely studied by the document engineering community to deal with common structures and textual fragments. Though, templating mechanisms are often hidden in mainstream word-precessors and even unknown by common users.
This paper presents a pattern-based language for templates, serialized in HTML and exploited in a user-friendly WYSIWYG editor for writing technical documentation. We discuss the deployment of the editor by an engineering company in the railway domain, as well as some generalized lessons learned about templates.

References

[1]
Mark Anderson, Leslie Carr, and David E. Millard. 2017. There and Here: Patterns of Content Transclusion in Wikipedia. InÂăProceedings of the 28th ACM Conference on Hypertext and Social Media (HT '17). ACM, New York, NY, USA, 115--124.
[2]
Ja-Ryoung Choi, Sungeun An, and Soon-Bum Lim. 2014. Spatial hypertext modeling for dynamic contents authoring system based on transclusion. In Proceedings of the 25th ACM conference on Hypertext and social media (HT '14).
[3]
Ja-Ryoung Choi and Soon-Bum Lim. 2016. A digital publishing system with open resources transclusion and tracing. In Proceedings of the 4th International Workshop on Document Changes: Modeling, Detection, Storage and Visualization (DChanges '16). ACM, New York, NY, USA, Article 3, 4 pages.
[4]
Francesc Campoy Flores, Vincent Quint, and Irène Vatton. 2006. Templates, microformats and structured editing. In Proceedings of the 2006 ACM symposium on Document engineering (DocEng '06). ACM, New York, NY, USA, 188--197.
[5]
M. Garrish, T. Siegman, M. Gylling, S. McCarron, Digital Publishing WAI-ARIA Module 1.0, W3C Recommendation, https://www.w3.org/TR/dpub-aria-1.0/, 2017.
[6]
A. Di Iorio, S. Peroni, F. Poggi, F. Vitali "Dealing with structural patterns of XML documents". Journal of the American Society for Information Science and Technology, JASIST, vol. 65, no. 9, pp. 1884--1900.
[7]
Ali Khalili and SÃűren Auer. 2013. Review article: User interfaces for semantic authoring of textual content: A systematic literature review. Web Semant. 22 (October 2013), 1--18.
[8]
Lung-Chen Lee, Christof Lutteroth, and Gerald Weber. 2010. Improving end-user GUI customization with transclusion. In Proceedings of the Thirty-Third Australasian Conference on Computer Science - Volume 102 (ACSC '10), Bernard Mans and Mark Reynolds (Eds.), Vol. 102. Australian Computer Society, Inc., Darlinghurst, Australia, Australia, 163--172.
[9]
J. Marsh, D. Orchard, and D. Veillard. XML Inclusions (XInclude) Version 1.0. http://www.w3.org/TR/xinclude/, 2006.
[10]
Takehiro Nagatomo, Takahiro Tachibana, Keizo Sato, and Makoto Nakashima. 2016. Partial Bookmarking: A Structure-independent Mechanism of Transclusion for a Portion of any Web Page. In Proceedings of the 29th Annual Symposium on User Interface Software and Technology (UIST '16 Adjunct). ACM, New York, NY, USA, 185--186.
[11]
Peroni, S., Osborne, F., Di Iorio, A., Nuzzolese, A.G., Poggi, F., Vitali, F. and Motta, E., 2017. Research Articles in Simplified HTML: a Web-first format for HTML-based scholarly articles. PeerJ Computer Science, 3, p.e132.
[12]
T. H. Nelson. Literary Machines. Mindful Press, Sausalito, CA, USA, 1990.
[13]
Vincent Quint and Irène Vatton. 2007. Structured templates for authoring semantically rich documents. In Proceedings of the 2007 international workshop on Semantically aware document processing and indexing (SADPI '07). ACM, New York, NY, USA, 41--48.
[14]
S. De Rose, E. Maler, D. Orchard, and N. Walsh. XML Linking Language (XLink) Version 1.1. http://www.w3.org/TR/xlink11/, 2001.
[15]
Gianmarco Spinaci, Silvio Peroni, Angelo Di Iorio, Francesco Poggi, and Fabio Vitali. 2017. The RASH JavaScript Editor (RAJE): A Wordprocessor for Writing Web-first Scholarly Articles. In Proceedings of the 2017 ACM Symposium on Document Engineering (DocEng '17). ACM, New York, NY, USA, 85--94.
[16]
Ingo Stock and Michael Weber. 2006. Authoring technical documentation using a generic document model. In Proceedings of the 24th annual ACM international conference on Design of communication (SIGDOC '06). ACM, New York, NY, USA, 172--179.
[17]
N. Meyrowitz. Hypertext|does it reduce cholesterol, too? Pages 287--318, 1991.

Cited By

View all
  • (2024)A TEMPLATE FOR TECHNICAL DESIGN DOCUMENTS TO HELP DISTRIBUTED SOFTWARE DEVELOPMENT TEAMS COLLABORATE BETTERЕкономіка та суспільство10.32782/2524-0072/2024-63-3Online publication date: 27-May-2024
  • (2020)Information correspondence between types of documentation for APIsEmpirical Software Engineering10.1007/s10664-020-09857-0Online publication date: 26-Aug-2020

Recommendations

Comments

Please enable JavaScript to view thecomments powered by Disqus.

Information & Contributors

Information

Published In

cover image ACM Conferences
DocEng '18: Proceedings of the ACM Symposium on Document Engineering 2018
August 2018
311 pages
ISBN:9781450357692
DOI:10.1145/3209280
Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than the author(s) must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected].

Sponsors

In-Cooperation

  • SIGDOC: ACM Special Interest Group on Systems Documentation

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 28 August 2018

Permissions

Request permissions for this article.

Check for updates

Author Tags

  1. Collaborative editing
  2. HTML
  3. Technical documentation
  4. Templating

Qualifiers

  • Research-article
  • Research
  • Refereed limited

Conference

DocEng '18
Sponsor:
DocEng '18: ACM Symposium on Document Engineering 2018
August 28 - 31, 2018
NS, Halifax, Canada

Acceptance Rates

Overall Acceptance Rate 194 of 564 submissions, 34%

Contributors

Other Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

  • Downloads (Last 12 months)17
  • Downloads (Last 6 weeks)2
Reflects downloads up to 15 Jan 2025

Other Metrics

Citations

Cited By

View all
  • (2024)A TEMPLATE FOR TECHNICAL DESIGN DOCUMENTS TO HELP DISTRIBUTED SOFTWARE DEVELOPMENT TEAMS COLLABORATE BETTERЕкономіка та суспільство10.32782/2524-0072/2024-63-3Online publication date: 27-May-2024
  • (2020)Information correspondence between types of documentation for APIsEmpirical Software Engineering10.1007/s10664-020-09857-0Online publication date: 26-Aug-2020

View Options

Login options

View options

PDF

View or Download as a PDF file.

PDF

eReader

View online with eReader.

eReader

Media

Figures

Other

Tables

Share

Share

Share this Publication link

Share on social media