Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
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/packages/footnotes.html

576 lines
37 KiB
HTML
Raw Normal View History

Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</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">
docs: update documentation
2021-08-09 10:27:33 +00:00
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
<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" />
docs: update documentation
2021-08-09 10:27:33 +00:00
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
<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="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">
docs: update documentation
2021-08-09 10:27:33 +00:00
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
docs: update documentation
2021-08-09 10:27:33 +00:00
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
docs: update documentation
2021-05-01 20:39:33 +00:00
<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>
docs: update documentation
2021-04-26 22:06:10 +00:00
</section>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
docs: update documentation
2021-08-09 10:27:33 +00:00
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
docs: update documentation
2021-05-02 20:27:53 +00:00
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
<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">
</ul>
<article class="phpdocumentor-element -package">
docs: update readme and PHPDoc settings (#120) * update readme.txt * Test * Test * docs: update documentation * docs: add package tag * docs: add PHPDoc config, alter Composer script Co-authored-by: Rumperuu <me+footnotes@bengoldsworthy.net>
2021-04-18 19:30:42 +00:00
<h2 class="phpdocumentor-content__title">footnotes</h2>
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
ci: improve release process, clean up and re-org repo, add automated minification (#143) * ci: update scripts * release 2.7.1 * remove tracked stylesheets * docs: revert stable tag to 2.7.0 * chore: move Plugin source into own dir * docs: delete info texts These can now be found in the [project wiki][wiki]. [wiki]: https://github.com/markcheret/footnotes/wiki * docs: tweak contributing guide * ci: reflect new directory structure * chore: update gitignore * chore: reflect new dir structure * docs: update documentation * build(linting): add Husky hooks, Markdown linting, lint all MD files * fix pre-push command * fix pre-push command * build: add stylesheet, JS minification * ci: add linting steps * ci: comment out CSS linting step (that's going to be a whole *thing*) * ci: minify all JS files * ci: call correct JS file * chore: lint * ci: fix PHP linting commands * chore: increment version constant string * ci: concat AMP stylesheets * ci: improve build scripts * chore: add assets dir
2021-04-25 08:28:02 +00:00
<h3 id="packages">
Packages
<a href="#packages" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
ci: rename docs cache
2021-05-01 20:42:10 +00:00
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></dt>
ci: improve release process, clean up and re-org repo, add automated minification (#143) * ci: update scripts * release 2.7.1 * remove tracked stylesheets * docs: revert stable tag to 2.7.0 * chore: move Plugin source into own dir * docs: delete info texts These can now be found in the [project wiki][wiki]. [wiki]: https://github.com/markcheret/footnotes/wiki * docs: tweak contributing guide * ci: reflect new directory structure * chore: update gitignore * chore: reflect new dir structure * docs: update documentation * build(linting): add Husky hooks, Markdown linting, lint all MD files * fix pre-push command * fix pre-push command * build: add stylesheet, JS minification * ci: add linting steps * ci: comment out CSS linting step (that's going to be a whole *thing*) * ci: minify all JS files * ci: call correct JS file * chore: lint * ci: fix PHP linting commands * chore: increment version constant string * ci: concat AMP stylesheets * ci: improve build scripts * chore: add assets dir
2021-04-25 08:28:02 +00:00
</dl>
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
<h3 id="interfaces_class_traits">
Interfaces, Classes and Traits
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
ci: rename docs cache
2021-05-01 20:42:10 +00:00
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-admin-Admin.html"><abbr title="\footnotes\admin\Admin">Admin</abbr></a></dt>
<dd>Class provide all admin-specific functionality of the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-admin-WYSIWYG.html"><abbr title="\footnotes\admin\WYSIWYG">WYSIWYG</abbr></a></dt>
<dd>Class providing WYSIWYG editor intergration for the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-admin-layout-Engine.html"><abbr title="\footnotes\admin\layout\Engine">Engine</abbr></a></dt>
<dd>Class to be extended by page layout sub-classes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-admin-layout-Init.html"><abbr title="\footnotes\admin\layout\Init">Init</abbr></a></dt>
<dd>Class to initialise all defined page layouts.</dd>
docs: update documentation
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-admin-layout-SettingsPage.html"><abbr title="\footnotes\admin\layout\SettingsPage">SettingsPage</abbr></a></dt>
ci: rename docs cache
2021-05-01 20:42:10 +00:00
<dd>Class to initialise all defined page layouts.</dd>
docs: update documentation
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Activator.html"><abbr title="\footnotes\includes\Activator">Activator</abbr></a></dt>
<dd>Class providing action(s) on plugin activation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Config.html"><abbr title="\footnotes\includes\Config">Config</abbr></a></dt>
<dd>Class defining plugin constants.</dd>
docs: update documentation
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Convert.html"><abbr title="\footnotes\includes\Convert">Convert</abbr></a></dt>
<dd>Class providing variable type and value conversion functions.</dd>
docs: update documentation
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Core.html"><abbr title="\footnotes\includes\Core">Core</abbr></a></dt>
<dd>Class providing core plugin functionality.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Deactivator.html"><abbr title="\footnotes\includes\Deactivator">Deactivator</abbr></a></dt>
<dd>Class providing action(s) on plugin deactivation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-i18n.html"><abbr title="\footnotes\includes\i18n">i18n</abbr></a></dt>
<dd>Class providing internationalization functionality.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Loader.html"><abbr title="\footnotes\includes\Loader">Loader</abbr></a></dt>
<dd>Class defining action/filter registration for the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a></dt>
<dd>Class defining configurable plugin settings.</dd>
docs: update documentation
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-Setting.html"><abbr title="\footnotes\includes\settings\Setting">Setting</abbr></a></dt>
<dd>Class defining a configurable plugin setting.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-SettingsGroup.html"><abbr title="\footnotes\includes\settings\SettingsGroup">SettingsGroup</abbr></a></dt>
<dd>Class defining a group of plugin settings within a section.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-SettingsSection.html"><abbr title="\footnotes\includes\settings\SettingsSection">SettingsSection</abbr></a></dt>
<dd>Abstract class defining a section of plugin settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsGroup.html"><abbr title="\footnotes\includes\settings\customcss\CustomCSSSettingsGroup">CustomCSSSettingsGroup</abbr></a></dt>
<dd>Class defining the custom CSS settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.html"><abbr title="\footnotes\includes\settings\customcss\CustomCSSSettingsSection">CustomCSSSettingsSection</abbr></a></dt>
<dd>Class defining plugin referrer and tooltips settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-general-AMPCompatSettingsGroup.html"><abbr title="\footnotes\includes\settings\general\AMPCompatSettingsGroup">AMPCompatSettingsGroup</abbr></a></dt>
<dd>Class defining the AMP compat. settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-general-ExcerptsSettingsGroup.html"><abbr title="\footnotes\includes\settings\general\ExcerptsSettingsGroup">ExcerptsSettingsGroup</abbr></a></dt>
<dd>Class defining the footnote exerpts settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-general-GeneralSettingsSection.html"><abbr title="\footnotes\includes\settings\general\GeneralSettingsSection">GeneralSettingsSection</abbr></a></dt>
<dd>Class defining general plugin settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-general-HardLinksSettingsGroup.html"><abbr title="\footnotes\includes\settings\general\HardLinksSettingsGroup">HardLinksSettingsGroup</abbr></a></dt>
<dd>Class defining the hard links settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-general-LoveSettingsGroup.html"><abbr title="\footnotes\includes\settings\general\LoveSettingsGroup">LoveSettingsGroup</abbr></a></dt>
<dd>Class defining the footnote love settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-general-NumberingSettingsGroup.html"><abbr title="\footnotes\includes\settings\general\NumberingSettingsGroup">NumberingSettingsGroup</abbr></a></dt>
<dd>Class defining the footnote numbering settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html"><abbr title="\footnotes\includes\settings\general\ReferenceContainerSettingsGroup">ReferenceContainerSettingsGroup</abbr></a></dt>
<dd>Class defining the reference container settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-general-ScrollingSettingsGroup.html"><abbr title="\footnotes\includes\settings\general\ScrollingSettingsGroup">ScrollingSettingsGroup</abbr></a></dt>
<dd>Class defining the scrolling settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-general-ShortcodeSettingsGroup.html"><abbr title="\footnotes\includes\settings\general\ShortcodeSettingsGroup">ShortcodeSettingsGroup</abbr></a></dt>
<dd>Class defining the footnote shortcode delimiter settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\BacklinkSymbolSettingsGroup">BacklinkSymbolSettingsGroup</abbr></a></dt>
<dd>Class defining the backlink symbol settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-ReferrersAndTooltipsSettingsSection.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\ReferrersAndTooltipsSettingsSection">ReferrersAndTooltipsSettingsSection</abbr></a></dt>
<dd>Class defining plugin referrer and tooltips settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-ReferrersInLabelsSettingsGroup.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\ReferrersInLabelsSettingsGroup">ReferrersInLabelsSettingsGroup</abbr></a></dt>
<dd>Class defining the referrer in labels settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-ReferrersSettingsGroup.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\ReferrersSettingsGroup">ReferrersSettingsGroup</abbr></a></dt>
<dd>Class defining the referrer settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-TooltipAppearanceSettingsGroup.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\TooltipAppearanceSettingsGroup">TooltipAppearanceSettingsGroup</abbr></a></dt>
<dd>Class defining the tooltip appearance settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-TooltipDimensionsSettingsGroup.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\TooltipDimensionsSettingsGroup">TooltipDimensionsSettingsGroup</abbr></a></dt>
<dd>Class defining the tooltip dimension settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-TooltipPositionSettingsGroup.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\TooltipPositionSettingsGroup">TooltipPositionSettingsGroup</abbr></a></dt>
<dd>Class defining the tooltip position settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-TooltipTextSettingsGroup.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\TooltipTextSettingsGroup">TooltipTextSettingsGroup</abbr></a></dt>
<dd>Class defining the tooltip position settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-TooltipTimingSettingsGroup.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\TooltipTimingSettingsGroup">TooltipTimingSettingsGroup</abbr></a></dt>
<dd>Class defining the tooltip timing settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-TooltipTruncationSettingsGroup.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\TooltipTruncationSettingsGroup">TooltipTruncationSettingsGroup</abbr></a></dt>
<dd>Class defining the tooltip truncation settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-referrersandtooltips-TooltipsSettingsGroup.html"><abbr title="\footnotes\includes\settings\referrersandtooltips\TooltipsSettingsGroup">TooltipsSettingsGroup</abbr></a></dt>
<dd>Class defining the tooltip settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-scopeandpriority-ScopeAndPrioritySettingsSection.html"><abbr title="\footnotes\includes\settings\scopeandpriority\ScopeAndPrioritySettingsSection">ScopeAndPrioritySettingsSection</abbr></a></dt>
<dd>Class defining plugin hook priority settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-settings-scopeandpriority-WordPressHooksSettingsGroup.html"><abbr title="\footnotes\includes\settings\scopeandpriority\WordPressHooksSettingsGroup">WordPressHooksSettingsGroup</abbr></a></dt>
<dd>Class defining the WordPress hook settings.</dd>
docs: update documentation
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-general-General.html"><abbr title="\footnotes\general\General">General</abbr></a></dt>
<dd>Class provide all public-facing functionality of the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-general-Parser.html"><abbr title="\footnotes\general\Parser">Parser</abbr></a></dt>
docs: update documentation
2021-04-27 07:42:43 +00:00
<dd>Searches and replaces the footnotes and generates the reference container.</dd>
docs: update documentation
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-general-Widget-Base.html"><abbr title="\footnotes\general\Widget\Base">Base</abbr></a></dt>
<dd>Base class to be extended by all widget sub-classes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-general-Widget-Reference-Container.html"><abbr title="\footnotes\general\Widget\Reference_Container">Reference_Container</abbr></a></dt>
<dd>Registers a Widget to put the Reference Container to the widget area.</dd>
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
</dl>
docs: update documentation
2021-08-09 10:27:33 +00:00
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="namespaces/default.html#constant_PLUGIN_VERSION">PLUGIN_VERSION</a>
<span>
&nbsp;= &#039;2.8.0d&#039; </span>
</dt>
<dd>The plugin version.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="namespaces/default.html#constant_PRODUCTION_ENV">PRODUCTION_ENV</a>
<span>
&nbsp;= false </span>
</dt>
<dd>The environment that the plugin is configured for.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a href="namespaces/footnotes.html#function_activate_footnotes">activate_footnotes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Handles the activation of the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a href="namespaces/footnotes.html#function_deactivate_footnotes">deactivate_footnotes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Handles the deactivation of the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a href="namespaces/footnotes.html#function_run_footnotes">run_footnotes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Begins execution of the plugin.</dd>
</dl>
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
docs: update readme and PHPDoc settings (#120) * update readme.txt * Test * Test * docs: update documentation * docs: add package tag * docs: add PHPDoc config, alter Composer script Co-authored-by: Rumperuu <me+footnotes@bengoldsworthy.net>
2021-04-18 19:30:42 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="packages/footnotes.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_PLUGIN_VERSION">
PLUGIN_VERSION
<a href="namespaces/default.html#constant_PLUGIN_VERSION" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<p class="phpdocumentor-summary">The plugin version.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">PLUGIN_VERSION</span>
= <span class="phpdocumentor-signature__default-value">&#039;2.8.0d&#039;</span>
</code>
ci: improve release process, clean up and re-org repo, add automated minification (#143) * ci: update scripts * release 2.7.1 * remove tracked stylesheets * docs: revert stable tag to 2.7.0 * chore: move Plugin source into own dir * docs: delete info texts These can now be found in the [project wiki][wiki]. [wiki]: https://github.com/markcheret/footnotes/wiki * docs: tweak contributing guide * ci: reflect new directory structure * chore: update gitignore * chore: reflect new dir structure * docs: update documentation * build(linting): add Husky hooks, Markdown linting, lint all MD files * fix pre-push command * fix pre-push command * build: add stylesheet, JS minification * ci: add linting steps * ci: comment out CSS linting step (that's going to be a whole *thing*) * ci: minify all JS files * ci: call correct JS file * chore: lint * ci: fix PHP linting commands * chore: increment version constant string * ci: concat AMP stylesheets * ci: improve build scripts * chore: add assets dir
2021-04-25 08:28:02 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/markcheret/footnotes/wiki/Versioning"> <p>Versioning Guide</p>
</a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.1.4</span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Draw from envfile rather than hard-coding.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">global</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>string PLUGIN_VERSION The version of this instance of the plugin.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_PRODUCTION_ENV">
PRODUCTION_ENV
<a href="namespaces/default.html#constant_PRODUCTION_ENV" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">The environment that the plugin is configured for.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">PRODUCTION_ENV</span>
= <span class="phpdocumentor-signature__default-value">false</span>
</code>
<section class="phpdocumentor-description"><p>This primarily affects whether minified or unminified CSS/JS files are
requested.</p>
</section>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.5.5</span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Draw from envfile rather than hard-coding.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Replace with string for &gt;2 environment options.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">global</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>bool PRODUCTION_ENV Whether the plugin is running in production mode or not.</p>
</section>
</dd>
</dl>
</article>
</section>
<section class="phpdocumentor-functions">
<h3 class="phpdocumentor-elements__header" id="functions">
Functions
<a href="packages/footnotes.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_activate_footnotes">
activate_footnotes()
<a href="namespaces/footnotes.html#function_activate_footnotes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">Handles the activation of the plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">activate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Activator.html#method_activate"><abbr title="\footnotes\includes\Activator::activate()">Activator::activate()</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_deactivate_footnotes">
deactivate_footnotes()
<a href="namespaces/footnotes.html#function_deactivate_footnotes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Handles the deactivation of the plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">deactivate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Deactivator.html#method_deactivate"><abbr title="\footnotes\includes\Deactivator::deactivate()">Deactivator::deactivate()</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run_footnotes">
run_footnotes()
<a href="namespaces/footnotes.html#function_run_footnotes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
<p class="phpdocumentor-summary">Begins execution of the plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Since everything within the plugin is registered via hooks, then kicking off
the plugin from this point in the file does not affect the page life cycle.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
docs: update documentation
2021-05-02 20:27:53 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
</article>
</section>
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
</article>
<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>
docs: update readme and PHPDoc settings (#120) * update readme.txt * Test * Test * docs: update documentation * docs: add package tag * docs: add PHPDoc config, alter Composer script Co-authored-by: Rumperuu <me+footnotes@bengoldsworthy.net>
2021-04-18 19:30:42 +00:00
<a href="packages/footnotes.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
</main>
<script>
cssVars({});
</script>
docs: update documentation
2021-08-09 10:27:33 +00:00
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
Generate HTML documentation using phpDocumentor
2021-02-20 19:55:52 +00:00
</body>
</html>
Reference in a new issue Copy permalink