Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebobo/shel.neos.hyphens
CKEditor plugin to insert hyphens & non-breaking spaces in Neos CMS
https://github.com/sebobo/shel.neos.hyphens
hacktoberfest insert-hyphens nbsp neos-cms soft-hyphens
Last synced: 13 days ago
JSON representation
CKEditor plugin to insert hyphens & non-breaking spaces in Neos CMS
- Host: GitHub
- URL: https://github.com/sebobo/shel.neos.hyphens
- Owner: Sebobo
- License: gpl-3.0
- Created: 2019-04-11T07:34:20.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T08:55:28.000Z (8 months ago)
- Last Synced: 2024-10-31T13:33:35.659Z (20 days ago)
- Topics: hacktoberfest, insert-hyphens, nbsp, neos-cms, soft-hyphens
- Language: JavaScript
- Homepage:
- Size: 2.39 MB
- Stars: 20
- Watchers: 4
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Hyphens CKEditor5 plugin for Neos CMS
[](https://packagist.org/packages/shel/neos-hyphens)
[](https://packagist.org/packages/shel/neos-hyphens)
[](https://packagist.org/packages/shel/neos-hyphens)
## Introduction
This package provides a button to insert soft hyphens and non-breaking spaces for the inline editor in Neos CMS.
Many browsers support some kind of hyphenation via CSS, but it doesn't work reliably on all systems
and not with all languages. See the [CanIuse](https://caniuse.com/#feat=css-hyphens) table for details.
Therefore this package provides a manual way to insert them. You should be careful with using the
CSS-based hyphenation in combination with the manual hyphens as results can be unexpected.
It's compatible with Neos CMS 4.3, 5, 7 and 8 but only the active Neos LTS versions receive new bug fixes.
## Example
In the backend, this plugin will add the option to add soft hyphens. They will look like this while editing:
And in the frontend will convert this:
Into this:
And in action:
## Advantages
* Your editors gain control over word breaks.
* Stores the special character in the database with their UTF8 representation, which the browser interprets as ``.
* You don't need other characters which you replace with correct characters in the frontend.
* Should work fine with Elasticsearch and other search engines.
### Planned features
See [enhancement issue list](https://github.com/Sebobo/Shel.Neos.Hyphens/issues?utf8=✓&q=is%3Aissue+label%3Aenhancement+).
## Installation
Run this in your site package
```bash
composer require --no-update shel/neos-hyphens
```
Then run `composer update` in your project directory.
## How to use
### Hyphen
Enable it for a node with editable text like this:
```yaml
'Neos.NodeTypes:Text':
properties:
text:
ui:
inline:
editorOptions:
hyphens: true
```
This will add a new button to insert a soft hyphen. As an alternative, you can use the shortcut `Ctrl + Shift + -` to add a new soft hyphen. To change the shortcut keys, have a look at the [Settings.yaml](Configuration/Settings.yaml#L12) file.
### Non-breaking space
Enable it for a node with editable text like this:
```yaml
'Neos.NodeTypes:Text':
properties:
text:
ui:
inline:
editorOptions:
nbsp: true
```
This will add a new button to insert a non-breaking space.
## Customization
### Hyphen & non-breaking space styling in the backend
You can provide your own styling by referencing your own stylesheet.
See the file `Override.Page.fusion` on how the default styling is included.
You can either override the configuration from your own package and just use your stylesheet
or you can add yours and use both.
## Contributions
Contributions are very welcome!
Please create detailed issues and PRs.
**If you use this package and want to support or speed up it's development, [get in touch with me](mailto:[email protected]).**
Or you can also support me directly via [patreon](https://www.patreon.com/shelzle).
## License
See [License](./LICENSE.txt)