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

Latest revision as of 07:30, 21 May 2024

Extension

BlueSpice Extension: BlueSpiceUEModuleBookPDF

Usage

This script allows to export the wiki pages from all content namespaces to PDF.

To run the script, execute:

php {MW_ROOT}/extensions/BlueSpiceUEModuleBookPDF/maintenance/dumpPDF.php --file=<localpath> --limit=200 --mail=admin@mymail.com

Options

--file: Defines the output path and the base filename.
This name will be appended with the namespace number and — if --limit is set — with the split group. Example: --file=/tmp/test.pdf will result in /tmp/test_0.pdf or /tmp/test_0_ABC.pdf.
--limit: Sets a limit for wikipages in a namespace included in one pdf. If the limit is exceeded, the namspace will be split into pdfs depending on the first character of the page name. If the parameter --limit is not set, all pages of a namespace will be exported to one pdf file.
--verbose: Runs the script in verbose mode.
--mail: E-mail address for a notification email.

You can see the list of possible options with descriptions by using the following command:

php {MW_ROOT}/extensions/BlueSpiceUEModuleBookPDF/maintenance/dumpPDF.php --help

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

@@ Line 1: / Line 1: @@
 [[Setup:Installation_Guide/Advanced/Maintenance_scripts|{{Icon|bi bi-arrow-right-circle|||}} all maintenance scripts]]
-==Reference==
+==Extension==
-BlueSpice Extension: [[Reference:BlueSpiceUEModuleBookPDF|BlueSpiceUEMoudleBookPDF]]
+BlueSpice Extension: [[Reference:BlueSpiceUEModuleBookPDF|BlueSpiceUEModuleBookPDF]]
-Script location: <code>extensions/BlueSpiceUEModuleBookPDF/maintenance/dumpPDF.php</code>
-==Usage==
+==Usage ==
-==Configuration ==
+This script allows to export the wiki pages '''from all content namespaces''' to PDF.
+To run the script, execute:<syntaxhighlight lang="text">
+php {MW_ROOT}/extensions/BlueSpiceUEModuleBookPDF/maintenance/dumpPDF.php --file=<localpath> --limit=200 --mail=admin@mymail.com
+</syntaxhighlight>
 ==Options==
+*<code>--file:</code> Defines the output path and the base filename.  <br />This name will be appended with the namespace number and — if  <code>--limit</code>  is set — with the split group.  ''Example:'' <code>--file=/tmp/test.pdf</code> will result in <code>/tmp/test_0.pdf</code> or <code>/tmp/test_0_ABC.pdf.</code>
+*<code>--limit:</code> Sets a limit for wikipages in a namespace included in one pdf. If the limit is exceeded, the namspace will be split into pdfs depending on the first character of the page name. If the parameter <code>--limit</code>  is not set, all pages of a namespace will be exported to one pdf file.
+*<code>--verbose</code>:  Runs the script in verbose mode.
+*<code>--mail:</code> E-mail address for a notification email.
+You can see the list of possible options with descriptions by using the following command:<syntaxhighlight lang="text">
+php {MW_ROOT}/extensions/BlueSpiceUEModuleBookPDF/maintenance/dumpPDF.php --help
+</syntaxhighlight>