Setup:Installation Guide/Advanced/Maintenance scripts/CreatePDF: Difference between revisions

Redaktion (talk | contribs)
No edit summary
Redaktion (talk | contribs)
No edit summary
Line 26: Line 26:
php extensions/PDFCreator/maintenance/CreatePDF.php cache/specification.json
php extensions/PDFCreator/maintenance/CreatePDF.php cache/specification.json
</syntaxhighlight>
</syntaxhighlight>
{| class="wikitable"
|+Key/value pairs for the specification file
! style="" |key
! style="" |possible values
! style="" |module=pdf
(exports a set of wiki pages)
|-
| style="" |target
| style="" |filesystem
| style="" |The file is exported to a local file system
|-
| style="" |file-name
| style="" |
| style="" |Name of the exported PDF file
|-
| style="" |filesystem-path
| style="" |
| style="" |Target file location
|-
| style="" |attachments
| style="" |true
false
| style="" |true = attachments (links to "media" files) are included
false = no attachments are included
|-
| style="" |type
| style="" |
| style="" |type of resource to be exported
|-
| style="" |target
| style="" |
| style="" |Name of the page to be exported
|}
__FORCETOC__
__FORCETOC__

Revision as of 08:32, 25 April 2025

Review PDF export compatibility!The PDF export script for BlueSpice 4 is different.


Export PDF from cli

After creating a specificaton json file, the pdf export can be triggered from CLI.

Example json content:

{
    "module": "batch",
    "params": {
        "filename": "MyExport.pdf",
        "filesystem-path": "/app/d/pdfcreator/cache",
        "target": "filesystem",
        "user": "WikiSysop"
    },
    "options": {
        "attachments" : true
    },
    "pages": [
        {
            "type": "page",
            "target": "Main_Page"
        }
    ]
}

Start export form CLI:

php extensions/PDFCreator/maintenance/CreatePDF.php cache/specification.json
Key/value pairs for the specification file
key possible values module=pdf

(exports a set of wiki pages)

target filesystem The file is exported to a local file system
file-name Name of the exported PDF file
filesystem-path Target file location
attachments true

false

true = attachments (links to "media" files) are included

false = no attachments are included

type type of resource to be exported
target Name of the page to be exported




To submit feedback about this documentation, visit our community forum.