Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 1.88 KB

README.md

File metadata and controls

52 lines (36 loc) · 1.88 KB

Magkit

build-module

Scope

The purpose of this project is to provide commonly used helper classes for magnolia projects. It contains 5 modules:

  • magkit-core: A maven module providing utility classes for working with jcr nodes and their properties and values, cache, links...
  • magkit-notfound: A magnolia module that provides improved 404 handling
  • magkit-query: A maven module that provides builders for SQL2 and XPATH query strings
  • magkit-setup: A maven module that provides util classes to write magnolia configurations and version handler tasks.
  • magkit-ui: A magnolia module that provides some additional dialog fields and a folder template

Usage

This project needs

  • Java 11 or later
  • Magnolia 6.2.19 or later

It contains some legacy code for Magnolia 5.x used in old projects but this is deprecated and will be deleted soon.

For the purpose of the modules and usage examples please see their module readme.md files.

Notes

If you have any questions or issues you can create a new issue here.

Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example:

  1. Fork the repo
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

All source files must include a Copyright and License header. The SPDX license header is preferred because it can be easily scanned.

If you would like to see the detailed LICENSE click here.

#
# Copyright IBM Corp. 2020-
# SPDX-License-Identifier: Apache2.0
#