Transclusion

For information about transclusion on Wikipedia, see Wikipedia:Transclusion

File:Transclusion simple.svg

B is transcluded in the document A

In computer science, transclusion is the inclusion of a document or part of a document into another document by reference.

For example, an article about a country might include a chart or a paragraph describing that country's agricultural exports from a different article about agriculture. Rather than copying the included data and storing it in two places, a transclusion embodies modular design, by allowing it to be stored only once (and perhaps corrected and updated if the link type supported that) and viewed in different contexts. The reference also serves to link both articles.

The term was coined by hypertext pioneer Ted Nelson in 1982.

Technical considerations

Context neutrality

Transclusion works better when transcluded sections of text are self-contained, so that the meaning and validity of the text is independent of the context in which it appears. For example, formulations like "as explained in the previous section" are problematic, because the transcluded section may appear in a different context, causing confusion. What constitutes "context neutral" text varies, but often includes things like company information or boilerplate.

Parameterization

Under some circumstances, and in some technical contexts, transcluded sections of text may not require strict adherence to the "context neutrality" principle, because the transcluded sections are capable of parameterization. Parameterization implies the ability to modify certain portions or subsections of a transcluded text depending on exogenous variables that can be changed independently. This is customarily done by supplying a transcluded text with one or more substitution placeholders. These placeholders are then replaced with the corresponding variable values prior to rendering the final transcluded output in context.

History and implementation by Project Xanadu

Nelson (who had also originated the words "hypertext" and "hypermedia") coined the term "transclusion" in his 1982 book, Literary Machines. Part of his proposal was the idea that micropayments could be automatically exacted from the reader for all the text, no matter how many snippets of content are taken from various places.

However, according to Nelson, the concept of transclusion had already formed part of his 1965 description of hypertext; he also interprets the notion of "trails" in Vannevar Bush's 1945 essay As We May Think as describing transclusion rather than hyperlinks.

Nelson defines transclusion as "the same content knowably in more than one place", setting it apart from more special cases such as the inclusion of content stored in a different location (which he calls "transdelivery") or "explicit quotation which remains connected to its origins" (which he calls "transquotation").

Some hypertext systems, including Ted Nelson's own Xanadu Project, support transclusion.

