From e6a6cfbd4ce85799d9c5dc3127bcf7574450b21c Mon Sep 17 00:00:00 2001 From: Carsten Rose <carsten.rose@math.uzh.ch> Date: Sun, 11 Dec 2022 21:53:19 +0100 Subject: [PATCH] Refs #15111. Update doc --- Documentation/Report.rst | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/Documentation/Report.rst b/Documentation/Report.rst index c17abd4b7..5ac16128b 100644 --- a/Documentation/Report.rst +++ b/Documentation/Report.rst @@ -1611,20 +1611,16 @@ Example:: Column: _saveZip ^^^^^^^^^^^^^^^^ -Generated ZIP can be stored directly on the server with this functionality. The link query consists of the following parameters: +Save generated ZIP locally on the server. -* One or more element sources (such as ``F:``, ``U:``, ``p:``, see :ref:`download-parameter-files`), including possible wkhtmltopdf parameters -* Any element sources given with ``F:`` is accepted for insert in zip file. -* Element sources given with ``U:`` or ``p:`` will first generated as pdf files before they are added to zip. Generated pdf files will be named "file-#.pdf". +* One or more element sources (such as ``F:``, ``U:``, ``p:``, see :ref:`download-parameter-files`), including possible + wkhtmltopdf parameters. +* Element sources given with ``U:`` or ``p:`` will first generated as pdf files before they are added to ZIP. Generated + pdf files will be named "file-#.pdf". * The export filename and path as ``d:`` - for security reasons, this path has to start with *fileadmin/* and end with *.zip*. - -Tips: - -* Please note that this option does not render anything in the front end, but is executed each time it is parsed. - You may want to add a check to prevent multiple execution. -* It is not advised to generate the filename with user input for security reasons. -* If the target file already exists it will be overwriten. To save individual files, choose a new filename, - for example by adding a timestamp. +* If the target file already exists it will be overwritten. +* This option does not render anything in the front end, but is executed each time it is parsed! + Add a check to prevent unnecessary execution. Example:: -- GitLab