Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Version 1.0.5

Browse source 
The Plugin has been submitted to wordpress.org for review and (hopefully) publication.
 * Update: Plugin description for public directories (WordPress.org and GitHub)
 * Feature: the **footnotes** WordPress Plugin now has its very own CI
   * Update: Styling
   * Update: Settings to support the styling
 * Add: Inspirational Screenshots for further development
 * Add: Settings screenshot
 * Update: i18n fine-tuning

git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@917823 b8457f37-d9ea-0310-8a92-e5e31aec5664
This commit is contained in:
Aricura 2014-05-20 11:53:13 +00:00
parent 2862e52731
commit cf6f817dfe
9 changed files with 45 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -4,13 +4,14 @@
#### 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.
**footnotes** gives you the ability to display decently-formated footnotes on your WordPress Pages or Posts. **footnotes** aims to be the all-in-one solution that ships with a set of sane defaults (those footnotes we know from offline publishing) but also give the user control over how their **footnotes** are being displayed.
![screenshot](https://raw.githubusercontent.com/media-competence-institute/footnotes/master/assets/screenshot-example.jpg)
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.
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. Using `((` + `))` is the default. You can decide on what the shortcode for **footnotes** should be.
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.
This plugin (once released on wordpress.org) will give you full customizability while being shipped with a set of sane defaults.

10
classes/footnotes_settings.php
View file

@ -104,9 +104,9 @@ class Class_FootnotesSettings
return;
}
/* submenu page title */
$l_str_PageTitle = 'footnotes';
$l_str_PageTitle = '<span style="color: #2bb975; ">foot</span><span style="color: #545f5a; ">notes</span>';
/* submenu title */
$l_str_MenuTitle = 'footnotes';
$l_str_MenuTitle = '<span style="color: #2bb975; ">foot</span><span style="color: #545f5a; ">notes</span>';
/* Add a new submenu to the standard Settings panel */
$this->a_str_Pagehook = add_options_page( $l_str_PageTitle, $l_str_MenuTitle, 'administrator', FOOTNOTES_SETTINGS_PAGE_ID, array( $this, 'OutputSettingsPage' ) );
}
@ -310,14 +310,14 @@ class Class_FootnotesSettings
/* add tab to the tab array */
$this->a_arr_SettingsTabs[ FOOTNOTE_SETTINGS_LABEL_GENERAL ] = __( "General", FOOTNOTES_PLUGIN_NAME );
/* register settings tab */
add_settings_section( $l_str_SectionName, __( "Settings", FOOTNOTES_PLUGIN_NAME ), array( $this, 'RegisterTab_General_Description' ), FOOTNOTE_SETTINGS_LABEL_GENERAL );
add_settings_section( $l_str_SectionName, sprintf(__( "%s Settings", FOOTNOTES_PLUGIN_NAME ), '<span style="color: #2bb975; ">foot</span><span style="color: #545f5a; ">notes</span>'), array( $this, 'RegisterTab_General_Description' ), FOOTNOTE_SETTINGS_LABEL_GENERAL );
add_settings_field( 'Register_References_Label', __( "References label:", FOOTNOTES_PLUGIN_NAME ), array( $this, 'Register_References_Label' ), FOOTNOTE_SETTINGS_LABEL_GENERAL, $l_str_SectionName );
add_settings_field( 'Register_Collapse_References', __( "Collapse references by default:", FOOTNOTES_PLUGIN_NAME ), array( $this, 'Register_Collapse_References' ), FOOTNOTE_SETTINGS_LABEL_GENERAL, $l_str_SectionName );
add_settings_field( 'Register_Combine_Identical', __( "Combine identical footnotes:", FOOTNOTES_PLUGIN_NAME ), array( $this, 'Register_Combine_Identical' ), FOOTNOTE_SETTINGS_LABEL_GENERAL, $l_str_SectionName );
add_settings_field( 'Register_Placeholder_Tags', __( "Footnote tag:", FOOTNOTES_PLUGIN_NAME ), array( $this, 'Register_Placeholder_Tags' ), FOOTNOTE_SETTINGS_LABEL_GENERAL, $l_str_SectionName );
add_settings_field( 'Register_CounterStyle', __( "Counter style:", FOOTNOTES_PLUGIN_NAME ), array( $this, 'Register_CounterStyle' ), FOOTNOTE_SETTINGS_LABEL_GENERAL, $l_str_SectionName );
add_settings_field( 'Register_SearchExcerpt', __( "Allow footnotes on Summarized Posts:", FOOTNOTES_PLUGIN_NAME ), array( $this, 'Register_SearchExcerpt' ), FOOTNOTE_SETTINGS_LABEL_GENERAL, $l_str_SectionName );
add_settings_field( 'Register_LoveAndShare', sprintf(__( "Tell the world you're using %sfootnotes%s:", FOOTNOTES_PLUGIN_NAME ), '<span style="color:#ff524b">', '</span>'), array( $this, 'Register_LoveAndShare' ), FOOTNOTE_SETTINGS_LABEL_GENERAL, $l_str_SectionName );
add_settings_field( 'Register_LoveAndShare', sprintf(__( "Tell the world you're using %sfoot%snotes%s:", FOOTNOTES_PLUGIN_NAME ), '<span style="color: #2bb975; ">', '</span><span style="color: #545f5a; ">', '</span>'), array( $this, 'Register_LoveAndShare' ), FOOTNOTE_SETTINGS_LABEL_GENERAL, $l_str_SectionName );
}
/**
@ -484,7 +484,7 @@ class Class_FootnotesSettings
</div>
<p>
<?php echo sprintf( __( "If you have any questions, please don't hesitate to %smail us%s.", FOOTNOTES_PLUGIN_NAME ), '<a href="mailto:support@herndler.org" class="footnote_plugin">', '</a>' ); ?>
<?php echo sprintf( __( "If you have any questions, please don't hesitate to %se-mail%s us.", FOOTNOTES_PLUGIN_NAME ), '<a href="mailto:mci@cheret.co.uk" class="footnote_plugin">', '</a>' ); ?>
</p>
</div>
</div>

2
css/settings.css
View file

@ -61,7 +61,7 @@ span.footnote_highlight_placeholder {
}
.footnote_placeholder_box_example {
border: 2px solid #ff524b !important;
border: 2px solid #2bb975 !important;
border-radius: 4px !important;
padding-top: 16px !important;
padding-bottom: 16px !important;

6
index.php
View file

@ -2,10 +2,10 @@
/*
Plugin Name: footnotes
Plugin URI: https://github.com/media-competence-institute/footnotes
Description: simple adding footnotes to your pages
Author: Mark Cheret, Stefan Herndler
Description: time to bring footnotes to your website! footnotes are known from offline publishing and everybody takes them for granted when reading a magazine.
Author: media competence institute
Version: 1.0.5
Author URI: https://github.com/media-competence-institute/footnotes
Author URI: http://cheret.co.uk/mci
Text Domain: footnotes
Domain Path: /languages
*/

