diff --git a/README.md b/README.md new file mode 100755 index 0000000..c7a78ff --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +footnotes +========= + +**footnotes** WordPress Plugin + +#### this plugin intends to be straight forward and customizable at the same time #### + +**footnotes** gives you the ability to display decently-formated footnotes on your WordPress Pages or Posts. + +The syntax is based on the common DokuWiki syntax for footnotes. So, to include a footnote with the text "with a footnote," you use: + + Your awesome text((with a footnote)) + +And that's all you need to do. When you add a footnote, **footnotes** will create a note marker at the point that the foonote appears in the text, and includes the text of the footnote in a styled list of notes down the page. When a reader clicks on the link in a JavaScript-enabled browser, a script included with the plugin will create a small bubble inline in the text, which pops up over the footnote marker for easy reading without losing their place. Just like you're used to on a DokuWiki Page. + +In non-JavaScript-enabled contexts, clicking on the footnote marker jumps down the page to the text of the note. The jump is based on a unique anchor which the plugin can automatically generate for you. diff --git a/constants.php b/constants.php new file mode 100755 index 0000000..a57c22d --- /dev/null +++ b/constants.php @@ -0,0 +1,30 @@ + p { + font-size: 1.5em; + margin-top: 1em; + margin-bottom: 0.25em; + padding: 0; + line-height: 1.3; + font-weight: normal; + overflow: hidden; + border-bottom: 1px solid #aaaaaa; + display: block; + -webkit-margin-before: 0.83em; + -webkit-margin-after: 0.83em; + -webkit-margin-start: 0px; + -webkit-margin-end: 0px; +} +.footnote_container_prepare > p > span { + +} + +/* container for the footnote in the bottom */ +.footnote_plugin_container { + display: block; + width: 100%; + padding-bottom: 14px; +} + +/* footnote (bottom) index */ +.footnote_plugin_index { + float: left; + min-width: 40px; + white-space: nowrap; + text-align: right; +} + +/* footnote (bottom) text */ +.footnote_plugin_text { + float: left; + padding-left: 16px; +} + +/* footnote (bottom) link to the footnote implementation */ +.footnote_plugin_link { + outline: none; + text-decoration: none; + cursor: pointer; +} +.footnote_plugin_link:hover { + color: #4777ff; + text-decoration: none; +} + +/* footnote (bottom) styling end tag */ +.footnote_plugin_end { + clear: left; +} + +/* tooltip */ +a.footnote_plugin_tooltip { + outline: none; + color: #4777ff; + text-decoration: none; + cursor: pointer; +} +a.footnote_plugin_tooltip strong { + line-height: 30px; +} +a.footnote_plugin_tooltip:hover { + text-decoration: none; +} +a.footnote_plugin_tooltip span { + z-index: 10; + display: none; + padding: 14px 20px; + margin-top: -30px; + margin-left: 28px; + /*width: 240px;*/ + line-height: 16px; +} +a.footnote_plugin_tooltip:hover span { + display: inline; + position: absolute; + color: #474747; + border: 1px solid #ddccaa; + background: #fffaf0; +} +.callout { + z-index: 20; + position: absolute; + top: 30px; + border: 0; + left: -12px; +} + +/*CSS3 extras*/ +a.footnote_plugin_tooltip span { + border-radius: 4px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + -moz-box-shadow: 5px 5px 8px #cccccc; + -webkit-box-shadow: 5px 5px 8px #cccccc; + box-shadow: 5px 5px 8px #cccccc; +} \ No newline at end of file diff --git a/css/settings.css b/css/settings.css new file mode 100755 index 0000000..2e96f73 --- /dev/null +++ b/css/settings.css @@ -0,0 +1,60 @@ +/** + * Created by Stefan on 15.05.14. + */ + +/* overwrite some styling for labels */ +label { + min-width: 160px !important; +} + +/* overwrite some styling for inputs [type=text] and select-boxes */ +input[type=text], select { + padding-left: 8px !important; + padding-right: 8px !important; + margin-left: 12px !important; +} + +a.footnote_plugin { + text-decoration: underline; + cursor: pointer; + color: #202020; +} + +/* settings container */ +.footnote_plugin_container { + display: block !important; + width: 100% !important; + padding-bottom: 18px !important; +} + +/* setting with 25% width */ +.footnote_plugin_25 { + width: 24% !important; +} + +/* setting with half width */ +.footnote_plugin_50 { + width: 49% !important; +} +/* setting with 75% width */ +.footnote_plugin_75 { + width: 74% !important; +} +/* setting with full width */ +.footnote_plugin_100 { + width: 99% !important; +} + +/* container for the box holding the placeholder tags at the end */ +.footnote_placeholder_box_container { + text-align: center; + width: auto; + display: inline-block; +} + +/* highlight the placeholders */ +span.footnote_highlight_placeholder { + font-weight: bold; + padding-left: 8px; + padding-right: 8px; +} \ No newline at end of file diff --git a/functions.php b/functions.php new file mode 100755 index 0000000..9d48374 --- /dev/null +++ b/functions.php @@ -0,0 +1,219 @@ + $l_str_Value) { + $l_arr_Options[$l_str_Key] = stripcslashes($l_str_Value); + } + /* returns the filtered array */ + return $l_arr_Options; +} + +/** + * reads the wordpress langauge and returns only the language code lowercase + * removes the localization code + * @return string (only the "en" from "en_US") + */ +function footnotes_getLanguageCode() +{ + /* read current wordpress langauge */ + $l_str_locale = apply_filters('plugin_locale', get_locale(), FOOTNOTES_PLUGIN_NAME); + /* check if wordpress language has a localization (e.g. "en_US" or "de_AT") */ + if (strpos($l_str_locale, "_") !== false) { + /* remove localization code */ + $l_arr_languageCode = explode("_", $l_str_locale); + $l_str_languageCode = $l_arr_languageCode[0]; + return $l_str_languageCode; + } + /* return language code lowercase */ + return strtolower($l_str_locale); +} + +/** + * loads the langauge file including localization if exists + * otherwise loads the langauge file without localization information + */ +function footnotes_load_language() +{ + /* read current wordpress langauge */ + $l_str_locale = apply_filters('plugin_locale', get_locale(), FOOTNOTES_PLUGIN_NAME); + /* get only language code (removed localization code) */ + $l_str_languageCode = footnotes_getLanguageCode(); + + /* language file with localization exists */ + if ($l_bool_loaded = load_textdomain(FOOTNOTES_PLUGIN_NAME, dirname(__FILE__) . '/languages/' . FOOTNOTES_PLUGIN_NAME . '-' . $l_str_locale . '.mo')) { + + /* language file without localization exists */ + } else if ($l_bool_loaded = load_textdomain(FOOTNOTES_PLUGIN_NAME, dirname(__FILE__) . '/languages/' . FOOTNOTES_PLUGIN_NAME . '-' . $l_str_languageCode . '.mo')) { + + /* load default language file, nothing will happen: default language will be used (=english) */ + } else { + load_textdomain(FOOTNOTES_PLUGIN_NAME, dirname(__FILE__) . '/languages/' . FOOTNOTES_PLUGIN_NAME . '-en.mo'); + } +} + +/** + * register and add a stylesheet to the public pages + */ +function footnotes_public_page_scripts() { + /* register stylesheet for the public page */ + wp_register_style('footnote_public_style', plugins_url('css/footnote.css', __FILE__)); + /* add stylesheet to the public page */ + wp_enqueue_style('footnote_public_style'); +} + +/** + * @param string $p_str_FootnoteText + * @return string + */ +function footnote_example_replacer($p_str_FootnoteText) { + $l_int_FootnoteIndex = 1; + $l_str_FootnoteTemplate = file_get_contents(dirname(__FILE__) . "/templates/footnote.html"); + $l_str_ReplaceText = str_replace("[[FOOTNOTE INDEX]]", $l_int_FootnoteIndex, $l_str_FootnoteTemplate); + $l_str_ReplaceText = str_replace("[[FOOTNOTE TEXT]]", $p_str_FootnoteText, $l_str_ReplaceText); + return $l_str_ReplaceText; +} + +/** + * replace the /forms.contact placeholders in the current public page + * @param string $p_str_Content + * @return string + */ +function footnotes_replace_public_placeholders($p_str_Content) +{ + /* read settings */ + $l_arr_Options = footnote_filter_options(FOOTNOTE_SETTINGS_CONTAINER); + /* get setting for combine identical footnotes */ + $l_str_CombineIdentical = $l_arr_Options[FOOTNOTE_INPUT_COMBINE_IDENTICAL_NAME]; + /* get setting for preferences label */ + $l_str_ReferencesLabel = $l_arr_Options[FOOTNOTE_INPUT_REFERENCES_NAME]; + /* convert it from string to boolean */ + $l_bool_CombineIdentical = false; + if ($l_str_CombineIdentical == "yes") { + $l_bool_CombineIdentical = true; + } + + /* contains the index for the next footnote on this page */ + $l_int_FootnoteIndex = 1; + /* contains the inner text for the footnotes */ + $l_str_FootnoteBody = array(); + /* contains the starting position for the lookup of a footnote */ + $l_int_PosStart = 0; + /* contains the footnote template */ + $l_str_FootnoteTemplate = file_get_contents(dirname(__FILE__) . "/templates/footnote.html"); + + /* check for a footnote placeholder in the current page */ + do { + /* get first occurence of a footnote starting tag */ + $l_int_PosStart = strpos($p_str_Content, FOOTNOTE_PLACEHOLDER_START, $l_int_PosStart); + /* tag found */ + if ($l_int_PosStart !== false) { + /* get first occurence of a footnote ending tag after the starting tag */ + $l_int_PosEnd = strpos($p_str_Content, FOOTNOTE_PLACEHOLDER_END, $l_int_PosStart); + /* tag found */ + if ($l_int_PosEnd !== false) { + /* get length of footnote text */ + $l_int_Length = $l_int_PosEnd - $l_int_PosStart; + /* get text inside footnote */ + $l_str_FootnoteText = substr($p_str_Content, $l_int_PosStart + strlen(FOOTNOTE_PLACEHOLDER_START), $l_int_Length - strlen(FOOTNOTE_PLACEHOLDER_START)); + /* set replacer for the footnote */ + $l_str_ReplaceText = str_replace("[[FOOTNOTE INDEX]]", $l_int_FootnoteIndex, $l_str_FootnoteTemplate); + $l_str_ReplaceText = str_replace("[[FOOTNOTE TEXT]]", $l_str_FootnoteText, $l_str_ReplaceText); + /* replace footnote in content */ + $p_str_Content = substr_replace($p_str_Content, $l_str_ReplaceText, $l_int_PosStart, $l_int_Length + strlen(FOOTNOTE_PLACEHOLDER_END)); + /* set footnote to the output box at the end */ + $l_str_FootnoteBody[] = $l_str_FootnoteText; + /* increase footnote index */ + $l_int_FootnoteIndex++; + /* add offset to the new starting position */ + $l_int_PosStart += ($l_int_PosEnd - $l_int_PosStart); + /* no ending tag found */ + } else { + $l_int_PosStart++; + } + /* no starting tag found */ + } else { + break; + } + } while (true); + + /* no footnotes has been replaced on this page */ + if (count($l_str_FootnoteBody) == 0) { + /* return content */ + return $p_str_Content; + } + + /* contains the footnote template */ + $l_str_FootnoteTemplate = file_get_contents(dirname(__FILE__) . "/templates/container.html"); + + /* loop through all footnotes found in the page */ + for($l_str_Index = 0; $l_str_Index < count($l_str_FootnoteBody); $l_str_Index++) { + /* get footnote text */ + $l_str_Footnote = $l_str_FootnoteBody[$l_str_Index]; + /* if fottnote is empty, get to the next one */ + if (empty($l_str_Footnote)) { + continue; + } + /* get footnote index */ + $l_str_FirstFootnoteIndex = ($l_str_Index+1); + $l_str_FootnoteIndex = ($l_str_Index+1); + + /* check if it isn't the last footnote in the array */ + if ($l_str_Index+1 < count($l_str_FootnoteBody) && $l_bool_CombineIdentical) { + /* get all footnotes that I haven't passed yet */ + for ($l_str_CheckIndex = $l_str_Index + 1; $l_str_CheckIndex < count($l_str_FootnoteBody); $l_str_CheckIndex++) { + /* check if a further footnote is the same as the actual one */ + if ($l_str_Footnote == $l_str_FootnoteBody[$l_str_CheckIndex]) { + /* set the further footnote as empty so it won't be displayed later */ + $l_str_FootnoteBody[$l_str_CheckIndex] = ""; + /* add the footnote index to the actual index */ + $l_str_FootnoteIndex .= ", " . ($l_str_CheckIndex + 1); + } + } + } + + /* add a headline to the footer container in the bottom, but only once */ + if ($l_str_Index == 0) { + $p_str_Content = $p_str_Content . '

