Single-source publishing

Last updated

Single-source publishing, also known as single-sourcing publishing, is a content management method which allows the same source content to be used across different forms of media and more than one time. [1] [2] [3] [4] The labor-intensive and expensive work of editing need only be carried out once, on only one document; [5] that source document (the single source of truth) can then be stored in one place and reused. [6] This reduces the potential for error, as corrections are only made one time in the source document. [7]

Contents

The benefits of single-source publishing primarily relate to the editor rather than the user. The user benefits from the consistency that single-sourcing brings to terminology and information. This assumes the content manager has applied an organized conceptualization to the underlying content (A poor conceptualization can make single-source publishing less useful). [4] Single-source publishing is sometimes used synonymously with multi-channel publishing though whether or not the two terms are synonymous is a matter of discussion. [8]

Definition

While there is a general definition of single-source publishing, there is no single official delineation between single-source publishing and multi-channel publishing, nor are there any official governing bodies to provide such a delineation. Single-source publishing is most often understood as the creation of one source document in an authoring tool and converting that document into different file formats or human languages (or both) multiple times with minimal effort. Multi-channel publishing can either be seen as synonymous with single-source publishing, or similar in that there is one source document but the process itself results in more than a mere reproduction of that source. [8]

History

The origins of single-source publishing lie, indirectly, with the release of Windows 3.0 in 1990. [9] With the eclipsing of MS-DOS by graphical user interfaces, help files went from being unreadable text along the bottom of the screen to hypertext systems such as WinHelp. On-screen help interfaces allowed software companies to cease the printing of large, expensive help manuals with their products, reducing costs for both producer and consumer. This system raised opportunities as well, and many developers fundamentally changed the way they thought about publishing. Writers of software documentation did not simply move from being writers of traditional bound books to writers of electronic publishing, but rather they became authors of central documents which could be reused multiple times across multiple formats. [9]

The first single-source publishing project was started in 1993 by Cornelia Hofmann at Schneider Electric in Seligenstadt, using software based on Interleaf to automatically create paper documentation in multiple languages based on a single original source file. [10]

XML, developed during the mid- to late-1990s, was also significant to the development of single-source publishing as a method. XML, a markup language, allows developers to separate their documentation into two layers: a shell-like layer based on presentation and a core-like layer based on the actual written content. This method allows developers to write the content only one time while switching it in and out of multiple different formats and delivery methods. [11]

In the mid-1990s, several firms began creating and using single-source content for technical documentation (Boeing Helicopter, Sikorsky Aviation and Pratt & Whitney Canada) and user manuals (Ford owners manuals) based on tagged SGML and XML content generated using the Arbortext Epic editor with add-on functions developed by a contractor. [12] The concept behind this usage was that complex, hierarchical content that did not lend itself to discrete componentization could be used across a variety of requirements by tagging the differences within a single document using the capabilities built into SGML and XML. [13] Ford, for example, was able to tag its single owner's manual files so that 12 model years could be generated via a resolution script running on the single completed file. Pratt & Whitney, likewise, was able to tag up to 20 subsets of its jet engine manuals in single-source files, calling out the desired version at publication time. World Book Encyclopedia also used the concept to tag its articles for American and British versions of English. [14]

Starting from the early 2000s, single-source publishing was used with an increasing frequency in the field of technical translation. It is still regarded as the most efficient method of publishing the same material in different languages. [15] Once a printed manual was translated, for example, the online help for the software program which the manual accompanies could be automatically generated using the method. [16] Metadata could be created for an entire manual and individual pages or files could then be translated from that metadata with only one step, removing the need to recreate information or even database structures. [17]

Although single-source publishing is now decades old, its importance has increased urgently as of the 2010s. As consumption of information products rises and the number of target audiences expands, so does the work of developers and content creators. Within the industry of software and its documentation, there is a perception that the choice is to embrace single-source publishing or render one's operations obsolete. [5]

Criticism

Editors using single-source publishing have been criticized for below-standard work quality, leading some critics to describe single-source publishing as the "conveyor belt assembly" of content creation. [18]

While heavily used in technical translation, there are risks of error in regard to indexing. While two words might be synonyms in English, they may not be synonyms in another language. In a document produced via single-sourcing, the index will be translated automatically and the two words will be rendered as synonyms. This is because they are synonyms in the source language, while in the target language they are not. [19]

See also

List of single-source publishing tools

Related Research Articles