BIN
languages/footnotes-de.mo
View file

Binary file not shown.

23
languages/footnotes-de.po
View file

@ -1,9 +1,9 @@
msgid ""
msgstr ""
"Project-Id-Version: footnotes\n"
"POT-Creation-Date: 2014-05-17 01:03+0100\n"
"PO-Revision-Date: 2014-05-17 01:03+0100\n"
"Last-Translator: SHE <s.herndler@methis.at>\n"
"POT-Creation-Date: 2014-05-19 09:15+0100\n"
"PO-Revision-Date: 2014-05-19 09:16+0100\n"
"Last-Translator: Mark Cheret <mark@cheret.de>\n"
"Language-Team: SHE <s.herndler@methis.at>\n"
"Language: de\n"
"MIME-Version: 1.0\n"
@ -22,9 +22,10 @@ msgstr ""
msgid "General"
msgstr "Allgemein"
#: classes/footnotes_settings.php:313 includes/plugin-settings.php:22
msgid "Settings"
msgstr "Einstellungen"
#: classes/footnotes_settings.php:313
#, php-format
msgid "%s Settings"
msgstr "%s Einstellungen"
#: classes/footnotes_settings.php:314
msgid "References label:"
@ -52,8 +53,8 @@ msgstr "Erlaube Fußnoten in Zusammenfassungen:"
#: classes/footnotes_settings.php:320
#, php-format
msgid "Tell the world you're using %sfootnotes%s:"
msgstr "Teil der Community mit dass Ich %sfootnotes%s verwende:"
msgid "Tell the world you're using %sfoot%snotes%s:"
msgstr "Teile der Welt mit, dass du %sfoot%snotes%s verwendest:"
#: classes/footnotes_settings.php:361 classes/footnotes_settings.php:409
#: classes/footnotes_settings.php:424
@ -119,9 +120,13 @@ msgstr "wird dargestellt als:"
#: classes/footnotes_settings.php:487
#, php-format
msgid "If you have any questions, please don't hesitate to %smail us%s."
msgid "If you have any questions, please don't hesitate to %se-mail%s us."
msgstr "Bei Fragen können Sie uns gerne eine %se-Mail%s senden."
#: includes/plugin-settings.php:22
msgid "Settings"
msgstr "Einstellungen"
#: includes/replacer.php:104
#, php-format
msgid "Hey there, I'm using the awesome WordPress Plugin called %sfootnotes%s"

