Commit 64bcc762 authored by Viktor Jelínek's avatar Viktor Jelínek

title as pathway

parent 26075b62
# [User manual](README.md) - Access logs
# [Easy Feeder](README.md) - Access logs
- Shows logs and performance statistics of recorded feed views
![Easy Feeder - Access logs](assets/logs.png)
......
# [Documentation](README.md) - Compatibility
# [Easy Feeder](README.md) - Compatibility
- **Joomla:** 2.5 ~ 3.x
- *Last test was in 3.4.1*
- **Virtuemart:** 2.6.14 ~ 3.0.x
......
# [User manual](README.md) - Control panel
# [Easy Feeder](README.md) - Control panel
- Overview of the component's administration
- Notice the link to component's [Options](OPTIONS.md) on the top right (same position in Joomla 2.5)
......
# [Elements](ELEMENTS.md) - Element
# [Easy Feeder](README.md) - [Elements](ELEMENTS.md) - Element
Element represents one property of feed item, basically a value from database column placed into
- xml elements
......
# [User manual](README.md) - Elements
# [Easy Feeder](README.md) - Elements
- Used to define set of elements for feeding item properties
- **You can [Add/Edit Element](ELEMENT.md) from here**
- You should use only [element types](ELEMENT_TYPES.md) from folder same as [server type](SERVER_TYPES.md) of assigned [server](SERVER.md)
......
# [Element](ELEMENT.md) - Advanced settings
# [Easy Feeder](README.md) - [Elements](ELEMENTS.md) - [Element](ELEMENT.md) - Advanced settings
- **Data type:** This will force the value to be selected data type such as integer
- **Apply function:** This will apply php function to the value
- **Argument 2:** Second argument for applied function *(first is the value)*
......
# [Element](ELEMENT.md) - Basic settings
# [Easy Feeder](README.md) - [Elements](ELEMENTS.md) - [Element](ELEMENT.md) - Basic settings
- **Feed empty value:** If set to Yes, element will be not printed for this item if its value is [`empty()`](http://php.net/manual/en/function.empty.php)
- **Prepend string to value:** Entered string will be prepended to value of this element
- **Append string to value:** Entered string will be appended to value of this element
......
# [Developer manual](README.md) - Element type class
# [Easy Feeder](README.md) - Element type class
- Almost everything can be inherited from generic element helper class
- Specific methods can be overridden to extend default element behavior which is to select column based on element_type and then feed raw db value
......
# [Element](ELEMENT.md) - General settings
# [Easy Feeder](README.md) - [Elements](ELEMENTS.md) - [Element](ELEMENT.md) - General settings
- **Element name**: Name of element, should not contain special or accented characters
- **Server**: Select server to which this element belongs, will be preselected if list of elements was filtered to one server
......
# [Element](ELEMENT.md) - Mapping settings
# [Easy Feeder](README.md) - [Elements](ELEMENTS.md) - [Element](ELEMENT.md) - Mapping settings
You can assign some mapping from [list of mappings](MAPPINGS.md) to make the element replace local values to mapped external values.
......
# [Element](ELEMENT.md) - Restriction settings
# [Easy Feeder](README.md) - [Elements](ELEMENTS.md) - [Element](ELEMENT.md) - Restriction settings
- Restriction settings and options are specific to each [element type](ELEMENT_TYPES.md)
- Element type must support restrictions for this section to appear and show some settings
- Usually has 3 main settings but their options may be different:
......
# [Element](ELEMENT.md) - Type specific settings
# [Easy Feeder](README.md) - [Elements](ELEMENTS.md) - [Element](ELEMENT.md) - Type specific settings
- Settings specific for selected [element type](ELEMENT_TYPES.md)
- May hold important element options, always check it
......
# [User manual](README.md) - Element types
# [Easy Feeder](README.md) - Element types
- Shows recognized [Element](ELEMENTS.md) types with php file & xml configuration file location
- Element settings are shown in element edit form in [Type specific](ELEMENT_SPECIFIC.md) tab
- This is useful for developing new [Element classes](ELEMENT_CLASS.md) and there may be some features in the future.
......
# [Enumerations](ENUMERATIONS.md) - Enumeration
# [Easy Feeder](README.md) - [Enumerations](ENUMERATIONS.md) - Enumeration
![Easy Feeder - Enumeration](assets/enumeration.png)
# [User manual](README.md) - Enumerations
# [Easy Feeder](README.md) - Enumerations
- Shows list of enumerations
- Used to define list of possible values for mappings
- [Add/Edit Enumeration](ENUMERATION.md)
......
# [Documentation](README.md) - Supported output formats
# [Easy Feeder](README.md) - Output formats
EasyFeeder is capable of exporting data into formats listed below.
This list it is determined by present [renderer types](RENDERER_TYPES.md). *(Atom and RSS inherit most features from XML)*
......
# [Mappings](MAPPINGS.md) - Mapping
# [Easy Feeder](README.md) - [Mappings](MAPPINGS.md) - Mapping
![Easy Feeder - Mapping](assets/mapping.png)
# [User manual](README.md) - Mappings
# [Easy Feeder](README.md) - Mappings
- Shows list of mappings
- Used to define mappings of local element values to values for external systems
- Only virtuemart/product_category is supporting mappings at this time, but all elements will support mappings in future
......
# [User manual](README.md) - Options
# [Easy Feeder](README.md) - Options
- **Server**
- **Error reporting**:
- Applies to all formats except debug
......
# [Documentation](README.md) - Quick start
# [Easy Feeder](README.md) - Quick start
1. Install latest version of Easy Feeder component
- Easy Feeder can be purchased at [EasyJoomla.org](http://www.easyjoomla.org)
......
# Easy Feeder
# Easy Feeder - Documentation
Easy Feeder is component for Joomla! CMS and the purpose of Easy Feeder is to feed or export information from database.
## Introduction
......@@ -8,8 +8,6 @@ For example Virtuemart products, Content articles and basically anything in diff
- [Features](FEATURES.md)
- [Data sources](DATASOURCES.md)
- [Output formats](FORMATS.md)
## Documentation
- [Quick start](QUICK_START.md)
- [Compatibility](COMPATIBILITY.md)
......
# [Developer manual](README.md) - Renderer type class
# [Easy Feeder](README.md) - Renderer type class
- Method `render()` has to be implemented and is responsible for "echoing" the output based on array of server items and their element_values
- *view.xyz.php* should be added to support custom format ...such as *view.csv.php* for *format=csv*
......
# [User manual](README.md) - Renderer types
# [Easy Feeder](README.md) - Renderer types
- Shows recognized Renderer types with php file & xml configuration file location
- Renderer settings are shown in server edit form in tabs like [XML specific](SERVER_XML.md) (there is a tab for each renderer type having a config file)
- This is useful for developing new [Renderer classes](RENDERER_CLASS.md) and there may be some features in the future.
......
# [Servers](SERVERS.md) - Add/Edit Server
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - Add/Edit Server
Server defines source of the feed data and global settings of the feed.
[Server type](SERVER_TYPES.md) dictates [Element types group](ELEMENT_TYPES.md) usable with the server
......
# [User manual](README.md) - Servers
# [Easy Feeder](README.md) - Servers
- Shows list of existing server configurations
- **You can [add/edit server](SERVER.md) from here**
- Links to [list of server's elements](ELEMENTS.md)
......
# [Server](SERVER.md) - Atom settings
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - [Server](SERVER.md) - Atom settings
- **Force download:** Setting this to Yes will tell browser to download the file instead of displaying it
- **Root element:** Root element to surround whole feed (`feed` for standard atom)
- **Item element:** Item element surrounding all elements of one item (`entry` for standard atom)
......
# [Developer manual](README.md) - Server type class
# [Easy Feeder](README.md) - Server type class
- Almost everything can be inherited from generic server helper class
- Main server properties to look at:
- **$table_name**: Must be set, determines from which DB table to select data
......
# [Server](SERVER.md) - CSV settings
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - [Server](SERVER.md) - CSV settings
- **Force download:** Setting this to Yes will tell browser to download the file instead of displaying it
- **CSV delimiter:** Character separating columns (defaults to `;`)
- **CSV quote:** Character encapsulating values of columns (defaults to `"`)
......
# [Server](SERVER.md) - General settings
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - [Server](SERVER.md) - General settings
- **Title**: Name of your feed, for some feeds like rss is used as feed title
- **Alias**: Unique alias for generating SEF urls and output file names
......
# [Server](SERVER.md) - HTML settings
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - [Server](SERVER.md) - HTML settings
- **Force download:** Setting this to Yes will tell browser to download the file instead of displaying it
- **Show info:** Setting this to Yes will show basic feed information inside table footer *(feed title, ...)*
- **HTML type:** Type of generated HTML output *(table for now, more coming soon)*
......
# [Server](SERVER.md) - JSON settings
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - [Server](SERVER.md) - JSON settings
- **Force download:** Setting this to Yes will tell browser to download the file instead of displaying it
![Easy Feeder - Server json](assets/server_json.png)
# [Server](SERVER.md) - Output settings
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - [Server](SERVER.md) - Output settings
- **Links appendix:** String appended to links inside feed *(must be supported by specific elements)*
- **Sef urls:** If links inside feed should be SEF *(must be supported by specific elements)*
- **Language:** Language for output values *(must be supported by specific elements)*
......
# [Server](SERVER.md) - RSS settings
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - [Server](SERVER.md) - RSS settings
- **Force download:** Setting this to Yes will tell browser to download the file instead of displaying it
- **Root element:** Root element to surround whole feed (`rss` for standard rss)
- **Items element:** Element surrounding all items (`channel` for standard rss)
......
# [Server](SERVER.md) - Type specific settings
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - [Server](SERVER.md) - Type specific settings
- Settings specific to selected [Server type](SERVER_TYPES.md)
- Predefined servers has items ordering settings here
......
# [Server](SERVER.md) - System settings
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - [Server](SERVER.md) - System settings
- **Max count:** Limits number of items contained inside feed to defined maximum count *(0 = unlimited)*
- **Log feed access:** Enables/Disabled recording of access logs for this feed
- **Cache feed:** Enables/Disables caching of feed output using JCache
......
# [User manual](README.md) - Server types
# [Easy Feeder](README.md) - Server types
- Shows recognized Server types with php file & xml configuration file location
- Server settings are shown in server edit form in [Type specific](SERVER_SPECIFIC.md) tab
- This is useful for developing new [Server classes](SERVER_CLASS.md) and there may be some features in the future.
......
# [Server](SERVER.md) - XML settings
# [Easy Feeder](README.md) - [Servers](SERVERS.md) - [Server](SERVER.md) - XML settings
- **Force download:** Setting this to Yes will tell browser to download the file instead of displaying it
- **Root element:** Root element to surround whole feed
- **Item element:** Item element surrounding all elements of one item
......
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