diff --git a/docs/cli.md b/docs/cli.md index 508cadb..6116fe4 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -8,9 +8,9 @@ The plugin provides a number of WP CLI commands. ## Import -`wp eml import [URLs] [--login= --password=]` +`wp eml import [URL] [--login= --password=]` -* You can specify any number of URLs whose protocols are supported by the plugin here. +* You can specify a URL whose protocol are supported by the plugin. * The optional access data is used for each of these URLs. ## Delete diff --git a/docs/cli_de.md b/docs/cli_de.md index 0bbffc8..3868b60 100644 --- a/docs/cli_de.md +++ b/docs/cli_de.md @@ -8,9 +8,9 @@ Das Plugin stellt eine Reihe von WP CLI Kommandos bereit. ## Import -`wp eml import [URLs] [--login= --password=]` +`wp eml import [URL] [--login= --password=]` -* Du kannst beliebig viele URLs, deren Protokolle vom Plugin unterstützt werden, hier angeben. +* Du kannst eine URL, deren Protokoll vom Plugin unterstützt wird, hier angeben. * Die optionalen Zugangsdaten werden bei jeder dieser URLs verwendet. ## Löschen diff --git a/docs/import/file.md b/docs/import/file.md new file mode 100644 index 0000000..355e51b --- /dev/null +++ b/docs/import/file.md @@ -0,0 +1,13 @@ +# Import from local directory + +This section describes how you can import files from a local directory on the project hosting. + +## Requirements + +You only need the absolute path of the directory. You can see this under Tools > Website status > Info. + +## Note + +The absolute path must be specified with a leading `file://`. + +Example: `file:///var/www/website/httpdocs/picture.png` diff --git a/docs/import/file_de.md b/docs/import/file_de.md new file mode 100644 index 0000000..9f89c35 --- /dev/null +++ b/docs/import/file_de.md @@ -0,0 +1,13 @@ +# Import von lokalem Verzeichnis + +Hier wird beschrieben wie Du Dateien von einem lokalen Verzeichnis auf dem Hosting des Projektes importieren kannst. + +## Voraussetzungen + +Du benötigst von dem Verzeichnis lediglich den absoluten Pfad. Du kannst den ggfs. unter Werkzeuge > Website-Zustand > Info sehen. + +## Hinweis + +Der absolute Pfad muss mit führendem `file://` angegeben werden. + +Beispiel: `file:///var/www/website/httpdocs/picture.png` diff --git a/docs/protocols.md b/docs/protocols.md new file mode 100644 index 0000000..abad0c4 --- /dev/null +++ b/docs/protocols.md @@ -0,0 +1,11 @@ +# Protocols + +The plugin currently supports the following protocols for integrating external files into WordPress: + +* [http://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/http.md) +* [https://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/http.md) +* [ftp://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/ftp.md) +* [ftps://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/ftp.md) +* [sftp://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/sftp.md) +* [file://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/file.md) + diff --git a/docs/protocols_de.md b/docs/protocols_de.md index 03fbf5d..d9aa98c 100644 --- a/docs/protocols_de.md +++ b/docs/protocols_de.md @@ -1,10 +1,11 @@ # Protokolle -Das Plugin unterstützt derzeit die folgenden Protokolle um externe Dateien in WordPress einzubinden: +Das Plugin unterstützt derzeit die folgenden Protokolle, um externe Dateien in WordPress einzubinden: -* http:// -* https:// -* ftp:// -* ftps:// -* sftp:// +* [http://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/http_de.md) +* [https://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/http_de.md) +* [ftp://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/ftp_de.md) +* [ftps://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/ftp_de.md) +* [sftp://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/sftp_de.md) +* [file://](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/file_de.md) diff --git a/readme.md b/readme.md index bc5fd76..19ea07a 100644 --- a/readme.md +++ b/readme.md @@ -4,6 +4,10 @@ This repository provides the features of the WordPress plugin _External files in media library_. The repository is used as a basis for deploying the plugin to the WordPress repository. It is not intended to run as a plugin as it is, even if that is possible for development. +## Hint + +As user of the plugin you find documentation for protocols and handling in the [doc-directory](https://github.com/threadi/external-files-in-media-library/tree/master/docs/). + ## Usage After checkout go through the following steps: diff --git a/readme.txt b/readme.txt index 2d73c87..634d06b 100644 --- a/readme.txt +++ b/readme.txt @@ -16,8 +16,7 @@ Add one or more files under Media > "Add new media file". You can use the files == Mass-Import == -You can import complete directories from any of the supported TCP protocols. Just enter the directory as path to import -and the plugin will import any supported files from it. +You can import complete directories from any of the supported TCP protocols. Just enter the directory as path to import and the plugin will import any supported files from it. == TCP Protocols == @@ -66,7 +65,7 @@ Yes, but these files will included locally and not from the external URL. = Can I embed files from FTP? = -Yes, but these files will included locally and not from the external URL. +Yes, see [our documentation](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/ftp.md). = Can I import complete directories? = @@ -74,13 +73,17 @@ Yes, you can. Just enter the directory to import. = Can I import from my local server? = -Yes, you can. Simply enter the absolute path with file-protocol, e.g.: file:///var/www/path/to/file.png +Yes, you can. Simply enter the absolute path with file-protocol, e.g.: `file:///var/www/path/to/file.png` - see also [our documentation](https://github.com/threadi/external-files-in-media-library/blob/master/docs/import/file.md). = Can I import external product images for WooCommerce? = Yes, simply enable the setting under Settings > External files in Media Library > WooCommerce. Add your external URLs for images in the CSV you want to import as it is already possible with WooCommerce. They will be handled as -external files by this plugin. +external files by this plugin. This also allows you to use all protocols supported by the plugin for importing these files. + += Is there a WP CLI command? = + +Yes, there are many options on WP CLI, see [our documentation](https://github.com/threadi/external-files-in-media-library/blob/master/docs/cli.md). == Screenshots ==