Documentation for MODX 3 Alpha

[Mark-H]

This issue will contain a work-in-progress list of changes in 3.0 that should be documented.

It's probably not complete... please do pop in and help. To edit a page in the docs, find the "Edit this page link" under the title on docs.modx.org or browse the repo and click Edit on the relevant source file.

Make sure you're targetting the 3.x branch!

New features

• Changes to manager language selection, including on the fly selection
• Passwordless login Passwordless login modxcms/revolution#14351
• Content-type based icons for in the tree - is the template based icon documented? Customized icons for content types modxcms/revolution#14383
• New output filters related to file handling Add modifiers to get information from filepath: dirname, basename, fi… modxcms/revolution#14198
• custom backgrounds on the login screen, plus ability to use extras for it like https://github.com/Mark-H/Login_Unsplash (unreleased proof of concept)
• Dashboard widgets configurable on the dashboard itself Update dashboards modxcms/revolution#13844
• New options on grid (extjs) to control the automatically added gear icon Add actions column to grids modxcms/revolution#14806

xPDO 3

... bunch of stuff goes here ...

PSR-4 autoloading w/ composer
xPDO 3 model refactor

Changed features

These may or may not have existing documentation but should probably be noted somewhere.

• Changes to password reset handling, such as no passwords in the email Forgot password for new login screen modxcms/revolution#13786
• Package attributes now being parsed as markdown Add support of Markdown in package attributes modxcms/revolution#13853
• Core directory protected in media sources Protect important directories modxcms/revolution#14374
• Something about this parser change for better array support in custom parsers Generate sortable tag signature with serialized array values modxcms/revolution#14689
• MODx.perm is now always loading all permissions automatically Load all mgr permissions at once to MODx.perm modxcms/revolution#14425 Load all mgr permissions at once to MODx.perm modxcms/revolution#13924
• modRestService empty string return for empty tags Return empty string for empty xml tag in modRestService modxcms/revolution#14305
• parser change for brackets around tags Fix modParser so we can output brackets around parsed elements modxcms/revolution#13904
• media sources based on flysystem, AWS v3 support Fixes #13701 use League\Flysystem for MediaSources modxcms/revolution#13709 Update media sources modxcms/revolution#13811

Removed/cleaned up features

This may also need an update in the 2.x branch to note it as being removed in 3.0

