docs/site/menu/index.html

205 lines
8.8 KiB
HTML
Raw Normal View History

2024-04-26 18:45:10 +01:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Menu - OwlBoard Documentation</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Menu";
var mkdocs_page_input_path = "menu.md";
var mkdocs_page_url = null;
</script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> OwlBoard Documentation
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="" href="https://owlboard.info">Go to OwlBoard</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Website</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="..">Welcome</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../registering/">Registering for OwlBoard</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../pages/">Pages</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../pis/">PIS</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../timetable/">Timetable Search</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../departures/">Departure Boards</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="#">Menu</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#your-data">Your Data</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#registration">Registration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#settings">Settings</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#help">Help</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#about">About</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#location-reference-code-lookup">Location Reference Code Lookup</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#reason-code-lookup">Reason Code Lookup</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#privacy-policy">Privacy Policy</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#component-versions">Component Versions</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#statistics">Statistics</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../code-lookup/">Code Lookup</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../settings/">Settings</a>
</li>
</ul>
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api-intro/">OwlBoard API</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Components</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../components/">OwlBoard Components</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">OwlBoard Documentation</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item">Website</li>
<li class="breadcrumb-item active">Menu</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="menu">Menu</h1>
<p>The menu is the gateway to additional features.</p>
<p><img alt="Menu" src="../img/menu.png" /></p>
<h2 id="your-data">Your Data</h2>
<p>Your Data shows you the data held about you, captured when you registered.</p>
<p>A very limited amount of data is held about you:</p>
<ul>
<li>Registration Domain (eg. owlboard.info, example-toc.co.uk)</li>
<li>Access Time (the last time you accessed OwlBoard)</li>
<li>UUID (your unique password, stored in your browser)</li>
</ul>
<h2 id="registration">Registration</h2>
<p>See the <a href="../registering/">registration guide</a> for details.</p>
<h2 id="settings">Settings</h2>
<p>See the <a href="../settings/">settings guide</a> for details.</p>
<h2 id="help">Help</h2>
<p>Provides pathways to get help, such as out Facebook group, issue reporting and this help site.</p>
<h2 id="about">About</h2>
<p>Gives some background information about OwlBoard.</p>
<h2 id="location-reference-code-lookup">Location Reference Code Lookup</h2>
<p>See the <a href="../code-lookup/">code lookup guide</a> for details.</p>
<h2 id="reason-code-lookup">Reason Code Lookup</h2>
<p>Provides a way to look up a 'reason code'. A 'reason code' is a three digit code which maps to a reason for a delay or cancellation.</p>
<h2 id="privacy-policy">Privacy Policy</h2>
<p>Links to the OwlBoard privacy policy.</p>
<h2 id="component-versions">Component Versions</h2>
<p>Shows the version of the various pieces of software the provide the OwlBoard service.</p>
<h2 id="statistics">Statistics</h2>
<p>Shows statistics about the OwlBoard service:</p>
<ul>
<li>Last update of Timetable, PIS, Reason and location code data</li>
<li>Request counts (how many times data has been requested)</li>
<li>Database lengths (how many individual items are stored)</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../departures/" class="btn btn-neutral float-left" title="Departure Boards"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../code-lookup/" class="btn btn-neutral float-right" title="Code Lookup">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="../departures/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../code-lookup/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script src="../js/jquery-3.6.0.min.js"></script>
<script>var base_url = "..";</script>
<script src="../js/theme_extra.js"></script>
<script src="../js/theme.js"></script>
<script src="../search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>