add example for 'url-metadata' option (closes #1884)

3 years ago · 8c29a6e491
parent d0761454b1
commit 8c29a6e491
1 changed files with 6 additions and 0 deletions
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@ -524,6 +524,12 @@ Default
 Description
    Insert a file's download URL into its metadata dictionary as the given name.

+    For example, setting this option to ``"gdl_file_url"`` will cause a new
+    metadata field with name ``gdl_file_url`` to appear, which contains the
+    current file's download URL.
+    This can then be used in `filenames <extractor.*.filename_>`_,
+    with a ``metadata`` post processor, etc.
+

 extractor.*.category-transfer
 -----------------------------