PDF Controller 3¶

Table of Contents¶

PDF Controller 3 1

Screen shots 3

Frontend 3

Backend 4

Introduction 5

What does it do? 5

Restrictions and Incapacities 5

Manual as PDF file 5

Website 5

Forum 5

Installation 6

Controlling 7

Workflow 7

Requirements 8

PDF Properties 9

Layout Restrictions 10

CSS 10

HTML 12

Optimisation by the PDF Controller 13

Constant Editor 14

PDF CONTROLLER - BUTTON 14

PDF CONTROLLER - CONFIG 14

PDF CONTROLLER – PAGES PDF 14

PDF CONTROLLER – PAGES PRINT 14

This effects the PAGE object pdfcontrollerPrint 14

PDF CONTROLLER – PAGES USER INTERFACE 14

PDF CONTROLLER – URL 15

PDF CONTROLLER – VIEW 15

Reference 16

PAGE 16

tt_content 16

tx_pdfcontroller: PDF Controller User Interface 17

tx_pdfcontroller_pi2: PDF Controller Button 23

Extensions 25

Fonts 28

Install custom fonts 28

Debugging 29

Mode 29

DRS (Development Reporting System) 30

3rd party! 31

Grid Elements 31

Organiser – TYPO3 for Lobby and Organisers 32

Slick – responsive Carousel and Slider 32

Start – Starter Kit for a responsive TYPO3 33

What's new 34

4.x 34

3.x 34

Upgrades 35

From 3.x to 4.x 35

From 2.x to 3.x 35

Known Bugs 36

Further Information 37

Other extensions published by Die Netzmacher 37

SEO - Search Engine Optimisation 38

Credits 39

Helpful suggestions 40

Forum 40

Change log 41

Illustration Index 44

Alphabetical Index 45

Screen shots¶

Introduction¶

Installation¶

• Install the extensions

  • TCPDF for TYPO3 (t3_tcpdf)
  • PDF Controller 3 (pdfcontroller)
  • PDF Controller 3 Additional Fonts (pdfcontroller_fonts)

• Include the static TypoScript templates into the static template of your root page:

  • PDF Controller [1] (pdfcontroller) :sup:`0 <#sdfootnote3sym>`_
  • PDF Controller [1.1] +tt_content optimising (pdfcontroller) :sup:`0 <#sdfootnote4sym>`_
  • ...
  • PDF Controller [2] Ext: Slick (pdfcontroller) :sup:`0 <#sdfootnote5sym>`_
  • PDF Controller [2] Ext: Start (pdfcontroller) :sup:`0 <#sdfootnote6sym>`_ ^, :sup:`0 <#sdfootnote7sym>`_
  • PDF Controller [2.1] Ext: Start Gridelements (pdfcontroller) :sup:`0 <#sdfootnote8sym>`_

• Create in your library folder (or everywhere) the page (not a folder!):

  PDF Controller

• Add to the page PDF Controller the plugin PDF Controller User Interface.Check the first tab [Check!]. See details at section "Requirements" on page 8 below.

• Add the plugin PDF Controller Button to the page, which should be downloadable as a PDF document.

• Configure the plugin PDF Controller Button by the TypoScript Constant Editor. SeeCONSTANT EDITOR categories

  • [PDF CONTROLLER - PAGES USER INTERFACE]
  • [PDF CONTROLLER - URL]

That's all.

Test the PDF Controller 3: Click the PDF Controller button in your frontend.

Controlling¶

Layout Restrictions¶

Constant Editor¶

Reference¶

pdfcontrollerPDF < plugin.tx_pdfcontroller.settings.master_templates.pdf

pdfcontrollerPrint < plugin.tx_pdfcontroller.settings.master_templates.print

[globalVar = GP:type = {$plugin.pdfcontroller.pages.print.typeNum}]
  ## images
  tt_content.image {
    20 {
      1 {
        layout {
          default {
            element := appendString ( <br /> )
          }
        }
      }
      layout {
        # above-center
        default {
          value (
            <table cellspacing="0" cellpadding="0" style="width:100%;" class="columns01">
              <tr>
                <td>
                  ###IMAGES###
                </td>
              </tr>
              <tr>
                <td>
                  ###TEXT###
                </td>
              </tr>
            </table>
)
          override >
        }
        # above-right
        ...
      }
      renderMethod = simple
      rendering {
        simple {
          imageStdWrapNoWidth.wrap = |
          imageStdWrap.dataWrap = |
          caption.wrap = <p>|<br /><br /></p>
        }
      }
    }
  }