A document type definition (DTD) is a specification file that contains set of markup declarations that define a document type for an SGML-family markup language. The DTD specification file can be used to validate documents.

<span class="mw-page-title-main">HTML</span> HyperText Markup Language

Hypertext Markup Language (HTML) is the standard markup language for documents designed to be displayed in a web browser. It defines the content and structure of web content. It is often assisted by technologies such as Cascading Style Sheets (CSS) and scripting languages such as JavaScript.

<span class="mw-page-title-main">Transclusion</span> Including one data set inside another automatically

In computer science, transclusion is the inclusion of part or all of an electronic document into one or more other documents by reference via hypertext. Transclusion is usually performed when the referencing document is displayed, and is normally automatic and transparent to the end user. The result of transclusion is a single integrated document made of parts assembled dynamically from separate sources, possibly stored on different computers in disparate places.

<span class="mw-page-title-main">Markup language</span> Modern system for annotating a document

A markuplanguage is a text-encoding system which specifies the structure and formatting of a document and potentially the relationships among its parts. Markup can control the display of a document or enrich its content to facilitate automated processing.

<span class="mw-page-title-main">Standard Generalized Markup Language</span> Markup language

The Standard Generalized Markup Language is a standard for defining generalized markup languages for documents. ISO 8879 Annex A.1 states that generalized markup is "based on two postulates":

<span class="mw-page-title-main">XML</span> Markup language by the W3C for encoding of data

Extensible Markup Language (XML) is a markup language and file format for storing, transmitting, and reconstructing arbitrary data. It defines a set of rules for encoding documents in a format that is both human-readable and machine-readable. The World Wide Web Consortium's XML 1.0 Specification of 1998 and several other related specifications—all of them free open standards—define XML.

Zope is a family of free and open-source web application servers written in Python, and their associated online community. Zope stands for "Z Object Publishing Environment", and was the first system using the now common object publishing methodology for the Web. Zope has been called a Python killer app, an application that helped put Python in the spotlight.

DocBook is a semantic markup language for technical documentation. It was originally intended for writing technical documents related to computer hardware and software, but it can be used for any other sort of documentation.

<span class="mw-page-title-main">Adobe FrameMaker</span> Document processor for the production and manipulation of large structured documents

Adobe FrameMaker is a document processor designed for writing and editing large or complex documents, including structured documents. It was originally developed by Frame Technology Corporation, which was bought by Adobe.

The Organization for the Advancement of Structured Information Standards is a nonprofit consortium that works on the development, convergence, and adoption of projects - both open standards and open source - for Computer security, blockchain, Internet of things (IoT), emergency management, cloud computing, legal data exchange, energy, content technologies, and other areas.

In web development, "tag soup" is a pejorative for HTML written for a web page that is syntactically or structurally incorrect. Web browsers have historically treated structural or syntax errors in HTML leniently, so there has been little pressure for web developers to follow published standards. Therefore there is a need for all browser implementations to provide mechanisms to cope with the appearance of "tag soup", accepting and correcting for invalid syntax and structure where possible.

The following tables compare general and technical information for many wiki software packages.

Generalized Markup Language (GML) is a set of macros that implement intent-based (procedural) markup tags for the IBM text formatter, SCRIPT. SCRIPT/VS is the main component of IBM's Document Composition Facility (DCF). A starter set of tags in GML is provided with the DCF product.

OmniMark is a fourth-generation programming language used mostly in the publishing industry. It is currently a proprietary software product of Stilo International. As of July 2022, the most recent release of OmniMark was 11.0.

<span class="mw-page-title-main">Comment (computer programming)</span> Explanatory note in the source code of a computer program

In computer programming, a comment is a human-readable explanation or annotation in the source code of a computer program. They are added with the purpose of making the source code easier for humans to understand, and are generally ignored by compilers and interpreters. The syntax of comments in various programming languages varies considerably.

Scribe is a markup language and word processing system that pioneered the use of descriptive markup. Scribe was revolutionary when it was proposed, because it involved for the first time a clean separation of presentation and content.

Data exchange is the process of taking data structured under a source schema and transforming it into a target schema, so that the target data is an accurate representation of the source data. Data exchange allows data to be shared between different computer programs.

In markup languages and the digital humanities, overlap occurs when a document has two or more structures that interact in a non-hierarchical manner. A document with overlapping markup cannot be represented as a tree. This is also known as concurrent markup. Overlap happens, for instance, in poetry, where there may be a metrical structure of feet and lines; a linguistic structure of sentences and quotations; and a physical structure of volumes and pages and editorial annotations.

