diff --git a/404.html b/404.html index f9c9131..60703b6 100644 --- a/404.html +++ b/404.html @@ -16,7 +16,7 @@
Exporter

Appearance

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Take me home
- + \ No newline at end of file diff --git a/custom-elements.html b/custom-elements.html index c06f2e1..2cff451 100644 --- a/custom-elements.html +++ b/custom-elements.html @@ -85,7 +85,7 @@ ]); } ); - + \ No newline at end of file diff --git a/custom-fields.html b/custom-fields.html index f71f452..8aed59a 100644 --- a/custom-fields.html +++ b/custom-fields.html @@ -47,7 +47,7 @@ ]); } );

Included Parsers ​

There all live under the studioespresso\exporter\fields\ namespace.

- + \ No newline at end of file diff --git a/fields.html b/fields.html index 36d0a28..748fbd7 100644 --- a/fields.html +++ b/fields.html @@ -19,7 +19,7 @@
Exporter

Appearance

Brought to you by:

Elements, fields & formats ​

This is an overview, per element type, of the fields that can be exported out of the box. Versions of the plugin in which support is added are listed, as well as versions in which certain value options are added as well.

Supported elements ​

Output formats ​

The plugins supports generating files in the following formats:

  • XLSX 4.0.0
  • CSV 4.0.0

Missing format?

If you need a different file format than the ones listed here, feel free to create an issue here and I'll see if it can be added to the plugin

Field Parsers ​

The handle fields, the plugin come with a number of "parser". The selected parser defines how the data will be added to the export and if there are any formatting options available for the data in question.

RelationFieldParser 4.0.0 ​

  • Used for any relation fields
  • Output options are: title, id, url

OptionsFieldParser 4.0.0 ​

  • Used for any single-value select fields (dropdown, radio buttons)
  • Output options are: label, value

MultiOptionsFieldParser 4.0.0 ​

  • Used for any multi-value select fields (checkboxes)
  • Output options are: label, value

OptionsFieldParser 4.0.0 ​

  • Used for any dropdown or select fields
  • Output options are: label, value

DateTimeParser 4.0.0 ​

  • Used for Date and DateTime fields
  • Output options are: d/M/Y, m/d/Y, d/M/Y H:i, m/d/Y H:i, d/M/Y H:i:s, m/d/Y H:i:s

TimeParser 4.0.0 ​

  • Used for Date and DateTime fields
  • Output options are: H:i:s, H:i

PlainTextParser 4.0.0 ​

Straight forward, this output the data as it's entered. This is also the fallback for any data that can't be process by the other parsers.

- + \ No newline at end of file diff --git a/hashmap.json b/hashmap.json index 842d3a5..181b680 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"custom-fields.md":"c9b1779b","usage.md":"95c03534","settings.md":"8d94006f","index.md":"c521b06d","custom-elements.md":"3845250b","fields.md":"8de1b1ad"} +{"custom-elements.md":"3845250b","fields.md":"8de1b1ad","index.md":"c521b06d","settings.md":"8d94006f","custom-fields.md":"c9b1779b","usage.md":"95c03534"} diff --git a/index.html b/index.html index 436c2f4..8f64051 100644 --- a/index.html +++ b/index.html @@ -33,7 +33,7 @@ # tell Craft to install the plugin ./craft install/plugin exporter

Roadmap ​

The following additions & improvements are being considered:

Get in touch if there's anything elso you'd like to see added!

Brought to you by Studio Espresso

- + \ No newline at end of file diff --git a/settings.html b/settings.html index 87f2c2c..fe99468 100644 --- a/settings.html +++ b/settings.html @@ -19,7 +19,7 @@
Exporter

Appearance

Brought to you by:

Plugin settings ​

How the plugin will be called in the sidebar of the control panel

HTML Email template ​

Path the template that will be used to send to export (as an attachment) to the provided email-address.

- + \ No newline at end of file diff --git a/usage.html b/usage.html index 5858119..7527ce0 100644 --- a/usage.html +++ b/usage.html @@ -19,7 +19,7 @@
Exporter

Appearance

Brought to you by:

Usage ​

Element exporter can be set up in a number of ways,

Step 1: Element selection ​

On the first step, you start by selecting the type of Element you want to export. If the element in question has groups (and possibly subgroups), you have to select on of these as well.

These element types and groups are supported out of the box:

  • Entry (grouped by Sections and Entry Types) 4.0.0
  • Categories (grouped by Category groups) 4.0.0
  • Formie submissions (grouped by Form) 4.0.0
Step 1 of the new export flow

If the element can be localized, you also have to select the site from which you want to export items.

Step 2: Field selection ​

On the next step, you'll select which attributes & fields you want to be included in the export.

All custom fields available on the elements in question will be listed, in 1 of 3 ways:

  • Without value parsing options (for straight forward values, eg: plain text, email, url)
  • With value parsing options (date or time fields, relation fields)
  • Not supported fields.

Not supported fields

Complex fields, with sub-fields, like Matrix or SuperTable fields are not supported out of the box. You can register a Field Parser to add support yourself.

Step 2 of the export creation flow

Step 3: Delivery settings ​

On this step, you can narrow down the number of elements that will be exported, in which format you'd like the export to be generated and to which e-mailaddress the export should be delivered.

Element selection ​

You can choose one of the following options, all of those based on the criteria you selected in Step 1

  • All elements
  • The last x elements created
  • Elements created between a certain date and now
  • Elements created between 2 dates

File formats ​

The plugin supports these file formats:

  • XLSX 4.0.0
  • CSV 4.0.0

Missing format?

If you need a different file format than the ones listed here, feel free to create an issue here and I'll see if it can be added to the plugin

Delivery options ​

You can select to deliver the export in the inbox of the user that is logged in in that moment, or to set one or more email-addresses to which the file will be delivered.

Depending on the number of elements in your export, generating the file will take longer so when you receive the file depends on that.

Why email?

Since the plugin can't predict how long it will take to generate the file, the safest way to ensure it's delivery is to let Craft's queue system generate the file and when that is done you'll receive an email with the export attached.

- + \ No newline at end of file