' . $l_str_ReferencesLabel . '

'; + } + + /* add the footnote to the output box */ + $l_str_ReplaceText = str_replace("[[FOOTNOTE INDEX SHORT]]", $l_str_FirstFootnoteIndex, $l_str_FootnoteTemplate); + $l_str_ReplaceText = str_replace("[[FOOTNOTE INDEX]]", $l_str_FootnoteIndex, $l_str_ReplaceText); + $l_str_ReplaceText = str_replace("[[FOOTNOTE TEXT]]", $l_str_Footnote, $l_str_ReplaceText); + /* add the footnote container to the output */ + $p_str_Content = $p_str_Content . $l_str_ReplaceText; + } + + /* return content */ + return $p_str_Content; +} + +/** + * add short links to the plugin main page + * @param array $links + * @param mixed $file + * @return array + */ +function footnotes_plugin_settings_link($links, $file) +{ + /* add link to the /forms.contact plugin's settings page */ + $settings_link = '' . __('Settings', FOOTNOTES_PLUGIN_NAME) . ''; + array_unshift($links, $settings_link); + + /* return new links */ + return $links; +} \ No newline at end of file diff --git a/index.php b/index.php new file mode 100755 index 0000000..8e0fe4e --- /dev/null +++ b/index.php @@ -0,0 +1,77 @@ +\n" +"Language-Team: SHE \n" +"Language: de\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Poedit 1.6.5\n" +"X-Poedit-Basepath: ..\n" +"X-Poedit-SourceCharset: UTF-8\n" +"X-Poedit-KeywordsList: __;_e;_n:1,2;_x:1,2c;_ex:1,2c;_nx:4c,1,2;esc_attr__;" +"esc_attr_e;esc_attr_x:1,2c;esc_html__;esc_html_e;esc_html_x:1,2c;_n_noop:1,2;" +"_nx_noop:3c,1,2;__ngettext_noop:1,2\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Poedit-SearchPath-0: .\n" + +#: functions.php:214 settings.class.php:170 settings.class.php:216 +msgid "Settings" +msgstr "Einstellungen" + +#: settings.class.php:175 settings.class.php:193 +msgid "Save" +msgstr "Speichern" + +#: settings.class.php:217 +msgid "General Information" +msgstr "Allgemeine Informationen" + +#: settings.class.php:225 +msgid "References label:" +msgstr "Überschrift \"Einzelnachweis\":" + +#: settings.class.php:234 +msgid "Combine identical footnotes:" +msgstr "Kombiniere meine Fußnoten:" + +#: settings.class.php:237 +msgid "Yes" +msgstr "Ja" + +#: settings.class.php:238 +msgid "No" +msgstr "Nein" + +#: settings.class.php:257 +msgid "Start your footnote with the following shortcode:" +msgstr "Starten Sie eine Fußnote mit:" + +#: settings.class.php:261 +msgid "...and end your footnote with this shortcode:" +msgstr "...und beenden Sie diese mit:" + +#: settings.class.php:268 settings.class.php:271 +msgid "example string" +msgstr "Beispieltext" + +#: settings.class.php:269 +msgid "will be displayed as:" +msgstr "wird dargestellt als:" + +#: settings.class.php:277 +#, php-format +msgid "If you have any questions, please don't hesitate to %smail us%s." +msgstr "Bei Fragen können Sie uns gerne eine %se-Mail%s senden." + +#~ msgid "" +#~ "Insert the following shortcode where you want your footnotes to be " +#~ "displayed:" +#~ msgstr "Folgender Platzhalter wird durch Ihre Fußnote ersetzt:" + +#~ msgid "The plugin replaces this shortcode automatically with your footnotes" +#~ msgstr "Das Plugin ersetzt Ihren Text duch einen Fußnote" diff --git a/languages/footnotes-en.mo b/languages/footnotes-en.mo new file mode 100755 index 0000000..ea7a5a3 Binary files /dev/null and b/languages/footnotes-en.mo differ diff --git a/languages/footnotes-en.po b/languages/footnotes-en.po new file mode 100755 index 0000000..1355535 --- /dev/null +++ b/languages/footnotes-en.po @@ -0,0 +1,79 @@ +msgid "" +msgstr "" +"Project-Id-Version: footnotes\n" +"POT-Creation-Date: 2014-05-15 21:40+0100\n" +"PO-Revision-Date: 2014-05-15 21:40+0100\n" +"Last-Translator: SHE \n" +"Language-Team: SHE \n" +"Language: en\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Poedit 1.6.5\n" +"X-Poedit-Basepath: ..\n" +"X-Poedit-SourceCharset: UTF-8\n" +"X-Poedit-KeywordsList: __;_e;_n:1,2;_x:1,2c;_ex:1,2c;_nx:4c,1,2;esc_attr__;" +"esc_attr_e;esc_attr_x:1,2c;esc_html__;esc_html_e;esc_html_x:1,2c;_n_noop:1,2;" +"_nx_noop:3c,1,2;__ngettext_noop:1,2\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Poedit-SearchPath-0: .\n" + +#: functions.php:214 settings.class.php:170 settings.class.php:216 +msgid "Settings" +msgstr "Settings" + +#: settings.class.php:175 settings.class.php:193 +msgid "Save" +msgstr "Save" + +#: settings.class.php:217 +msgid "General Information" +msgstr "General Information" + +#: settings.class.php:225 +msgid "References label:" +msgstr "References label:" + +#: settings.class.php:234 +msgid "Combine identical footnotes:" +msgstr "Combine identical footnotes:" + +#: settings.class.php:237 +msgid "Yes" +msgstr "Yes" + +#: settings.class.php:238 +msgid "No" +msgstr "No" + +#: settings.class.php:257 +msgid "Start your footnote with the following shortcode:" +msgstr "Start your footnote with the following shortcode:" + +#: settings.class.php:261 +msgid "...and end your footnote with this shortcode:" +msgstr "...and end your footnote with this shortcode:" + +#: settings.class.php:268 settings.class.php:271 +msgid "example string" +msgstr "example string" + +#: settings.class.php:269 +msgid "will be displayed as:" +msgstr "will be displayed as:" + +#: settings.class.php:277 +#, php-format +msgid "If you have any questions, please don't hesitate to %smail us%s." +msgstr "If you have any questions, please don't hesitate to %smail us%s." + +#~ msgid "" +#~ "Insert the following shortcode where you want your footnotes to be " +#~ "displayed:" +#~ msgstr "" +#~ "Insert the following shortcode where you want your footnotes to be " +#~ "displayed:" + +#~ msgid "The plugin replaces this shortcode automatically with your footnotes" +#~ msgstr "" +#~ "The plugin replaces this shortcode automatically with your footnotes" diff --git a/license.txt b/license.txt new file mode 100755 index 0000000..3d90694 --- /dev/null +++ b/license.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/plugin.class.php b/plugin.class.php new file mode 100755 index 0000000..b49071d --- /dev/null +++ b/plugin.class.php @@ -0,0 +1,85 @@ +settings = new footnotes_class_settings(); + } + + /* execute class function: init, admin_init and admin_menu */ + add_action('init', array($this, 'init')); + add_action('admin_init', array($this, 'admin_init')); + add_action('admin_menu', array($this, 'admin_menu')); + + /* register hook for activating the plugin */ + register_activation_hook(__FILE__, array($this, 'activate')); + /* register hook for deactivating the plugin */ + register_deactivation_hook(__FILE__, array($this, 'deactivate')); + /* register hook for uninstalling the plugin */ + register_uninstall_hook(__FILE__, array(__CLASS__, 'uninstall')); + } + + /** + * activates the plugin + */ + function activate() + { + } + + /** + * deactivates the plugin + */ + function deactivate() + { + } + + /** + * uninstalls the plugin + */ + function uninstall() + { + require_once(PLUGIN_DIR . 'uninstall.php'); + } + + /** + * initialize function + * called in the class constructor + */ + function init() + { + } + + /** + * do admin init stuff + * called in the class constructor + */ + function admin_init() + { + } + + /** + * do admin menu stuff + * called in the class constructor + */ + function admin_menu() + { + } + +} /* class footnotes_class_plugin */ \ No newline at end of file diff --git a/readme.txt b/readme.txt new file mode 100755 index 0000000..df6cffc --- /dev/null +++ b/readme.txt @@ -0,0 +1,42 @@ +=== Plugin Name === +Contributors: Aricura, mark.cheret +Tags: footnote, footnotes, smart, bibliography, formatting, notes, Post, posts, reference, referencing +Requires at least: 3.9 +Tested up to: 3.9.1 +License: GPLv3 or later +License URI: http://www.gnu.org/licenses/gpl-3.0.html + +== Description == + +This WordPress Plugin enables you to easily add footnotes to your Posts or Pages. They are DokuWiki-Style footnotes. + +== Frequently Asked Questions == + += How do I use this Plugin? = + +It's relatively simple. Check out [the manual](https://github.com/markcheret/footnotes#footnotes). + += Is your Plugin not a copy of footnotes x? = + +No, this Plugin has been written from scratch. + +== Installation == +* Download the latest version from GitHub (https://github.com/markcheret/footnotes) +* in the bottom right there is a `Download ZIP` button +* Visit your WordPress Admin area +* Navigate to `Plugins\Add` +* Select the Tab `Upload` +* Upload the previously downloaded .zip file and hit `Install` +* Activate the Plugin + +== Screenshots == +coming soon + +== Changelog == + += 1.0.0 = +* First development Version of the Plugin + +== Feedback == + +== Get involved == \ No newline at end of file diff --git a/settings.class.php b/settings.class.php new file mode 100755 index 0000000..4220a90 --- /dev/null +++ b/settings.class.php @@ -0,0 +1,283 @@ + 'yes', + FOOTNOTE_INPUT_REFERENCES_NAME => 'References' + ); + var $pagehook, $page_id, $settings_field, $options; /* class attributes */ + + private $a_arr_CombineIdentical; /* contains the storage value for the "combine identical" setting */ + private $a_arr_References; /* contains the storage value for the references setting */ + + /** + * @constructor + */ + function __construct() + { + $this->page_id = FOOTNOTES_SETTINGS_PAGE_ID; + /* This is the get_options slug used in the database to store our plugin option values. */ + $this->settings_field = FOOTNOTE_SETTINGS_CONTAINER; + /* read plugin settings from database */ + $this->options = footnote_filter_options($this->settings_field); + /* execute class functions: admin_init and admin_menu */ + add_action('admin_init', array($this, 'admin_init'), 20); + add_action('admin_menu', array($this, 'admin_menu'), 20); + } + + /** + * initialize settings page + * called in class constructor + */ + function admin_init() + { + /* add the jQuery plugin to the settings page */ + wp_enqueue_script('jquery'); + /* register stylesheet for the settings page */ + wp_register_style('footnote_settings_style', plugins_url('css/settings.css', __FILE__)); + /* add stylesheet to the settings page */ + wp_enqueue_style('footnote_settings_style'); + /* register stylesheet for the public page */ + wp_register_style('footnote_public_style', plugins_url('css/footnote.css', __FILE__)); + /* add stylesheet to the public page */ + wp_enqueue_style('footnote_public_style'); + /* Needed to allow metabox layout and close functionality */ + wp_enqueue_script('postbox'); + + /* register the settings and sanitize the values loaded from database */ + register_setting($this->settings_field, $this->settings_field, array($this, 'sanitize_theme_options')); + /* adds the values from database to the options array or adds the default values if the database values are invalid */ + add_option($this->settings_field, self::$default_settings); + /* collect data for "combine identical" */ + $this->a_arr_CombineIdentical = array(); + $this->a_arr_CombineIdentical["id"] = $this->get_field_id(FOOTNOTE_INPUT_COMBINE_IDENTICAL_NAME); + $this->a_arr_CombineIdentical["name"] = $this->get_field_name(FOOTNOTE_INPUT_COMBINE_IDENTICAL_NAME); + $this->a_arr_CombineIdentical["value"] = esc_attr($this->get_field_value(FOOTNOTE_INPUT_COMBINE_IDENTICAL_NAME)); + + /* collect data for "references" label */ + $this->a_arr_References = array(); + $this->a_arr_References["id"] = $this->get_field_id(FOOTNOTE_INPUT_REFERENCES_NAME); + $this->a_arr_References["name"] = $this->get_field_name(FOOTNOTE_INPUT_REFERENCES_NAME); + $this->a_arr_References["value"] = esc_attr($this->get_field_value(FOOTNOTE_INPUT_REFERENCES_NAME)); + } + + /** + * add admin menu for plugin settings + * called in class constructor + */ + function admin_menu() + { + /* current user needs the permission to update plugins */ + if (!current_user_can('update_plugins')) { + return; + } + + /* submenu page title */ + $l_str_PageTitle = "Footnotes"; + /* submenu title */ + $l_str_MenuTitle = "Footnotes"; + + /* Add a new submenu to the standard Settings panel */ + $this->pagehook = $page = add_options_page( $l_str_PageTitle, $l_str_MenuTitle, 'administrator', $this->page_id, array($this, 'render')); + + /* Executed on-load. Add all metaboxes. calls function: metaboxes */ + add_action('load-' . $this->pagehook, array($this, 'metaboxes')); + + /* Include js, css, or header *only* for our settings page, calls function: js_includes */ + add_action("admin_print_scripts-$page", array($this, 'js_includes')); + /* calls function: admin_head */ + add_action("admin_head-$page", array($this, 'admin_head')); + } + + /** + * called in admin_menu() + */ + function admin_head() + { + } + + /** + * called in admin_menu() + */ + function js_includes() + { + } + + /** + * Sanitize our plugin settings array as needed. + * @param array $options + * @return array + */ + function sanitize_theme_options($options) + { + /* loop through all keys in the array and filters them */ + foreach ($options as $l_str_Key => $l_str_Value) { + $options[$l_str_Key] = stripcslashes($l_str_Value); + } + return $options; + } + + /** + * access settings field by name + * @param string $name + * @return string + */ + protected function get_field_name($name) + { + return sprintf('%s[%s]', $this->settings_field, $name); + } + + /** + * access settings field by id + * @param string $id + * @return string + */ + protected function get_field_id($id) + { + return sprintf('%s[%s]', $this->settings_field, $id); + + } + + /** + * get settings field value + * @param string $key + * @return string + */ + protected function get_field_value($key) + { + return $this->options[$key]; + } + + /** + * Render settings page, display the page container + */ + function render() + { + global $wp_meta_boxes; + ?> + +
+

