This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
footnotes/docs/reports/markers.html

534 lines
28 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 lang="en">
<head>
<meta charset="utf-8">
<title> Documentation &raquo; Markers
</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
<li><a href="namespaces/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
<li><a href="namespaces/footnotes-general.html"><abbr title="\footnotes\general">general</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li><a href="">Home</a></li>
</ul>
<div class="phpdocumentor-row">
<h2 class="phpdocumentor-content__title">Markers</h2>
<h3>Table of Contents</h3>
<table class="phpdocumentor-table_of_contents">
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-config.php">src/includes/class-config.php</a></td>
<td class="phpdocumentor-cell">6</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-convert.php">src/includes/class-convert.php</a></td>
<td class="phpdocumentor-cell">5</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-settings.php">src/includes/class-settings.php</a></td>
<td class="phpdocumentor-cell">7</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-template.php">src/includes/class-template.php</a></td>
<td class="phpdocumentor-cell">7</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/admin/class-wysiwyg.php">src/admin/class-wysiwyg.php</a></td>
<td class="phpdocumentor-cell">2</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/admin/layout/class-engine.php">src/admin/layout/class-engine.php</a></td>
<td class="phpdocumentor-cell">16</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/public/class-parser.php">src/public/class-parser.php</a></td>
<td class="phpdocumentor-cell">8</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/public/widget/class-base.php">src/public/widget/class-base.php</a></td>
<td class="phpdocumentor-cell">1</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/public/widget/class-reference-container.php">src/public/widget/class-reference-container.php</a></td>
<td class="phpdocumentor-cell">1</td>
</tr>
</table>
<a id="src/includes/class-config.php"></a>
<h3><abbr title="src/includes/class-config.php">class-config.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">46</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">56</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">73</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">84</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">95</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">106</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
</tbody>
</table>
<a id="src/includes/class-convert.php"></a>
<h3><abbr title="src/includes/class-convert.php">class-convert.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">60</td>
<td class="phpdocumentor-cell">Replace with built-in char casting.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">92</td>
<td class="phpdocumentor-cell">Replace with built-in string formatting.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">154</td>
<td class="phpdocumentor-cell">Replace with built-in type casting.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">179</td>
<td class="phpdocumentor-cell">Review.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">203</td>
<td class="phpdocumentor-cell">Replace with proper logging/debug functions.</td>
</tr>
</tbody>
</table>
<a id="src/includes/class-settings.php"></a>
<h3><abbr title="src/includes/class-settings.php">class-settings.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1350</td>
<td class="phpdocumentor-cell">Remove?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">48</td>
<td class="phpdocumentor-cell">Refactor to use sane typing.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">202</td>
<td class="phpdocumentor-cell">The mouse-over content truncation should be enabled by default to raise
awareness of the functionality, prevent the screen from being filled on
mouse-over, and allow the use of Continue Reading functionality.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">234</td>
<td class="phpdocumentor-cell">In titles, footnotes are still buggy, because WordPress uses the
title string in menus and in the title element, but Footnotes doesn&#039;t
delete footnotes in them.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">293</td>
<td class="phpdocumentor-cell">Un-deprecate.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1082</td>
<td class="phpdocumentor-cell">Review, remove?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1142</td>
<td class="phpdocumentor-cell">Review. Why are the constants just initialised with these values?
At the very least, we should stop using yes to mean `true` etc.</td>
</tr>
</tbody>
</table>
<a id="src/includes/class-template.php"></a>
<h3><abbr title="src/includes/class-template.php">class-template.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">28</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">85</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">111</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">134</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">146</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">159</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">183</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
</tbody>
</table>
<a id="src/admin/class-wysiwyg.php"></a>
<h3><abbr title="src/admin/class-wysiwyg.php">class-wysiwyg.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">60</td>
<td class="phpdocumentor-cell">Should this be `static`?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">86</td>
<td class="phpdocumentor-cell">Should this be `static`?</td>
</tr>
</tbody>
</table>
<a id="src/admin/layout/class-engine.php"></a>
<h3><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">137</td>
<td class="phpdocumentor-cell">Refactor sections into their own class?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">167</td>
<td class="phpdocumentor-cell">Refactor meta boxes into their own class?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">167</td>
<td class="phpdocumentor-cell">Pass actual functions rather than strings?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">253</td>
<td class="phpdocumentor-cell">Move to {@see}.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">266</td>
<td class="phpdocumentor-cell">Review nonce verification.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">339</td>
<td class="phpdocumentor-cell">Review nonce verification.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">368</td>
<td class="phpdocumentor-cell">Required? Should be `abstract`?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">409</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">424</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">456</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">484</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">506</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">541</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">564</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">564</td>
<td class="phpdocumentor-cell">Use proper colorpicker element.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">588</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
</tbody>
</table>
<a id="src/public/class-parser.php"></a>
<h3><abbr title="src/public/class-parser.php">class-parser.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">267</td>
<td class="phpdocumentor-cell">Reorganise dependencies.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">267</td>
<td class="phpdocumentor-cell">Move call to `register_hooks()` to {@see}.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">287</td>
<td class="phpdocumentor-cell">Move to {@see}.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">380</td>
<td class="phpdocumentor-cell">Refactor to enqueue stylesheets properly in {@see}.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1144</td>
<td class="phpdocumentor-cell">Refactor to parse DOM rather than using RegEx.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">155</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">164</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">173</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
</tbody>
</table>
<a id="src/public/widget/class-base.php"></a>
<h3><abbr title="src/public/widget/class-base.php">class-base.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">29</td>
<td class="phpdocumentor-cell">Review implemenation of Widgets API.</td>
</tr>
</tbody>
</table>
<a id="src/public/widget/class-reference-container.php"></a>
<h3><abbr title="src/public/widget/class-reference-container.php">class-reference-container.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">27</td>
<td class="phpdocumentor-cell">Review implemenation of Widgets API.</td>
</tr>
</tbody>
</table>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="reports/markers.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>