[global]

plugin.tx_pdfcontroller {
  settings {
    flexform {
      template {
        filepath = TEXT
        filepath {
          data = GP:tx_browser_pi1|jobUid
        }
        filepath >
        filepath = CONTENT
        filepath {
          table = tx_org_headquarters
          select {
            pidInList = {$plugin.org.sysfolder.headquarters}
            join = tx_org_mm_all ON tx_org_mm_all.uid_local = \
                   tx_org_headquarters.uid
            where {
              data = GP:tx_browser_pi1|jobUid
              noTrimWrap = |tx_org_mm_all.uid_foreign = | \
                        AND tx_org_mm_all.table_local = 'tx_org_headquarters' \
                        AND tx_org_mm_all.table_foreign = 'tx_org_job'|
            }
            orderBy = tx_org_headquarters.title
          }
            // tx_org_news.title croped and linked
          renderObj = CASE
          renderObj {
            key {
              field = uid
            }
            default = TEXT
            default {
              value = Company {field:title} (uid #{field:uid}) isn't part \
                      of TypoScript. Please see: Home/Jobs/Detail [109] > \
                      +ext_pdfcontroller_074
              noTrimWrap = |: ||
              insertData = 1
            }
            8 = TEXT
            8 {
              value = fileadmin/jobofferByCompany08.pdf
            }
            12 = TEXT
            12 {
              value = fileadmin/jobofferByCompany12.pdf
            }
            ...
          }
        }
      }
    }
  }
}

plugin.tx_pdfcontroller {
  settings {
    master_templates {
      pdf = PAGE
      pdf {
        config {
          ... <- Please inspect code by the TypoScript Object Browser
        }
        typeNum = {$plugin.pdfcontroller.pages.pdf.typeNum}
        10 = COA
        10 {
          ... <- Please inspect code by the TypoScript Object Browser
        }
      }
      print = PAGE
      print {
        config {
          ... <- Please inspect code by the TypoScript Object Browser
        }
        typeNum = {$plugin.pdfcontroller.pages.pdf.typeNum}
        10 = COA
        10 {
          ... <- Please inspect code by the TypoScript Object Browser
        }
      }
    }
  }
}

plugin.tx_pdfcontroller {
  settings {
    pdf {
      content {
          // empty statement for proper comments only
        footer {
        }
          // placeholders: %page% for the current page, %pages% for the number of pages
        footer = TEXT
        footer {
          // placeholders: %page% for the current page, %pages% for the number of pages
          value = page %page% from %pages%
          lang {
            de = Seite %page% von %pages%
            en = page %page% from %pages%
          }
          wrap  = <div style="text-align:right;">|</div>
        }
      }
    }
  }
}

plugin.tx_pdfcontroller {
  settings {
    pdf {
      css {
        margin {
            // bottom, top
          div =
          div {
              // value: 0, times: 0
            bottom =
            bottom {
              value = 0
              times = 0
            }
              // value: 0, times: 0
            top =
            top {
              value = 0
              times = 0
            }
          }
            // bottom, top
          h1 < .div
            // bottom, top
          h2 < .div
            // bottom, top
          h3 < .div
            // bottom, top
          ol < .div
          ol {
              // value: 1, times: 3
            bottom =
            bottom {
              value = 1
              times = 3
            }
          }
            // bottom, top
          p < .div
            // bottom, top
          ul < .ol
        }
      }
    }
  }
}

plugin.tx_pdfcontroller {
  settings {
    pdf {
      filename = COA
      filename {
          // page : title
        10 = TEXT
        10 {
          stdWrap {
            data = page : title
            htmlSpecialChars = 1
          }
          wrap = |
        }
          // date
        30 = TEXT
        30 {
          data      = date : U
          strftime  = %Y%m%d%H%M%S
          wrap      = _|
        }
          // extension pdf
        50 = TEXT
        50 {
          value = pdf
          wrap  = .|
        }
      }
    }
  }
}

plugin.tx_pdfcontroller {
  settings {
    pdf {
      pageproperties {
          // page : author
        documentAuthor = CONTENT
        documentAuthor {
          table = pages
          select {
            where = 1 OR (uid = {page:uid} AND pid >= 0)
            where {
              insertData = 1
            }
            max = 1
          }
          renderObj = TEXT
          renderObj {
            field = author
          }
        }
          // page : keywords
        documentKeywords < .documentAuthor
        documentKeywords {
          renderObj {
            field = keywords
          }
        }
          // page : description
        documentSubject < .documentAuthor
        documentSubject {
          renderObj {
            field = description
          }
        }
          // page : title
        documentTitle < .documentAuthor
        documentTitle {
          renderObj {
            field = title
          }
        }
      }
    }
  }
}

plugin.tx_pdfcontroller {
  settings {
    pid {
      userinterface = {$plugin.pdfcontroller.pages.userinterface.pid}
    }
  }
}

plugin.tx_pdfcontroller {
  settings {
    typeNum {
      pdf   = {$plugin.pdfcontroller.pages.pdf.typeNum}
      print = {$plugin.pdfcontroller.pages.print.typeNum}
    }
  }
}

plugin.tx_pdfcontroller {
  view {
    templateRootPath = {$plugin.tx_pdfcontroller.view.templateRootPath}
    partialRootPath = {$plugin.tx_pdfcontroller.view.partialRootPath}
    layoutRootPath = {$plugin.tx_pdfcontroller.view.layoutRootPath}
  }
}

plugin.tx_pdfcontroller_pi2 {
  button = IMAGE
  button {
    wrap = | 
    file = {$plugin.pdfcontroller.button.icon}
    altText {
      stdWrap {
        cObject = TEXT
        cObject {
          value = Download content as PDF file
          lang {
            de = Inhalt als PDF-Datei herunterladen
            en = Download content as PDF file
          }
        }
      }
    }
    titleText < .altText
    imageLinkWrap = 1
    imageLinkWrap {
      enable = 1
      typolink {
        parameter {
          cObject = COA
          cObject {
              // url
            10 = TEXT
            10 {
              data = page:uid
            }
              // target
            20 = TEXT
            20 {
              value       = _blank
              noTrimWrap  = | "|"|
            }
              // class
            30 = TEXT
            30 {
              value       = -
              noTrimWrap  = | "|"|
            }
              // title
            40 = TEXT
            40 {
              value = Download content as PDF file
              lang {
                de = Inhalt als PDF-Datei herunterladen
                en = Download content as PDF file
              }
              noTrimWrap  = | "|"|
            }
          }
        }
        additionalParams  = &type={$plugin.pdfcontroller.pages.pdf.typeNum}
          // #i0024, 150904, dwildt, 4+
        addQueryString    = 1
        addQueryString {
          exclude = id, cHash
        }
        ATagParams        = rel="nofollow"
      }
    }
  }
  text = TEXT
  text {
    ... <- See next section below
  }
}

plugin.tx_pdfcontroller_pi2 {
  text = TEXT
  text {
    value = PDF Download
    lang {
      de = PDF Download
      en = PDF Download
    }
    typolink {
      ... <- See typolink from button in the section from above
    }
  }
}

start.gridelements {
  1 {
    columns.default.wrap.noTrimWrap = |<td class="columns |">|
    columns.default.wrap2 = |</td>
    wrap.stdWrap.cObject.10.value = <table class="row columns01
    wrap.stdWrap.cObject.30.value = "><tbody><tr>|</tr></tbody></table>
  }
  ...
}

tt_content.gridelements_pi1.20.10.setup.1 < start.gridelements.1
tt_content.gridelements_pi1.20.10.setup... < start.gridelements...

start {
  structure {
    inlineCss {
      pdfcontroller = TEXT
      pdfcontroller {
        value (
<style>
  table.columns01 { width:100%; }
  table.columns02 { width:100%; }
  table.columns03 { width:100%; }
  table.columns04 { width:100%; }
  table.columns05 { width:100%; }
  table.columns06 { width:100%; }

  table.columns01 tr td { width:100%; }
  table.columns02 tr td { width:49%; }
  table.columns03 tr td { width:32%; }
  table.columns04 tr td { width:23.5%; }
  table.columns05 tr td { width:18.4%; }
  table.columns06 tr td { width:15%; }

  table.columns02 tr td.space { width:2%; }
  table.columns03 tr td.space { width:2%; }
  table.columns04 tr td.space { width:2%; }
  table.columns05 tr td.space { width:2%; }
  table.columns06 tr td.space { width:2%; }

  .align-center { text-align:center; }
  .align-left { text-align:left; }
  .align-right { text-align:right; }

  .csc-header-alignment-center { text-align:center; }
  .csc-header-alignment-left { text-align:left; }
  .csc-header-alignment-right { text-align:right; }
</style>
)
      }
    }
  }
}

[globalVar = GP:type = {$plugin.pdfcontroller.pages.print.typeNum}]
  ## images
  tt_content.slickslideshow {
    20 {
      1 {
        layout {
          default {
            element := appendString ( <br /> )
          }
        }
      }
      layout {
        default {
          value (
            <table cellspacing="0" cellpadding="0" style="width: 100%; text-align: left; margin: 0;">
              <tr>
                <td valign="top" align="left" style="text-align: left;">
                  ###IMAGES###
                </td>
              </tr>
              <tr>
                <td valign="top">
                  ###TEXT###
                </td>
              </tr>
            </table>
)
          override >
        }
      }
      renderMethod = simple
      rendering {
        simple {
          imageStdWrapNoWidth.wrap = |
          imageStdWrap.dataWrap = |
          caption.wrap = <p>|<br /><br /></p>
        }
      }
    }
  }
[global]

pdfcontrollerPrint >
pdfcontrollerPrint < plugin.tx_pdfcontroller.settings.extensions.start.master_templates.print

plugin.tx_pdfcontroller {
  settings {
    extensions {
      start {
        master_templates {
          print = PAGE
          print {
            ... -> Please inspect it by the TypoScript Object Browser
          }
        }
      }
    }
  }
}

Fonts¶

Debugging¶

You can get a report for debugging and development purposes in the frontend and the backend.

Please us the tab [Debugging] of the plugin of the PDF Controller 3 User Interface.

If you are enabling the DRS (Development Reporting System), you will get a report in the devlog. :sup:`0 <#sdfootnote13sym>`_

3rd party!¶

The PDF Controller supports third party extensions respectevely third party extensions supports the PDF Controller.

Suppor means:

• Usually the HTML code is optimised for a responsive layout.
• But TCPDF can't handle the CSS of a responisve layout in principle.

The PDF Controller optimise HTML and CSS of the third party extension from below. Optimisation doesn't mean, that you will get a one-to-one layout.

What's new¶

Upgrades¶

Known Bugs¶

See https://forge.typo3.org/projects/extension-pdfcontroller/issues

Further Information¶

Helpful suggestions¶

Change log¶

4.2.0 Feature * #i0038: Flexform values got the TypoScript property Content Object

4.1.6 Improvement * #i0037: locallang* #i0036: Manual: section upgrade 3.x -> 4.x

4.1.5 Improvement * #i0035: favicon* #i0034: Improvement tt_content.image caption

4.1.4 Improvement * #i0033: Extension description

4.1.3 Improvement * #i0031: tt_content optimisation: image caption got the wrap <p class="caption">|<br /></p>

4.1.2 New Features * #i0030: slick optimisation for tt_content.images Improvement * #i0029: tt_content optimisation added for image layout: 1, 2, 8, 9, 10, 17, 18* #i0028: td.space for grid elements Bugfix * #i0027: <tr> was missing in typoscript for grid elements

4.1.1 New Feature * #i0025: Support for Start: grid layouts* #i0024: addQueryString Improvement * #i0023: Flexform tab sDEF is removed* #i0022: Suggests pdfcontroller_fonts

4.1.0 New Feature * #i0021: Constant for config.disableAllHeaderCode* #i0020: Template for tt_content optimisation* #i0019: Support for startEffected files:* Configuration/TypoScript/Extensions/Start (new)* Resources/Private/Extensions/Start/Templates (new)

4.0.6 Improvement * #i0018: Check for [ 'FE' ][ 'lockIP' ]* #i0017: _ffValue: error prompt* #i0016: Labeling *.xlf

4.0.5 Improvement * #i0015: Update Manual

4.0.4 Improvement * #i0014: Flexform with DRS

4.0.3 Update * #i0013: Manual with CSS sample for images

4.0.2 Update * #i0012: Manual with CSS sample

4.0.1 Bugfix * #i0011: XML: missing tagResources/Private/Language/de.locallang_db.xlf

4.0.0 Major Features * #i0010: Preparation for TYPO3 7.x* #i0009: Session handling

3.1.1 Improvement * #i0008: Constant Editor: new property url. Bugfix * #i0007: PHP Warning: in_array() expects parameter 2 to be array,null given in Classes/Userfunc/Flexforms/Controller.php line 181

3.0.0 Feature * #i0005: Constant Editor: page.pdf_button. Id of the page, which contains the PDF Controller button.Moved* plugin.tx_pdfcontroller_pi2.page.pdf_controller > plugin.pdfcontroller.pages.userinterface.id* plugin.tx_pdfcontroller_pi2.realUrl.print > plugin.pdfcontroller.realUrl.print* plugin.tx_pdfcontroller_pi2.typeNum.print > plugin.pdfcontroller.pages.print.typeNum

2.0.4 Manual * #i0004: Update

2.0.3 SECURITY FIX! * #i0003: Fix against Cross-Site ScriptingDone by Christian Bernet, http://www.bernetimux.ch/

2.0.2 Bugfix * #i0001: Class t3lib_extMgm is moved to TYPO3CMSCoreUtilityExtensionManagementUtility Improvement * #i0002: state is moved from alpha to beta

2.0.0 Major Feature * #62278: Upgrade TYPO3 6.2#62285: PHP 5.4 E_ALL & ~E_STRICT#62289: PHP 5: Call to undefined method FPDF::GetFontAscender()#62281: Warning in case of [FE][pageNotFoundOnCHashError]#53019: Depracted require() functions for Typo3 6.2* #47107: Manual: Configuration in case of HTML5 (HTML4)

1.4.3 Manual * #00000: Note frontend user sessions

1.4.1 Bugfix * #00000: Wrong TypoScript snippet is now proper in the manual

1.3.0 Bugfix * #36862: Additional Parameter has to encoded since TYPO 4.6Marker ###ADDITIONALPARAMS### is handled by rawUrlEncode( )Effected file:* pi2/class.tx_pdfcontroller_pi2.php Improvement * #00000: Two master template are added. One for a rawUrlEncode case, one for a realUrl case.* #00000: DRS got prompts for marker and typolink* #00000: Manual is updated

1.2.1 Bugfix * #36857: Missing index in systemcheck.php: JPG SupportEffected file:* res/html2ps_v2043/public_html/demo/systemcheck.php

1.2.0 New Features

* #36513: Enable Batch ProcessingCoded by Jonas Goetze http://forge.typo3.org/users/4345* #36228: Display PHP error messages – configurable by the plugin / flexformCoded by Ulfried Herrmann http://herrmann.at.die-netzmacher.de

1.1.4 Bugfix

* #34939: Get rid of PHP notice logsThanks to Alexander Krimm for the bug report

1.1.3 Improvement

* #34858: Usage of $ICON_TYPES is deprecated since 4.4.Thanks to Rene Staecker http://forge.typo3.org/users/1993

1.1.2 Bugfix

* #00000: SQL error in the query in context with development toolsThanks to Borries Jensen, who send the Bugfix.

* #00000: After clearing the dirs cache, out and temp each folder get a file index.html

1.1.1 New Feature * #33851: SEO rel="nofollow" Improvements * #00000: pi1/flexform_locallang.xml

1.1.0 Security fix

1.0.1 Improvements * #32516: Systemcheck should check fonts in directory of pdfcontroller_fonts* #32513: typeNum print template is configurable by the TypoScript constant editor* #32482: PDF Controller suggests to install Fonts

Bugfixes * #32518: Wrong field name for proxy in the flexform. Thanks to Borries Jensen* #31191: Missing folders temp and out. Thanks to Borries Jensen* #31190: Parameter are missing - without RealURL only. Thanks to Borries Jensen

1.0.0 Initial release

Illustration Index¶

Illustration 1: PDF Controller 3: Responsive TYPO3 to PDF 3

Illustration 2: Example for more than one page: first page can designed differently. 3

Illustration 3: PDF Controller 3 flexform 4

Illustration 4: index.php?id=x&type=0 7

Illustration 5: ... &type=67426 7

Illustration 6: ... =67425 7

Illustration 7: The PDF Controller 3 can move responsive HTML output to PDF, which is based on one of the six grid elements provided by Start. 31

Illustration 8: The PDF Controller 3 can move responsive HTML output to PDF, which is based on one of the 12 backend layouts provided by Start. 33

Alphabetical Index¶

67425

typeNum 7, 14

67426

typeNum 7, 14

Bugs 36

Button

icon 14

IMAGE 23

TEXT 24

config

disableAllHeaderCode 14

CSS 10

a 9, 11

align 25

border 11

Content Element 10

csc-header 25

disableAllHeaderCode 10

div 19

File 10

h1 19

h2 19

h3 19

HTML 12

inlineCss 25

line-height 11

list-style-type 11

margin 11, 19

ol 19

Own CSS 10

p 19

padding 11

Pagebreak 11

properties 11

rules 11

Sample 11

table 25

text-align 25

ul 19

Development

Production 29

Test

HTML 29

TCPDF sample 29

TypoScript 29

DRS 30

FE_SESSION_KEY 30

Session management 30

filename 20

Flexform 9

Typoscript 17

Fluidtemplates

Constant Editor 15

Fonts 28

default fonts 9

PDF Controller Additional Fonts 6

footer 18

Forum 40

Grid elements 25, 31

tt_content 25

HTML 12

CSS 10

DIV 12

TABLE 12

CAPTION 12

units 12

Images 13

Scaling factor 9

tt_content 16

margin

CSS 19

master-templates 18

PAGE 18

pdf 18

print 18

Organiser 32

PAGE

master-templates 18

pdfcontrollerPDF 7, 16

Constant Editor 14

pdfcontrollerPrint 7, 16

Constant Editor 14

PDF Controller Additional Fonts 6

PDF Properties

a-tag 9

author 21

default fonts 9

description 21

documentAuthor 21

documentKeywords 21

documentSubject 21

documentTitle 21

images scaling factor 9

keywords 21

page margins 9

pageproperties 21

PDF template 9

title 21

pdfcontrollerPDF

Constant Editor 14

typeNum 14

pdfcontrollerPrint

Constant Editor 14

copyright 14

header 14

Start 27

strftime 14

typeNum 14

Plugin 9

Requirements

Check 8

lockHashKeyWords 8

lockIP 8

Plugin 8

SEO 38

nofollow 38

Session management 30

Slick 32

Start 33

master 27

pdfcontrollerPrint 27

TCPDF 6

tt_content

gridelements 25

image 13, 16

Slick 26

slickslideshow 26

typeNum 22

67425 7, 14

67426 7, 14

TypoScript

flexform 17

Templates 6

url 15

User interface

pid 14, 21

view 22

0 You need Start from version 2.0.2. Currently it is a developer version only. Therefor it isn't available in the TYPO3 repository but in the SVN repository. https://forge.typo3.org/projects/extension-start/wiki . I try to publish Start 2.0.2 in the TER soon.

0 Organiser – TYPO3 for the Lobby and the Organisers: http://typo3-organiser.de

0 Position must be below the templates of CSS Styled Content and Grid Elements.

0 Optional: moves <div> to <table> in the image content element. Only in context with generating PDF.

0 Position must be below the templates of Slick.

0 Oprional: moves <div> to <table> in the fluid templates of the extension TYPO3 responsive Starter (start). Only in context with generating PDF.

0 Position must be below the templates of Start.

0 Recommended, if you are using the grid elements, which are delivered by Start.

0 Default fonts are used, if there isn't set any font by CSS

0 The absolute path must contain letter in lower case only!

0 dito

0 dito

0 You need the extension Developer Log (devlog)

45