← Back to branch summary

~yacinechaouche/+junk/BZR

« back to all changes in this revision

Viewing changes to CODE/GITHUB/FeedEk/README.md

  • Committer: yacinechaouche at yahoo
  • Date: 2015-01-14 22:23:03 UTC
  • Revision ID: yacinechaouche@yahoo.com-20150114222303-6gbtqqxii717vyka
Ajout de CODE et PROD. Il faudra ensuite ajouter ce qu'il y avait dan TMP

Show diffs side-by-side

added added

removed removed

Lines of Context:
CODE/GITHUB/FeedEk/README.md
 
1
FeedEk jQuery RSS/ATOM Feed Plugin
 
2
======
 
3
 
 
4
**FeedEk** is a jQuery plugin for parsing and displaying RSS and Atom feeds. FeedEk uses **Google Feed API** to retrieve feeds. 
 
5
 
 
6
You can obtain feeds easily from any domain. No need for server-side scripts.
 
7
 
 
8
[Plugin Homepage](http://jquery-plugins.net/FeedEk/FeedEk.html)
 
9
 
 
10
[Demo](http://jquery-plugins.net/FeedEk/FeedEk_demo.html)
 
11
 
 
12
 
 
13
## Usage
 
14
1- Include jQuery and FeedEk plugin scripts into your page.
 
15
 
 
16
     <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
 
17
     <script type="text/javascript" src="FeedEk.js"></script>
 
18
 
 
19
2- Add a placeholder for the plugin to your page.
 
20
 
 
21
    <div id="divRss"></div>
 
22
 
 
23
3- Call the plugin.
 
24
 
 
25
**- Basic**
 
26
 
 
27
    $('#divRss').FeedEk({
 
28
        FeedUrl : 'http://rss.cnn.com/rss/edition.rss',
 
29
      });
 
30
 
 
31
**- With Options**
 
32
 
 
33
    $('#divRss').FeedEk({
 
34
        FeedUrl : 'http://rss.cnn.com/rss/edition.rss',
 
35
        MaxCount : 5,
 
36
        ShowDesc : true,
 
37
        ShowPubDate:true,
 
38
        DescCharacterLimit:100,
 
39
        TitleLinkTarget:'_blank'
 
40
      });
 
41
 
 
42
**- With Date Format Options**
 
43
 
 
44
    ('#divRss').FeedEk({
 
45
        FeedUrl : 'http://rss.cnn.com/rss/edition.rss',
 
46
        MaxCount : 5,
 
47
        ShowDesc : true,
 
48
        ShowPubDate:true,
 
49
        DescCharacterLimit:100,
 
50
        TitleLinkTarget:'_blank',
 
51
                DateFormat:'MM/DD/YYYY',
 
52
                DateFormatLang:'en'
 
53
      });
 
54
 
 
55
**IMPORTANT :** [Moment.js](http://momentjs.com) is used for DateFormat options. You must include [Moment.js](http://momentjs.com/downloads/moment.min.js) for date format.
 
56
If you want to localize date format (day name, month name) you must include [Moment.js with langs](http://momentjs.com/downloads/moment-with-langs.min.js) instead.
 
57
 
 
58
Please visit [format examples](http://momentjs.com/docs/#/displaying/format/) and [languages](http://momentjs.com). for more information.
 
59
 
 
60
Check out [FeedEk examples](http://jquery-plugins.net/FeedEk/FeedEk-examples.html) page for date format usage.
 
61
 
 
62
 
 
63
## Options
 
64
 
 
65
- **FeedUrl**
 
66
  Your Feed Url and it's required
 
67
- **MaxCount**
 
68
  Feed Item Count. Default is `5`
 
69
- **ShowDesc**
 
70
  Option to show Feed Item Description. Default is `true`
 
71
- **ShowPubDate**
 
72
  Option to show Feed Item Publish Date. Default is `true`
 
73
- **DescCharacterLimit**
 
74
  Feed Description Characters Limit Count. Default is no limit
 
75
- **TitleLinkTarget**
 
76
  Option for Feed Title Link Target. Default is `_blank`
 
77
- **DateFormat**
 
78
  Option for Feed Publish Date Format. Default is none
 
79
- **DateFormatLang**
 
80
  Option for Feed Publish Date Format Language for localization. Default is `en`
 
81
 
 
82
## Demo
 
83
 
 
84
[Plugin Homepage](http://jquery-plugins.net/FeedEk/FeedEk.html)
 
85
 
 
86
[Demo](http://jquery-plugins.net/FeedEk/FeedEk_demo.html)
 
87