Footnotes

+ +
+

+ "/> +

+ +
+
+ settings_field); + do_meta_boxes($this->pagehook, 'main', null); + if (isset($wp_meta_boxes[$this->pagehook]['layout'])) { + do_meta_boxes($this->pagehook, 'layout', null); + } + ?> +
+
+ +

+ "/> +

+
+
+ + + + pagehook, 'main'); + add_meta_box('footnote-plugin-general', __("General Information", FOOTNOTES_PLUGIN_NAME), array($this, 'placeholder_box'), $this->pagehook, 'main'); + } + + function settings_box() { + ?> + +
+ + " id="a_arr_References["id"]; ?>" + value="a_arr_References["value"]; ?>"/> +
+ + +
+ + + +
+ +
+
+

+ + +

+

+ + +

+ +

 

+ +

+ + +      + +

+ +

 

+ +

+ ', ''); ?> +

+
+
+ +
+ [[FOOTNOTE INDEX]]. +
+
+   + [[FOOTNOTE TEXT]] +
+
+ \ No newline at end of file diff --git a/templates/footnote.html b/templates/footnote.html new file mode 100755 index 0000000..fe6afad --- /dev/null +++ b/templates/footnote.html @@ -0,0 +1,8 @@ + + + [[FOOTNOTE INDEX]]) + + [[FOOTNOTE TEXT]] + + + \ No newline at end of file diff --git a/uninstall.php b/uninstall.php new file mode 100755 index 0000000..f6f14b4 --- /dev/null +++ b/uninstall.php @@ -0,0 +1,23 @@ +