BIN
languages/footnotes-en.mo
View file

Binary file not shown.

25
languages/footnotes-en.po
View file

@ -1,9 +1,9 @@
msgid ""
msgstr ""
"Project-Id-Version: footnotes\n"
"POT-Creation-Date: 2014-05-17 01:01+0100\n"
"PO-Revision-Date: 2014-05-17 01:01+0100\n"
"Last-Translator: SHE <s.herndler@methis.at>\n"
"POT-Creation-Date: 2014-05-19 09:15+0100\n"
"PO-Revision-Date: 2014-05-19 09:15+0100\n"
"Last-Translator: Mark Cheret <mark@cheret.de>\n"
"Language-Team: SHE <s.herndler@methis.at>\n"
"Language: en\n"
"MIME-Version: 1.0\n"
@ -22,9 +22,10 @@ msgstr ""
msgid "General"
msgstr "General"
#: classes/footnotes_settings.php:313 includes/plugin-settings.php:22
msgid "Settings"
msgstr "Settings"
#: classes/footnotes_settings.php:313
#, php-format
msgid "%s Settings"
msgstr "%s Settings"
#: classes/footnotes_settings.php:314
msgid "References label:"
@ -52,8 +53,8 @@ msgstr "Allow footnotes on Summarized Posts:"
#: classes/footnotes_settings.php:320
#, php-format
msgid "Tell the world you're using %sfootnotes%s:"
msgstr "Tell the world you're using %sfootnotes%s:"
msgid "Tell the world you're using %sfoot%snotes%s:"
msgstr "Tell the world you're using %sfoot%snotes%s:"
#: classes/footnotes_settings.php:361 classes/footnotes_settings.php:409
#: classes/footnotes_settings.php:424
@ -119,8 +120,12 @@ msgstr "will be displayed as:"
#: classes/footnotes_settings.php:487
#, 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 "If you have any questions, please don't hesitate to %se-mail%s us."
msgstr "If you have any questions, please don't hesitate to %se-mail%s us."
#: includes/plugin-settings.php:22
msgid "Settings"
msgstr "Settings"
#: includes/replacer.php:104
#, php-format

6
readme.txt
View file

@ -19,7 +19,7 @@ footnotes aims to be the all-in-one solution that ships with a set of sane defau
It's relatively simple. Check out [the manual](https://github.com/markcheret/footnotes#footnotes).
= Is your Plugin a copy of footnotes x? =
= Is your Plugina copy of footnotes x? =
No, this Plugin has been written from scratch. Of course some inspirations were taken from other plugins.
@ -86,5 +86,5 @@ The Plugin has been submitted to wordpress.org for review and (hopefully) public
* First development Version of the Plugin
== Upgrade Notice ==
To upgrade our plugin is simple. Just update the plugin within your WordPress installation.
To cross-upgrade from other footnotes plugins, there will be a migration assistant in the future
to upgrade our plugin is simple. Just update the plugin within your WordPress installation.
To cross-upgrade from other footnotes plugins, there will be a migration assistant in the future