diff --git a/book/_static/element_pdf_and_cdf.html b/book/_static/element_pdf_and_cdf.html new file mode 100644 index 0000000..d41fc47 --- /dev/null +++ b/book/_static/element_pdf_and_cdf.html @@ -0,0 +1,392 @@ + + + + + + + + + +
+ + +
+ + + + \ No newline at end of file diff --git a/book/_toc.yml b/book/_toc.yml index 2aa86c4..e3e1240 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -39,6 +39,7 @@ parts: sections: - file: features/grasple.md - file: features/h5p.md + - file: features/adding_basic_HTML_elements.md - file: features/live_code.md sections: - file: features/widgets.ipynb diff --git a/book/features/adding_basic_HTML_elements.md b/book/features/adding_basic_HTML_elements.md new file mode 100644 index 0000000..113e19a --- /dev/null +++ b/book/features/adding_basic_HTML_elements.md @@ -0,0 +1,863 @@ +# Adding basic interactive HTML/JavaScript elements + +## Embedding HTML files +A straightforward way to create interactive web-based elements is to code them directly using HTML with JavaScript. This allows us to build elements such as the one below, which shows the connection between a probability density function (pdf) and the associated cumulative density function (cdf): + + + +If we want to embed such figures in the teachbook, you can do so via an iframe which reference a html file in the _static folder: + +```html + +``` + +Here, the src path moves up one subdirectory, then enters the _static folder, and loads the element_pdf_and_cdf.html file. So how do we create this figure? + +## Creating a basic interactive HTML/JavaScript element + +At the bottom of this page, I will provide the full code for the interactive element above. In this section, let us go through the code piece by piece. Let us begin by looking at the start of the code. + +We begin by specifying that this file is a HTML file. In the header, we can load packages we need later on. Within the ` + + + + +``` + +Next, we create a `
`, an HTML element that can group other HTML elements, that contians a [SVG](https://en.wikipedia.org/wiki/SVG) named `"click"`. This SVG will serve as the canvas on which we will place the interactive content. + +```html + +
+ + +
+``` + +So far, all of this has just been setup. The real magic begins in the ` + + +``` + +## HTML code for the pdf/cdf element + +This is the code for the element above: + +```html + + + + + + + + + +
+ + +
+ + + + + + +``` \ No newline at end of file diff --git a/book/features/interactive_element.ipynb b/book/features/interactive_element.ipynb index f0099c0..b29afd2 100644 --- a/book/features/interactive_element.ipynb +++ b/book/features/interactive_element.ipynb @@ -15,7 +15,9 @@ " - JupyterQuiz: code-based implementation of multiple-choiche questions and numerical answer questions. This is a basic open course tool which requires you to write your quiz questions in Python language as a `dict` or to a `.json` file.\n", " - H5p: TU-Delft-licensed tool to create questions (and many other interactive elements) using an [online GUI](https://tudelft.h5p.com/). These elements are embedded into the book using an iframe which requires very little coding. This elements are easier to implement than the JupyterQuiz and have more features (although proper numerical answer questions are missing). More information on this is provided in [this subchapter](h5p.md)\n", " - Grasple-exercises: TU-Delft-licensed tool to creating math-based quiz questions. Again, these elements are embedded into the book using an iframe which requiries very little coding. These elements are very well suited to math-based problems as it allows analytical evaluation of numerical values and formulas. Furthermore, Grasple allows parameterization (not required for formative exercises). More information on this is provided in [this subchapter](grasple.md)\n", - " - Non-kernel-based widgets: You can create interactive widgets with Python which doesn't need a kernel to run online. The use of the [plotly](https://plotly.com/python/getting-started/) package is an example which allows this use.\n", + " - Non-kernel-based widgets: You can create interactive widgets with Python which doesn't need a kernel to run online:\n", + " - You can create html/javascript widgets, an example is shown in [this subchapter](adding_basic_HTML_elements.md)\n", + " - The use of the [plotly](https://plotly.com/python/getting-started/) package is an example which allows this use.\n", "\n", "Examples of each type is shown below based on the following problem:\n", "\n",