diff --git a/README.md b/README.md index 82f27f6d..519b71d4 100755 --- a/README.md +++ b/README.md @@ -1,31 +1,11 @@ # [![](https://bitbag.io/wp-content/uploads/2021/01/CMS.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) -# Sylius CMS Plugin +# SyliusCMSPlugin ---- [![](https://img.shields.io/packagist/l/bitbag/cms-plugin.svg) ](https://packagist.org/packages/bitbag/cms-plugin "License") [ ![](https://img.shields.io/packagist/v/bitbag/cms-plugin.svg) ](https://packagist.org/packages/bitbag/cms-plugin "Version") [ ![](https://img.shields.io/github/actions/workflow/status/BitBagCommerce/SyliusCmsPlugin/build.yml) ](https://github.com/BitBagCommerce/SyliusCmsPlugin/actions "Build status") [ ![](https://img.shields.io/scrutinizer/g/BitBagCommerce/SyliusCMSPlugin.svg) ](https://scrutinizer-ci.com/g/BitBagCommerce/SyliusCMSPlugin/ "Scrutinizer") [![](https://poser.pugx.org/bitbag/cms-plugin/downloads)](https://packagist.org/packages/bitbag/cms-plugin "Total Downloads") [![Slack](https://img.shields.io/badge/community%20chat-slack-FF1493.svg)](http://sylius-devs.slack.com) [![Support](https://img.shields.io/badge/support-contact%20author-blue])](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) -

- -

