Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-1190: Updated readme to fit new template #214

Merged
merged 1 commit into from
Oct 20, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 7 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,18 @@
# Ibexa RichText Field Type Bundle
# Ibexa RichText Field Type

This Bundle provides RichText (`ezrichtext`) Field Type
for [Ibexa DXP](https://www.ibexa.co/products) and Ibexa Open Source. It is a Field Type for
supporting rich formatted text stored in a structured XML format.
This package is part of [Ibexa DXP](https://ibexa.co).

This Field Type succeeds the former [XMLText](https://github.com/ezsystems/ezplatform-xmltext-fieldtype)
Field Type found in eZ Publish 5.x and before.
To use this package, [install Ibexa DXP](https://doc.ibexa.co/en/latest/install/).

## Installation

1. In your Ibexa project, require this package by the Composer.

```bash
composer require ezsystems/ezplatform-richtext
```

2. Enable the Bundle in `config/bundles.php`:

```php
return [
// ...
EzSystems\EzPlatformRichTextBundle\EzPlatformRichTextBundle::class => ['all' => true],
// ...
];
```

3. Remember to clear the Symfony Cache (for `SYMFONY_ENV` your project uses).
```bash
php bin/console cache:clear
```

## Background

When looking to find a structured text format for Ibexa, we wanted to pick something that
was widely used in the industry and which could support the custom & embed structures we have
had in eZ Publish for years, which has enabled us to seamlessly target several channels / formats
based on the same internal stored formats.

What we had at the time was inspired by early drafts of XHTML 2.0, a standard made for the most
part obsolete by html5.

We also knew from experience we had to support html5 as an input/output format for RichText editors
to reduce the number of customizations we had to apply on top of available editors. Which would make
it hard to keep up to date, and forces us to deal with edge cases ourselves instead of relying on
the editor doing it for us.

In RichText we have ended up with a solution that is built on a more widely used internal format,
moved closer to html5 supported by editors, and better suited to support wider range of formats.

## Format

### Storage format

Storage format in RichText is [DocBook](http://docbook.org/), for further info on its schema and how we
extend it with RELAX NG, see [Resources/schemas/docbook/](src/lib/eZ/RichText/Resources/schemas/docbook).

### Input/Output formats

This Field Type supports several output and input formats, DocBook, ezxml _(legacy format)_, and
two forms of HTML5 _(edit and output)_.

Further reading on these formats and how they uses schemas, XSLT and DTD, see [Resources/](src/lib/eZ/RichText/Resources).

## Migrating

The architecture allows for migration to and from several formats in the future, currently
the following is the main one supported:

### From eZ Publish

For migrating from eZ Publish's XMLText format, have a look at the seperate [XMLText Field Type](https://github.com/ezsystems/ezplatform-xmltext-fieldtype).
This package contains the RichText (`ezrichtext`) Field Type for [Ibexa DXP](https://ibexa.co).
It is a Field Type for supporting rich formatted text stored in a structured XML format.

## COPYRIGHT

Copyright (C) 1999-2021 Ibexa AS (formerly eZ Systems AS). All rights reserved.

## LICENSE

This source code is available separately under the following licenses:

A - Ibexa Business Use License Agreement (Ibexa BUL),
Expand Down