brookinsconsulting/bcezextensionskeleton

eZ Publish Legacy extension skeleton which provides a basic set of bash scripts to create the basic default documentation files with the new extension name within. Great for developers looking to speed up branding extension documentation.

dev-master 2019-02-07 22:11 UTC

README

This extension which provides a simple ajax based alternative to the default shop/orderlist module view report.

Version

  • The current version of BC eZ Extension Skeleton is 0.1.0

  • Last Major update: February 7, 2019

Copyright

  • BC eZ Extension Skeleton is copyright 1999 - 2019 Brookins Consulting

  • See: COPYRIGHT.md for more information on the terms of the copyright and license

License

BC eZ Extension Skeleton is licensed under the GNU General Public License.

The complete license agreement is included in the LICENSE file.

BC eZ Extension Skeleton is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License or at your option a later version.

BC eZ Extension Skeleton is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

The GNU GPL gives you the right to use, modify and redistribute BC eZ Extension Skeleton under certain conditions. The GNU GPL license is distributed with the software, see the file doc/LICENSE.

It is also available at http://www.gnu.org/licenses/gpl.txt

You should have received a copy of the GNU General Public License along with BC eZ Extension Skeleton in doc/LICENSE. If not, see http://www.gnu.org/licenses/.

Using BC eZ Extension Skeleton under the terms of the GNU GPL is free (as in freedom).

For more information or questions please contact: license@brookinsconsulting.com

Requirements

The following requirements exists for using BC eZ Extension Skeleton extension:

eZ Publish version

  • Make sure you use eZ Publish version 5.x (required) or higher.

  • Designed and tested with eZ Publish Platform 5.4

PHP version

  • Make sure you have PHP 5.x or higher.

Features

This solution provides the following features:

  • Bash Shell Script: bin/shell/rename.sh

Usage

./bcezextensionskeleton/bin/shell/rename.sh bcmarkuptidyoutputfilter 2019 "BC Markup Tidy Output Filter"
  • Required input parameters for this script
    • $1 : BC_PRODUCT_EXTENSION_NAME
    • $2 : BC_COPYRIGHT_PRESENT_END_DATE
    • $3 : BC_PRODUCT_NAME

Dependencies

This solution depends on eZ Publish Legacy only

Installation

Bundle Installation via Composer

Run the following command from your project root to install the bundle:

bash$ composer require brookinsconsulting/bcezextensionskeleton dev-master;

Extension Activation

Not required

Troubleshooting

Read the FAQ

Some problems are more common than others. The most common ones are listed in the the doc/FAQ.md

Support

If you have find any problems not handled by this document or the FAQ you can contact Brookins Consulting through the support system: http://brookinsconsulting.com/contact