Setup:Installation Guide/Advanced/Maintenance scripts/CreatePDF

== Running the script ==
The script to export wiki pages to PDF is executed from: <syntaxhighlight lang="text">
php {MW_ROOT}/extensions/BlueSpiceUniversalExport/maintenance/export.php --specification-file=spec.json
</syntaxhighlight>The specification file <code>spec.json</code> can have the following content:<syntaxhighlight lang="text">
{
    "module": "pdf",
    "attachments": 1,
    "recursive": 1,
    "title": "MyPDF",
    "target": "localfilesystem",
    "target-file-name": "All.pdf",
    "target-file-path": "/path/to/target-file"
}
</syntaxhighlight>
{| class="wikitable" style="width: 100%;"
|+
! style="width:200px;" |Key
! style="width:200px;" |Value
!Description
|-
| style="width:200px;" |module
| style="width:200px;" |pdf
|Output type
|-
| style="width:200px;" |attachments
| style="width:200px;" |1
0
|Attachments will be included in the export
|-
| style="width:200px;" |recursive
| style="width:200px;" |1
0
|Linked pages (one level deep) will be included.
|-
| style="width:200px;" |title
| style="width:200px;" |string
|Title of the wiki page that contains the list of pages to be exported. <span class="col-red">The pages need to be links.</span>
|-
| style="width:200px;" |target
| style="width:200px;" |localfilesystem
|
|-
| style="width:200px;" |target-file-name
| style="width:200px;" |
|Name of the exported PDF file
|-
| style="width:200px;" |target-file-path
| style="width:200px;" |
|Target file location
|}

== Creating a page list for the export ==
The export list is defined in the wiki page that is shown as the <code>title</code> in the json-file. (In the example above, this is the page <code>MyPDF</code> .)

The page <code>MyPDF</code> now needs to list all pages  that will be exported to PDF. 

This list can be created with an [[SMW queries|SMW inline query]] (BlueSpice free) or with a [[Manual:Extension/DynamicPageList3|DPL3 list]] (BlueSpice free).
Example of an SMW query to create an export for all pages in the categories <code>Process</code> and <code>Work instruction</code>:

You would add the following to your <code>MyPDF</code> page in the wiki:<syntaxhighlight lang="text">
==All processes==
{{#ask:[[Process:+]]|format=ul|limit=99999}}

==All work instructions==
{{#ask:[[Work instruction:+]]|format=ul|limit=99999}}
</syntaxhighlight>The same list can be created with the following DPL3 syntax:<syntaxhighlight lang="text">
==All processes==
{{#dpl:category=Process}}

==All work instructions==
{{#dpl:category=Work instruction}}
</syntaxhighlight>

== Setting up a CronJob ==
To automate the export, the following CronJob is available:<syntaxhighlight lang="text">
php {MW_ROOT}/extensions/BlueSpiceUniversalExport/maintenance/export.php --specification-file={MW_ROOT}/extensions/BlueSpiceFoundation/data/spec.json
</syntaxhighlight>
__FORCETOC__