[DAISY] Updated: LinkRewriterTransformer
[email protected] Wed, 10 Sep 2008 14:32:15 +0000 (GMT+00:00)
| Newsgroups | gmane.text.xml.cocoon.documentation |
|---|---|
| Message-ID | <[email protected]> |
A document has been updated:
http://cocoon.zones.apache.org/daisy/documentation/1102.html
Document ID: 1102
Branch: main
Language: default
Name: LinkRewriterTransformer (unchanged)
Document Type: Sitemap Component (unchanged)
Updated on: 9/10/08 2:32:05 PM
Updated by: David Legg
A new version has been created, state: draft
Parts
=====
Long description
----------------
This part has been updated.
Mime type: text/xml (unchanged)
File name: (unchanged)
Size: 8558 bytes (previous version: 8461 bytes)
Content diff:
<html>
<body>
<p>The LinkRewriterTransformer can help in situations where one resource needs
--- to link to another resource but without needing to know in advance the final
--- destination of that second resource.</p>
+++ to link to another resource; but you want to avoid hard-coding the actual
+++ location of the other resource.</p>
--- <p>The transformer was originally developed as part of the Apache Forrest
--- project where there was a need to allow documents to refer to other documents in
--- a portable way that didn't break as those documents were moved around or
--- rendered to different formats. The solution was to give those references a
--- separate namespace and transform them as necessary when the target's final
--- address became known. So for example, instead of one document referring to
--- another like this: <a href="aPage.html"> it could use <a
--- href="site:aPage"> where:</p>
+++ <p>The transformer was originally developed as part of the
+++ <a href="http://forrest.apache.org/">Apache Forrest</a> project. A way was
+++ needed to allow documents to refer to other documents such that changing the
+++ location or rendering a document differently didn't break the link. The
+++ solution was to give those references a separate namespace and transform them as
+++ necessary when the target's final address became known. So for example, instead
+++ of one document referring to another like this: <a href="aPage.html"> it
+++ could use <a href="site:aPage"> where:</p>
<ul>
<li>site - is a URI "scheme"; a namespace that restricts the syntax and
--- semantics of the rest of the URI. The semantics of "site" are "this identifier
+++ semantics of the rest of the URI. The semantics of 'site' are "this identifier
locates something in the site's XML sources".</li>
<li>aPage - identifies the content by reference. We call this indirect, or
<em>semantic</em> linking because instead of linking to a physical
--- representation (e.g. aPage.html), it refers to the "idea" of "the aPage file".
--- It doesn't matter where it physically lives.</li>
+++ representation (e.g. aPage.html), it refers to the concept of the aPage
+++ resource. It doesn't matter where it physically lives (although it is assumed
+++ you can retrieve it based on this identifier if needed).</li>
</ul>
<p>If that was all this transformer could do, it wouldn't be anything that you
(169 equal lines skipped)