-
Notifications
You must be signed in to change notification settings - Fork 50
/
readme.txt
233 lines (175 loc) · 8.84 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
=== Knight Lab Timeline ===
Contributors: miguelpeixe, zachwise, KnightLab, joegermuska
Donate link: http://knightlab.northwestern.edu/
Tags: timeline, shortcode, stamen, timeline.verite.co, verite, html5, KnightLab
Requires at least: 2.0.2
Tested up to: 6.2.2
Stable tag: 3.9.3.4
Use the incredible HTML5 Timeline developed by Knight Lab on your website. As easy as writing a shortcode.
After June 8, 2021, if you configure your timelines with Google Sheets, you must use
version 3.8.2.0 of this plugin, or newer. Changes to the Google Sheets API mean that older
versions of TimelineJS (which are included in older versions of this plugin) will no longer work.
See [our blog post](https://knightlab.northwestern.edu/2020/09/16/timelinejs-update-2/index.html)
for more information.
== Description ==
A simple shortcode plugin to add the TimelineJS made by Knight Lab.
**NOTE** While this plugin works up to the listed "tested" version of WordPress, it does not work as it originally did. Knight Lab does not have dedicated PHP development resources, and has not been able to fully adapt this plugin to the new Gutenberg blocks editor in WordPress. The original plugin provided an interface for customizing a timeline in WordPress, but that doesn't work in the new editor. In short, if you've been using the Timeline plugin for WordPress, your existing timelines should continue to work. We would love help from the WordPress community in updating or replacing this plugin with something which is better suited to the new editor paradigm.
Supports custom width and height, [Google Spreadsheet and JSON data sources](http://timeline.knightlab.com/) "Learn how to create your data source") and many more.
Checkout how to create your amazing Timeline at http://timeline.knightlab.com/
To embed your timeline use the button located at the post content editor (TinyMCE).
**You can also embed the Timeline on your post using this shortcode :**
`[timeline src="Your source url here"]`
**TIP** - If you want to embed outside of a post, use the following code:
`<?php echo do_shortcode('[timeline src="Your source url here"]'); ?>`
**Supported languages**
* Afrikaans
* Arabic
* Armenian
* Basque
* Belarusian
* Bulgarian
* Catalan
* Chinese
* Croatian / Hrvatski
* Czech
* Danish
* Dutch
* English
* English (24-hour time)
* Esperanto
* Estonian
* Faroese
* Farsi
* Finnish
* French
* Frisian
* Galician
* Georgian
* German / Deutsch
* Greek
* Hebrew
* Hindi
* Hungarian
* Icelandic
* Indonesian
* Irish
* Italian
* Japanese
* Korean
* Latvian
* Lithuanian
* Luxembourgish
* Malay
* Myanmar
* Nepali
* Norwegian
* Polish
* Portuguese
* Portuguese (Brazilian)
* Romanian
* Romansh
* Russian
* Serbian - Cyrillic
* Serbian - Latin
* Sinhalese
* Slovak
* Slovenian
* Spanish
* Swedish
* Tagalog
* Tamil
* Taiwanese
* Telugu
* Thai
* Turkish
* Ukrainian
* Urdu
== Installation ==
1. Upload the plugin to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Learn how to create the Timeline source at http://timeline.knightlab.com/
1. Use the shortcode on your post/page: `[timeline src="Your source url here"]`
**Extra tip** - If you want do embed outside of a post, use the following code on your template:
`<?php echo do_shortcode('[timeline src="Your source url here"]'); ?>`
Alternatively, you can use the TinyMCE button to create your own shortcode as well.
== Changelog ==
If you find this changelog out of date, you can assume that the plugin update is merely to pull in a new version of TimelineJS (especially if the plugin version number is 3.x.y.0)
The most up to date change log for TimelineJS itself can be found at https://github.com/NUKnightLab/TimelineJS3/blob/master/CHANGELOG
= 3.9.3.4 =
* Escape shortcode attributes before writing JS configuration.
= 3.9.3.3 =
* Revert to pre-code formatter plugin since it seems to have introduced more regressions than realized.
= 3.9.3.2 =
* Fix regression introduced by codeformatter which forced percentage-based width/height values to integers instead.
= 3.8.11.0 =
* Update error messaging to give clearer instructions when encountering Google CSV permissions bug.
= 3.8.10.0 =
* Update to TimelineJS 3.8.10. Fixes Instagram MediaType in response to API changes.
= 3.8.2.0 =
* Update to TimelineJS 3.8.2
= 3.6.3.0 =
* Update to TimelineJS 3.6.2, verify plugin works with WP5
= 3.6.0.0 =
* Update to TimelineJS 3.6.0, which anonymizes IP addresses when tracking Timeline events in accordance with the GDPR.
= 3.5.4.0 =
* Catch up to latest release of TimelineJS, test on latest version of Wordpress.
= 3.3.16.0 =
* CSS styling fixes, including one affecting Wordpress plugin users who use the `.vcard` CSS class.
= 3.3.15.0 =
* Improvements in translations for Finnish, Hungarian, Swedish
* support more image URL formats for timenav thumbnails
= 3.3.14.0 =
* Update to TimelineJS 3.3.14 -- fixes Imgur bug
* Experimental: register a TimelineJS oembed provider. You can now embed a timeline just by getting the URL for "get link to preview" from https://timeline.knightlab.com and putting it in a post on a line by itself. We're not entirely clear why width/height parameters are not being honored.
= 3.3.11.2 =
* Minor TimelineJS3 version update
* Fixes to plugin deployment/working out kinks in update
= 3.3.11.2 =
* Minor TimelineJS3 version update
* Fixes to plugin deployment/working out kinks in update
= 3.3.10.0 =
* Major update: this plugin now supports the TimelineJS3 rewrite. To preserve backwards compatibility, you must include this in your shortcode to use the new version of Timeline: `version="timeline3"`. This will be done automatically if you use the "Add Timeline" button in the editing interface.
= 2.35.6.0 =
* Revert animation changes introduced in 2.35.5
= 2.35.5.0 =
* Fix URL linking regression introduced in 2.35.3
* Animation optimizations from #681
= 2.35.4.0 =
* Fix Stamen map tile URL bug
= 2.35.3.0 =
* Many updates to localization: new and changed languages.
= 2.35.2 =
* Fix mobile display bug.
= 2.35.0 =
* Fix date initialization process to address Firefox bug in UK/Ireland (https://github.com/NUKnightLab/TimelineJS/issues/718)
= 2.34.0 =
* Remove HTTPS URL rewriting for older IE.
* don't do analytics on https
* Check to make sure that every slide has a start date, so that people get a clear warning if the spreadsheet header has been changed.
* fix jquery version check, again. (should accept jquery 2, although TimelineJS has not been tested with jquery 2) cf. #551
* Update ko.js translation file
* Update fa.js translation file
= 2.33.1.0 =
* Update to TimelineJS 2.33.1: fix bug handling maps.google media URLs; minor updates to zh-cn localization file.
= 2.33.0.0 =
* Update to TimelineJS 2.33.0: better handle changes to Google Maps and Spreadsheet URLs; add 'W' token for date format; accept *.bmp as image URL; fix jQuery version check; fix untagify; more permissive on iframe markup; treat Google Streetview API images as images, not maps; set maxheight on soundcloud embeds; crush png files.
= 2.32.0.0 =
* Update to TimelineJS 2.32.0: Stop YouTube players when slide changes; Better method for determining embed path root; Check for iframe and blockquote media before other url tests; Add languages: 'hr' (Croatian), 'uk' (Ukrainian); minor fixes to language files for 'fi' (Finnish) 'sl' (Slovenian). Plugin-specific: add 'OpenStreetMap' option to map-type menu in shortcode builder.
= 2.31.0.0 =
* Update to TimelineJS 2.31.0: Add languages: 'ro' (Romanian), 'th' (Thai); minor fixes to language files for 'es' (Spanish) 'fa' (Farsi), 'hu' (Hungarian), 'no' (Norwegian); add OpenStreetMap as a map option ('osm'); Support '.svg' as an image media type; support custom thumbnails when no media is specified; clearer warning about "compatibility mode" to IE users.
= 2.30.0.0 =
* Update to TimelineJS 2.30.0: Fix language code for 'zh-cn' (Chinese); add 'fa' (Farsi); Move 'remove' function from Array.prototype to a util method to avoid adverse affects on other JS code.
= 2.28.1.2 =
* Incremented version for semi-separate versioning with TimelineJS
= 2.28.1.1 =
* Initial time using deployment script
= 2.28.1 =
* Modified to match current TimelineJS version number
= 1.0.0 =
* First stable release
== Shortcode options ==
`[timeline width="800" height="600" maptype="watercolor" src="Your source url here"]`
* **src**: Data source url, typically to a Google Spreadsheet as [documented on the TimelineJS website](https://timeline.knightlab.com/docs/using-spreadsheets.html). Alternatively, you may use [JSON](http://timeline.knightlab.com/docs/json-format.html) to configure your timeline. **[required]**
* **width**: Custom width *(default is 100%)*
* **height**: Custom height *(default is 650)*
* **version**: Optional. If set to 'timeline3', then the current version of TimelineJS will be used. If omitted, TimelineJS 2.35.6 will be used. This version of TimelineJS is no longer supported, but is preserved for backwards compatibility.