Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Group footnotes 2 #3

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Group footnotes 2 #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4cd4d8a
Merge pull request #1 from nash-ye/master
dawnbirth Jun 18, 2020
860371e
Create a setting to enable/disable footenotes grouping
dawnbirth Jun 19, 2020
ffdfc17
Apply footnotes grouping
dawnbirth Jun 19, 2020
14763e5
Add an extra class "bfn-footnoteRef-child" to the footenoteRef repeat…
dawnbirth Jun 19, 2020
1ca9372
Remove unnecessary variables reassignment.
dawnbirth Jun 19, 2020
a68abac
Remove an extra semicolon
dawnbirth Jun 19, 2020
b0ada72
Fix "occurrence" word typo
dawnbirth Jun 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 78 additions & 31 deletions assets/js/better-footnotes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
var betterFootnotes = {
options: {
scrollGap: 0,
scrollSpeed: 0
scrollSpeed: 0,
groupFootnotes: 0
},
occurrenceLog: [],
init: function () {
if (typeof betterFootnotesOptions !== 'undefined') {
betterFootnotes.options = Object.assign(betterFootnotes.options, betterFootnotesOptions);
Expand Down Expand Up @@ -40,60 +42,83 @@
containerSelector = "#post-" + footnotePostId;
}

var $footenotesList = $(".bfn-footnotesList", $footenotes);
$('.bfn-footnoteHook', containerSelector).each(function(index) {
var footnoteNum = index + 1;

var $footnoteHook = $(this);
betterFootnotes.populateFootnoteHook($footnoteHook, footnotePostId, footnoteNum);
$('.bfn-footnoteHook', containerSelector).each(function() {
var $footnoteHook = $(this);
var footnoteNum = betterFootnotes.logOccurrence($footnoteHook.data('footnote-content'));
var occurrenceCount = betterFootnotes.occurrenceLog[footnoteNum-1].count;

betterFootnotes.populateFootnoteHook($footnoteHook, footnotePostId, footnoteNum, occurrenceCount);

var $footnoteItem = betterFootnotes.generateFootnoteItem($footnoteHook);
$footenotesList.append($footnoteItem);
});

if (! $footenotesList.is(":empty")) {
$footenotes.show();
}
},
populateFootnoteHook: function($footnoteHook, footnotePostId, footnoteNum) {
var footnoteId = betterFootnotes.generateFootnoteId(footnotePostId, footnoteNum);
var footnoteHookId = betterFootnotes.generateFootnoteHookId(footnotePostId, footnoteNum);
this.generateFootnotesList(footnotePostId, $footenotes);

},
populateFootnoteHook: function($footnoteHook, footnotePostId, footnoteNum, occurrenceCount) {
var footnoteId = betterFootnotes.generateFootnoteId(footnotePostId, footnoteNum);
var footnoteHookId = betterFootnotes.generateFootnoteHookId(footnotePostId, footnoteNum, occurrenceCount);
$footnoteHook.attr("id", footnoteHookId);
$footnoteHook.attr("href", "#" + footnoteId);
$footnoteHook.attr("data-footnote-id", footnoteId);
if ($footnoteHook.attr("data-footnote-type") === "numeric") {
if ($footnoteHook.attr("data-footnote-type") === "numeric" || betterFootnotes.options.groupFootnotes == 1) {
$footnoteHook.text(footnoteNum);
}

return $footnoteHook;
},
generateFootnoteHookId: function (postId, footnoteNum) {
return "article-footnote-hook-" + postId + "-" + footnoteNum;
generateFootnoteHookId: function (postId, footnoteNum, occurrenceCount) {
var id = "article-footnote-hook-" + postId + "-" + footnoteNum;
return (betterFootnotes.options.groupFootnotes == 1) ? id + "-" + occurrenceCount : id;
},
generateFootnoteId: function (postId, footnoteNum) {
return "article-footnote-" + postId + "-" + footnoteNum;;
return "article-footnote-" + postId + "-" + footnoteNum;
},
generateFootnoteRef: function ($footnoteHook) {
generateFootnoteRef: function (footnoteHookId, footnoteId, footnoteNum, occurrenceCount, type) {
var $footnoteRef = $("<a></a>");

$footnoteRef.text($footnoteHook.text());
var text = ('numeric' === type) ? footnoteNum : String.fromCharCode(96 + occurrenceCount);
$footnoteRef.text(text);
$footnoteRef.addClass("bfn-footnoteRef");
$footnoteRef.attr("href", "#" + $footnoteHook.attr("id"));
$footnoteRef.attr("id", $footnoteHook.attr("data-footnote-id"));

$footnoteRef.attr("href", "#" + footnoteHookId);
if('numeric' === type) {
$footnoteRef.attr("id", footnoteId);
} else {
$footnoteRef.addClass("bfn-footnoteRef-child");
}
return $footnoteRef;
},
generateFootnoteItem: function ($footnoteHook) {
generateFootnoteItem: function (logItem, postId, footnoteHookId, footnoteId, footnoteNum) {
var $footnoteItem = $("<li></li>");
$footnoteItem.addClass("bfn-footnoteItem");

$footnoteItem.append(betterFootnotes.generateFootnoteRef($footnoteHook));
$footnoteItem.append(this.generateFootnoteRef(footnoteHookId, footnoteId, footnoteNum, 1, 'numeric'));
$footnoteItem.append("&nbsp;");
$footnoteItem.append($footnoteHook.attr("data-footnote-content"));

if(logItem.count > 1 ) {
for(var x=1; x <= logItem.count; x++){
footnoteHookId = (x >1) ? this.generateFootnoteHookId(postId, footnoteNum, x) : footnoteHookId;
$footnoteItem.append(this.generateFootnoteRef(footnoteHookId, footnoteId, footnoteNum, x));
$footnoteItem.append("&nbsp;");
}
}
$footnoteItem.append(logItem.contentRaw);
return $footnoteItem;
},
generateFootnotesList: function(postId, $footenotes)
{
var $footenotesList = $(".bfn-footnotesList", $footenotes);

for(var i=0; i< this.occurrenceLog.length; i++)
{
var logItem = this.occurrenceLog[i];
var footnoteNum = i + 1;
var footnoteHookId = this.generateFootnoteHookId(postId, footnoteNum, 1);
var footnoteId = this.generateFootnoteId(postId, footnoteNum);

$footenotesList.append(this.generateFootnoteItem(logItem, postId, footnoteHookId, footnoteId, footnoteNum));
}

if (! $footenotesList.is(":empty")) {
$footenotes.show();
}
},
scrollTo: function (target, time) {
if (!betterFootnotes.isDefined(time) || time === false) {
time = 800;
Expand All @@ -118,6 +143,28 @@
} else {
return false;
}
},
getOccurrenceIndex: function(footnoteContent) {
for(var i=0; i< this.occurrenceLog.length; i++) {
if(this.occurrenceLog[i].content == footnoteContent) {
return i;
}
}
return -1;
},
logOccurrence: function(footnoteContent) {

var footnoteContentNorm = footnoteContent.toLowerCase();

if(this.options.groupFootnotes == 1 ) {
var occurrenceIndex = this.getOccurrenceIndex(footnoteContentNorm);
if(occurrenceIndex >= 0) {
this.occurrenceLog[occurrenceIndex].count++;
return occurrenceIndex +1;
}
}

return this.occurrenceLog.push({content: footnoteContentNorm, contentRaw: footnoteContent, count: 1});
}
};

Expand Down
2 changes: 1 addition & 1 deletion assets/js/better-footnotes.min.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions src/BetterFootnotes/src/Admin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,18 @@ public function registerSettingsFields()
]
);

add_settings_field(
'group_footnotes',
__('Group footnotes', 'better-footnotes'),
[$this, 'renderSettingsField'],
'better_footnotes',
'bfn_general',
[
'id' => 'bfn_group_footnotes',
'name' => 'group_footnotes',
]
);

// Strings
add_settings_section(
'bfn_strings',
Expand Down Expand Up @@ -199,6 +211,12 @@ public function renderSettingsField($args)
<?php esc_html_e('Append the footnotes list to post content automatically.', 'better-footnotes') ?>
</label>

<?php elseif ('group_footnotes' === $args['name']) : ?>
<label>
<input type="checkbox" id="<?php echo esc_attr($args['id']) ?>" name="<?php echo esc_attr($fieldName) ?>" value="1" <?php checked('1', Options::getOption($args['name'])) ?>>
<?php esc_html_e('Group repeated footnotes in one list item.', 'better-footnotes') ?>
</label>

<?php elseif ('scroll_gap' === $args['name']) : ?>
<input type="number" id="<?php echo esc_attr($args['id']) ?>" name="<?php echo esc_attr($fieldName) ?>" value="<?php echo esc_attr(Options::getOption($args['name'])) ?>" class="regular-text">
<br>
Expand Down
5 changes: 3 additions & 2 deletions src/BetterFootnotes/src/Main.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,9 @@ public function enqueueScripts()
'better-footnotes',
'betterFootnotesOptions',
[
'scrollGap' => Options::getOption('scroll_gap'),
'scrollSpeed' => Options::getOption('scroll_speed'),
'scrollGap' => Options::getOption('scroll_gap'),
'scrollSpeed' => Options::getOption('scroll_speed'),
'groupFootnotes' => (int) Options::getOption('group_footnotes'),
]
);
}
Expand Down
1 change: 1 addition & 0 deletions src/BetterFootnotes/src/Options.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ public static function getOptions()
'auto_append' => 'n',
'scroll_gap' => 0,
'scroll_speed' => 350,
'group_footnotes' => 0,
];

$options = get_option('bfn_opts', $defaults);
Expand Down