Commit 21597f98 authored by Viktor Jelínek's avatar Viktor Jelínek

Move docs to separate repository

parent d35c6d1f
# [Easy Feeder](README.md) - Features
## Basic
- XML feeds
- RSS feeds
- Atom feeds
- CSV exports (Can be opened in Excel or OpenOffice as a spreadsheet)
- JSON exports (Can be called by ajax to retrieve data)
- HTML output (Can be used to display table of records on frontend)
## Advanced
- Any database table
- Any column included column from joined tables
- Supports Joomla cache
- Output can be stored to physical file in images stories
- Export/Import of server and element configurations, enumeration items etc.
- Sample data with predefined examples including Google products feed
- Mapping of categories (more mapping soon)
- Applying various PHP functions to element values
(like append string or even str_replace or force integer datatype etc.)
## Other
- Transform elements name
- Exclude empty elements
- Feeds can have sef urls
- Exclude items having all elements empty
- Many more settins like XML namespaces
- Ordering of items in feed as well as elements of items
...And many, many, more ;-)
## For developers
- Can be extended for specific data sources and output formats by new server/element/renderer classes with few lines of coding.
- Inheritance and sharing of common functionality across all server types, element types and output formats
- Debug view showing whole server object where sql query, params and feed data can be openly seen
\ No newline at end of file
# Easy Feeder
Generates various feeds/exports, primarily XML feeds for search engines.
Easy Feeder is component for Joomla! CMS and the purpose of Easy Feeder is to feed or export information from database.
## Introduction
Easy Feeder is component for Joomla CMS and its purpose is to feed or export data.
For example Virtuemart products, Content articles and basically anything in different [formats](docs/SUPPORTED_FORMATS.md).
Generates various feeds/exports, primarily XML feeds for search engines.
For example Virtuemart products, Content articles and basically anything in different formats.
- [Features](FEATURES.md)
## Documentation
- [Quick start](QUICK_START.md)
- [Supported output formats](SUPPORTED_FORMATS.md)
- [Compatibility](COMPATIBILITY.md)
### User manual
How to use configure and use Easy Feeder:
- [Control panel](CPANEL.md)
- [Servers](SERVERS.md)
- [Add/Edit Server](SERVER.md)
- [Elements](ELEMENTS.md)
- [Add/Edit Element](ELEMENT.md)
- [Mappings](MAPPINGS.md)
- [Add/Edit Mapping](MAPPING.md)
- [Enumerations](ENUMERATIONS.md)
- [Add/Edit Enumeration](ENUMERATION.md)
- [Access logs](ACCESS_LOGS.md)
- [Server types](SERVER_TYPES.md)
- [Element types](ELEMENT_TYPES.md)
- [Renderer types](RENDERER_TYPES.md)
- [Options](OPTIONS.md)
### Developer manual
How to customize or extend Easy Feeder by adding new Server types, Element types and Renderer types.
- Can be used also for exporting data (except feeding them)
- Can be used also for responding to ajax calls to fetch some data.
- Able to feed / export any column from any table in database.
- Every created server is theoretically able to generate all output formats.
- Export/Import of feed configurations and sample data with predefined examples.
- Can be extended for specific data sources and output formats by new server/element/renderer classes with few lines of coding.
Simply extend / override / clone:
## [Documentation](docs/README.md)
- Please check it before contacting support ;-)
- Contains manual for users as well as some information for developers
- [Server classes](SERVER_CLASS.md)
- [Element classes](ELEMENT_CLASS.md)
- [Renderer classes](RENDERER_CLASS.md)
## About
### About
- Authors:
- [Viktor Jelínek](mailto:vikijel@gmail.com)
- [Rudolf Baláš](mailto:support@easyjoomla.org)
......
# Documentation
- [Quick start](QUICK_START.md)
- [Supported output formats](SUPPORTED_FORMATS.md)
- [Compatibility](COMPATIBILITY.md)
## User manual
How to use configure and use Easy Feeder:
- [Control panel](CPANEL.md)
- [Servers](SERVERS.md)
- [Add/Edit Server](SERVER.md)
- [Elements](ELEMENTS.md)
- [Add/Edit Element](ELEMENT.md)
- [Mappings](MAPPINGS.md)
- [Add/Edit Mapping](MAPPING.md)
- [Enumerations](ENUMERATIONS.md)
- [Add/Edit Enumeration](ENUMERATION.md)
- [Access logs](ACCESS_LOGS.md)
- [Server types](SERVER_TYPES.md)
- [Element types](ELEMENT_TYPES.md)
- [Renderer types](RENDERER_TYPES.md)
- [Options](OPTIONS.md)
## Developer manual
How to customize or extend Easy Feeder by adding new Server types, Element types and Renderer types.
Simply extend / override / clone:
- [Server classes](SERVER_CLASS.md)
- [Element classes](ELEMENT_CLASS.md)
- [Renderer classes](RENDERER_CLASS.md)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment