README

A set of features that allow editing (typically textual) components on a webpage.

Editable Fragments is designed for applications built on Atk14Skelet.

Usage

In a template:

{* file: app/views/main/index.tpl *}

{editable key="about_us"}
<p>We are who we are!</p>
<p>We are here because we are here!</p>
{/editable}

By default, editable content is being edited in the textarea (as the DEFAULT_EDITABLE_CONTENT_TYPE is set as "text").

Other ways of usage:

{editable_string key="about_us/title"}About Us{/editable_string}

{editable_markdown key="about_us"}
* We are who we are!
* We are here because we are here!
{/editable_markdown}

{editable_render partial="person_info" person=$person key="vip_person"}


{editable_link_content key="about_us/title"}
  <a  href="{"about_us"|link_to_page}">
    About us
  </a>
{/editable_link_content}

Images:

{editable_pupiq_image key="image_about_us" geometry="400x300"}
  <img src="http://i.pupiq.net/i/77/77/083/31083/600x500/5ucyEH_600x500_c834ac5ca651b903.png" class="img-fluid">
{/editable_pupiq_image}

{* or *}
                                                                                                                          
{editable_pupiq_image key="image_about_us" geometry="400x300"}
  <picture>
    <source srcset="http://i.pupiq.net/i/77/77/083/31083/600x500/5ucyEH_600x500_c834ac5ca651b903.webp" type="image/webp">
    <img src="http://i.pupiq.net/i/77/77/083/31083/600x500/5ucyEH_600x500_c834ac5ca651b903.png" class="img-fluid">
  </picture>
{/editable_pupiq_image}

Prerequisites

User Authorization

Iobjects

Icons

When in the application is constant USING_FONTAWESOME defined to true, Fontawesome icons are used automatically. Otherwise, Ionicons icons are used.

Configuration

define("DEFAULT_EDITABLE_CONTENT_TYPE","text");
define("DEFAULT_EDITABLE_CONTENT_SECTION","content");
define("DEFAULT_EDITABLE_KEY","content");

Installation

cd path/to/your/project/
composer require atk14/editable-fragments

ln -s ../../../vendor/atk14/editable-fragments/src/app/controllers/admin/editable_fragments_controller.php app/controllers/admin/
ln -s ../../../vendor/atk14/editable-fragments/src/app/forms/admin/editable_fragments app/forms/admin/
ln -s ../../../vendor/atk14/editable-fragments/src/app/views/admin/editable_fragments app/views/admin/
ln -s ../../vendor/atk14/editable-fragments/src/app/helpers/block.editable.php app/helpers/
ln -s ../../vendor/atk14/editable-fragments/src/app/helpers/block.editable_markdown.php app/helpers/
ln -s ../../vendor/atk14/editable-fragments/src/app/helpers/block.editable_link_content.php app/helpers/
ln -s ../../vendor/atk14/editable-fragments/src/app/helpers/block.editable_page_description.php app/helpers/
ln -s ../../vendor/atk14/editable-fragments/src/app/helpers/block.editable_page_title.php app/helpers/
ln -s ../../vendor/atk14/editable-fragments/src/app/helpers/function.editable_render.php app/helpers/
ln -s ../../vendor/atk14/editable-fragments/src/app/helpers/block.editable_string.php app/helpers/
ln -s ../../vendor/atk14/editable-fragments/src/app/helpers/block.editable_pupiq_image.php app/helpers/
ln -s ../../vendor/atk14/editable-fragments/src/app/models/editable_fragment.php app/models/
ln -s ../../vendor/atk14/editable-fragments/src/app/models/editable_fragment_history.php app/models/

Copy migration to a proper filename into your project and perform the migration script:

cp vendor/atk14/editable-fragments/src/db/migrations/0144_editable_fragments.sql db/migrations/
./scripts/migrate

Linking a proper style form either for or Bootstrap 4 (scss) or Bootstrap 3 (less).

# Bootstrap 4
ln -s ../../vendor/atk14/editable-fragments/src/public/styles/_editable_fragments.scss public/styles/

# or Bootstrap 3
ln -s ../../vendor/atk14/editable-fragments/src/public/styles/editable_fragments.less public/styles/

Now include the selected style to your application style.

atk14 / editable-fragments

Maintainers

Details