- -At BitBag we do believe in open source. However, we are able to do it just because of our awesome clients, who are kind enough to share some parts of our work with the community. Therefore, if you feel like there is a possibility for us to work together, feel free to reach out. You will find out more about our professional services, technologies, and contact details at [https://bitbag.io/](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms). - -Like what we do? Want to join us? Check out our job listings on our [career page](https://bitbag.io/career/?utm_source=github&utm_medium=referral&utm_campaign=career). Not familiar with Symfony & Sylius yet, but still want to start with us? Join our [academy](https://bitbag.io/pl/akademia?utm_source=github&utm_medium=url&utm_campaign=akademia)! - -## Table of Content - -*** - -* [Overview](#overview) -* [Support](#we-are-here-to-help) -* [About us](#about-us) - * [Community](#community) -* [Demo](#demo-sylius-shop) -* [License](#license) -* [Contact](#contact) - # Overview *** @@ -37,96 +17,31 @@ with content elements to your storefront. - [Use Case](doc/use_case.md) - [Collections](doc/use_case_collections.md) - - [Templates](doc/use_case_templates.md) + - [Content Templates](doc/use_case_content_templates.md) - [Pages](doc/use_case_pages.md) - [Blocks](doc/use_case_blocks.md) - [Media](doc/use_case_media.md) - [Installation](doc/installation.md) - [Upgrading](UPGRADE.md) - [Collections](doc/collections.md) -- [Templates](doc/templates.md) +- [Content Templates](doc/content_templates.md) - [Pages](doc/pages.md) - [Blocks](doc/blocks.md) +- [Page/Block templates](doc/templates.md) - [Media](doc/media.md) - [Fixtures](doc/fixtures.md) - [WYSIWYG](doc/wysiwyg.md) - [Importing resources](doc/importing-resources.md) +- [Legacy data migration](doc/legacy_data_migration.md) - [Sitemap](doc/sitemap.md) - [Customization](doc/customization.md) -## We are here to help -This **open-source plugin was developed to help the Sylius community**. If you have any additional questions, would like help with installing or configuring the plugin, or need any assistance with your Sylius project - let us know! - -[![](https://bitbag.io/wp-content/uploads/2020/10/button-contact.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) - -Read more about [Sylius CMS](https://bitbag.io/sylius-cms-all-you-need-to-know-3-implementation-methods/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) - -# About us - ---- - -BitBag is a company of people who **love what they do** and do it right. We fulfill the eCommerce technology stack with **Sylius**, Shopware, Akeneo, and Pimcore for PIM, eZ Platform for CMS, and VueStorefront for PWA. Our goal is to provide real digital transformation with an agile solution that scales with the **clients’ needs**. Our main area of expertise includes eCommerce consulting and development for B2C, B2B, and Multi-vendor Marketplaces.
-We are advisers in the first place. We start each project with a diagnosis of problems, and an analysis of the needs and **goals** that the client wants to achieve.
-We build **unforgettable**, consistent digital customer journeys on top of the **best technologies**. Based on a detailed analysis of the goals and needs of a given organization, we create dedicated systems and applications that let businesses grow.
-Our team is fluent in **Polish, English, German and, French**. That is why our cooperation with clients from all over the world is smooth. - -**Some numbers from BitBag regarding Sylius:** - - 50+ **experts** including consultants, UI/UX designers, Sylius trained front-end and back-end developers, - - 120+ projects **delivered** on top of Sylius, - - 25+ **countries** of BitBag’s customers, - - 4+ **years** in the Sylius ecosystem. - -**Our services:** - - Business audit/Consulting in the field of **strategy** development, - - Data/shop **migration**, - - Headless **eCommerce**, - - Personalized **software** development, - - **Project** maintenance and long term support, - - Technical **support**. - -**Key clients:** Mollie, Guave, P24, Folkstar, i-LUNCH, Elvi Project, WestCoast Gifts. - ---- - -If you need some help with Sylius development, don't be hesitated to contact us directly. You can fill the form on [this site](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) or send us an e-mail at hello@bitbag.io! - ---- - -[![](https://bitbag.io/wp-content/uploads/2021/08/sylius-badges-transparent-wide.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) - ## Community ---- For online communication, we invite you to chat with us & other users on [Sylius Slack](https://sylius-devs.slack.com/). -# Demo Sylius Shop - ---- - -We created a demo app with some useful use-cases of plugins! -Visit [sylius-demo.bitbag.io](https://sylius-demo.bitbag.io/) to take a look at it. The admin can be accessed under -[sylius-demo.bitbag.io/admin/login](https://sylius-demo.bitbag.io/admin/login) link and `bitbag: bitbag` credentials. -Plugins that we have used in the demo: - -| BitBag's Plugin | GitHub | Sylius' Store| -| ------ | ------ | ------| -| ACL Plugin | *Private. Available after the purchasing.*| https://plugins.sylius.com/plugin/access-control-layer-plugin/| -| Braintree Plugin | https://github.com/BitBagCommerce/SyliusBraintreePlugin |https://plugins.sylius.com/plugin/braintree-plugin/| -| CMS Plugin | https://github.com/BitBagCommerce/SyliusCmsPlugin | https://plugins.sylius.com/plugin/cmsplugin/| -| Elasticsearch Plugin | https://github.com/BitBagCommerce/SyliusElasticsearchPlugin | https://plugins.sylius.com/plugin/2004/| -| Mailchimp Plugin | https://github.com/BitBagCommerce/SyliusMailChimpPlugin | https://plugins.sylius.com/plugin/mailchimp/ | -| Multisafepay Plugin | https://github.com/BitBagCommerce/SyliusMultiSafepayPlugin | -| Wishlist Plugin | https://github.com/BitBagCommerce/SyliusWishlistPlugin | https://plugins.sylius.com/plugin/wishlist-plugin/| -| **Sylius' Plugin** | **GitHub** | **Sylius' Store** | -| Admin Order Creation Plugin | https://github.com/Sylius/AdminOrderCreationPlugin | https://plugins.sylius.com/plugin/admin-order-creation-plugin/ | -| Invoicing Plugin | https://github.com/Sylius/InvoicingPlugin | https://plugins.sylius.com/plugin/invoicing-plugin/ | -| Refund Plugin | https://github.com/Sylius/RefundPlugin | https://plugins.sylius.com/plugin/refund-plugin/ | - -**If you need an overview of Sylius' capabilities, schedule a consultation with our expert.** - -[![](https://bitbag.io/wp-content/uploads/2020/10/button_free_consulatation-1.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) - ## Additional resources for developers --- @@ -143,10 +58,3 @@ To learn more about our contribution workflow and more, we encourage you to use This plugin's source code is completely free and released under the terms of the MIT license. [//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.) - -## Contact - ---- -If you want to contact us, the best way is to fill the form on [our website](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) or send us an e-mail to hello@bitbag.io with your question(s). We guarantee that we answer as soon as we can! - -[![](https://bitbag.io/wp-content/uploads/2021/08/badges-bitbag.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md index dcd23938..1509e096 100644 --- a/UPGRADE-5.0.md +++ b/UPGRADE-5.0.md @@ -8,8 +8,8 @@ and removes the old way of creating blocks and pages. * Sections are now Collections, as it was a more suitable name for the feature. * Pages and Blocks now have `Content elements` segment, where you can add elements to the page or block. * Removed FAQ, as you can now create a FAQ page with the new content elements. -* Added new `Templates` section where you can create templates for your content elements. Read more about it in [Use case templates](doc/use_case_templates.md) -and [Templates](doc/templates.md) docs. +* Added new `Content Templates` section where you can create templates for your content elements. Read more about it in [Use case content templates](doc/use_case_content_templates.md) +and [Content Templates](doc/content_templates.md) docs. * Removed CKEditor deprecation modal. * Reordered forms/elements for functionality consistency. * Updated import functionality to work with the new structure. diff --git a/doc/blocks.md b/doc/blocks.md index bd421f81..c03196ce 100644 --- a/doc/blocks.md +++ b/doc/blocks.md @@ -54,3 +54,7 @@ read [Sylius template customization guide](http://docs.sylius.org/en/latest/cust Even if you can pass template argument to render block resource, you can change the global templates under `app/templates/bundles/SyliusCmsPlugin/Shop/Block` location. Available templates you can override can be found under [this location](../src/Resources/views/Shop/Block). + +### Custom Block Templates + +For more information about custom block templates, check the [documentation](templates.md). diff --git a/doc/blocks_create_cms.png b/doc/blocks_create_cms.png index e54b375a..3ac93476 100644 Binary files a/doc/blocks_create_cms.png and b/doc/blocks_create_cms.png differ diff --git a/doc/content_management.png b/doc/content_management.png index 910efa9b..70c87893 100644 Binary files a/doc/content_management.png and b/doc/content_management.png differ diff --git a/doc/template_create_cms.png b/doc/content_template_create_cms.png similarity index 100% rename from doc/template_create_cms.png rename to doc/content_template_create_cms.png diff --git a/doc/templates.gif b/doc/content_templates.gif similarity index 100% rename from doc/templates.gif rename to doc/content_templates.gif diff --git a/doc/content_templates.md b/doc/content_templates.md new file mode 100644 index 00000000..1dce1837 --- /dev/null +++ b/doc/content_templates.md @@ -0,0 +1,21 @@ +# Content Templates + +Content Templates are a way to define the structure of content elements, which can be used in blocks and pages. + +![Content Templates usage](content_templates.gif) + +## General usage + +Let's assume you want to create a content template for a blog post. +You want to add following content elements: +- **Title** (textarea) +- **Subtitle** (textarea) +- **Image** (single media) +- **Content** (textarea) +- **Author** (textarea) +- **Products carousel** (products carousel by taxon) + +Then, when you create a page, in the content elements section you can choose the content template you created. +It will create a form with fields you defined in the template. \ +Your job is just to fill them with content. \ +Of course, you can add additional content elements to the form, after you choose the template. It's super flexible! diff --git a/doc/templates_cms.png b/doc/content_templates_cms.png similarity index 100% rename from doc/templates_cms.png rename to doc/content_templates_cms.png diff --git a/doc/pages.md b/doc/pages.md index 8c407cd5..919362e4 100644 --- a/doc/pages.md +++ b/doc/pages.md @@ -41,3 +41,7 @@ read [Sylius template customization guide](http://docs.sylius.org/en/latest/cust You can create a template under `app/templates/bundles/SyliusCmsPlugin/Shop/Page` location. Available templates you can override can be found under [this location](../src/Resources/views/Shop/Page). + +### Custom Page Templates + +For more information about custom page templates, check the [documentation](templates.md). diff --git a/doc/pages_create_cms.png b/doc/pages_create_cms.png index ab25782c..d6c6689d 100644 Binary files a/doc/pages_create_cms.png and b/doc/pages_create_cms.png differ diff --git a/doc/templates.md b/doc/templates.md index 5a278442..d32b6f82 100644 --- a/doc/templates.md +++ b/doc/templates.md @@ -1,21 +1,24 @@ -# Templates +# Page/Block Templates -Templates are a way to define the structure of content elements, which can be used in blocks and pages. - -![Templates usage](templates.gif) +Templates allow you to define and select the layout of your pages and blocks. ## General usage -Let's assume you want to create a template for a blog post. -You want to add following content elements: -- **Title** (textarea) -- **Subtitle** (textarea) -- **Image** (single media) -- **Content** (textarea) -- **Author** (textarea) -- **Products carousel** (products carousel by taxon) +By default, the blocks and pages have its own templates. You can create your own templates and use it in specific blocks or pages. + +### Creating a new template -Then, when you create a page, in the content elements section you can choose the template you created. -It will create a form with fields you defined in the template. \ -Your job is just to fill them with content. \ -Of course, you can add additional content elements to the form, after you choose the template. It's super flexible! +1. Go to the `config/packages/cms_plugin.yaml` file. +2. Define your templates in following format: +```yaml +sylius_cms: + templates: + pages: + - "@SyliusCMSPlugin/Shop/MyPage/template.twig" + - "@SyliusCMSPlugin/Shop/MySecondPage/template.twig" + blocks: + - "@SyliusCMSPlugin/Shop/MyPage/template.twig" + - "@SyliusCMSPlugin/Shop/MySecondPage/template.twig +``` +3. Create a new template file. For example, `templates/bundles/SyliusCMSPlugin/Shop/MyPage/template.twig`. +4. Go to the Block/Page form and select your template from the list. diff --git a/doc/use_case.md b/doc/use_case.md index 734141e9..0d23bcfb 100644 --- a/doc/use_case.md +++ b/doc/use_case.md @@ -24,7 +24,7 @@ In admin panel, the whole CMS functionality is located under "Content Management Our CMS Plugin allows you to manage: * **Collections** - responsible for grouping the pages/blocks/media -* **Templates** - allows to create a template of content elements for the page or block +* **Content Templates** - allows to create a template of content elements for the page or block * **Pages** - whole pages, obtainable by the link * **Blocks** - separate parts for the content, composed of the content elements * **Media** - images, videos, etc. that can be used in other segments of the CMS @@ -42,11 +42,11 @@ By utilizing collections, administrators can group related content elements toge More information about Collections you can get [here](use_case_collections.md). -### Templates: +### Content Templates: -The Templates tile allows administrators to create and manage templates built from content elements skeletons. +The Content Templates tile allows administrators to create and manage templates built from content elements skeletons. -![Screenshot showing content management config in admin](templates_cms.png) +![Screenshot showing content management config in admin](content_templates_cms.png) ### Pages: @@ -81,7 +81,7 @@ More information about Media you can get [here](use_case_media.md). ## Summary In summary, the Sylius CMS Plugin provides administrators with a range of tiles in the admin panel, -including [Collections](use_case_collections.md), [Templates](use_case_templates.md), [Pages](use_case_pages.md), [Blocks](use_case_blocks.md), [Media](use_case_media.md). +including [Collections](use_case_collections.md), [Content Templates](use_case_content_templates.md), [Pages](use_case_pages.md), [Blocks](use_case_blocks.md), [Media](use_case_media.md). These tiles offer functionalities for managing CMS segments. Together, they enable administrators to efficiently create, edit, and organize content within the Sylius e-commerce system, diff --git a/doc/use_case_content_templates.md b/doc/use_case_content_templates.md new file mode 100644 index 00000000..fed17845 --- /dev/null +++ b/doc/use_case_content_templates.md @@ -0,0 +1,20 @@ +# Content Templates + +In this plugin, content templates are responsible for defining the structure of content elements, which can be used in blocks and pages. + +## The process of creating a Content Template + +By following these steps below, administrators can easily add and manage content templates. + +1. Please access the administrator panel of the Sylius e-commerce system. +2. Navigate to the CMS section or the designated area for managing content templates. +3. Select the option to create a new content template item. +4. Fill in the required fields in the content template creation form, such as the name and type. +5. Add some content elements. +6. Save the content template item after filling in the necessary details. +7. Repeat the process to add additional content template items, as needed. +8. Now you can use content templates in blocks and pages. + +The mentioned form: + +![Screenshot showing content template creation form in admin](content_template_create_cms.png) diff --git a/doc/use_case_templates.md b/doc/use_case_templates.md deleted file mode 100644 index 35a3349a..00000000 --- a/doc/use_case_templates.md +++ /dev/null @@ -1,20 +0,0 @@ -# Templates - -In this plugin, templates are responsible for defining the structure of content elements, which can be used in blocks and pages. - -## The process of creating a Template - -By following these steps below, administrators can easily add and manage templates. - -1. Please access the administrator panel of the Sylius e-commerce system. -2. Navigate to the CMS section or the designated area for managing templates. -3. Select the option to create a new template item. -4. Fill in the required fields in the template creation form, such as the name and type. -5. Add some content elements. -6. Save the template item after filling in the necessary details. -7. Repeat the process to add additional template items, as needed. -8. Now you can use templates in blocks and pages. - -The mentioned form: - -![Screenshot showing template creation form in admin](template_create_cms.png)