{ "info": { "author": "Abdallah Deeb", "author_email": "abdallah@deeb.me", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP" ], "description": "# Django-TimelineJS \n## Document history with TimelineJS\nTags: timeline, shortcode, stamen, timeline.verite.co, VeriteCo, HTML5\n\nUse TimelineJS developed by V\u00e9rit\u00e9Co for your Django site. Just load the tags.\nI'm simply going to copy and adapt the info and docs as per the [TimelineJS-Wordpress-Plugin](https://github.com/VeriteCo/TimelineJS-Wordpress-Plugin)\n\n## Description\n\nThere are lots of timeline tools on the web but they are almost all either\nhard on the eyes or hard to use. Create timelines that are at the same time\nbeautiful and intuitive for users\n\nTimelineJS is great for pulling in media from different sources. Just throw in a\nlink from Twitter, YouTube, Flickr, Vimeo, Google Maps or SoundCloud and\nTimelineJS will format it to fit perfectly. More media types will be supported\nin the future.\n\nCreating one is as easy as filling in a Google spreadsheet or as detailed as\nJSON.\n\n**You can also embed the Timeline on your post using this shortcode :**\n`[timeline src=\"Your source url here\"]`\n\n**TIP** - If you want to embed outside of a post, use the following code:\n``\n\n\n## Installation\n\n1. Upload the plugin to the `/wp-content/plugins/` directory\n1. Activate the plugin through the 'Plugins' menu in WordPress\n1. Learn how to create the TimelineJS source at http://timeline.verite.co/#fileformat\n1. Use the shortcode on your post/page: `[timeline src=\"Your source url here\"]`\n\n**Extra tip** - If you want do embed outside of a post, use the following code on your template:\n``\n\n## File Formats\n\n### Google Docs:\n\nIf you don\u2019t want to mess with JSON, fire up Google Docs and build your\ntimeline in a spreadsheet. It\u2019s as simple as dropping a date, text, and links\ninto the appropriate columns in TimelineJS\u2019s template.\n\nYou can find the template here: [TimelineJS Google Spreadsheet Template](https://docs.google.com/a/digitalartwork.net/previewtemplate?id=0AppSVxABhnltdEhzQjQ4MlpOaldjTmZLclQxQWFTOUE&mode=public)\n\nThere are only a couple things you need to know in order to create a timeline\nusing Google Docs:\n\n 1. Make the spreadsheet public: \n\tGoogle Docs are automatically set to private but the spreadsheet must be\n\tpublic.\n\t\n\tClick the blue \u201cShare\u201d button on the top right-hand corner. In the \u201cShare\n\tsettings\u201d window, you\u2019ll see the private setting of the spreadsheet: click\n\t\u201cChange...\u201d. In the Visibility options window, choose \u201cPublic on the Web\u201d and\n\tsave.\n\n 2. Publish to the Web \n\tUnder the File menu, select \u201cPublish to the Web.\u201d\n\t\n\tIn the next window, check the box next to \u201cAutomatically republish when\n\tchanges are made.\u201d Uncheck all other boxes. Click \u201cstart publishing.\u201d This\n\twill give you the URL to embed in your HTML file.\n\n 3. Copy/paste the Web URL into your TimelineJS HTML file \n\tAfter you publish the spreadsheet, Google Docs will generate a link to the\n\tfile. Copy the link for the Web Page option (as opposed to PDF, HTML, XLS,\n\tetc.), then paste it into the timeline\u2019s HTML file (see [Add it to your site](#add-it-to-your-site) )\n\n\n## Shortcode Options\nHere are some of the options you can set in the config.\n\n### Language\n`lang`\nLocalization\n*default is en*\nLanguages available:\n* `en` *English*\n* `fr` *Fran\u00e7ais*\n* `es` *Espa\u00f1ol*\n* `de` *Deutsch*\n* `it` *Italiano*\n* `pt-br` *Portugu\u00eas Brazil*\n* `pt` *Portugu\u00eas*\n* `nl` *Dutch*\n* `cz` *Czech*\n* `dk` *Danish*\n* `id` *Indonesian*\n* `pl` *Polish*\n* `sl` *Slovenian*\n* `ru` *Russian*\n* `sk` *Slovak*\n* `is` *Icelandic*\n* `fo` *Faroese*\n* `kr` *\uc6d4\uc694\uc77c*\n* `ja` *\u65e5\u672c\u8a9e*\n* `zh-ch` *\u4e2d\u6587*\n* `zh-tw` *Taiwanese Mandarin*\n* `ta` *\u0ba4\u0bae\u0bbf\u0bb4\u0bcd - Tamil*\n* `ar` *Arabic* *May be issues with right to left (need some help here)* \n\nHelp us add more. Grab a copy of a language file and replace it with your language [Example language file](https://github.com/VeriteCo/StoryJS-Core/blob/master/Language/locale/en.js) and find your language's [two letter code here](http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1)\n\n###Start at End \n`start_at_end`\nset to true to start the timeline on the last date.\n*default is false*\n\n###Start at Slide \n`start_at_slide`\nYou can tell TimelineJS to start at a specific slide number\n*default is 0*\n\n###Start Zoom Adjust\n`start_zoom_adjust`\nThis 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.\n*default is 0*\n\n###Hash Bookmark \n`hash_bookmark`\nset to true to allow bookmarking slides using the hash tag\n*default is false*\n\n###Debug \n`debug`\nWill log events etc to the console.\n*default is false*\n\n\n###Map Style Types \nDue to recent changes to the Google Maps API, you need a [API Key](https://developers.google.com/places/documentation/#Authentication) in order to use custom map types.\n`gmap_key:`\n*required in order to use maptype*\n\n`maptype:`\n* [Stamen Maps ](maps.stamen.com)\n* `toner`\n* `toner-lines`\n* `toner-labels`\n* `watercolor`\n* `sterrain`\n\t\t\n* Google Maps\n* `ROADMAP`\n* `TERRAIN`\n* `HYBRID`\n* `SATELLITE`\n\n###Font Options \n`font:`\n* `Arvo-PTSans`\n* `Merriweather-NewsCycle`\n* `PoiretOne-Molengo`\n* `PTSerif-PTSans`\n* `DroidSerif-DroidSans`\n* `Lekton-Molengo`\n* `NixieOne-Ledger`\n* `AbrilFatface-Average`\n* `PlayfairDisplay-Muli`\n* `Rancho-Gudea`\n* `Bevan-PotanoSans`\n* `BreeSerif-OpenSans`\n* `SansitaOne-Kameron`\n* `Pacifico-Arimo`\n* Or make your own\n\n####Font Combination Preview:\n![Font Combination Preview](http://timeline.verite.co/gfx/font-options.png)\n \n## Best practices\n\nTips and tricks to best utilize TimelineJS\n\n 1. Keep it light - don\u2019t get bogged down by text or other elements\n 2. Pick stories that have a strong chronological narrative. It does not work well for stories that need to jump around in the timeline.\n 3. Include events that build up to major occurrences, not just the major events.\n 4. Don't overwhelm the user. A timeline with hundreds of events is probably not the best use of the format.\n \n## License\nThis Source Code Form is subject to the terms of the Mozilla Public\nLicense, v. 2.0. If a copy of the MPL was not distributed with this\nfile, You can obtain one at http://mozilla.org/MPL/2.0/.\n\n## Changelog\n\n### 0.2 ###\n* First stable release.", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/abdallah/Django-TimelineJS/zipball/master", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/abdallah/Django-TimelineJS", "keywords": null, "license": "MPL2.0", "maintainer": null, "maintainer_email": null, "name": "Django-TimelineJS", "package_url": "https://pypi.org/project/Django-TimelineJS/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/Django-TimelineJS/", "project_urls": { "Download": "https://github.com/abdallah/Django-TimelineJS/zipball/master", "Homepage": "https://github.com/abdallah/Django-TimelineJS" }, "release_url": "https://pypi.org/project/Django-TimelineJS/0.2/", "requires_dist": null, "requires_python": null, "summary": "Pluggable app for Django to edit and display TimelineJS timelines", "version": "0.2" }, "last_serial": 784139, "releases": { "0.2": [ { "comment_text": "", "digests": { "md5": "73ef07e9737c59d6280922fbc1236c1a", "sha256": "e71e1d9e7c59c90a81f4a5cd42d8a28b62943c2cf888666e27d2382e68a7c208" }, "downloads": -1, "filename": "Django-TimelineJS-0.2.tar.gz", "has_sig": false, "md5_digest": "73ef07e9737c59d6280922fbc1236c1a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 238957, "upload_time": "2012-10-05T21:07:55", "url": "https://files.pythonhosted.org/packages/b2/62/584ee1eca82db36886cff3566615d5a1343dc9d067144d56ad9687f76adc/Django-TimelineJS-0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "73ef07e9737c59d6280922fbc1236c1a", "sha256": "e71e1d9e7c59c90a81f4a5cd42d8a28b62943c2cf888666e27d2382e68a7c208" }, "downloads": -1, "filename": "Django-TimelineJS-0.2.tar.gz", "has_sig": false, "md5_digest": "73ef07e9737c59d6280922fbc1236c1a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 238957, "upload_time": "2012-10-05T21:07:55", "url": "https://files.pythonhosted.org/packages/b2/62/584ee1eca82db36886cff3566615d5a1343dc9d067144d56ad9687f76adc/Django-TimelineJS-0.2.tar.gz" } ] }