Loading...
 

Plugin PDF


Overview

To use the PluginPDF you must have installed and activated mPDF. It is used to change default Administration PDF Settings and use custom settings for any specific Tiki page. When we apply PluginPDF on any page, all settings made in the plugin take effect on all the pages of the PDF document produced. Edit the page which you want to convert to a PDF document. Click on the Question Mark on the right corner of the editor as shown in the diagram below to open Plugin Help Window. See also: PluginPdfpagebreak


Introduced in Tiki 17

Image

It will open up the Help Window, click on “Plugin Help” and type in the Filter search box “PDF” and three plugins will appear in the list. Click on the icon before PluginPDF to open PluginPDF Options.

Image



You get to see the list of PDF Options here, if you do not change or use any of the options then default options setup from the admin panel will be used. If you modify any PDF settings here on the page using the plugin then the new settings will be used.

Image


PluginPDF Parameters

Introduced in Tiki 17.
Preferences required: wikiplugin_pdf
Parameters Accepted Values Description Default Since
printfriendly (blank)
y
n
Print friendly option will change theme background color to white and text /headings color to black. If set to ‘n’, theme colors will be retained in pdf
orientation (blank)
P
L
Landscape or Portrait P
pagesize (blank)| Letter| Legal| Tabloid/Ledger| A0| A1| A2| A3| A4| A5| A6 ISO Standard sizes: A0, A1, A2, A3, A4, A5 or North American paper sizes: Letter, Legal, Tabloid/Ledger (for ledger, select landscape orientation)
toc (blank)
y
n
Set if table of contents will be autogenerated before PDF content n
toclinks (blank)
y
n
Link TOC headings with content on pdf document n
tocheading Heading to be appeared before table of content is printed Table of Contents
toclevels Will be autopicked from content of document, for example: H1|H2|H3 H1|H2|H3
header Format: Left text| Center Text | Right Text. Possible values, custom text, {PAGENO},{PAGETITLE},{DATE j-m-Y}.
footer Possible values, custom text, {PAGENO}, {DATE j-m-Y} For example:Document Title|Center Text|{PAGENO}
margin_left digits Numeric value.For example 10 10
margin_right digits Numeric value, no need to add px. For example 10 10
margin_top digits Numeric value, no need to add px. For example 10 10
margin_bottom digits Numeric value, no need to add px. For example 10 10
margin_header digits Only applicable if header is set. Numeric value only, no need to add px.Warning: Header can overlap text if top margin is not set properly 5
margin_footer digits Only applicable if footer is set.Numeric value only, no need to add px. Warning: Footer can overlap text if bottom margin is not set properly 5
password Secure confidential PDF with password, leave blank if password protected is not needed



Sample PluginPDF Code


{pdf  pagesize="A4" toc="n" pagetitle="n" header=" Document Title |  | {DATE j-m-Y }"footer="Document Copyrights | www.example.org |{PAGENO}" margin_left="10" margin_right="10" margin_top="20" margin_bottom="20" margin_header="10" margin_footer="10" coverpage_text_settings=" "  coverpage_image_settings="http://example.org/filename.jpg" toc="y" toclinks="y" tocheading="Table of Contents" toclevels="H1|H2|H3"  }


Margin Top & Margin Header


This needs to be configured correctly for the page contents and header contents appear without overlapping. Margin Top is the space between document top and the contents of the document. And Margin Header is the space between Header and the document top. Check the diagram below:

Image

Cover Page

This features allow users to add a cover page to their PDF comprising of a background image and text on top of it. There are two variables to set this up. This cover page is not visible on the TIKI page but will be added whenever a PDF is produced. Following is the image size guide to help design some great PDF cover pages. Image


Image Size and Dimensions for Cover Page

Image Resolution: DPI / PPI 96
Page Size Image Dimensions
Letter 816 x 1056 px
Legal 816 x 1344 px
Ledger 1056 x 1632 px
A0  3179 x 4494 px
A1  2245 x 3179 px
A2  1587 x 2245 px
A3  1123 x 1587 px
A4  794 x 1123 px
A5  559 x 794 px
A6  397 x 559 px


Related
Collection of References on doc.tiki.org

PDF general overview about PDF creation in Tiki
mPDF create PDFs from Tiki content (advanced library that works even on shared hosting)
PluginPDF alter default settings of mPDF per wiki page
PluginPDFPageBreak add a page break for PDFs created with mPDF
wkhtmltopdf create PDFs from Tiki content (needs root installation)
dompdf used for pdf print of slideshows
PluginMediaPlayer display PDF file from file gallery
PluginArchiveBuilder
Print



doc.tiki.org


Bootstrap

AdminGuide

UserGuide

Keywords

Keywords serve as “hubs” for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):

Accessibility (WAI and 508)
Accounting (7.x)
Articles and Submissions
Backlinks
Banners
Batch (6.x)
BigBlueButton audio/video/chat/screensharing (5.x)
Blog
Bookmark
Browser Compatibility
Link Cache
Calendar
Category
Chat
Clean URLs
Comments
Communication Center
Compression (gzip)
Contacts (Address Book)
Contact us
Content Templates
Contribution (2.x)
Cookie
Copyright
Credit (6.x)
Custom Home and Group Home Page
Date and Time
Debugger Console
Directory of hyperlinks
Documentation link from Tiki to doc.tiki.org (Help System)
Docs 8.x
Draw 7.x
Dynamic Content
Dynamic Variable
External Authentication
FAQ
Featured links
File Gallery
Forum
Friendship Network (Community)
Gmap Google maps
Groups
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
Kaltura video management (4.x)
Karma
Live Support
Login
Logs (system & action)
Look and Feel
Lost edit protection
Mail-in
Map with Mapserver
Menu
Meta Tags
Mobile Tiki and Voice Tiki
Mods
Module
MultiTiki
MyTiki
Newsletter
Notepad
Payment
Performance Speed / Load
Permissions
Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
Polls
Profiles
Profile Manager
Report
Toolbar
Quiz
Rating
Feeds
Score
Search engine optimization
Search
Search and Replace
Security
Semantic links (3.x)
Shadowbox
Shadow Layers
Share
Shopping cart
Shoutbox
Slideshow
Smiley
Social Networks
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Stats
Surveys
Tags (2.x)
Task
Tell a Friend, alert + Social Bookmarking
TikiTests (2.x)
Theme CSS & Smarty
Trackers
Transitions (5.x)
TRIM
User Administration including registration and banning
User Files
User Menu
Watch
WebHelp
WebDAV (5.x)
Webmail
Web Services
Wiki 3D
Wiki History, page rename, etc
Wiki Page Staging and Approval (2.x)
Wiki Plugin extends basic syntax
Wiki Syntax
Wiki structure (book and table of content)
Workspace
WSOD
WYSIWYCA
WYSIWYG (2.x)
XMLRPC


Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki
Show php error messages