From svn-return-155-apmail-forrest-svn-archive=forrest.apache.org@forrest.apache.org Sun Jul 18 14:34:44 2004 Return-Path: Delivered-To: apmail-forrest-svn-archive@www.apache.org Received: (qmail 57437 invoked from network); 18 Jul 2004 14:34:44 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur-2.apache.org with SMTP; 18 Jul 2004 14:34:44 -0000 Received: (qmail 90486 invoked by uid 500); 18 Jul 2004 14:34:44 -0000 Delivered-To: apmail-forrest-svn-archive@forrest.apache.org Received: (qmail 90445 invoked by uid 500); 18 Jul 2004 14:34:43 -0000 Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: list-post: Reply-To: "Forrest Developers List" Delivered-To: mailing list svn@forrest.apache.org Received: (qmail 90432 invoked by uid 99); 18 Jul 2004 14:34:43 -0000 X-ASF-Spam-Status: No, hits=0.5 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.27.1) with SMTP; Sun, 18 Jul 2004 07:34:43 -0700 Received: (qmail 57429 invoked by uid 65534); 18 Jul 2004 14:34:42 -0000 Date: 18 Jul 2004 14:34:42 -0000 Message-ID: <20040718143442.57425.qmail@minotaur.apache.org> From: crossley@apache.org To: svn@forrest.apache.org Subject: svn commit: rev 23029 - in forrest/trunk: . src/documentation/content/xdocs/howto X-Virus-Checked: Checked X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N Author: crossley Date: Sun Jul 18 07:34:41 2004 New Revision: 23029 Added: forrest/trunk/src/documentation/content/xdocs/howto/howto-pdf-tab.xml (contents, props changed) Removed: forrest/trunk/src/documentation/content/xdocs/howto/pdf-howto.xml Modified: forrest/trunk/status.xml Log: Add the "How to create a PDF document for each tab" document. Submitted by: Stephan E. Schlierf stephan.schlierfvsa.de Issue: FOR-218 Added: forrest/trunk/src/documentation/content/xdocs/howto/howto-pdf-tab.xml ============================================================================== --- (empty file) +++ forrest/trunk/src/documentation/content/xdocs/howto/howto-pdf-tab.xml Sun Jul 18 07:34:41 2004 @@ -0,0 +1,189 @@ + + + + + +
+ How to create a PDF document for each tab + 0.1 + This How-To describes the generation of a PDF document for each + group of documents that is defined by a tab. + + +
+ + +

+ Users who need to generate one printable document aggregated from a + group of documents. +

+ + + +

+ By default Forrest generates a pdf-file for each site of your project. As well you can create a pdf of the whole site. But sometimes it may be necessary to + generate a pdf-file out of selected tab. Trying to say only parts of the site. This howto describes how you can get at it. +

+ + + +
    +
  • Understand how to create project-specific sitemaps by following the + Using Forrest document.
    • +
+ + + +

Define a project sitemap.xmap and create a new + pdf-tab.xmap based on the aggregate.xmap +

+ +
+ Create your project's main sitemap.xmap +

+ Simply copy the sitemap.xmap from the Forrest sitemaps at + ${FORREST_HOME}/context/sitemap.xmap into your + src/documentation directory (or wherever + ${project.sitemap-dir} points to). +

+
+ +
+ Create the aggregator sitemap pdf-tab.xmap +

+ Copy the aggregate.xmap from Forrest sitemaps into your + ${project.sitemap-dir} and rename it to pdf-tab.xmap +

+
+ +
+ Edit project sitemap.xmap + + This is a workaround for Issue +#FIXME + +

+ Edit the project sitemap.xmap to comment-out the match + for the sitemap like this: +

+ + + + + + +]]> + +
+ +
+ Edit project sitemap.xmap to mount pdf-tab.xmap +

+ Insert the following lines after the + ]]> + pipeline (around line 194): +

+ + + +...]]> + +
+ +
+ Edit the file <code>foo.xmap</code> +

+ The ]]> element + should look like the following: +

+ + + + + + + + + + + + + +]]> + +
+ +
+ Explanation of the operation +

+ Line 4 of our example +
+ ]]> + looks at your site.xml and finds something like: +

+ + + + +...]]> + +

+ So it takes all the elements of ]]> - that means ]]> + and its "children" - for the content of the pdf file to be generated. +

+

+ Line 8 defines the title of the pdf file by taking the content + of the project-name variable in + skinconf.xml and adding some funny text: +
+ ]]> +

+ + In the original aggregate.xmap there is the line +
+ ]]> +
+ just before the title definition (]]>). Be sure to + delete it or comment it out if you like to generate a pdf-file for specific sites. You only need it for + the generation of one pdf-file for the whole project (this is what aggregate.xmap usually does). + +

+ In site.xml, add something like +

+ + + +]]> + +

+ This allows you to link to it via a ]]> reference. If you need + it in the menue entries add the label attribute to the ]]> element: + ]]> +

+
+ + + Modified: forrest/trunk/status.xml ============================================================================== --- forrest/trunk/status.xml (original) +++ forrest/trunk/status.xml Sun Jul 18 07:34:41 2004 @@ -56,8 +56,8 @@ Add more desriptions to forrest targets. Highlight the most common ones. - - Stephan E. Schlierf (stephan.schlierf@vsa.de) posted a HowTo about tab specific PDF + + Added a How-To about tab specific PDF. css-style-dev skin - all div based skin as dev version added.