Nelson has delivered a demonstration of Web transclusion, the Little Transquoter (programmed to Nelson's specification by Andrew Pam in 2004-2005). It creates a new format built on portion addresses from Web pages; when dereferenced, each portion on the resulting page remains click-connected to its original context—always a key aspect of transclusion for Nelson, but missing in most implementations of transclusion.

Implementations on the Web

HTML

At present, transclusion in HTML is somewhat limited by lack of standards support in web browsers. Although all graphical browsers can transclude an image, including a document is a bit more difficult. There are currently two methods of achieving this result:

• The IFrame (inline frame) element, which includes whole documents.
• The Object element. In Firefox and other browsers, this allows true document transclusion, enabling one page to be built from several smaller documents.

In addition, Ajax can achieve a similar result across all modern, JavaScript-enabled browsers.

Future versions of HTML may support deeper transclusion of portions of documents using XML technologies such as entities, XPointer document referencing, and XSLT manipulations. (XPointer is patent-encumbered.)

The practice of 'remote loading'—including data, such as images, directly from other sites—is usually frowned upon because of the use of bandwidth and computing power required from the remote computer system (see Bandwidth theft). This is said to "tax" another server, and is often considered an example of leeching. Increased distribution of proxy servers has the potential to turn this around and take advantage of transclusion to reduce redundant transmissions of the same data.

A major exception to this rule is web advertising, where advertisements supplied by an advertiser are published with other content by a publisher. An advertiser prefers to serve an advertisement and be able to detect when it was viewed, rather than have it served by the publisher and have to trust the publisher. (See also Hit counter, Web bug).

Mashups and meshups are a recent phenomenon similar to transclusion.

Server-side Transclusion

Transclusion can also be accomplished on the server side, provided the server software includes this functionality. This can be done through multiple different technologies, including Server Side Includes and markup entity references resolved by the server software. It is a feature of substitution templates. Client-side transclusion is generally preferable as data transcluded into several pages can be cached by the client rather than sent out again for every page.

Transclusion of source code into HTML or wiki documents

In order to produce some kinds of software documents (external documents, such as design documents), it is often important to include source code fragments in the text. The transclusion of source code into the documents is an economic and elegant way of preserving the semantic consistency of the inserted code w+in relation to its source codebase.

Crystalbox provides a simple and easy to use mechanism to support transclusion of source code directly from source code repositories (CVS, Subversion, Git, etc) into any piece of HTML code, wiki text, blog, etc.

Further reading

• Di Iorio, A.; Vitali, F. (August 2003). "A Xanalogical Collaborative Editing Environment" (PDF). Proceedings of the Second International Workshop of Web Document Analysis 2003 (WDA2003). Edinburgh, UK. http://www.csc.liv.ac.uk/~wda2003/Papers/Section_III/Paper_11.pdf. 
• Kolbitsch, J.; Maurer, H. (June 2006). "Transclusions in an HTML-Based Environment". Journal of Computing and Information Technology 14 (2): 161–174. doi:10.2498/cit.2006.02.07. http://cit.zesoi.fer.hr/browseIssue.php?issue=25. 
• Kolbitsch, J. (June 2005). "Fine-Grained Transclusions of Multimedia Documents in HTML". Journal of Universal Computer Science 11 (6). http://www.jucs.org/jucs_11_6/fine_grained_transclusions_of/. 
• Krottmaier, H. (2002). "Transcluded Documents: Advantages of Reusing Document Fragments" (PDF). Proceedings of the 6th International ICCC/IFIP Conference on Electronic Publishing (ELPUB2002). Czech Republic: Karlovy Vary. pp. 359–367. http://hkrott.iicm.edu/docs/publications/elpub-2002.pdf. 
• Krottmaier, H.; D., Helic (2002). "Issues of Transclusions" (PDF). Proceedings of the World Conference on E-Learning in Corporate, Government, Healthcare, & Higher Education (E-Learn 2002). Montreal, Canada. pp. 1730–1733. http://coronet.iicm.edu/denis/pubs/elearn2002b.pdf. 
• Krottmaier, H.; Maurer, H. (July 2001). "Transclusions in the 21st Century" (PDF, HTML, PostScript). Journal of Universal Computer Science 7 (12): 1125–1136. http://www.jucs.org/jucs_7_12/transclusions_in_the_21st/. 
• Moore, A.; et al. (2001). "Personally tailored teaching in WHURLE using conditional translucion". Proceedings of the Twelfth ACM Conference on Hypertext and Hypermedia. Aarhus, Danmark. pp. 163–164. 
• Nelson, T. H. (1981). Literary Machines. Mindful Press. 
• Nelson, T. H. (1995). "The Heart of Connection: Hypermedia Unified by Transclusion". Communications of the ACM 38 (8): 31–33. doi:10.1145/208344.208353. 
• Nelson, T. H. (1996). "Generalized Links, Micropayment and Transcopyright". Almaden Research Center. http://www.almaden.ibm.com/almaden/npuc97/1996/tnelson.htm. 
• Nelson, T. H. (1998). "Transcopyright: Pre-Permission for Virtual Republishing". http://www.aus.xanadu.com/xanadu/transcopy.html. 
• Nelson, T. H. (1999). "Xanalogical Structure, Needed Now More than Ever: Parallel Documents, Deep Links to Content, Deep Versioning and Deep Re-Use". ACM Computing Surveys 31 (4es): 33. doi:10.1145/345966.346033. http://xanadu.com.au/ted/XUsurvey/xuDation.html. 
• Pam, A. (1997). "Fine-Grained Transclusion in the Hypertext Markup Language" (Text). Internet Draft. http://xanadu.com.au/archive/draft-pam-html-fine-trans-00.txt. 
• Wilde, E.; Lowe, D. (2002). "XML Linking Language" (PDF). XPath, XLink, XPointer, and XML: A Practical Guide to Web Hyperlinking and Transclusion. Addison-Wesley Professional. pp. 169–198. http://searchwebservices.techtarget.com/searchWebServices/downloads/wilde-lowe_07.pdf. 

See also

• Compound document
• Cross-reference
• Macro
• Object Linking and Embedding
• Publish and Subscribe
• Single source publishing
• Subroutine

External links

• Ted Nelson: Transclusion: Fixing Electronic Literature Google Tech Talks January 29, 2007