diff --git a/docs/indices/files.html b/docs/indices/files.html index fbe1ea6..461f859 100644 --- a/docs/indices/files.html +++ b/docs/indices/files.html @@ -92,8 +92,8 @@
  • class-loader.php
  • class-parser.php
  • class-reference-container.php
  • -
  • class-settings.php
  • class-settings.php
  • +
  • class-settings.php
  • class-template.php
  • class-wysiwyg.php
  • diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index 0553a74..883310d 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -1,6 +1,421 @@ Search.appendIndex( [ { + "fqsen": "\\footnotes\\admin\\Admin", + "name": "Admin", + "summary": "Class\u0020provide\u0020all\u0020admin\u002Dspecific\u0020functionality\u0020of\u0020the\u0020plugin.", + "url": "classes/footnotes-admin-Admin.html" + }, { + "fqsen": "\\footnotes\\admin\\Admin\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", + "url": "classes/footnotes-admin-Admin.html#method___construct" + }, { + "fqsen": "\\footnotes\\admin\\Admin\u003A\u003Aload_dependencies\u0028\u0029", + "name": "load_dependencies", + "summary": "Load\u0020the\u0020required\u0020admin\u002Dspecific\u0020dependencies.", + "url": "classes/footnotes-admin-Admin.html#method_load_dependencies" + }, { + "fqsen": "\\footnotes\\admin\\Admin\u003A\u003Aenqueue_styles\u0028\u0029", + "name": "enqueue_styles", + "summary": "Register\u0020the\u0020stylesheets\u0020for\u0020the\u0020admin\u0020area.", + "url": "classes/footnotes-admin-Admin.html#method_enqueue_styles" + }, { + "fqsen": "\\footnotes\\admin\\Admin\u003A\u003Aenqueue_scripts\u0028\u0029", + "name": "enqueue_scripts", + "summary": "Register\u0020the\u0020JavaScript\u0020for\u0020the\u0020admin\u0020area.", + "url": "classes/footnotes-admin-Admin.html#method_enqueue_scripts" + }, { + "fqsen": "\\footnotes\\admin\\Admin\u003A\u003Aaction_links\u0028\u0029", + "name": "action_links", + "summary": "Appends\u0020the\u0020Plugin\u0020links\u0020for\u0020display\u0020in\u0020the\u0020dashboard\u0020Plugins\u0020page.", + "url": "classes/footnotes-admin-Admin.html#method_action_links" + }, { + "fqsen": "\\footnotes\\admin\\Admin\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", + "url": "classes/footnotes-admin-Admin.html#property_plugin_name" + }, { + "fqsen": "\\footnotes\\admin\\Admin\u003A\u003A\u0024version", + "name": "version", + "summary": "The\u0020version\u0020of\u0020this\u0020plugin.", + "url": "classes/footnotes-admin-Admin.html#property_version" + }, { + "fqsen": "\\footnotes\\admin\\Admin\u003A\u003A\u0024wysiwyg", + "name": "wysiwyg", + "summary": "The\u0020WYSIWYG\u0020editor\u0020integration\u0020object.", + "url": "classes/footnotes-admin-Admin.html#property_wysiwyg" + }, { + "fqsen": "\\footnotes\\admin\\WYSIWYG", + "name": "WYSIWYG", + "summary": "Class\u0020providing\u0020WYSIWYG\u0020editor\u0020intergration\u0020for\u0020the\u0020plugin.", + "url": "classes/footnotes-admin-WYSIWYG.html" + }, { + "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", + "url": "classes/footnotes-admin-WYSIWYG.html#method___construct" + }, { + "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003Anew_visual_editor_button\u0028\u0029", + "name": "new_visual_editor_button", + "summary": "Append\u0020a\u0020new\u0020Button\u0020to\u0020the\u0020WYSIWYG\u0020editor\u0020of\u0020Posts\u0020and\u0020Pages.", + "url": "classes/footnotes-admin-WYSIWYG.html#method_new_visual_editor_button" + }, { + "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003Anew_plain_text_editor_button\u0028\u0029", + "name": "new_plain_text_editor_button", + "summary": "Add\u0020a\u0020new\u0020button\u0020to\u0020the\u0020plain\u0020text\u0020editor.", + "url": "classes/footnotes-admin-WYSIWYG.html#method_new_plain_text_editor_button" + }, { + "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003Ainclude_scripts\u0028\u0029", + "name": "include_scripts", + "summary": "Includes\u0020the\u0020Plugins\u0020WYSIWYG\u0020editor\u0020script.", + "url": "classes/footnotes-admin-WYSIWYG.html#method_include_scripts" + }, { + "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003Aajax_callback\u0028\u0029", + "name": "ajax_callback", + "summary": "AJAX\u0020Callback\u0020function\u0020when\u0020the\u0020Footnotes\u0020Button\u0020is\u0020clicked.\u0020Either\u0020in\u0020the\u0020Plain\u0020text\u0020or\u0020Visual\u0020editor.", + "url": "classes/footnotes-admin-WYSIWYG.html#method_ajax_callback" + }, { + "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", + "url": "classes/footnotes-admin-WYSIWYG.html#property_plugin_name" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine", + "name": "Engine", + "summary": "Class\u0020to\u0020be\u0020extended\u0020by\u0020page\u0020layout\u0020sub\u002Dclasses.", + "url": "classes/footnotes-admin-layout-Engine.html" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aget_priority\u0028\u0029", + "name": "get_priority", + "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020priority.", + "url": "classes/footnotes-admin-layout-Engine.html#method_get_priority" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aget_sub_page_slug\u0028\u0029", + "name": "get_sub_page_slug", + "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020child\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Engine.html#method_get_sub_page_slug" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aget_sub_page_title\u0028\u0029", + "name": "get_sub_page_title", + "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020child\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Engine.html#method_get_sub_page_title" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aget_sections\u0028\u0029", + "name": "get_sections", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020a\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Engine.html#method_get_sections" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aget_meta_boxes\u0028\u0029", + "name": "get_meta_boxes", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes.", + "url": "classes/footnotes-admin-layout-Engine.html#method_get_meta_boxes" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_section\u0028\u0029", + "name": "add_section", + "summary": "Returns\u0020an\u0020array\u0020describing\u0020a\u0020sub\u002Dpage\u0020section.", + "url": "classes/footnotes-admin-layout-Engine.html#method_add_section" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_meta_box\u0028\u0029", + "name": "add_meta_box", + "summary": "Returns\u0020an\u0020array\u0020describing\u0020a\u0020meta\u0020box.", + "url": "classes/footnotes-admin-layout-Engine.html#method_add_meta_box" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aregister_sub_page\u0028\u0029", + "name": "register_sub_page", + "summary": "Registers\u0020a\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Engine.html#method_register_sub_page" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aregister_sections\u0028\u0029", + "name": "register_sections", + "summary": "Registers\u0020all\u0020sections\u0020for\u0020a\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Engine.html#method_register_sections" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aregister_meta_boxes\u0028\u0029", + "name": "register_meta_boxes", + "summary": "Registers\u0020all\u0020Meta\u0020boxes\u0020for\u0020a\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Engine.html#method_register_meta_boxes" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aappend_scripts\u0028\u0029", + "name": "append_scripts", + "summary": "Append\u0020JavaScript\u0020and\u0020CSS\u0020files\u0020for\u0020specific\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Engine.html#method_append_scripts" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Adisplay_content\u0028\u0029", + "name": "display_content", + "summary": "Displays\u0020the\u0020content\u0020of\u0020specific\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Engine.html#method_display_content" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Asave_settings\u0028\u0029", + "name": "save_settings", + "summary": "Save\u0020all\u0020plugin\u0020settings.", + "url": "classes/footnotes-admin-layout-Engine.html#method_save_settings" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Adescription\u0028\u0029", + "name": "description", + "summary": "Output\u0020the\u0020description\u0020of\u0020a\u0020section.\u0020May\u0020be\u0020overwritten\u0020in\u0020any\u0020section.", + "url": "classes/footnotes-admin-layout-Engine.html#method_description" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aload_setting\u0028\u0029", + "name": "load_setting", + "summary": "Loads\u0020a\u0020specified\u0020setting.", + "url": "classes/footnotes-admin-layout-Engine.html#method_load_setting" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_text\u0028\u0029", + "name": "add_text", + "summary": "Returns\u0020a\u0020simple\u0020text\u0020inside\u0020HTML\u0020\u0060\u003Cspan\u003E\u0060\u0020element.", + "url": "classes/footnotes-admin-layout-Engine.html#method_add_text" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_label\u0028\u0029", + "name": "add_label", + "summary": "Returns\u0020the\u0020HTML\u0020tag\u0020for\u0020an\u0020\u0060\u003Cinput\u003E\u0060\/\u0060\u003Cselect\u003E\u0060\u0020label.", + "url": "classes/footnotes-admin-layout-Engine.html#method_add_label" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_text_box\u0028\u0029", + "name": "add_text_box", + "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020a\u0020text\u0020\u0060\u003Cinput\u003E\u0060\u0020element.", + "url": "classes/footnotes-admin-layout-Engine.html#method_add_text_box" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_checkbox\u0028\u0029", + "name": "add_checkbox", + "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020a\u0020checkbox\u0020\u0060\u003Cinput\u003E\u0060\u0020element.", + "url": "classes/footnotes-admin-layout-Engine.html#method_add_checkbox" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_select_box\u0028\u0029", + "name": "add_select_box", + "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020a\u0020\u0060\u003Cselect\u003E\u0060\u0020element.", + "url": "classes/footnotes-admin-layout-Engine.html#method_add_select_box" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_textarea\u0028\u0029", + "name": "add_textarea", + "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020a\u0020\u0060\u003Ctextarea\u003E\u0060\u0020element.", + "url": "classes/footnotes-admin-layout-Engine.html#method_add_textarea" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_color_selection\u0028\u0029", + "name": "add_color_selection", + "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020a\u0020text\u0020\u0060\u003Cinput\u003E\u0060\u0020element\u0020with\u0020the\u0020colour\u0020selection\nclass.", + "url": "classes/footnotes-admin-layout-Engine.html#method_add_color_selection" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_num_box\u0028\u0029", + "name": "add_num_box", + "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020numeric\u0020\u0060\u003Cinput\u003E\u0060\u0020element.", + "url": "classes/footnotes-admin-layout-Engine.html#method_add_num_box" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", + "url": "classes/footnotes-admin-layout-Engine.html#property_plugin_name" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003A\u0024a_str_sub_page_hook", + "name": "a_str_sub_page_hook", + "summary": "Stores\u0020the\u0020Hook\u0020connection\u0020string\u0020for\u0020the\u0020child\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Engine.html#property_a_str_sub_page_hook" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003A\u0024a_arr_sections", + "name": "a_arr_sections", + "summary": "Stores\u0020all\u0020Sections\u0020for\u0020the\u0020child\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Engine.html#property_a_arr_sections" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Init", + "name": "Init", + "summary": "Class\u0020to\u0020initialise\u0020all\u0020defined\u0020page\u0020layouts.", + "url": "classes/footnotes-admin-layout-Init.html" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initializes\u0020all\u0020WordPress\u0020hooks\u0020for\u0020the\u0020Plugin\u0020Settings.", + "url": "classes/footnotes-admin-layout-Init.html#method___construct" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003Aload_dependencies\u0028\u0029", + "name": "load_dependencies", + "summary": "Load\u0020the\u0020required\u0020dependencies\u0020for\u0020the\u0020layouts\u0020pages.", + "url": "classes/footnotes-admin-layout-Init.html#method_load_dependencies" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003Ainitialize_settings\u0028\u0029", + "name": "initialize_settings", + "summary": "Registers\u0020the\u0020settings\u0020and\u0020initialises\u0020the\u0020settings\u0020page.", + "url": "classes/footnotes-admin-layout-Init.html#method_initialize_settings" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003Aregister_options_submenu\u0028\u0029", + "name": "register_options_submenu", + "summary": "Registers\u0020the\u0020footnotes\u0020submenu\u0020page.", + "url": "classes/footnotes-admin-layout-Init.html#method_register_options_submenu" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003Aget_plugin_meta_information\u0028\u0029", + "name": "get_plugin_meta_information", + "summary": "AJAX\u0020call.\u0020returns\u0020a\u0020JSON\u0020string\u0020containing\u0020meta\u0020information\u0020about\u0020a\u0020specific\u0020WordPress\u0020Plugin.", + "url": "classes/footnotes-admin-layout-Init.html#method_get_plugin_meta_information" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003AC_STR_MAIN_MENU_SLUG", + "name": "C_STR_MAIN_MENU_SLUG", + "summary": "Slug\u0020for\u0020the\u0020Plugin\u0020main\u0020menu.", + "url": "classes/footnotes-admin-layout-Init.html#constant_C_STR_MAIN_MENU_SLUG" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", + "url": "classes/footnotes-admin-layout-Init.html#property_plugin_name" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003A\u0024settings_page", + "name": "settings_page", + "summary": "Contains\u0020the\u0020settings\u0020page.", + "url": "classes/footnotes-admin-layout-Init.html#property_settings_page" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings", + "name": "Settings", + "summary": "Class\u0020to\u0020initialise\u0020all\u0020defined\u0020page\u0020layouts.", + "url": "classes/footnotes-admin-layout-Settings.html" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", + "url": "classes/footnotes-admin-layout-Settings.html#method___construct" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aget_priority\u0028\u0029", + "name": "get_priority", + "summary": "Returns\u0020a\u0020priority\u0020index.", + "url": "classes/footnotes-admin-layout-Settings.html#method_get_priority" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aget_sub_page_slug\u0028\u0029", + "name": "get_sub_page_slug", + "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Settings.html#method_get_sub_page_slug" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aget_sub_page_title\u0028\u0029", + "name": "get_sub_page_title", + "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Settings.html#method_get_sub_page_title" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aget_sections\u0028\u0029", + "name": "get_sections", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020the\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Settings.html#method_get_sections" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aget_meta_boxes\u0028\u0029", + "name": "get_meta_boxes", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes\u0020for\u0020each\u0020section\u0020of\u0020the\u0020sub\u002Dpage.", + "url": "classes/footnotes-admin-layout-Settings.html#method_get_meta_boxes" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aamp_compat\u0028\u0029", + "name": "amp_compat", + "summary": "Displays\u0020the\u0020AMP\u0020compatibility\u0020mode\u0020option.", + "url": "classes/footnotes-admin-layout-Settings.html#method_amp_compat" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Areference_container\u0028\u0029", + "name": "reference_container", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020reference\u0020container.", + "url": "classes/footnotes-admin-layout-Settings.html#method_reference_container" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Astart_end\u0028\u0029", + "name": "start_end", + "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020start\u0020and\u0020end\u0020tag\u0020short\u0020codes.", + "url": "classes/footnotes-admin-layout-Settings.html#method_start_end" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Anumbering\u0028\u0029", + "name": "numbering", + "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020numbering.", + "url": "classes/footnotes-admin-layout-Settings.html#method_numbering" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Ascrolling\u0028\u0029", + "name": "scrolling", + "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020scrolling\u0020behavior.", + "url": "classes/footnotes-admin-layout-Settings.html#method_scrolling" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Ahard_links\u0028\u0029", + "name": "hard_links", + "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020fragment\u0020identifier\u0020configuration.", + "url": "classes/footnotes-admin-layout-Settings.html#method_hard_links" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Alove\u0028\u0029", + "name": "love", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020\u2018I\u0020love\u0020Footnotes\u2019\u0020note.", + "url": "classes/footnotes-admin-layout-Settings.html#method_love" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aexcerpts\u0028\u0029", + "name": "excerpts", + "summary": "Displays\u0020the\u0020footnotes\u0020in\u0020excerpt\u0020setting.", + "url": "classes/footnotes-admin-layout-Settings.html#method_excerpts" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Asuperscript\u0028\u0029", + "name": "superscript", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020footnote\u0020referrers.", + "url": "classes/footnotes-admin-layout-Settings.html#method_superscript" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Alabel_solution\u0028\u0029", + "name": "label_solution", + "summary": "Displays\u0020the\u0020setting\u0020for\u0020the\u0020input\u0020label\u0020issue\u0020solution.", + "url": "classes/footnotes-admin-layout-Settings.html#method_label_solution" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box\u0028\u0029", + "name": "mouseover_box", + "summary": "Displays\u0020enabled\u0020status\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_position\u0028\u0029", + "name": "mouseover_box_position", + "summary": "Displays\u0020position\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_position" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_dimensions\u0028\u0029", + "name": "mouseover_box_dimensions", + "summary": "Displays\u0020dimensions\u0020setting\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_dimensions" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_timing\u0028\u0029", + "name": "mouseover_box_timing", + "summary": "Displays\u0020timing\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_timing" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_truncation\u0028\u0029", + "name": "mouseover_box_truncation", + "summary": "Displays\u0020truncation\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_truncation" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_text\u0028\u0029", + "name": "mouseover_box_text", + "summary": "Displays\u0020dedicated\u0020tooltip\u0020text\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_text" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_appearance\u0028\u0029", + "name": "mouseover_box_appearance", + "summary": "Displays\u0020style\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_appearance" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Ahyperlink_arrow\u0028\u0029", + "name": "hyperlink_arrow", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020backlink\u0020symbol.", + "url": "classes/footnotes-admin-layout-Settings.html#method_hyperlink_arrow" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Acustom_css\u0028\u0029", + "name": "custom_css", + "summary": "Displays\u0020the\u0020Custom\u0020CSS\u0020box.", + "url": "classes/footnotes-admin-layout-Settings.html#method_custom_css" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Acustom_css_migration\u0028\u0029", + "name": "custom_css_migration", + "summary": "Displays\u0020transitional\u0020legacy\u0020Custom\u0020CSS\u0020box.", + "url": "classes/footnotes-admin-layout-Settings.html#method_custom_css_migration" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Acustom_css_new\u0028\u0029", + "name": "custom_css_new", + "summary": "Displays\u0020the\u0020new\u0020Custom\u0020CSS\u0020box.", + "url": "classes/footnotes-admin-layout-Settings.html#method_custom_css_new" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Alookup_hooks\u0028\u0029", + "name": "lookup_hooks", + "summary": "Displays\u0020available\u0020Hooks\u0020to\u0020look\u0020for\u0020Footnote\u0020short\u0020codes.", + "url": "classes/footnotes-admin-layout-Settings.html#method_lookup_hooks" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003AHelp\u0028\u0029", + "name": "Help", + "summary": "Displays\u0020a\u0020short\u0020introduction\u0020to\u0020the\u0020plugin.", + "url": "classes/footnotes-admin-layout-Settings.html#method_Help" + }, { + "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Adonate\u0028\u0029", + "name": "donate", + "summary": "Displays\u0020all\u0020Donate\u0020button\u0020to\u0020support\u0020the\u0020developers.", + "url": "classes/footnotes-admin-layout-Settings.html#method_donate" + }, { "fqsen": "\\footnotes\\activate_footnotes\u0028\u0029", "name": "activate_footnotes", "summary": "Handles\u0020the\u0020activation\u0020of\u0020the\u0020plugin.", @@ -870,421 +1285,6 @@ Search.appendIndex( "name": "plugin_directory", "summary": "Plugin\u0020Directory", "url": "classes/footnotes-includes-Template.html#property_plugin_directory" - }, { - "fqsen": "\\footnotes\\admin\\Admin", - "name": "Admin", - "summary": "Class\u0020provide\u0020all\u0020admin\u002Dspecific\u0020functionality\u0020of\u0020the\u0020plugin.", - "url": "classes/footnotes-admin-Admin.html" - }, { - "fqsen": "\\footnotes\\admin\\Admin\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", - "url": "classes/footnotes-admin-Admin.html#method___construct" - }, { - "fqsen": "\\footnotes\\admin\\Admin\u003A\u003Aload_dependencies\u0028\u0029", - "name": "load_dependencies", - "summary": "Load\u0020the\u0020required\u0020admin\u002Dspecific\u0020dependencies.", - "url": "classes/footnotes-admin-Admin.html#method_load_dependencies" - }, { - "fqsen": "\\footnotes\\admin\\Admin\u003A\u003Aenqueue_styles\u0028\u0029", - "name": "enqueue_styles", - "summary": "Register\u0020the\u0020stylesheets\u0020for\u0020the\u0020admin\u0020area.", - "url": "classes/footnotes-admin-Admin.html#method_enqueue_styles" - }, { - "fqsen": "\\footnotes\\admin\\Admin\u003A\u003Aenqueue_scripts\u0028\u0029", - "name": "enqueue_scripts", - "summary": "Register\u0020the\u0020JavaScript\u0020for\u0020the\u0020admin\u0020area.", - "url": "classes/footnotes-admin-Admin.html#method_enqueue_scripts" - }, { - "fqsen": "\\footnotes\\admin\\Admin\u003A\u003Aaction_links\u0028\u0029", - "name": "action_links", - "summary": "Appends\u0020the\u0020Plugin\u0020links\u0020for\u0020display\u0020in\u0020the\u0020dashboard\u0020Plugins\u0020page.", - "url": "classes/footnotes-admin-Admin.html#method_action_links" - }, { - "fqsen": "\\footnotes\\admin\\Admin\u003A\u003A\u0024plugin_name", - "name": "plugin_name", - "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", - "url": "classes/footnotes-admin-Admin.html#property_plugin_name" - }, { - "fqsen": "\\footnotes\\admin\\Admin\u003A\u003A\u0024version", - "name": "version", - "summary": "The\u0020version\u0020of\u0020this\u0020plugin.", - "url": "classes/footnotes-admin-Admin.html#property_version" - }, { - "fqsen": "\\footnotes\\admin\\Admin\u003A\u003A\u0024wysiwyg", - "name": "wysiwyg", - "summary": "The\u0020WYSIWYG\u0020editor\u0020integration\u0020object.", - "url": "classes/footnotes-admin-Admin.html#property_wysiwyg" - }, { - "fqsen": "\\footnotes\\admin\\WYSIWYG", - "name": "WYSIWYG", - "summary": "Class\u0020providing\u0020WYSIWYG\u0020editor\u0020intergration\u0020for\u0020the\u0020plugin.", - "url": "classes/footnotes-admin-WYSIWYG.html" - }, { - "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", - "url": "classes/footnotes-admin-WYSIWYG.html#method___construct" - }, { - "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003Anew_visual_editor_button\u0028\u0029", - "name": "new_visual_editor_button", - "summary": "Append\u0020a\u0020new\u0020Button\u0020to\u0020the\u0020WYSIWYG\u0020editor\u0020of\u0020Posts\u0020and\u0020Pages.", - "url": "classes/footnotes-admin-WYSIWYG.html#method_new_visual_editor_button" - }, { - "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003Anew_plain_text_editor_button\u0028\u0029", - "name": "new_plain_text_editor_button", - "summary": "Add\u0020a\u0020new\u0020button\u0020to\u0020the\u0020plain\u0020text\u0020editor.", - "url": "classes/footnotes-admin-WYSIWYG.html#method_new_plain_text_editor_button" - }, { - "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003Ainclude_scripts\u0028\u0029", - "name": "include_scripts", - "summary": "Includes\u0020the\u0020Plugins\u0020WYSIWYG\u0020editor\u0020script.", - "url": "classes/footnotes-admin-WYSIWYG.html#method_include_scripts" - }, { - "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003Aajax_callback\u0028\u0029", - "name": "ajax_callback", - "summary": "AJAX\u0020Callback\u0020function\u0020when\u0020the\u0020Footnotes\u0020Button\u0020is\u0020clicked.\u0020Either\u0020in\u0020the\u0020Plain\u0020text\u0020or\u0020Visual\u0020editor.", - "url": "classes/footnotes-admin-WYSIWYG.html#method_ajax_callback" - }, { - "fqsen": "\\footnotes\\admin\\WYSIWYG\u003A\u003A\u0024plugin_name", - "name": "plugin_name", - "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", - "url": "classes/footnotes-admin-WYSIWYG.html#property_plugin_name" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine", - "name": "Engine", - "summary": "Class\u0020to\u0020be\u0020extended\u0020by\u0020page\u0020layout\u0020sub\u002Dclasses.", - "url": "classes/footnotes-admin-layout-Engine.html" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aget_priority\u0028\u0029", - "name": "get_priority", - "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020priority.", - "url": "classes/footnotes-admin-layout-Engine.html#method_get_priority" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aget_sub_page_slug\u0028\u0029", - "name": "get_sub_page_slug", - "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020child\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Engine.html#method_get_sub_page_slug" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aget_sub_page_title\u0028\u0029", - "name": "get_sub_page_title", - "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020child\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Engine.html#method_get_sub_page_title" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aget_sections\u0028\u0029", - "name": "get_sections", - "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020a\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Engine.html#method_get_sections" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aget_meta_boxes\u0028\u0029", - "name": "get_meta_boxes", - "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes.", - "url": "classes/footnotes-admin-layout-Engine.html#method_get_meta_boxes" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_section\u0028\u0029", - "name": "add_section", - "summary": "Returns\u0020an\u0020array\u0020describing\u0020a\u0020sub\u002Dpage\u0020section.", - "url": "classes/footnotes-admin-layout-Engine.html#method_add_section" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_meta_box\u0028\u0029", - "name": "add_meta_box", - "summary": "Returns\u0020an\u0020array\u0020describing\u0020a\u0020meta\u0020box.", - "url": "classes/footnotes-admin-layout-Engine.html#method_add_meta_box" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aregister_sub_page\u0028\u0029", - "name": "register_sub_page", - "summary": "Registers\u0020a\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Engine.html#method_register_sub_page" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aregister_sections\u0028\u0029", - "name": "register_sections", - "summary": "Registers\u0020all\u0020sections\u0020for\u0020a\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Engine.html#method_register_sections" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aregister_meta_boxes\u0028\u0029", - "name": "register_meta_boxes", - "summary": "Registers\u0020all\u0020Meta\u0020boxes\u0020for\u0020a\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Engine.html#method_register_meta_boxes" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aappend_scripts\u0028\u0029", - "name": "append_scripts", - "summary": "Append\u0020JavaScript\u0020and\u0020CSS\u0020files\u0020for\u0020specific\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Engine.html#method_append_scripts" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Adisplay_content\u0028\u0029", - "name": "display_content", - "summary": "Displays\u0020the\u0020content\u0020of\u0020specific\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Engine.html#method_display_content" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Asave_settings\u0028\u0029", - "name": "save_settings", - "summary": "Save\u0020all\u0020plugin\u0020settings.", - "url": "classes/footnotes-admin-layout-Engine.html#method_save_settings" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Adescription\u0028\u0029", - "name": "description", - "summary": "Output\u0020the\u0020description\u0020of\u0020a\u0020section.\u0020May\u0020be\u0020overwritten\u0020in\u0020any\u0020section.", - "url": "classes/footnotes-admin-layout-Engine.html#method_description" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aload_setting\u0028\u0029", - "name": "load_setting", - "summary": "Loads\u0020a\u0020specified\u0020setting.", - "url": "classes/footnotes-admin-layout-Engine.html#method_load_setting" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_text\u0028\u0029", - "name": "add_text", - "summary": "Returns\u0020a\u0020simple\u0020text\u0020inside\u0020HTML\u0020\u0060\u003Cspan\u003E\u0060\u0020element.", - "url": "classes/footnotes-admin-layout-Engine.html#method_add_text" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_label\u0028\u0029", - "name": "add_label", - "summary": "Returns\u0020the\u0020HTML\u0020tag\u0020for\u0020an\u0020\u0060\u003Cinput\u003E\u0060\/\u0060\u003Cselect\u003E\u0060\u0020label.", - "url": "classes/footnotes-admin-layout-Engine.html#method_add_label" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_text_box\u0028\u0029", - "name": "add_text_box", - "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020a\u0020text\u0020\u0060\u003Cinput\u003E\u0060\u0020element.", - "url": "classes/footnotes-admin-layout-Engine.html#method_add_text_box" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_checkbox\u0028\u0029", - "name": "add_checkbox", - "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020a\u0020checkbox\u0020\u0060\u003Cinput\u003E\u0060\u0020element.", - "url": "classes/footnotes-admin-layout-Engine.html#method_add_checkbox" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_select_box\u0028\u0029", - "name": "add_select_box", - "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020a\u0020\u0060\u003Cselect\u003E\u0060\u0020element.", - "url": "classes/footnotes-admin-layout-Engine.html#method_add_select_box" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_textarea\u0028\u0029", - "name": "add_textarea", - "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020a\u0020\u0060\u003Ctextarea\u003E\u0060\u0020element.", - "url": "classes/footnotes-admin-layout-Engine.html#method_add_textarea" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_color_selection\u0028\u0029", - "name": "add_color_selection", - "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020a\u0020text\u0020\u0060\u003Cinput\u003E\u0060\u0020element\u0020with\u0020the\u0020colour\u0020selection\nclass.", - "url": "classes/footnotes-admin-layout-Engine.html#method_add_color_selection" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003Aadd_num_box\u0028\u0029", - "name": "add_num_box", - "summary": "Constructs\u0020the\u0020HTML\u0020for\u0020numeric\u0020\u0060\u003Cinput\u003E\u0060\u0020element.", - "url": "classes/footnotes-admin-layout-Engine.html#method_add_num_box" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003A\u0024plugin_name", - "name": "plugin_name", - "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", - "url": "classes/footnotes-admin-layout-Engine.html#property_plugin_name" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003A\u0024a_str_sub_page_hook", - "name": "a_str_sub_page_hook", - "summary": "Stores\u0020the\u0020Hook\u0020connection\u0020string\u0020for\u0020the\u0020child\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Engine.html#property_a_str_sub_page_hook" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Engine\u003A\u003A\u0024a_arr_sections", - "name": "a_arr_sections", - "summary": "Stores\u0020all\u0020Sections\u0020for\u0020the\u0020child\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Engine.html#property_a_arr_sections" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Init", - "name": "Init", - "summary": "Class\u0020to\u0020initialise\u0020all\u0020defined\u0020page\u0020layouts.", - "url": "classes/footnotes-admin-layout-Init.html" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "Initializes\u0020all\u0020WordPress\u0020hooks\u0020for\u0020the\u0020Plugin\u0020Settings.", - "url": "classes/footnotes-admin-layout-Init.html#method___construct" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003Aload_dependencies\u0028\u0029", - "name": "load_dependencies", - "summary": "Load\u0020the\u0020required\u0020dependencies\u0020for\u0020the\u0020layouts\u0020pages.", - "url": "classes/footnotes-admin-layout-Init.html#method_load_dependencies" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003Ainitialize_settings\u0028\u0029", - "name": "initialize_settings", - "summary": "Registers\u0020the\u0020settings\u0020and\u0020initialises\u0020the\u0020settings\u0020page.", - "url": "classes/footnotes-admin-layout-Init.html#method_initialize_settings" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003Aregister_options_submenu\u0028\u0029", - "name": "register_options_submenu", - "summary": "Registers\u0020the\u0020footnotes\u0020submenu\u0020page.", - "url": "classes/footnotes-admin-layout-Init.html#method_register_options_submenu" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003Aget_plugin_meta_information\u0028\u0029", - "name": "get_plugin_meta_information", - "summary": "AJAX\u0020call.\u0020returns\u0020a\u0020JSON\u0020string\u0020containing\u0020meta\u0020information\u0020about\u0020a\u0020specific\u0020WordPress\u0020Plugin.", - "url": "classes/footnotes-admin-layout-Init.html#method_get_plugin_meta_information" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003AC_STR_MAIN_MENU_SLUG", - "name": "C_STR_MAIN_MENU_SLUG", - "summary": "Slug\u0020for\u0020the\u0020Plugin\u0020main\u0020menu.", - "url": "classes/footnotes-admin-layout-Init.html#constant_C_STR_MAIN_MENU_SLUG" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003A\u0024plugin_name", - "name": "plugin_name", - "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", - "url": "classes/footnotes-admin-layout-Init.html#property_plugin_name" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Init\u003A\u003A\u0024settings_page", - "name": "settings_page", - "summary": "Contains\u0020the\u0020settings\u0020page.", - "url": "classes/footnotes-admin-layout-Init.html#property_settings_page" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings", - "name": "Settings", - "summary": "Class\u0020to\u0020initialise\u0020all\u0020defined\u0020page\u0020layouts.", - "url": "classes/footnotes-admin-layout-Settings.html" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", - "url": "classes/footnotes-admin-layout-Settings.html#method___construct" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aget_priority\u0028\u0029", - "name": "get_priority", - "summary": "Returns\u0020a\u0020priority\u0020index.", - "url": "classes/footnotes-admin-layout-Settings.html#method_get_priority" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aget_sub_page_slug\u0028\u0029", - "name": "get_sub_page_slug", - "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Settings.html#method_get_sub_page_slug" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aget_sub_page_title\u0028\u0029", - "name": "get_sub_page_title", - "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Settings.html#method_get_sub_page_title" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aget_sections\u0028\u0029", - "name": "get_sections", - "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020the\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Settings.html#method_get_sections" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aget_meta_boxes\u0028\u0029", - "name": "get_meta_boxes", - "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes\u0020for\u0020each\u0020section\u0020of\u0020the\u0020sub\u002Dpage.", - "url": "classes/footnotes-admin-layout-Settings.html#method_get_meta_boxes" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aamp_compat\u0028\u0029", - "name": "amp_compat", - "summary": "Displays\u0020the\u0020AMP\u0020compatibility\u0020mode\u0020option.", - "url": "classes/footnotes-admin-layout-Settings.html#method_amp_compat" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Areference_container\u0028\u0029", - "name": "reference_container", - "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020reference\u0020container.", - "url": "classes/footnotes-admin-layout-Settings.html#method_reference_container" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Astart_end\u0028\u0029", - "name": "start_end", - "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020start\u0020and\u0020end\u0020tag\u0020short\u0020codes.", - "url": "classes/footnotes-admin-layout-Settings.html#method_start_end" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Anumbering\u0028\u0029", - "name": "numbering", - "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020numbering.", - "url": "classes/footnotes-admin-layout-Settings.html#method_numbering" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Ascrolling\u0028\u0029", - "name": "scrolling", - "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020scrolling\u0020behavior.", - "url": "classes/footnotes-admin-layout-Settings.html#method_scrolling" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Ahard_links\u0028\u0029", - "name": "hard_links", - "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020fragment\u0020identifier\u0020configuration.", - "url": "classes/footnotes-admin-layout-Settings.html#method_hard_links" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Alove\u0028\u0029", - "name": "love", - "summary": "Displays\u0020all\u0020settings\u0020for\u0020\u2018I\u0020love\u0020Footnotes\u2019\u0020note.", - "url": "classes/footnotes-admin-layout-Settings.html#method_love" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Aexcerpts\u0028\u0029", - "name": "excerpts", - "summary": "Displays\u0020the\u0020footnotes\u0020in\u0020excerpt\u0020setting.", - "url": "classes/footnotes-admin-layout-Settings.html#method_excerpts" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Asuperscript\u0028\u0029", - "name": "superscript", - "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020footnote\u0020referrers.", - "url": "classes/footnotes-admin-layout-Settings.html#method_superscript" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Alabel_solution\u0028\u0029", - "name": "label_solution", - "summary": "Displays\u0020the\u0020setting\u0020for\u0020the\u0020input\u0020label\u0020issue\u0020solution.", - "url": "classes/footnotes-admin-layout-Settings.html#method_label_solution" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box\u0028\u0029", - "name": "mouseover_box", - "summary": "Displays\u0020enabled\u0020status\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", - "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_position\u0028\u0029", - "name": "mouseover_box_position", - "summary": "Displays\u0020position\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", - "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_position" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_dimensions\u0028\u0029", - "name": "mouseover_box_dimensions", - "summary": "Displays\u0020dimensions\u0020setting\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", - "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_dimensions" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_timing\u0028\u0029", - "name": "mouseover_box_timing", - "summary": "Displays\u0020timing\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", - "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_timing" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_truncation\u0028\u0029", - "name": "mouseover_box_truncation", - "summary": "Displays\u0020truncation\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", - "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_truncation" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_text\u0028\u0029", - "name": "mouseover_box_text", - "summary": "Displays\u0020dedicated\u0020tooltip\u0020text\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", - "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_text" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Amouseover_box_appearance\u0028\u0029", - "name": "mouseover_box_appearance", - "summary": "Displays\u0020style\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", - "url": "classes/footnotes-admin-layout-Settings.html#method_mouseover_box_appearance" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Ahyperlink_arrow\u0028\u0029", - "name": "hyperlink_arrow", - "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020backlink\u0020symbol.", - "url": "classes/footnotes-admin-layout-Settings.html#method_hyperlink_arrow" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Acustom_css\u0028\u0029", - "name": "custom_css", - "summary": "Displays\u0020the\u0020Custom\u0020CSS\u0020box.", - "url": "classes/footnotes-admin-layout-Settings.html#method_custom_css" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Acustom_css_migration\u0028\u0029", - "name": "custom_css_migration", - "summary": "Displays\u0020transitional\u0020legacy\u0020Custom\u0020CSS\u0020box.", - "url": "classes/footnotes-admin-layout-Settings.html#method_custom_css_migration" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Acustom_css_new\u0028\u0029", - "name": "custom_css_new", - "summary": "Displays\u0020the\u0020new\u0020Custom\u0020CSS\u0020box.", - "url": "classes/footnotes-admin-layout-Settings.html#method_custom_css_new" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Alookup_hooks\u0028\u0029", - "name": "lookup_hooks", - "summary": "Displays\u0020available\u0020Hooks\u0020to\u0020look\u0020for\u0020Footnote\u0020short\u0020codes.", - "url": "classes/footnotes-admin-layout-Settings.html#method_lookup_hooks" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003AHelp\u0028\u0029", - "name": "Help", - "summary": "Displays\u0020a\u0020short\u0020introduction\u0020to\u0020the\u0020plugin.", - "url": "classes/footnotes-admin-layout-Settings.html#method_Help" - }, { - "fqsen": "\\footnotes\\admin\\layout\\Settings\u003A\u003Adonate\u0028\u0029", - "name": "donate", - "summary": "Displays\u0020all\u0020Donate\u0020button\u0020to\u0020support\u0020the\u0020developers.", - "url": "classes/footnotes-admin-layout-Settings.html#method_donate" }, { "fqsen": "\\footnotes\\general\\General", "name": "General", diff --git a/docs/packages/footnotes.html b/docs/packages/footnotes.html index 81ed2d4..79aa430 100644 --- a/docs/packages/footnotes.html +++ b/docs/packages/footnotes.html @@ -86,8 +86,8 @@
    -
    includes
    admin
    +
    includes
    @@ -98,6 +98,16 @@
    +
    Admin
    +
    Class provide all admin-specific functionality of the plugin.
    +
    WYSIWYG
    +
    Class providing WYSIWYG editor intergration for the plugin.
    +
    Engine
    +
    Class to be extended by page layout sub-classes.
    +
    Init
    +
    Class to initialise all defined page layouts.
    +
    Settings
    +
    Class to initialise all defined page layouts.
    Activator
    Class providing action(s) on plugin activation.
    Config
    @@ -114,16 +124,6 @@
    Class defining action/filter registration for the plugin.
    Settings
    Class defining configurable plugin settings.
    -
    Admin
    -
    Class provide all admin-specific functionality of the plugin.
    -
    WYSIWYG
    -
    Class providing WYSIWYG editor intergration for the plugin.
    -
    Engine
    -
    Class to be extended by page layout sub-classes.
    -
    Init
    -
    Class to initialise all defined page layouts.
    -
    Settings
    -
    Class to initialise all defined page layouts.
    General
    Class provide all public-facing functionality of the plugin.
    Parser
    diff --git a/docs/reports/deprecated.html b/docs/reports/deprecated.html index 23f842d..88dff50 100644 --- a/docs/reports/deprecated.html +++ b/docs/reports/deprecated.html @@ -85,16 +85,30 @@

    Table of Contents

    + + + - - -
    src/admin/layout/class-settings.php
    src/includes/class-config.php
    src/includes/class-settings.php
    src/admin/layout/class-settings.php
    + +

    class-settings.php

    + + + + + + + + + + + +
    LineElementReason
    1108Settings::custom_css_migration()

    class-config.php

    @@ -148,20 +162,6 @@
    - -

    class-settings.php

    - - - - - - - - - - - -
    LineElementReason
    1108Settings::custom_css_migration()
    diff --git a/docs/reports/markers.html b/docs/reports/markers.html index e2aa0be..48b5450 100644 --- a/docs/reports/markers.html +++ b/docs/reports/markers.html @@ -85,6 +85,14 @@

    Table of Contents

    + + + + + + + + @@ -99,14 +107,6 @@ - - - - - - - - @@ -122,6 +122,122 @@
    src/admin/class-wysiwyg.php2
    src/admin/layout/class-engine.php16
    src/includes/class-config.php 6
    src/includes/class-template.php 7
    src/admin/class-wysiwyg.php2
    src/admin/layout/class-engine.php16
    src/public/class-parser.php
    + +

    class-wysiwyg.php

    + + + + + + + + + + + + + + + + + + + + +
    TypeLineDescription
    TODO60Should this be `static`?
    TODO86Should this be `static`?
    + +

    class-engine.php

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeLineDescription
    TODO137Refactor sections into their own class?
    TODO167Refactor meta boxes into their own class?
    TODO167Pass actual functions rather than strings?
    TODO253Move to {@see}.
    TODO266Review nonce verification.
    TODO339Review nonce verification.
    TODO368Required? Should be `abstract`?
    TODO409Refactor HTML generation.
    TODO424Refactor HTML generation.
    TODO456Refactor HTML generation.
    TODO484Refactor HTML generation.
    TODO506Refactor HTML generation.
    TODO541Refactor HTML generation.
    TODO564Refactor HTML generation.
    TODO564Use proper colorpicker element.
    TODO588Refactor HTML generation.

    class-config.php

    @@ -303,122 +419,6 @@ At the very least, we should stop using ‘yes’ to mean `true` etc. -
    Refactor templating.
    - -

    class-wysiwyg.php

    - - - - - - - - - - - - - - - - - - - - -
    TypeLineDescription
    TODO60Should this be `static`?
    TODO86Should this be `static`?
    - -

    class-engine.php

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeLineDescription
    TODO137Refactor sections into their own class?
    TODO167Refactor meta boxes into their own class?
    TODO167Pass actual functions rather than strings?
    TODO253Move to {@see}.
    TODO266Review nonce verification.
    TODO339Review nonce verification.
    TODO368Required? Should be `abstract`?
    TODO409Refactor HTML generation.
    TODO424Refactor HTML generation.
    TODO456Refactor HTML generation.
    TODO484Refactor HTML generation.
    TODO506Refactor HTML generation.
    TODO541Refactor HTML generation.
    TODO564Refactor HTML generation.
    TODO564Use proper colorpicker element.
    TODO588Refactor HTML generation.

    class-parser.php

    diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml index 86e4e78..6903c6a 100644 --- a/phpdoc.dist.xml +++ b/phpdoc.dist.xml @@ -7,7 +7,7 @@ > docs - docs-cache + docs/.cache