DOC Document new in-modal file editing in changelogs

This commit is contained in:
Maxime Rainville 2020-03-05 14:59:30 +13:00
parent 693c4cde46
commit 62703d5cad

View File

@ -3,7 +3,8 @@
## Overview {#overview} ## Overview {#overview}
* [MySQL tables are auto-converted from MyISAM to InnoDB](#myisam) * [MySQL tables are auto-converted from MyISAM to InnoDB](#myisam)
* [Editing files directly in the insert-media modal](#in-modal-editing)
## MySQL tables are auto-converted from MyISAM to InnoDB {#myisam} ## MySQL tables are auto-converted from MyISAM to InnoDB {#myisam}
Beginning with [4.4.0](https://docs.silverstripe.org/en/4/changelogs/4.4.0/), Beginning with [4.4.0](https://docs.silverstripe.org/en/4/changelogs/4.4.0/),
@ -19,25 +20,25 @@ requiring us to enforce the MyISAM engine when devs opted into this index type
in their particular setup. There are a few ways in which this opt-in can happen: in their particular setup. There are a few ways in which this opt-in can happen:
* Adding the [FulltextSearchable](https://github.com/silverstripe/silverstripe-framework/blob/4/src/ORM/Search/FulltextSearchable.php) * Adding the [FulltextSearchable](https://github.com/silverstripe/silverstripe-framework/blob/4/src/ORM/Search/FulltextSearchable.php)
extension to a DataObject, as described in our extension to a DataObject, as described in our
[search docs](https://docs.silverstripe.org/en/4/developer_guides/search/fulltextsearch/) [search docs](https://docs.silverstripe.org/en/4/developer_guides/search/fulltextsearch/)
* Defining `'type' => 'fulltext'` in `DataObject::$db` column definitions * Defining `'type' => 'fulltext'` in `DataObject::$db` column definitions
* Implementing [DBIndexable](https://github.com/silverstripe/silverstripe-framework/blob/4/src/ORM/FieldType/DBIndexable.php) * Implementing [DBIndexable](https://github.com/silverstripe/silverstripe-framework/blob/4/src/ORM/FieldType/DBIndexable.php)
on a custom `DBField` subclass. on a custom `DBField` subclass.
* Setting `'ENGINE=MyISAM'` in `DataObject::$create_table_options` * Setting `'ENGINE=MyISAM'` in `DataObject::$create_table_options`
This search index is not required to enable simple text search This search index is not required to enable simple text search
in the "Pages" section of the CMS, or any ModelAdmin implementations. in the "Pages" section of the CMS, or any ModelAdmin implementations.
We generally recommend to choose a more powerful We generally recommend to choose a more powerful
[search addon](https://addons.silverstripe.org/add-ons?search=fulltext&type=&sort=downloads) [search addon](https://addons.silverstripe.org/add-ons?search=fulltext&type=&sort=downloads)
(e.g. based on Solr or ElasticSearch) for website frontend search use cases. (e.g. based on Solr or ElasticSearch) for website frontend search use cases.
As of 4.6.0, a `dev/build` will automatically switch MyISAM tables to InnoDB, As of 4.6.0, a `dev/build` will automatically switch MyISAM tables to InnoDB,
which automatically recreates any indexes required. If you have large indexes, which automatically recreates any indexes required. If you have large indexes,
this can extend the duration if this task. As usual, back up your database this can extend the duration if this task. As usual, back up your database
before upgrading, and test upgrades on non-production systems first. before upgrading, and test upgrades on non-production systems first.
Our tests indicate that indexes with thousands of records and screen pages Our tests indicate that indexes with thousands of records and screen pages
worth of content (15MB index size) are converted in a few seconds. worth of content (15MB index size) are converted in a few seconds.
In order to opt out of this change, you can set the engine explicitly In order to opt out of this change, you can set the engine explicitly
for your DataObject implementations: for your DataObject implementations:
@ -52,4 +53,21 @@ class MyDataObject extends DataObject
MySQLSchemaManager::ID => 'ENGINE=MyISAM' MySQLSchemaManager::ID => 'ENGINE=MyISAM'
]; ];
} }
``` ```
## Editing files directly in the insert-media modal{#in-modal-editing}
Editors can now directly edit file details when selecting a file in an UploadField or when inserting media in a
HTMLEditorField. The "image placement" and "file link" forms that show when inserting an image or a link in an
HTMLEditorField have been simplified.
This does mean that the order and structure of fields have changed somewhat. If you have customised the forms in the
asset administration area or in the "Insert Media Modal", you should do some regression testing when upgrading to
make sure your customisations still work as expected.
If your project uses the popular [jonom/focuspoint](https://github.com/jonom/silverstripe-focuspoint) community
module, you should upgrade it as well.
<!--- Changes below this line will be automatically regenerated -->
<!--- Changes above this line will be automatically regenerated -->