No edit summary |
No edit summary |
||
| Line 35: | Line 35: | ||
| style="width:200px;" |title | | style="width:200px;" |title | ||
| style="width:200px;" |string | | style="width:200px;" |string | ||
|Title of the wiki page that contains the list of pages to be exported. | |Title of the wiki page that contains the list of pages to be exported. '''The pages need to be links.''' | ||
|- | |- | ||
| style="width:200px;" |target | | style="width:200px;" |target | ||
| style="width:200px;" |localfilesystem | | style="width:200px;" |localfilesystem | ||
| | |The file will be exported to a local file system. | ||
|- | |- | ||
| style="width:200px;" |target-file-name | | style="width:200px;" |target-file-name | ||
Revision as of 13:00, 14 June 2023
Running the script
The script to export wiki pages to PDF is executed from:
php {MW_ROOT}/extensions/BlueSpiceUniversalExport/maintenance/export.php --specification-file=spec.json
The specification file spec.json can have the following content:
{
"module": "pdf",
"attachments": 1,
"recursive": 1,
"title": "MyPDF",
"target": "localfilesystem",
"target-file-name": "All.pdf",
"target-file-path": "/path/to/target-file"
}
| Key | Value | Description |
|---|---|---|
| module | Output type | |
| attachments | 1
0 |
Attachments will be included in the export |
| recursive | 1
0 |
Linked pages (one level deep) will be included. |
| title | string | Title of the wiki page that contains the list of pages to be exported. The pages need to be links. |
| target | localfilesystem | The file will be exported to a local file system. |
| target-file-name | Name of the exported PDF file | |
| target-file-path | Target file location |
Creating a page list for the export
The export list is defined in the wiki page that is shown as the title in the json-file. (In the example above, this is the page MyPDF .)
The page MyPDF now needs to list all pages that will be exported to PDF.
This list can be created with an SMW inline query (BlueSpice free) or with a DPL3 list (BlueSpice free).
Example of an SMW query to create an export for all pages in the categories Process and Work instruction:
You would add the following to your MyPDF page in the wiki:
==All processes==
{{#ask:[[Process:+]]|format=ul|limit=99999}}
==All work instructions==
{{#ask:[[Work instruction:+]]|format=ul|limit=99999}}
The same list can be created with the following DPL3 syntax:
==All processes==
{{#dpl:category=Process}}
==All work instructions==
{{#dpl:category=Work instruction}}
Setting up a CronJob
To automate the export, the following CronJob is available:
php {MW_ROOT}/extensions/BlueSpiceUniversalExport/maintenance/export.php --specification-file={MW_ROOT}/extensions/BlueSpiceFoundation/data/spec.json
