From: William Victor Mote
Date: Mon, 11 Aug 2003 23:18:08 +0000 (+0000)
Subject: 1. add documentation of fox:destination
X-Git-Tag: Root_Temp_KnuthStylePageBreaking~1218
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=71f91369f5741c37c65ec741c81d1e1f31ba1141;p=xmlgraphics-fop.git
1. add documentation of fox:destination
2. break explanation of fox: namespace into a separate section so that it is clear that it applies to all of the fox: extensions
3. some other minor cleanup
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196783 13f79535-47bb-0310-9956-ffa450edef68
---
diff --git a/src/documentation/content/xdocs/extensions.xml b/src/documentation/content/xdocs/extensions.xml
index 716b96dc8..256fc1424 100644
--- a/src/documentation/content/xdocs/extensions.xml
+++ b/src/documentation/content/xdocs/extensions.xml
@@ -17,21 +17,25 @@ By having a mechanism for supporting extensions, FOP is able to add features tha
Please see the SVG documentation for more details.
+
+ FO Extentions
+
+ Namespace
+
By convention, FO extensions in FOP use the "fox:" namespace identifier.
+To use any of the FO extensions, add a namespace entry for http://xml.apache.org/fop/extensions
+to the root element:
+
+ PDF Bookmarks
-To use this standard FOP extension, you need to add a namespace entry for
-http://xml.apache.org/fop/extensions on the root element.
-
-
You can provide outlines inside the root object (but outside any
page-sequences or other formatting objects). Here's an example of an outline
entry:
+
+ Anchors or Named Destinations
+
Use the fox:destination element to define "named destinations" inside a PDF document.
+These are useful as fragment identifiers, e.g. "http://server/document.pdf#anchor-name".
+fox:destination elements can be placed almost anywhere in the fo document, including a child of
+root, a block-level element, or an inline-level element.
+For the destination to actually work, it must correspond to an "id" attribute on some fo element
+within the document. In other words, the "id" attribute actually creates the "view" within the
+PDF document. The fox:destination simply gives that view an independent name.
+
+
+ It is possible that in some future release of FOP, all elements with
+"id" attributes will generate named-destinations, which will eliminate the need for
+fox:destination.
+
- Continued-label (for table-header/-footer
+ Continued-label (for table-header/-footer)