Files
ProcessControl/_book/index.html
T
2026-09-25 13:33:30 +02:00

1066 lines
44 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
<meta charset="utf-8">
<meta name="generator" content="quarto-1.10.18">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<meta name="author" content="Romain De Groote">
<meta name="dcterms.date" content="2026-09-24">
<title>From Calling to Eventing</title>
<style>
/* Default styles provided by pandoc.
** See https://pandoc.org/MANUAL.html#variables-for-html for config info.
*/
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: 1.5em;}
div.column{flex: auto;}
@media screen {
div.columns{gap: min(4vw, 1.5em);}
div.column{overflow-x: auto;}
}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
ul.task-list li input[type="checkbox"] {
width: 0.8em;
margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
vertical-align: middle;
}
/* CSS for syntax highlighting */
html { -webkit-text-size-adjust: 100%; }
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
}
pre.numberSource { margin-left: 3em; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
</style>
<script src="site_libs/quarto-nav/quarto-nav.js"></script>
<script src="site_libs/quarto-nav/headroom.min.js"></script>
<script src="site_libs/clipboard/clipboard.min.js"></script>
<script src="site_libs/quarto-search/autocomplete.umd.js"></script>
<script src="site_libs/quarto-search/fuse.min.js"></script>
<script src="site_libs/quarto-search/quarto-search.js"></script>
<meta name="quarto:offset" content="./">
<link href="./00-orientation.html" rel="next">
<script src="site_libs/quarto-html/quarto.js" type="module"></script>
<script src="site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
<script src="site_libs/quarto-html/popper.min.js"></script>
<script src="site_libs/quarto-html/tippy.umd.min.js"></script>
<script src="site_libs/quarto-html/anchor.min.js"></script>
<link href="site_libs/quarto-html/tippy.css" rel="stylesheet">
<link href="site_libs/quarto-html/quarto-syntax-highlighting-7c68a30ea258f1cbeb56603bc0a48370.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="site_libs/bootstrap/bootstrap.min.js"></script>
<link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="site_libs/bootstrap/bootstrap-cfe7114cbc4adb2af5ff3a891545d7fa.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script src="site_libs/quarto-contrib/calc-exo-2.0.0/exo.js"></script>
<link href="site_libs/quarto-contrib/calc-exo-2.0.0/exo.css" rel="stylesheet">
<link href="site_libs/quarto-contrib/calc-latex-tables-1.0.0/latex-tables.css" rel="stylesheet">
<script src="site_libs/quarto-contrib/calc-notes-1.0.0/calc-notes.js"></script>
<link href="site_libs/quarto-contrib/calc-notes-1.0.0/calc-notes.css" rel="stylesheet">
<script src="site_libs/quarto-contrib/calc-glossary-2.0.0/glossary.js"></script>
<link href="site_libs/quarto-contrib/calc-glossary-2.0.0/glossary.css" rel="stylesheet">
<script id="quarto-search-options" type="application/json">{
"location": "sidebar",
"copy-button": false,
"collapse-after": 3,
"panel-placement": "start",
"type": "textbox",
"limit": 50,
"keyboard-shortcut": [
"f",
"/",
"s"
],
"show-item-context": false,
"language": {
"search-no-results-text": "No results",
"search-matching-documents-text": "matching documents",
"search-copy-link-title": "Copy link to search",
"search-hide-matches-text": "Hide additional matches",
"search-more-match-text": "more match in this document",
"search-more-matches-text": "more matches in this document",
"search-clear-button-title": "Clear",
"search-text-placeholder": "",
"search-detached-cancel-button-title": "Cancel",
"search-submit-button-title": "Submit",
"search-label": "Search"
}
}</script>
<style>html{ scroll-behavior: smooth; }</style>
<!-- Language switcher for the html output only (included in the <head>).
Each profile's sidebar translate menu links to the start page of the other
languages (_book/ English, _book/fr/, _book/de/). All three books share the
same file names and section ids (#sec-...), so a click is sent to the same
page and section of the other language instead.
Quarto's page scripts rewrite those links in the browser (to an absolute
address without index.html), and can do so after this script runs. So
nothing is attached to the links themselves: one capture-phase listener on
the document reads the link's final address at click time.
If a language has not been built (./render-all.sh), its pages do not exist:
the target is checked first and a short note is shown instead of a
"Not Found" page.
The language picked in the menu is remembered for a year in a cookie
(notes-lang, limited to the book's address). A later visit to a page in
another language goes straight to the same page in the remembered one; this
runs in the <head>, before anything is drawn. Not in the local preview
(file:, localhost), where the other languages may not be built. -->
<script>
(function () {
var CODE = { 'Deutsch': 'de', 'Français': 'fr', 'English': 'en' };
var ROOT_LANG = 'en'; // the language at the top of _book/
var COOKIE = 'notes-lang';
var NOTE = {
de: 'Diese Sprache wurde noch nicht erstellt. Einmal ./render-all.sh ausführen – '
+ 'danach funktioniert der Wechsel auch in der Vorschau.',
fr: 'Cette langue n’a pas encore été générée. Lancez une fois ./render-all.sh : '
+ 'ensuite le changement fonctionne aussi dans l’aperçu.',
en: 'This language hasn’t been built yet. Run ./render-all.sh once, '
+ 'then switching works in the preview too.'
};
var here = (document.documentElement.lang || ROOT_LANG).slice(0, 2);
// the book's top folder: /…/fr/page.html -> /…/ ; /…/page.html -> /…/
var dir = location.pathname.replace(/[^\/]*$/, '');
var root = (here !== ROOT_LANG && dir.slice(-(here.length + 2)) === '/' + here + '/')
? dir.slice(0, -(here.length + 1)) : dir;
var page = location.pathname.slice(dir.length); // "" for a folder
function remembered() {
var m = document.cookie.match(/(?:^|;\s*)notes-lang=(de|fr|en)(?:;|$)/);
return m ? m[1] : null;
}
function remember(code) {
document.cookie = COOKIE + '=' + code + '; path=' + root + '; max-age=31536000; SameSite=Lax'
+ (location.protocol === 'https:' ? '; Secure' : '');
}
// a returning reader lands in the language picked last time
var live = /^https?:$/.test(location.protocol)
&& !/^(localhost|127\.0\.0\.1|\[::1\])$/.test(location.hostname);
var wanted = remembered();
if (live && wanted && wanted !== here) {
location.replace(root + (wanted === ROOT_LANG ? '' : wanted + '/') + page
+ location.search + location.hash);
return;
}
function note() {
var lang = (document.documentElement.lang || 'en').slice(0, 2);
var box = document.createElement('div');
box.setAttribute('role', 'status');
box.className = 'i18n-note';
box.textContent = NOTE[lang] || NOTE.en;
box.style.cssText = 'position:fixed;left:50%;bottom:1.25rem;transform:translateX(-50%);'
+ 'max-width:min(34rem,calc(100vw - 2rem));padding:.6rem .9rem;border-radius:6px;'
+ 'background:#1f2328;color:#fff;font-size:.85rem;line-height:1.4;z-index:2000;'
+ 'box-shadow:0 4px 16px rgba(0,0,0,.25)';
document.body.appendChild(box);
setTimeout(function () { box.remove(); }, 7000);
}
function exists(url) {
return fetch(url, { method: 'HEAD', cache: 'no-store' })
.then(function (r) { return r.status !== 404; }, function () { return true; });
}
document.addEventListener('click', function (ev) {
if (ev.button !== 0 || ev.metaKey || ev.ctrlKey || ev.shiftKey || ev.altKey) return;
var a = ev.target.closest && ev.target.closest('a.sidebar-tools-main-item');
if (!a || !a.href) return;
var code = CODE[a.textContent.trim()];
if (!code) return; // some other tool link
ev.preventDefault();
// the language being read already: just remember it
if (code === here) { remember(code); return; }
var link = new URL(a.href, location.href);
var target_root = link.pathname.replace(/index\.html$/, ''); // "/" or "/fr/"
if (target_root.slice(-1) !== '/') target_root += '/';
var target = link.origin + target_root + (page || 'index.html');
if (location.protocol === 'file:' || !window.fetch) {
remember(code);
location.href = target + location.hash;
return;
}
// same page in the other language, else its start page, else explain
exists(target).then(function (ok) {
if (ok) { remember(code); location.href = target + location.hash; return; }
return exists(link.origin + target_root).then(function (rootOk) {
if (rootOk) { remember(code); location.href = link.origin + target_root; }
else note();
});
});
}, true);
})();
</script>
<style>:root { --calc-notecolor: #B45309; }</style>
</head>
<body class="nav-sidebar docked quarto-light">
<div id="quarto-search-results"></div>
<header id="quarto-header" class="headroom fixed-top">
<nav class="quarto-secondary-nav">
<div class="container-fluid d-flex">
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./index.html">About these notes</a></li></ol></nav>
<a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
<i class="bi bi-search"></i>
</button>
</div>
</nav>
</header>
<!-- content -->
<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article">
<!-- sidebar -->
<nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal quarto-sidebar-collapse-item sidebar-navigation docked overflow-auto">
<div class="pt-lg-2 mt-2 text-left sidebar-header">
<div class="sidebar-title mb-0 py-0">
<a href="./">From Calling to Eventing</a>
<div class="sidebar-tools-main tools-wide">
<div class="dropdown">
<a href="" title="" id="quarto-navigation-tool-dropdown-0" class="quarto-navigation-tool dropdown-toggle px-1" data-bs-toggle="dropdown" aria-expanded="false" role="link" aria-label=""><i class="bi bi-translate"></i></a>
<ul class="dropdown-menu" aria-labelledby="quarto-navigation-tool-dropdown-0">
<li>
<a class="dropdown-item sidebar-tools-main-item" href="./index.html">
English
</a>
</li>
<li>
<a class="dropdown-item sidebar-tools-main-item" href="./fr/index.html">
Français
</a>
</li>
<li>
<a class="dropdown-item sidebar-tools-main-item" href="./de/index.html">
Deutsch
</a>
</li>
</ul>
</div>
<a href="./From-Calling-to-Eventing.pdf" title="Download PDF" class="quarto-navigation-tool px-1" aria-label="Download PDF"><i class="bi bi-file-pdf"></i></a>
<a href="" class="quarto-reader-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleReader(); return false;" title="Toggle reader mode">
<div class="quarto-reader-toggle-btn">
<i class="bi"></i>
</div>
</a>
</div>
</div>
</div>
<div class="mt-2 flex-shrink-0 align-items-center">
<div class="sidebar-search">
<div id="quarto-search" class="" title="Search"></div>
</div>
</div>
<div class="sidebar-menu-container">
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./index.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">About these notes</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./00-orientation.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">1</span>&nbsp; <span class="chapter-title">Step 0 — What the tutorial is about</span></span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./01-part-i-calls.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">2</span>&nbsp; <span class="chapter-title">Part I — Start with what you already know</span></span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./02-part-ii-processes.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">3</span>&nbsp; <span class="chapter-title">Part II — Cross the process boundary</span></span></a>
</div>
</li>
</ul>
</div>
</nav>
<div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div>
<!-- margin-sidebar -->
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
<nav id="TOC" role="doc-toc" class="toc-active">
<h2 id="toc-title">On this page</h2>
<ul>
<li><a href="#sec-about" id="toc-sec-about" class="nav-link active" data-scroll-target="#sec-about">About these notes</a>
<ul class="collapse">
<li><a href="#sec-diagrams" id="toc-sec-diagrams" class="nav-link" data-scroll-target="#sec-diagrams">How to read the diagrams</a></li>
<li><a href="#sec-build" id="toc-sec-build" class="nav-link" data-scroll-target="#sec-build">Building this book</a></li>
</ul></li>
</ul>
</nav>
</div>
<!-- main -->
<main class="content" id="quarto-document-content">
<header id="title-block-header" class="quarto-title-block default">
<div class="quarto-title">
<h1 class="title">From Calling to Eventing</h1>
</div>
<div class="quarto-title-meta">
<div>
<div class="quarto-title-meta-heading">Author</div>
<div class="quarto-title-meta-contents">
<p>Romain De Groote <a href="mailto:romain@de-groote.ch" class="quarto-title-author-email"><i class="bi bi-envelope"></i></a> </p>
</div>
</div>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">24 September 2026</p>
</div>
</div>
</div>
<div>
<div class="abstract">
<div class="block-title">Abstract</div>
Step-by-step summaries of the SIN.04028 tutorial “From Calling to Eventing”, from direct method calls to an Event-Driven Architecture over MQTT. Process Control, given by Reto Konig, University of Fribourg, autumn semester 2026.
</div>
</div>
</header>
<section id="sec-about" class="level1 unnumbered">
<h1 class="unnumbered">About these notes</h1>
<!--
MULTILINGUAL (see _extensions/notes/i18n.lua):
- prose: ::: {.en} / {.fr} / {.de}
- headings, captions: [..]{.en}[..]{.fr}[..]{.de}
- short strings inside attributes, raw HTML, file paths: @tr{key} (i18n.yml)
- figures: one drawing in figures/src/, labels in figures/labels.yml, built
per language by figures/build-figures.py; a chapter refers to it without an
extension so html takes the svg and pdf the pdf.
- a figure with the class .flow-figure is animated in the html output by
figures/flow-player.html; the pdf and the no-JavaScript case show the same
picture, just still.
- fixed section ids (#sec-...) so anchors are identical in all three books.
English is the verified source: the tutorial being summarised is written in
English. French and German are translations of it.
Code identifiers, mailbox and topic names, file names, commands and protocol
terms are never translated (consoleIn.outbox, rot13/inbox, WatchService,
Mediator.java, .msg, put/take, Intent/Status/Event).
-->
<p>These notes summarise the tutorial <strong>“SIN.04028 — From Calling to Eventing”</strong>, worked through step by step. The tutorial itself lives next to this book, in <code>SIN.04028-From-Calling-to-Eventing/README.md</code>, and belongs to the <em>Process Control</em> course given by Reto Konig at the University of Fribourg (autumn semester 2026).</p>
<p>The program under construction never changes: you type a line, it comes back rotated by 13 letters.</p>
<pre class="text"><code>keyboard → ROT13 → console</code></pre>
<p>What changes is everything around it. The tutorial rebuilds the same system again and again while asking three questions, in this order:</p>
<blockquote class="blockquote">
<p><strong>Who knows whom?</strong></p>
<p><strong>Who owns what?</strong></p>
<p><strong>Who decides how the system is wired together?</strong></p>
</blockquote>
<p>One summary is added here each time a step is finished, so the book grows at the pace of the work. Each summary says what the step did, what was observed when it ran, and what moved architecturally — usually a piece of knowledge that changed hands.</p>
<section id="sec-diagrams" class="level2">
<h2 class="anchored" data-anchor-id="sec-diagrams">How to read the diagrams</h2>
<p>Every diagram exists once as a drawing and three times as a language. In the web version, a diagram that carries a message flow has a small play bar under it: <strong>Play</strong> walks one message through the whole chain, <strong>One hop</strong> advances a single step, and <strong>Reset</strong> puts it back. Boxes light up as the message reaches them, so you can see which component is waiting and which one is working.</p>
<p>In the PDF, and in a browser with JavaScript switched off, the same picture is there — just still. Nothing in the notes depends on the animation.</p>
</section>
<section id="sec-build" class="level2">
<h2 class="anchored" data-anchor-id="sec-build">Building this book</h2>
<p>The three books come from one source:</p>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb2"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./render-all.sh</span> <span class="co"># figures, then html + pdf for en, fr, de</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="ex">./render-all.sh</span> <span class="at">--serve</span> <span class="co"># …and serve _book/ on http://localhost:8000</span></span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p><code>_book/</code> holds the English book, <code>_book/fr/</code> the French one and <code>_book/de/</code> the German one; the language menu in the sidebar switches between them and remembers the choice. A single <code>quarto render</code> builds English only and empties <code>_book/</code>, which removes the other two — so use the script.</p>
</section>
</section>
</main> <!-- /main -->
<!-- figures/flow-player.html -- the web version's interactive diagrams.
Injected at the end of <body> by include-in-header's sibling
include-after-body in _quarto.yml, so it is a no-op on a page that holds
no img.flow-figure.
A chapter writes an ordinary Quarto figure and adds the class:
![caption](figures/mailboxes-jvm-@tr{langcode}){#fig-x .flow-figure}
That keeps the PDF and the no-JavaScript case working: the built svg is
already the whole picture. Here the image is fetched, inlined, and given
a play bar that walks a message through the mailboxes, one hop per
[data-flow] edge of the svg, highlighting the [data-flow-node] each hop
ends at. Colours are diagram.css's, so the two stay in step. -->
<style>
.flow-wrap { margin: 0; }
.flow-wrap svg { width: 100%; height: auto; display: block; }
.flow-token { fill: #8a5a08; stroke: #fbfcfd; stroke-width: 1.2; }
.flow-wrap .flow-on .box,
.flow-wrap .flow-on .box-plain,
.flow-wrap .flow-on .box-accent { stroke-width: 3; }
.flow-wrap .flow-done { stroke: #8a5a08; }
.flow-bar {
display: flex; align-items: center; gap: .5rem; flex-wrap: wrap;
max-width: 100%; margin: .45rem 0 0;
}
.flow-bar button {
font: inherit; font-size: .82rem; padding: .18rem .7rem; cursor: pointer;
border: 1px solid #dae0e8; border-radius: 999px;
background: #fbfcfd; color: #5a6879;
}
.flow-bar button:hover { border-color: #20666f; color: #20666f; }
.flow-bar button[disabled] { opacity: .45; cursor: default; }
.flow-status { font-size: .8rem; color: #5a6879; }
.flow-status b { color: #20666f; font-weight: 600; }
@media (prefers-color-scheme: dark) {
.flow-token { fill: #c99a3a; stroke: #161b22; }
.flow-bar button { background: #161b22; border-color: #30363d; color: #8b98a8; }
.flow-bar button:hover { border-color: #4c9aa5; color: #7fc4cf; }
.flow-status { color: #8b98a8; }
.flow-status b { color: #7fc4cf; }
}
</style>
<script>
(() => {
const images = document.querySelectorAll("img.flow-figure");
if (!images.length) return;
const LANG = (document.documentElement.lang || "en").slice(0, 2);
const WORDS = {
en: { play: "Play", pause: "Pause", step: "One hop", reset: "Reset",
idle: "the message has not been sent yet", done: "arrived" },
fr: { play: "Lancer", pause: "Pause", step: "Un saut", reset: "Réinitialiser",
idle: "le message n'est pas encore parti", done: "arrivé" },
de: { play: "Abspielen", pause: "Pause", step: "Ein Sprung", reset: "Zurücksetzen",
idle: "die Nachricht ist noch nicht unterwegs", done: "angekommen" },
};
const W = WORDS[LANG] || WORDS.en;
const STILL = window.matchMedia("(prefers-reduced-motion: reduce)").matches;
const HOP = 620; // ms per hop
const label = (node) => {
const text = node && node.querySelector("text");
return text ? text.textContent.trim() : "";
};
async function upgrade(img) {
let svg;
try {
const response = await fetch(img.currentSrc || img.src);
if (!response.ok) return; // leave the plain image in place
const doc = new DOMParser().parseFromString(await response.text(), "image/svg+xml");
svg = doc.documentElement;
if (!svg || svg.nodeName !== "svg" || doc.querySelector("parsererror")) return;
} catch { return; } // file:// or offline: plain image
const edges = [...svg.querySelectorAll("[data-flow]")]
.sort((a, b) => Number(a.dataset.flow) - Number(b.dataset.flow));
if (!edges.length) return;
svg.removeAttribute("width");
svg.removeAttribute("height");
const wrap = document.createElement("div");
wrap.className = "flow-wrap";
wrap.appendChild(svg);
const bar = document.createElement("div");
bar.className = "flow-bar";
const make = (name) => {
const button = document.createElement("button");
button.type = "button";
button.textContent = W[name];
bar.appendChild(button);
return button;
};
const playButton = make("play");
const stepButton = make("step");
const resetButton = make("reset");
const status = document.createElement("span");
status.className = "flow-status";
bar.appendChild(status);
wrap.appendChild(bar);
img.hidden = true;
img.after(wrap);
const token = document.createElementNS("http://www.w3.org/2000/svg", "circle");
token.setAttribute("r", "6");
token.setAttribute("class", "flow-token");
token.style.display = "none";
svg.appendChild(token);
let at = 0; // hops already made
let playing = false;
let frame = null;
const nodeOf = (edge) =>
edge.dataset.flowTo
? svg.querySelector(`[data-flow-node="${edge.dataset.flowTo}"]`)
: null;
const say = () => {
if (at === 0) { status.textContent = W.idle; return; }
const here = label(nodeOf(edges[at - 1]));
status.innerHTML = `${at} / ${edges.length} — <b></b>`;
status.querySelector("b").textContent =
at === edges.length ? `${here} (${W.done})` : here;
};
const clear = () => {
svg.querySelectorAll(".flow-on").forEach((n) => n.classList.remove("flow-on"));
edges.forEach((e) => e.classList.remove("flow-done"));
};
const place = (edge, fraction) => {
const length = edge.getTotalLength();
const point = edge.getPointAtLength(length * fraction);
token.setAttribute("cx", point.x);
token.setAttribute("cy", point.y);
token.style.display = "";
};
function hop(then) {
const edge = edges[at];
if (!edge) { then && then(false); return; }
clear();
const arrive = () => {
edge.classList.add("flow-done");
const node = nodeOf(edge);
if (node) node.classList.add("flow-on");
at += 1;
say();
buttons();
then && then(at < edges.length);
};
if (STILL) { place(edge, 1); arrive(); return; }
const start = performance.now();
const tick = (now) => {
const done = Math.min((now - start) / HOP, 1);
place(edge, done);
if (done < 1) { frame = requestAnimationFrame(tick); } else { frame = null; arrive(); }
};
frame = requestAnimationFrame(tick);
}
function buttons() {
const end = at >= edges.length;
playButton.textContent = playing ? W.pause : W.play;
playButton.disabled = end && !playing;
stepButton.disabled = end || playing;
resetButton.disabled = at === 0 && !playing;
}
function stop() {
playing = false;
if (frame) { cancelAnimationFrame(frame); frame = null; }
buttons();
}
function run() {
if (at >= edges.length) at = 0;
playing = true;
buttons();
const next = (more) => {
if (!playing) return;
if (more) { hop(next); } else { stop(); }
};
hop(next);
}
playButton.addEventListener("click", () => (playing ? stop() : run()));
stepButton.addEventListener("click", () => { stop(); hop(); });
resetButton.addEventListener("click", () => {
stop();
at = 0;
clear();
token.style.display = "none";
say();
buttons();
});
say();
buttons();
}
images.forEach(upgrade);
})();
</script>
<script id="quarto-html-after-body" type="application/javascript">
window.document.addEventListener("DOMContentLoaded", function (event) {
const icon = "";
const anchorJS = new window.AnchorJS();
anchorJS.options = {
placement: 'right',
icon: icon
};
anchorJS.add('.anchored');
const isCodeAnnotation = (el) => {
for (const clz of el.classList) {
if (clz.startsWith('code-annotation-')) {
return true;
}
}
return false;
}
const onCopySuccess = function(e) {
// button target
const button = e.trigger;
// don't keep focus
button.blur();
// flash "checked"
button.classList.add('code-copy-button-checked');
var currentTitle = button.getAttribute("title");
button.setAttribute("title", "Copied!");
let tooltip;
if (window.bootstrap) {
button.setAttribute("data-bs-toggle", "tooltip");
button.setAttribute("data-bs-placement", "left");
button.setAttribute("data-bs-title", "Copied!");
tooltip = new bootstrap.Tooltip(button,
{ trigger: "manual",
customClass: "code-copy-button-tooltip",
offset: [0, -8]});
tooltip.show();
}
setTimeout(function() {
if (tooltip) {
tooltip.hide();
button.removeAttribute("data-bs-title");
button.removeAttribute("data-bs-toggle");
button.removeAttribute("data-bs-placement");
}
button.setAttribute("title", currentTitle);
button.classList.remove('code-copy-button-checked');
}, 1000);
// clear code selection
e.clearSelection();
}
const getTextToCopy = function(trigger) {
const outerScaffold = trigger.parentElement.cloneNode(true);
const codeEl = outerScaffold.querySelector('code');
for (const childEl of codeEl.children) {
if (isCodeAnnotation(childEl)) {
childEl.remove();
}
}
return codeEl.innerText;
}
const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
text: getTextToCopy
});
clipboard.on('success', onCopySuccess);
if (window.document.getElementById('quarto-embedded-source-code-modal')) {
const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
text: getTextToCopy,
container: window.document.getElementById('quarto-embedded-source-code-modal')
});
clipboardModal.on('success', onCopySuccess);
}
var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
var mailtoRegex = new RegExp(/^mailto:/);
var filterRegex = new RegExp('/' + window.location.host + '/');
var isInternal = (href) => {
return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
}
// Inspect non-navigation links and adorn them if external
var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)');
for (var i=0; i<links.length; i++) {
const link = links[i];
if (!isInternal(link.href)) {
// undo the damage that might have been done by quarto-nav.js in the case of
// links that we want to consider external
if (link.dataset.originalHref !== undefined) {
link.href = link.dataset.originalHref;
}
// target, if specified
link.setAttribute("target", "_blank");
if (link.getAttribute("rel") === null) {
link.setAttribute("rel", "noopener");
}
}
}
function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
const config = {
allowHTML: true,
maxWidth: 500,
delay: 100,
arrow: false,
appendTo: function(el) {
return el.parentElement;
},
interactive: true,
interactiveBorder: 10,
theme: 'quarto',
placement: 'bottom-start',
};
if (contentFn) {
config.content = contentFn;
}
if (onTriggerFn) {
config.onTrigger = onTriggerFn;
}
if (onUntriggerFn) {
config.onUntrigger = onUntriggerFn;
}
window.tippy(el, config);
}
const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
for (var i=0; i<noterefs.length; i++) {
const ref = noterefs[i];
tippyHover(ref, function() {
// use id or data attribute instead here
let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
try { href = new URL(href).hash; } catch {}
const id = href.replace(/^#\/?/, "");
const note = window.document.getElementById(id);
if (note) {
return note.innerHTML;
} else {
return "";
}
});
}
const xrefs = window.document.querySelectorAll('a.quarto-xref');
const processXRef = (id, note) => {
// Strip column container classes
const stripColumnClz = (el) => {
el.classList.remove("page-full", "page-columns");
if (el.children) {
for (const child of el.children) {
stripColumnClz(child);
}
}
}
stripColumnClz(note)
if (id === null || id.startsWith('sec-')) {
// Special case sections, only their first couple elements
const container = document.createElement("div");
if (note.children && note.children.length > 2) {
container.appendChild(note.children[0].cloneNode(true));
for (let i = 1; i < note.children.length; i++) {
const child = note.children[i];
if (child.tagName === "P" && child.innerText === "") {
continue;
} else {
container.appendChild(child.cloneNode(true));
break;
}
}
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(container);
}
return container.innerHTML
} else {
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(note);
}
return note.innerHTML;
}
} else {
// Remove any anchor links if they are present
const anchorLink = note.querySelector('a.anchorjs-link');
if (anchorLink) {
anchorLink.remove();
}
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(note);
}
if (note.classList.contains("callout")) {
return note.outerHTML;
} else {
return note.innerHTML;
}
}
}
for (var i=0; i<xrefs.length; i++) {
const xref = xrefs[i];
tippyHover(xref, undefined, function(instance) {
instance.disable();
let url = xref.getAttribute('href');
let hash = undefined;
if (url.startsWith('#')) {
hash = url;
} else {
try { hash = new URL(url).hash; } catch {}
}
if (hash) {
const id = hash.replace(/^#\/?/, "");
const note = window.document.getElementById(id);
if (note !== null) {
try {
const html = processXRef(id, note.cloneNode(true));
instance.setContent(html);
} finally {
instance.enable();
instance.show();
}
} else {
// See if we can fetch this
fetch(url.split('#')[0])
.then(res => res.text())
.then(html => {
const parser = new DOMParser();
const htmlDoc = parser.parseFromString(html, "text/html");
const note = htmlDoc.getElementById(id);
if (note !== null) {
const html = processXRef(id, note);
instance.setContent(html);
}
}).finally(() => {
instance.enable();
instance.show();
});
}
} else {
// See if we can fetch a full url (with no hash to target)
// This is a special case and we should probably do some content thinning / targeting
fetch(url)
.then(res => res.text())
.then(html => {
const parser = new DOMParser();
const htmlDoc = parser.parseFromString(html, "text/html");
const note = htmlDoc.querySelector('main.content');
if (note !== null) {
// This should only happen for chapter cross references
// (since there is no id in the URL)
// remove the first header
if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
note.children[0].remove();
}
const html = processXRef(null, note);
instance.setContent(html);
}
}).finally(() => {
instance.enable();
instance.show();
});
}
}, function(instance) {
});
}
let selectedAnnoteEl;
const selectorForAnnotation = ( cell, annotation) => {
let cellAttr = 'data-code-cell="' + cell + '"';
let lineAttr = 'data-code-annotation="' + annotation + '"';
const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
return selector;
}
const selectCodeLines = (annoteEl) => {
const doc = window.document;
const targetCell = annoteEl.getAttribute("data-target-cell");
const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
const lines = annoteSpan.getAttribute("data-code-lines").split(",");
const lineIds = lines.map((line) => {
return targetCell + "-" + line;
})
let top = null;
let height = null;
let parent = null;
if (lineIds.length > 0) {
//compute the position of the single el (top and bottom and make a div)
const el = window.document.getElementById(lineIds[0]);
top = el.offsetTop;
height = el.offsetHeight;
parent = el.parentElement.parentElement;
if (lineIds.length > 1) {
const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
const bottom = lastEl.offsetTop + lastEl.offsetHeight;
height = bottom - top;
}
if (top !== null && height !== null && parent !== null) {
// cook up a div (if necessary) and position it
let div = window.document.getElementById("code-annotation-line-highlight");
if (div === null) {
div = window.document.createElement("div");
div.setAttribute("id", "code-annotation-line-highlight");
div.style.position = 'absolute';
parent.appendChild(div);
}
div.style.top = top - 2 + "px";
div.style.height = height + 4 + "px";
div.style.left = 0;
let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
if (gutterDiv === null) {
gutterDiv = window.document.createElement("div");
gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
gutterDiv.style.position = 'absolute';
const codeCell = window.document.getElementById(targetCell);
const gutter = codeCell.querySelector('.code-annotation-gutter');
gutter.appendChild(gutterDiv);
}
gutterDiv.style.top = top - 2 + "px";
gutterDiv.style.height = height + 4 + "px";
}
selectedAnnoteEl = annoteEl;
}
};
const unselectCodeLines = () => {
const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
elementsIds.forEach((elId) => {
const div = window.document.getElementById(elId);
if (div) {
div.remove();
}
});
selectedAnnoteEl = undefined;
};
// Handle positioning of the toggle
window.addEventListener(
"resize",
throttle(() => {
elRect = undefined;
if (selectedAnnoteEl) {
selectCodeLines(selectedAnnoteEl);
}
}, 10)
);
function throttle(fn, ms) {
let throttle = false;
let timer;
return (...args) => {
if(!throttle) { // first call gets through
fn.apply(this, args);
throttle = true;
} else { // all the others get throttled
if(timer) clearTimeout(timer); // cancel #2
timer = setTimeout(() => {
fn.apply(this, args);
timer = throttle = false;
}, ms);
}
};
}
// Attach click handler to the DT
const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
for (const annoteDlNode of annoteDls) {
annoteDlNode.addEventListener('click', (event) => {
const clickedEl = event.target;
if (clickedEl !== selectedAnnoteEl) {
unselectCodeLines();
const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
if (activeEl) {
activeEl.classList.remove('code-annotation-active');
}
selectCodeLines(clickedEl);
clickedEl.classList.add('code-annotation-active');
} else {
// Unselect the line
unselectCodeLines();
clickedEl.classList.remove('code-annotation-active');
}
});
}
const findCites = (el) => {
const parentEl = el.parentElement;
if (parentEl) {
const cites = parentEl.dataset.cites;
if (cites) {
return {
el,
cites: cites.split(' ')
};
} else {
return findCites(el.parentElement)
}
} else {
return undefined;
}
};
var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
for (var i=0; i<bibliorefs.length; i++) {
const ref = bibliorefs[i];
const citeInfo = findCites(ref);
if (citeInfo) {
tippyHover(citeInfo.el, function() {
var popup = window.document.createElement('div');
citeInfo.cites.forEach(function(cite) {
var citeDiv = window.document.createElement('div');
citeDiv.classList.add('hanging-indent');
citeDiv.classList.add('csl-entry');
var biblioDiv = window.document.getElementById('ref-' + cite);
if (biblioDiv) {
citeDiv.innerHTML = biblioDiv.innerHTML;
}
popup.appendChild(citeDiv);
});
return popup.innerHTML;
});
}
}
});
</script>
<nav class="page-navigation">
<div class="nav-page nav-page-previous">
</div>
<div class="nav-page nav-page-next">
<a href="./00-orientation.html" class="pagination-link" aria-label="[Step 0 — What the tutorial is about]{.en}[Étape 0 — De quoi parle le tutoriel]{.fr}[Schritt 0 — Worum es im Tutorial geht]{.de}">
<span class="nav-page-text"><span class="chapter-number">1</span>&nbsp; <span class="chapter-title">Step 0 — What the tutorial is about</span></span> <i class="bi bi-arrow-right-short"></i>
</a>
</div>
</nav>
</div> <!-- /content -->
<script src="site_libs/quarto-html/zenscroll-min.js"></script>
</body></html>