• @EVAL binding in TVs removed, including allow_tv_eval setting [3.x] Remove @EVAL binding from TVs to prevent arbitrary code execution by admins modxcms/revolution#13865
• modParser095, modTranslate095, and modTranslator removed Remove outdated classes for converting evo tags to revo modxcms/revolution#14133
• modResource->contentType removed (which !== content_type, which still exists) Removing obsolete contentType field from resource modxcms/revolution#14057
• xmlrss Fix/remove custom xmlrss modxcms/revolution#14034
• xmlrpc/jsonrpc classes Remove unused and outdated xmlrpc and jsonrpc classes modxcms/revolution#14033
• flash based copy to clipboard Remove flash (.swf) based copy to clipboard (#13697) modxcms/revolution#13814

Other breaking changes

Which should probably only be mentioned in the breaking changes section.

• /manager/min/ directory removed rm -rf manager/min modxcms/revolution#12778 [3.x] Add setup upgrade to remove the manager/min/ folder on upgrade modxcms/revolution#13194 Remove manager/min folder from sources modxcms/revolution#14416
• Renamed processor class names and locations
  • Special attention to resource-related processors, because of custom resource types that may call/require those directly
• Renamed model classes, which are auto converted in loadClass which doesn't help with things like instanceof checks
• Renamed/moved classes that get a BC assist from the autoloader until 3.3 Make \modX and other class_aliases for backwards compatibility available in all requests modxcms/revolution#14704

Setting changes

• automatic_template_assignment default changed to sibling Change default automatic_template_assignment, tree node fallback, and preserve_menuindex modxcms/revolution#14328
• preserve_menuindex default changed to false Change default automatic_template_assignment, tree node fallback, and preserve_menuindex modxcms/revolution#14328
• manager_favicon_url new default icon Add favicon to manager in System settings modxcms/revolution#14324
• manager_time_format default changed Change the Manager date and time format after a clean installation. modxcms/revolution#14325

Removed settings

May have docs that need to be removed/updated, as well as changes in the 2.x branch to indicate changes are coming.

• allow_tv_eval [3.x] Remove @EVAL binding from TVs to prevent arbitrary code execution by admins modxcms/revolution#13865
• compress_js_max_files Remove obsolete system settings modxcms/revolution#13859
• manager_js_zlib_output_compression Remove obsolete system settings modxcms/revolution#13859
• upload_flash Remove support for "Uploadable Flash Types" modxcms/revolution#14252
• manager_language
• udperms_allowroot, webpwdreminder_message Deleted unnecessary system settings for "Authentication and Security" section modxcms/revolution#14841
• manager_js_cache_file_locking, manager_js_cache_max_age, manager_js_document_root Removed unused system settings for "Back-end Manager" section modxcms/revolution#14868
• resolve_hostnames, server_protocol Removed unused system settings for "System and Server" section modxcms/revolution#14877

Manager interface/design changes

Perhaps a "notable ui changes" document? IMO not as important in alpha phase as the UI is probably going to evolve further

• media browser responsiveness Added adaptive styles for MODX browser modxcms/revolution#14735
• changed user profile layout Corrected profile layout modxcms/revolution#14731 (among other PRs) Change layout on profile pages modxcms/revolution#14420
• Streamline UI for resource settings and quick update Made resource settings and quick resource window in one format modxcms/revolution#14726
• lot of consistency things, for buttons, tabs, descriptions... Consistency in "New" buttons on tables modxcms/revolution#14312 Changed the order of tabs in the Template and TV form modxcms/revolution#14251 Insert TV-tab before Settings-tab in resource editing form modxcms/revolution#14250
• ability to disable tooltips or change delay Add manager tooltip disable and delay modxcms/revolution#14535
• showing success message Add notification of successful database operation on System Info > Database tables modxcms/revolution#14525
• trimming search terms in uberbar Fixed #14448 (Spaces before or after search word distort the result) modxcms/revolution#14523
• redesigned installer New design for installer modxcms/revolution#14507
• translations disabled in manager Prevent Google Chrome translations from the admin panel modxcms/revolution#14414
• normalize.css added Add normalize.css modxcms/revolution#14369
• gravar disabled by default Disabled Gravatar by default for new installations modxcms/revolution#14215
• redesigned login Redesigned manager login modxcms/revolution#13773

Others

Upgrades to 3.0 are only supported for 2.6+ modxcms/revolution@9a527c6#diff-948b50215f9ff1174344c1b416fd0ac5 modxcms/revolution#14878

Uses of @EVAL in tutorials that need to be updated now that eval is gone:

• https://docs.modx.org/3.x/en/building-sites/tutorials/multiselect-related-pages
• https://docs.modx.org/3.x/en/extras/gallery/gallery/assinging-a-gallery-album-to-a-specifc-resource
• https://docs.modx.org/3.x/en/extras/migxdb/migxdb.tutorials/create-a-basic-gallery-management-from-scratch-with-migxdb/add-image-tagging

[JoshuaLuckers]

ExtJS / JS

Some notable changes related to ExtJS / JS.

• A new utility method dateFromTimestamp is added to MODX.util.Format Format timestamp to date & time in edit file panel modxcms/revolution#14873

[Ruslan-Aleev]

New features

Additionally, for "New options on grid (extjs) to control the automatically added gear icon modxcms/revolution#14806"

• it is worth adding "hover effect for editable grid columns" (Add hover effect and tooltip for editable grid columns [#14176] modxcms/revolution#14748)
• and "links for grid columns" (Added item links to grids modxcms/revolution#14864).

[Ruslan-Aleev]

New features

• Add a description of changing the visibility of the folder and file.
  

[Ibochkarev]

modxcms/revolution#15488 properties for @chunk and @snippet binding