diff options
author | sternenseemann <sternenseemann@systemli.org> | 2022-02-27 09:39:46 +0100 |
---|---|---|
committer | sterni <sternenseemann@systemli.org> | 2022-02-27 10:39:22 +0100 |
commit | 2ba3f2e4e7dade44df600c666c9b1aee482e3d97 (patch) | |
tree | d34e4ebabf11e2de741ccfc220975377e47039dd | |
parent | 2af2003c66b00ffb6113229f4fdc9fc0ba67e3d7 (diff) |
doc(bahnhofshalle): document JS requirement in FAQ
Since we are cross-referencing an FAQ section, we also make this convenient by adding ids for all headings and highlighting the currently targeted heading with an underline. This ensurse that it's clear which section to read when clicking on a link even when the screen may not jump around on even normal sized screens.
-rw-r--r-- | bahnhofshalle/index.html | 21 | ||||
-rw-r--r-- | bahnhofshalle/style.css | 5 |
2 files changed, 20 insertions, 6 deletions
diff --git a/bahnhofshalle/index.html b/bahnhofshalle/index.html index 0e98544..3b5e85c 100644 --- a/bahnhofshalle/index.html +++ b/bahnhofshalle/index.html @@ -62,7 +62,7 @@ <section id="faq"> <h2>faq</h2> - <h3>What the hell is this?</h3> + <h3 id="faq-about">What the hell is this?</h3> <p> flipdot-gschichtler is a set of network applications which allow @@ -79,7 +79,7 @@ annoy everyone who is present from the comfort of your own home. </p> - <h3>How does it work?</h3> + <h3 id="faq-architecture">How does it work?</h3> <p> This server provides a REST API which manages a queue of strings @@ -96,7 +96,7 @@ script to display the strings from the queue. </p> - <h3>Where's the source code?</h3> + <h3 id="faq-source">Where's the source code?</h3> <p> Hosted on GitHub: <a href="https://github.com/openlab-aux/flipdot-gschichtler"> @@ -104,7 +104,7 @@ </a> </p> - <h3>How do I use the API?</h3> + <h3 id="faq-api-doc">How do I use the API?</h3> <p> Long story short: <code>/api/v2/queue</code> @@ -120,16 +120,25 @@ <a href="https://github.com/openlab-aux/flipdot-gschichtler#api-documentation">API documentation</a>. </p> - <h3>Can I get an API token?</h3> + <h3 id="faq-api-token">Can I get an API token?</h3> <p> Authentication is only necessary to delete queue entries, so chances are you don't need one. If you need one regardless, ask <a href="https://wiki.openlab-augsburg.de/Mensch_sternenseemann"> - sterni + sternenseemann </a>. </p> + + <h3 id="faq-requirements">Why isn't this working for me?</h3> + + <p> + This site uses JavaScript, more specifically + <a href="https://caniuse.com/es6">EcmaScript2015</a>. + If you're browser doesn't support this, you should either upgrade to a + modern one or + <a href="#faq-api-doc">interact with the API directly</a>. </section> </main> </body> diff --git a/bahnhofshalle/style.css b/bahnhofshalle/style.css index e51a830..bbec6b6 100644 --- a/bahnhofshalle/style.css +++ b/bahnhofshalle/style.css @@ -36,6 +36,11 @@ a:visited, a:link { color: #0088aa; /* openlab blue */ } +h3:target { + /* highlight a FAQ heading when selected via a link */ + text-decoration: underline; +} + .table-container { max-width: 100%; overflow: auto; |