GenPDFAddOnDemo

This is a sample document to show what can be achieved with the GenPDFAddOn Plugin.

Here are some headings - note that <h1> level 1 headers always appear on a new page.

Level 1 Heading

Level 2 Heading

Level 3 Heading

Level 4 Heading

Level 5 Heading
Level 6 Heading
TWiki only goes this far frown HTMLDOC goes to level 15 smile

Features

Some of the cool features are:
  • Title topic is a fully rendered TWiki topic, editable from within TWiki's normal edit mechanism.
  • Headers/Footers are fully rendered TWiki variables embedded in HTMLDOC special comments, but defined in a normal TWiki topic.
  • Images are included
  • Margins can be defined
  • PDF permissions can be restricted (this has 'print,no-copy' so you can't copy and paste the text)

Limitations

There are a few limitations, like
Really long lines of text in verbatim blocks will run off the edge of the page unless you break them. This is a limitation of htmldoc, not the plugin, so don't complain to me. There is nothing I can do about it but complain to the authors of htmldoc, which you could do anyway. Then again - how would you fix it?

Overflowing tables
Tables_can_overflow_if_you_have_long_words_in_the_cells If_you_generate_a_page_for_the_GenPDFAddOn_topic,_you_will_see_that_text_will_overflow_off_the_page,_similar_to_verbatim_text_above.

Settings for this topic

This topic includes the following settings:

Title Topic

<p>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/></p>
<img src="%PUBURL%/%WEB%/TWikiLogos/twikiRobot121x54a.gif"
alt="Powered by TWiki" width="121" height="54" align="left" />
<img src="%PUBURL%/%WEB%/TWikiLogos/twikiRobot81x119.gif"
alt="Powered by TWiki" width="81" height="119" align="right" /><br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
<font size="7"><i>%GENPDFADDON_BANNER%</i></font><br/>
&nbsp;<br/>
&nbsp;<br/>
<hr size="5" noshade>
<font size="7">%WEB%.%GENPDFADDON_TITLE%</font><br/>
&nbsp;<br/>
<i>%FORMFIELD{"TopicHeadline" topic="%WEB%.%BASETOPIC%"}%</i><br/>
&nbsp;<br/>
<font size="3">%GENPDFADDON_SUBTITLE%</font>
<hr noshade>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
| *DocumentClassification* | %FORMFIELD{"DocumentClassification" topic="%WEB%.%BASETOPIC%"}% |
| *DocumentType* | %FORMFIELD{"DocumentType" topic="%WEB%.%BASETOPIC%"}% |
&nbsp;<br/>
&nbsp;<br/>
&nbsp;<br/>
Copyright &copy; %DISPLAYTIME{"$year"}% Your Company<br/>
All rights reserved

This document contains Proprietary and Confidential information of Your Company,
and is protected by copyright, trade secret and other state and federal
laws. Its receipt or possession does not convey any rights to reproduce, disclose
its contents, or to manufacture, use or sell anything it may describe. Reproduction,
disclosure or use without specific written authorization of Your Company
is strictly prohibited.
&nbsp;<br/>
Generated: %DISPLAYTIME%

Headers/Footers Topic

<!-- HEADER LEFT "%BASETOPIC%" -->
<!-- HEADER CENTER "%FORMFIELD{"DocumentClassification" topic="%WEB%.%BASETOPIC%"}%" -->
<!-- HEADER RIGHT "&copy; Your Company %WEB%" -->
<!-- FOOTER LEFT "%REVINFO{"r1.$rev &shy; $date &shy; $wikiusername" web="%WEB%" topic="%BASETOPIC%"}%" -->
<!-- FOOTER CENTER "" -->
<!-- FOOTER RIGHT "$PAGE(1)" -->

Preferences

   * TWiki.GenPDFAddOn Settings
      * Set GENPDFADDON_BANNER = Our Slogan %ORANGE%Rocks!!!%ENDCOLOR%
      * Set GENPDFADDON_TITLE = %BASETOPIC%
      * Set GENPDFADDON_SUBTITLE = %REVINFO{web="%WEB%" topic="%BASETOPIC%"}%
      * Set GENPDFADDON_TITLETOPIC = TWiki.GenPDFExampleTitleTopic
      * Set GENPDFADDON_HEADERTOPIC = TWiki.GenPDFExampleHeaderFooterTopic
      * Set GENPDFADDON_HEADFOOTFONT = helvetica-bold
      * Set GENPDFADDON_LOGOIMAGE = http://localhost/twiki/pub/TWiki/TWikiLogos/twikiRobot46x50.gif
      * Set GENPDFADDON_FORMAT = pdf14
      * Set GENPDFADDON_PERMISSIONS = print,no-copy
      * Set GENPDFADDON_ORIENTATION = portrait
      * Set GENPDFADDON_PAGESIZE = a4
      * Set GENPDFADDON_SKIN = print.pattern
      * Set GENPDFADDON_TOCHEADER = l..
      * Set GENPDFADDON_TOCFOOTER = ..i
      * Set GENPDFADDON_NUMBEREDTOC = True
      * Set GENPDFADDON_TOCLEVELS = 5
      * Set GENPDFADDON_HEADERSHIFT = 0
      * Set GENPDFADDON_MARGINS = top:20mm,left:80pt,right:1in,bottom:5cm
      * Set GENPDFADDON_WIDTH = 1060

Form fields

% META:FORM{name="DocumentClassificationForm"}%
% META:FIELD{name="DocumentClassification" title="DocumentClassification" value="CompanyConfidential"}%
% META:FIELD{name="DocumentType" title="DocumentType" value="HowTo"}%
% META:FIELD{name="TopicHeadline" title="TopicHeadline" value="A look at what the GenPDFAddOn plugin can do"}%
% META:FIELD{name="KeyWords" title="KeyWords" value="PDF, plugin, acrobat"}%

Related: GenPDFAddOn, GenPDFExampleHeaderFooterTopic, GenPDFExampleTitleTopic

-- TWiki:Main.WadeTurland - 14 Jun 2005

Topic revision: r1 - 2011-01-25 - TWikiContributor
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.GenPDFAddOnDemo.