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.

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

Allow custom link text in wiki links #373

Closed
srid opened this issue Sep 6, 2020 · 6 comments · Fixed by #624
Closed

Allow custom link text in wiki links #373

srid opened this issue Sep 6, 2020 · 6 comments · Fixed by #624
Labels
good first issue Good for newcomers NeuronNG/Done Done in Neuron-NG proposal Proposal with exact spec yet to be fleshed out Zettel Format Anything that affects the structure of the zettel text

Comments

@srid
Copy link
Owner

srid commented Sep 6, 2020

Proposed syntax:

[[ foo | a foo note ]]

Open question:

Does this play well with notable plain-text Zettelkasten apps (Obsidian, Zettlr)? If not, what would be a more suitable syntax?

@srid srid added proposal Proposal with exact spec yet to be fleshed out Zettel Format Anything that affects the structure of the zettel text labels Sep 6, 2020
@MaienM
Copy link

MaienM commented Sep 7, 2020

It (mostly) works as expected in Obsidian and Foam. Zettlr doesn't support this syntax.

Obsidian

Obsidian doesn't lookup the titles of the zettelkasten files for me, but it does use a title if one is provided with the proposed syntax.

Source:
2020-09-07-190018_394x30_scrot
Preview:
2020-09-07-190031_262x24_scrot

Foam

Just like Obsidian, with the added oddity that it preserves the surrounding [[ and ]] (regardless of whether a custom title is provided).

Source:
2020-09-07-190051_433x28_scrot
Preview:
2020-09-07-190101_252x22_scrot

Zettlr

Zettlr does not (and will not) support this syntax. They mention a hack that sort-of works in their documentation in the form of [name]([[id]]), but it has some drawbacks.

@srid srid added this to the 1.0 milestone Sep 12, 2020
@srid srid pinned this issue Sep 13, 2020
@srid
Copy link
Owner Author

srid commented Sep 18, 2020

@MaienM Thanks for checking -- so it looks like we should just go with the proposed syntax [[ foo | custom text ]].

As for Zettlr, well I guess Zettlr users should just refrain from using custom link text then. /cc @EyebrowHairs

@EyebrowHairs
Copy link

EyebrowHairs commented Sep 18, 2020

We could use [this kind of custom text](right.md)?

@srid
Copy link
Owner Author

srid commented Sep 18, 2020

@EyebrowHairs That already works in neuron, however those links will be always non-branching (non-folgezettel).

With wiki-links, you can make them folgezettel, i.e., [[right | this kind of custom text]]#.

@MaienM
Copy link

MaienM commented Sep 18, 2020

Just to clarify: Zettlr wasn't showing any of my wikilinks, regardless of whether I was trying to name them. I looked into it briefly and found out it does not support this syntax, and they intend to keep it that way. I've updated my previous post to include this.

@linusboyle
Copy link

May I know the progress on this? It seems like the last missing feature I need.

@srid srid added the good first issue Good for newcomers label Nov 17, 2020
@srid srid changed the title Allow custom link text in zettel links Allow custom link text in wiki links Apr 28, 2021
@srid srid added the NeuronNG/Done Done in Neuron-NG label May 13, 2021
@srid srid closed this as completed in #624 May 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers NeuronNG/Done Done in Neuron-NG proposal Proposal with exact spec yet to be fleshed out Zettel Format Anything that affects the structure of the zettel text
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants