Download the PHP package sheadawson/silverstripe-shortcodable without Composer
On this page you can find all versions of the php package sheadawson/silverstripe-shortcodable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sheadawson/silverstripe-shortcodable
More information about sheadawson/silverstripe-shortcodable
Files in sheadawson/silverstripe-shortcodable
Package silverstripe-shortcodable
Short Description Provides a GUI for CMS users to insert Shortcodes into the HTMLEditorField + an API for developers to define Shortcodable DataObjects and Views
License BSD License
Homepage https://github.com/sheadawson/silverstripe-shortcodable
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package silverstripe-shortcodable
SilverStripe Shortcodable 4
SS4 compatible version is WIP. Please submit PRs if you'd like to help move this along!
What’s working:
- The TinyMCE button/popup
- The form in the popup dialog
What’s not working:
- Placeholders
- Editing an existing shortcode
- Probably other things
Provides a GUI for CMS users to insert Shortcodes into the HTMLEditorField + an API for developers to define Shortcodable DataObjects and Views. This allows CMS users to easily embed and customise DataObjects and templated HTML snippets anywhere amongst their page content. Shortcodes can optionally be represented in the WYSIWYG with a custom placeholder image.
Requirements
- SilverStripe 4 +
See 3.x branch/releases for SilverStripe SS 3.5 compatibility See 2.x branch/releases for SilverStripe SS 3.1 - 3.4 compatibility
Installation
Install via composer, run dev/build
Configuration
See this gist for a well documented example of a Shortcodable ImageGallery to get you started. This example is for a subclass of DataObject. If your shortcodable object doesn't need it's own database record, you can use the same example but use ViewableData as the parent class.
TinyMCE block elements
In SilverStripe 3 shortcodes tend to get wrapped in paragraph elements, which is a problem if your shortcode will be rendered as a block element. To get around this you can flag shortcodable classes as block elements with a config setting. If you don't want to replace the paragraph tag with a div this can be disabled as well.
CMS Usage
Once installed a new icon will appear in the CMS HTMLEditor toolbar. It looks like this:
Clicking the toolbar will open a popup that allows you to insert a shortcode into the editor.
Highlighting an existing shortcode tag in the editor before clicking the shortcode icon will open the popup to allow editing of the selected shortcode tag.
Double clicking a shortcode placeholder in the editor will also open the popup to allow editing of the shortcode.
Upgrading from 1.x
Shortcodable 2.0 has an improved method for applying Shortcodable to DataObjects. We no longer use an interface, as this didn't allow for Shortcodable to be applied to core classes such as File, Member, Page etc without changing core code. Instead, Shortcodable is applied to your Objects via yml config. Some methods have also changed from statics to normal methods. See updated examples below.
