Obsidian Footnotes Plugin

This hotkey lets you:

Insert a new numbered footnote marker (e.g. [^1]) with auto-incremented index in your text
Insert a new named footnote marker (e.g. [^Citation]) in your text
Adds the corresponding footnote detail (e.g. [^1]: or [^Citation]: ) at the bottom of your text
Places your cursor so you can fill in the details quickly
Jump from your footnote TO the footnote detail
Jump from your footnote detail BACK to the footnote

IMPORTANT: You must to set up your footnote hotkeys

After installing and activating this plugin, you still have to SET UP your hotkeys. This is easy and quick:

Settings -> Hotkeys -> Search for "Footnote" -> Customize Command -> Your preferred hotkeys

I personally use:

Alt+0 as my auto-numbered footnote hotkey
Alt+- as my named footnote hotkey

Default Feature Details

Numbered Footnotes

Scenario: No previous numbered (e.g. "[^1]") footnotes exist:

Given my cursor is where I want a numbered footnote to exist (e.g. Foo bar baz▊)
When I hit auto-numbered footnote hotkey
Then a new footnote marker (e.g. [^1]) is inserted where my cursor was (e.g. Foo bar baz[^1])
And a new footnote details marker (e.g. [^1]: ) is inserted on the last line of the document
And my cursor is now placed at the end of the detail marker (e.g. [^1]: ▊)

Scenario: Previous numbered (e.g. "[^1]") footnotes exist:

Given there is one or more numbered footnotes in my text
And my cursor is where I want a numbered footnote to exist (e.g. Foo bar[^1] baz▊)
When I hit auto-numbered footnote hotkey
Then a new footnote marker with the next numbered index (e.g. [^2]) is inserted where my cursor was (e.g. Foo bar[^1] baz[^2])
And a new footnote details marker (e.g. [^2]: ) is inserted on the last line of the document
And my cursor is now placed at the end of the detail marker (e.g. [^2]: ▊)

Named Footnotes

Scenario: Add a named footnote:

Given my cursor is where I want a named footnote to exist (e.g. Foo bar baz▊)
When I hit named footnote hotkey
Then an empty footnote marker (e.g. [^]) is inserted around my cursor (e.g. Foo bar baz[^▊])
Then, I fill in the name I want (e.g. Foo bar baz[^customName])
When I hit named footnote hotkey again
A matching footnote details marker (e.g. [^customName]: ) is inserted on the last line of the document
And my cursor is now placed at the end of the detail marker (e.g. [^customName]: ▊)

Universal

Scenario: Jumping TO a footnote detail

Given I'm on a footnote detail line (e.g. [^1]: ▊)
When I hit auto-numbered footnote hotkey OR named footnote hotkey
Then my cursor is placed right after the first occurence of this footnote in my text (e.g. [^1]▊)

Scenario: Jumping BACK to a footnote

Given I'm on - or next to - a footnote (e.g. [^1]▊) in my text
When I hit auto-numbered footnote hotkey OR named footnote hotkey
Then my cursor is placed to the right of the footnote (e.g. [^1]: ▊)

Known Limitations or Untested Scenarios

Indices are not updated

Inserting new auto-numbered footnote in-between two existing footnotes will insert the next numeric index (e.g. 1, 3, 2).

It will NOT update the indices according to their natural order (e.g. 1, 2, 3).

Example sentence[^1] with two▊ footnotes[^2] already.
  
[^1]: Foo
[^2]: Bar

After insertion:

Example sentence[^1] with two[^3] footnotes[^2] already.
  
[^1]: Foo
[^2]: Bar
[^3]: Baz

See "Automatically Re-Index Footnotes" below for a proposed feature

Future Possible Feature Ideas

Suggest Existing Named Footnotes

When adding a new named footnote, suggest existing footnotes via an EditorSuggest popup. You can pick from the suggestions via arrow keys to save yourself typing if you want to repeat an existing footnote.

Demo of autosuggest in Templater

Automatically Re-Index Numbered Footnotes

Re-index and re-sort all auto-numbered footnotes when you insert a new one in-between one or more existing numbered footnotes:

Example sentence[^1] with two▊ footnotes[^2] already.
  
[^1]: Foo
[^2]: Bar

Base Scenario

Given there are two numbered footnotes already
When I enter a new numbered footnote in-between those two
Then the NEW footnote gets the index "2"
And the previously second footnote gets the index "3"
And the NEW footnote detail is inserted as the second entry at the bottom
And the previously second footnote detail at the bottom is updated to be "3"
And the previously second footnote detail at the bottom is updated to be in third position

Example sentence[^1] with two[^2] footnotes[^3] already.

[^1]: Foo
[^2]: Baz
[^3]: Bar▊

Edge Cases to consider ("What if...?")

What if... new footnote is inserted before the first footnote?

Some sentence▊ with existing note[^1]

[^1]: Details

What if... text has the same footnote at several places?

Some sentence with existing note[^1] and the same▊ footnote re-appears later[^1].


[^1]: Details

What if...Footnote details are spread across the text?

Some sentence with existing note[^1] some more text▊ 

[^1]: Inline footnote details

Another text part▊

What if... the footnote details are multi-line on the bottom?

Some sentence with existing note[^1] some more text▊ 

[^1]: The details that
Span across
Multiple lines

Background

This plugin is based on the great idea by jacob.4ristotle posted in the "Footnote Shortcut" thread.

Use case or problem:

I use Obsidian to take school notes, write essays and so on, and I find myself needing to add frequent footnotes. Currently, to add a new footnote, I need to:

scroll to the bottom to check how many footnotes I already have

type [^n] in the body of the note, where n is the next number

move to the end of the note, type [^n] again, and then add my citation.

Proposed solution:

It would be convenient to have a shortcut to automate these steps. In particular, I envision that the shortcut would: Using the smallest natural number n that has not yet been used for a footnote

add [^n] at the insertion point

add [^n]: to the end of the note, and move the insertion point there.

Comprehensive-Jason/obsidian-footnotes