References

  1. ↑ Kay Ethier, XML and FrameMaker, pg. 19. New York: Apress, 2004. ISBN   9781430207191
  2. ↑ Lucas Walsh, "The Application of Single-Source Publishing to E-Government." Taken from Encyclopedia of Digital Government, pg. 64. Eds. Ari-Veikko Anttiroiko and Matti Mälkiä. Hershey: IGI Global, 2007. ISBN   9781591407904
  3. ↑ Single-Source Publishing at Stylus Studio. Copyright © 2005-2013 Progress Software. Accessed June 11, 2013.
  4. 1 2 Single-Source Publishing with Flare. Copyright © 2010 WritersUA. Published November 16, 2010; accessed June 11, 2013.
  5. 1 2 Barry Schaeffer, Single-Source Publishing: Creating Customized Output. CMS Wire, 3 April 2012. Accessed 10 June 2013.
  6. ↑ Ann Rockley and Charles Cooper, Managing Enterprise Content: A Unified Content Strategy, Chapter 5: Product content. 2nd ed. Berkeley: New Riders Press, 2012. ISBN   9780132931649
  7. ↑ Janet Mackenzie, The Editor's Companion, pg. 92. Cambridge: Cambridge University Press, 2011. ISBN   9781107402188
  8. 1 2 Single-Source & Multi-Channel Publishing Archived 2010-04-06 at the Wayback Machine . © 2013 Mekon, accessed 23 June 2013.
  9. 1 2 Bob Boiko, Content Management Bible, pg. 162. Hoboken: John Wiley & Sons, 2005. ISBN   9780764583643
  10. ↑ Translating Into Success: Cutting-edge Strategies for Going Multilingual in a Global Age, pg. 227. Eds. Robert C. Sprung and Simone Jaroniec. Amsterdam: John Benjamins Publishing Company, 2000. ISBN   9789027231871
  11. ↑ Doug Wallace and Anthony Levinson, "The XML e-Learning Revolution: Is Your Production Model Holding You Back?" Taken from Best of The eLearning Guild's Learning Solutions: Articles from the eMagazine's First Five Years, pg. 63. Ed. Bill Brandon. Hoboken: John Wiley & Sons, 2008. ISBN   9780470277157
  12. ↑ "Pratt And Whitney Canada Manuals". pdflife.one. Retrieved 2022-02-17.
  13. ↑ "Getting Started with SGML/XML". www.oasis-open.org. Retrieved 2022-02-17.
  14. ↑ "The World Book Encyclopedia". 2012-06-19. Archived from the original on 19 June 2012. Retrieved 2022-02-17.
  15. ↑ Bert Esselink, "Localisation and translation." Taken from Computers and Translation: A Translator's Guide, pg. 73. Ed. H. L. Somers. Amsterdam: John Benjamins Publishing Company, 2003. ISBN   9789027216403
  16. ↑ Burt Esselink, A Practical Guide to Localization, pg. 228. Volume 4 of Language international world directory. Amsterdam: John Benjamins Publishing Company, 2000. ISBN   9781588110060
  17. ↑ Cornelia Hofmann and Thorsten Mehnert, "Multilingual Information Management at Schneider Automation." Taken from Translating Into Success, pg. 67.
  18. ↑ Mick Hiatt, The Myth of Single-Source Authoring Archived 2013-09-29 at the Wayback Machine , Archived 2013-04-27 at archive.today . Mashstream, November 18, 2009.
  19. ↑ Nancy Mulvany, Indexing Books, pg. 154. 2nd ed. Chicago: University of Chicago Press, 2009. ISBN   9780226550176
  20. ↑ Sarah S. O'Keefe, Sheila A. Loring, Terry Smith and Lydia K. Wong, Publishing Fundamentals: Unstructured FrameMaker 8, pg. 6. Scriptorium Publishing, 2008. ISBN   9780970473349
  21. ↑ "Sphinx is released! » And now for something completely Pythonic..." And now for something completely Pythonic... Georg Brandl. Archived from the original on 2012-03-22. Retrieved 2011-04-03.

Further reading

This page is based on this Wikipedia article
Text is available under the CC BY-SA 4.0 license; additional terms may apply.
Images, videos and audio are available under their respective licenses.