Skip to content

Commit

Permalink
added missing documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
threadi committed Nov 10, 2024
1 parent 128a8e0 commit 19952ee
Show file tree
Hide file tree
Showing 8 changed files with 60 additions and 15 deletions.
4 changes: 2 additions & 2 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ The plugin provides a number of WP CLI commands.

## Import

`wp eml import [URLs] [--login=<login> --password=<password>]`
`wp eml import [URL] [--login=<login> --password=<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
Expand Down
4 changes: 2 additions & 2 deletions docs/cli_de.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Das Plugin stellt eine Reihe von WP CLI Kommandos bereit.

## Import

`wp eml import [URLs] [--login=<login> --password=<password>]`
`wp eml import [URL] [--login=<login> --password=<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
Expand Down
13 changes: 13 additions & 0 deletions docs/import/file.md
Original file line number Diff line number Diff line change
@@ -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`
13 changes: 13 additions & 0 deletions docs/import/file_de.md
Original file line number Diff line number Diff line change
@@ -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`
11 changes: 11 additions & 0 deletions docs/protocols.md
Original file line number Diff line number Diff line change
@@ -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)

13 changes: 7 additions & 6 deletions docs/protocols_de.md
Original file line number Diff line number Diff line change
@@ -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)

4 changes: 4 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
13 changes: 8 additions & 5 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==

Expand Down Expand Up @@ -66,21 +65,25 @@ 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? =

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 ==

Expand Down

0 comments on commit 19952ee

Please sign in to comment.