Browse Source

Updated language documentation and added Start Zoom Adjust and Start at Slide documentation

pull/177/head
Zach Wise 13 years ago
parent
commit
0dd4759ccd
  1. 27
      README.markdown

27
README.markdown

@ -22,10 +22,11 @@ Place the embed code where you want the timeline to show in the `<body>` of your
<script type="text/javascript"> <script type="text/javascript">
var timeline_config = { var timeline_config = {
width: "100%", width: "100%",
height: "100%", height: "600",
source: 'path_to_json/or_link_to_googlespreadsheet', source: 'path_to_json/or_link_to_googlespreadsheet',
start_at_end: false, //OPTIONAL START AT LATEST DATE start_at_end: false, //OPTIONAL START AT LATEST DATE
start_at_slide: '4', //OPTIONAL START AT SPECIFIC SLIDE start_at_slide: '4', //OPTIONAL START AT SPECIFIC SLIDE
start_zoom_adjust: '3', //OPTIONAL TWEAK THE DEFAULT ZOOM LEVEL
hash_bookmark: true, //OPTIONAL LOCATION BAR HASHES hash_bookmark: true, //OPTIONAL LOCATION BAR HASHES
font: 'Bevan-PotanoSans', //OPTIONAL FONT font: 'Bevan-PotanoSans', //OPTIONAL FONT
lang: 'fr', //OPTIONAL LANGUAGE lang: 'fr', //OPTIONAL LANGUAGE
@ -48,14 +49,21 @@ Languages available:
* `fr` *Français* * `fr` *Français*
* `es` *Español* * `es` *Español*
* `de` *Deutsch* * `de` *Deutsch*
* `is` *Icelandic*
* `it` *Italiano* * `it` *Italiano*
* `nl` *Nederlands*
* `kr` *월요일*
* `pt-br` *Português Brazil * * `pt-br` *Português Brazil *
* `nl` *Dutch*
* `cz` *Czech*
* `dk` *Danish*
* `id` *Indonesian*
* `pl` *Polish*
* `ru` *Russian*
* `is` *Icelandic*
* `fo` *Icelandic*
* `kr` *월요일*
* `ja` *日本語* * `ja` *日本語*
* `zh-ch` *中文* * `zh-ch` *中文*
* `zh-tw` *Taiwanese Mandarin* * `zh-tw` *Taiwanese Mandarin*
Help us add more. Grab a copy of a language file and replace it with your language [Example language file](https://github.com/VeriteCo/Timeline/blob/master/source/js/locale/en.js) Help us add more. Grab a copy of a language file and replace it with your language [Example language file](https://github.com/VeriteCo/Timeline/blob/master/source/js/locale/en.js)
###Start at End ###Start at End
@ -63,6 +71,17 @@ Help us add more. Grab a copy of a language file and replace it with your langua
set to true to start the timeline on the last date. set to true to start the timeline on the last date.
*default is false* *default is false*
###Start at Slide
`start_at_slide`
You can tell TimelineJS to start at a specific slide number
*default is 0*
###Start Zoom Adjust
`start_zoom_adjust`
This will tweak the default zoom level. Equivilent to pressing the zoom in or zoom out button the specified number of times. Negative numbers zoom out.
*default is 0*
###Hash Bookmark ###Hash Bookmark
`hash_bookmark` `hash_bookmark`
set to true to allow bookmarking slides using the hash tag set to true to allow bookmarking slides using the hash tag

Loading…
Cancel
Save