document exporting

This commit is contained in:
Dave Vasilevsky 2025-02-15 20:16:32 -05:00
parent e67a148096
commit 336999ffeb

View File

@ -190,6 +190,42 @@ with `--dropbox-batch-mode async` then do a final transfer with
Note that there may be a pause when quitting rclone while rclone
finishes up the last batch using this mode.
### Exporting files
Certain files in Dropbox are "exportable", such as Dropbox Paper
documents. These files need to be converted to another format in
order to be downloaded. Often multiple formats are available for
conversion.
When rclone downloads a exportable file, it chooses the format to
download based on the `--dropbox-export-formats` setting. By
default, the export formats are `html,md`, which are sensible
defaults for Dropbox Paper.
Rclone chooses the first format ID in the export formats list that
Dropbox supports for a given file. If no format in the list is
usable, rclone will choose the default format that Dropbox suggests.
Rclone will change the extension to correspond to the export format.
Here are some examples of how extensions are mapped:
| File type | Filename in Dropbox | Filename in rclone |
|----------------|---------------------|--------------------|
| Paper | mydoc.paper | mydoc.html |
| Paper template | mydoc.papert | mydoc.papert.html |
| other | mydoc | mydoc.html |
_Importing_ exportable files is not yet supported by rclone.
Here are the supported export extensions known by rclone. Note that
rclone does not currently support other formats not on this list,
even if Dropbox supports them. Also, Dropbox could change the list
of supported formats at any time.
| Format ID | Name | Description |
|-----------|----------|----------------------|
| html | HTML | HTML document |
| md | Markdown | Markdown text format |
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/dropbox/dropbox.go then run make backenddocs" >}}
### Standard options
@ -522,6 +558,11 @@ non-personal account otherwise the visibility may not be correct.
[forum discussion](https://forum.rclone.org/t/rclone-link-dropbox-permissions/23211) and the
[dropbox SDK issue](https://github.com/dropbox/dropbox-sdk-go-unofficial/issues/75).
Modification times for Dropbox Paper documents are not exact, and
may not change for some period after the document is edited.
To make sure you get recent changes in a sync, either wait an hour
or so, or use `--ignore-times` to force a full sync.
## Get your own Dropbox App ID
When you use rclone with Dropbox in its default configuration you are using rclone's App ID. This is shared between all the rclone users.