Interactive text and figures
============================
This project provides quick starting point for anyone who wants to experiment
with **interactive text and figures** in their electronic publications
(EPUB3 / HTML5 + JavaScript). One possible reason why one would use interactive
text and figures is to **communicate many possible stories** to the audience,
instead of usual single story line. See [Physics World blogpost](https://physicsworld.com/a/do-interactive-figures-help-physicists-to-communicate-their-science/).
Two templates and corresponding tools are provided.
Tools generate HTML/Javascript output that can be seen in
web-browsers and e-readers.
Generated examples don't have any external dependencies that need to be
downloaded from the Internet. They are completely self contained,
and be seen on all devices (even without Internet access),
and they can be simply included in interactive texts/books in EPUB3 format,
as well as web-pages.
[**For detailed documentation and discussion of motivation and examples check here**](https://nikolasibalic.github.io/Interactive-Publishing/)
[](https://zenodo.org/badge/latestdoi/163100222) [](https://badge.fury.io/py/Interactive-Publishing)
---------
Note on implementation
----------------------
Interactive text example implements simple calculations in JavaScript. More
complex calculations should be precalculated and provided as look-up tables.
Interactive figures generate figures for all possible combinations of the
input. Control JavaScripts then displays just images corresponding to
selected combination of input parameters, while all other images are hidden.
This can make files relatively large, but it allows their viewing on devices
with minimal computational resources, like ereaders, and old phones.
License
-------
Overall license is BSD-3-Clause as outlined included in `LICENSE.md`.
This project uses [```TangleKit```](/TangleKit) package from this repository
for creating interactive text. That package is based on
on slightly modified and updated open-source
[Tangle.js](http://worrydream.com/Tangle/)
library of [Bret Victor](http://worrydream.com/ExplorableExplanations/).
Interactive figures use Matplotlib Python package and [```ifigures```](/ifigures)
package from this repository which is based
on updated and modified version of
[ipywidgets-static](https://github.com/jakevdp/ipywidgets-static).
Compared to original package, dependency on IPython is removed,
Python 2 and 3 are supported now, and few bugs are fixed.
Licenses are inherited from the original projects mentioned above.
They are permissive, and allow reuse, with or without modification, but for
details check corresponding LICENSE files and code headers.
Raw data
{
"_id": null,
"home_page": "https://nikolasibalic.github.io/Interactive-Publishing/",
"name": "interactive-publishing",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "EPUB3, interactive publishing, explorable explanation, quantum state visualisation",
"author": "Nikola Sibalic",
"author_email": "nikolasibalic@physics.org",
"download_url": "https://files.pythonhosted.org/packages/be/24/a94a9e45597ec93ba8dc40f45dcb454d3688cb46d84fd13a188bfe35d8be/interactive_publishing-0.2.8.tar.gz",
"platform": null,
"description": "Interactive text and figures\n============================\n\nThis project provides quick starting point for anyone who wants to experiment\nwith **interactive text and figures** in their electronic publications\n(EPUB3 / HTML5 + JavaScript). One possible reason why one would use interactive\ntext and figures is to **communicate many possible stories** to the audience,\ninstead of usual single story line. See [Physics World blogpost](https://physicsworld.com/a/do-interactive-figures-help-physicists-to-communicate-their-science/).\n\nTwo templates and corresponding tools are provided.\nTools generate HTML/Javascript output that can be seen in\nweb-browsers and e-readers.\nGenerated examples don't have any external dependencies that need to be\ndownloaded from the Internet. They are completely self contained,\nand be seen on all devices (even without Internet access),\nand they can be simply included in interactive texts/books in EPUB3 format,\nas well as web-pages.\n\n[**For detailed documentation and discussion of motivation and examples check here**](https://nikolasibalic.github.io/Interactive-Publishing/)\n\n[](https://zenodo.org/badge/latestdoi/163100222) [](https://badge.fury.io/py/Interactive-Publishing) \n\n---------\n\n\nNote on implementation\n----------------------\nInteractive text example implements simple calculations in JavaScript. More\ncomplex calculations should be precalculated and provided as look-up tables.\n\nInteractive figures generate figures for all possible combinations of the\ninput. Control JavaScripts then displays just images corresponding to\nselected combination of input parameters, while all other images are hidden.\nThis can make files relatively large, but it allows their viewing on devices\nwith minimal computational resources, like ereaders, and old phones.\n\nLicense\n-------\nOverall license is BSD-3-Clause as outlined included in `LICENSE.md`.\n\nThis project uses [```TangleKit```](/TangleKit) package from this repository \nfor creating interactive text. That package is based on \non slightly modified and updated open-source\n[Tangle.js](http://worrydream.com/Tangle/)\nlibrary of [Bret Victor](http://worrydream.com/ExplorableExplanations/).\n\nInteractive figures use Matplotlib Python package and [```ifigures```](/ifigures)\npackage from this repository which is based\non updated and modified version of \n[ipywidgets-static](https://github.com/jakevdp/ipywidgets-static).\nCompared to original package, dependency on IPython is removed,\nPython 2 and 3 are supported now, and few bugs are fixed.\n\nLicenses are inherited from the original projects mentioned above.\nThey are permissive, and allow reuse, with or without modification, but for\ndetails check corresponding LICENSE files and code headers. \n\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause license",
"summary": "Templates and tools for creating interactive figures and interactive text for publishing in EPUB3/HTML5.",
"version": "0.2.8",
"project_urls": {
"Documentation": "https://nikolasibalic.github.io/Interactive-Publishing/",
"Homepage": "https://nikolasibalic.github.io/Interactive-Publishing/",
"Repository": "https://github.com/nikolasibalic/Interactive-Publishing"
},
"split_keywords": [
"epub3",
" interactive publishing",
" explorable explanation",
" quantum state visualisation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be24a94a9e45597ec93ba8dc40f45dcb454d3688cb46d84fd13a188bfe35d8be",
"md5": "ee44da5437577bb544bf7c562136f7c4",
"sha256": "3f0aa454c47945ce99358438a61aefe17a9cc4fd584a33bbd1f8754ded8e05b0"
},
"downloads": -1,
"filename": "interactive_publishing-0.2.8.tar.gz",
"has_sig": false,
"md5_digest": "ee44da5437577bb544bf7c562136f7c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 28370,
"upload_time": "2024-06-04T19:16:21",
"upload_time_iso_8601": "2024-06-04T19:16:21.475208Z",
"url": "https://files.pythonhosted.org/packages/be/24/a94a9e45597ec93ba8dc40f45dcb454d3688cb46d84fd13a188bfe35d8be/interactive_publishing-0.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-04 19:16:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nikolasibalic",
"github_project": "Interactive-Publishing",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "interactive-publishing"
}
JSON
