Configurable Option for Other "Trigger" Character Prefixes Besides Double Hyphen

creativeincode commented 4 months ago

Is your feature request related to a problem? Please describe. As a developer & writer using Obsidian on various iOS devices, it's frustrating having to turn off "Smart Punctuation" to use this amazing Bible verse plugin! I really miss having double hyphens auto-convert into an "em dash"! 🥲 And I also miss my double quotes automatically getting cleaned up, yet another helpful feature of "Smart Punctuation." Basically, I shouldn't have to disable an incredibly "core" UX feature of iOS to use this Bible plugin.

Describe the solution you'd like

I would like to propose "++" as an alternative option to "--" for serving as a selectable trigger character prefix.
Modify the "regs.ts" file to add a new "alternative" option for the shortcode regex to use "++" at the front of the pattern being matched instead of the current "--".
It'd be nice to have a configurable setting for this in the plugin settings to allow users to switch between different "trigger" characters/prefixes like double plus "++" vs. being locked into "double hyphen" (currently hard-coded in regs.ts). This configurable setting could be implemented as a drop-down, but it at least needs to be a basic toggle switch to allow the user to switch between the current "double hyphen" delimiter and an alternative (e.g. "++") to trigger the verse lookup functionality of the Bible Reference plugin.

Describe alternatives you've considered

Other double character sequences could probably be considered as well, as long as they do not conflict with other core Obsidian features or prominent 3rd party Obsidian community plugins!
Eventually, we might consider implementing a feature the user to specify their own custom character "prefix" to trigger verse lookup—obviously, that's probably MUCH more involved & complicated to implement as a feature!

Additional context This essentially solves & provides a solid workaround to the "Smart Punctuation" conflict encountered by iOS users like me who don't want to turn off "Smart Punctuation" and want to continue enjoying the benefits, like "em dash." ☺️

tim-hub commented 4 months ago

This is a good idea I think.

Similar to another feature request to allow users to customise the trigger.

tim-hub commented 3 months ago

add ++ to make it easy to work on ios for now

I will trye to allow user to configure this in the future

tim-hub commented 3 months ago

check release 2.5.0

creativeincode commented 2 months ago

@tim-hub Thank you for implementing this—it's working great & helping so much! 🙌 God bless you bro.

tim-hub / obsidian-bible-reference

Configurable Option for Other "Trigger" Character Prefixes Besides Double Hyphen #182