Events, part 1

[Taitava]

Discussed in #60

Events that will be implemented now:

• When Obsidian is opened (more specifically, this would actually be: when the plugin is loaded). This would allow a user to open a set of tool applications every time they open a certain Obsidian vault, e.g. GIMP for manipulating note related images.
• When Obsidian is closed.
• Every n seconds (seconds could be later changed to a decimal number, allowing executing something e.g. every 0.5 seconds if needed)
• Command palette: Currently this is the only action that can launch shell commands. It's included in this list to mark that a user can also turn it off, if they use other launchers for a shell command. Turn off = means that a shell command would not appear in command palette.
• When a user switches the active panel. Example: Execute a shell command that reads the current file's last modification time and outputs the information to status bar (the status bar output feature is still under planning, see #16 ). The event helps to automatically give information for the file that is currently actively viewed in Obsidian.
• Context menus: This would allow a user to define a new item in context menus (editor context menu, file navigation context menu, what else are there?). By clicking that context menu item, a shell command is executed, with possible event related variables like to what file was the context menu related to, or to what position in the editor.

New variables:

• {{event_file_extension}}
• {{event_file_name}}
• {{event_file_path}}
• {{event_folder_name}}
• {{event_folder_path}}
• {{event_tags}}
• {{event_title}}
• {{event_yaml_value}}

Other things:

• Write documentation for the new events.
• Write documentation for the new variables.
• Add See also sections to variable documentation, will contain links to similar variables.
• Write example events to documentation.
• Add links to each event's documentation page in settings.
• Create tests for events.

[DaveyUS]

What are the chances we could get an event that triggers when a link is clicked with a {{event_link_text}} variable?

A usage example would be when clicking [[audiofile.mp3]] the event would trigger allowing me pass the mp3 name to a python script.

Amazing plugin btw!

[Taitava]

What are the chances we could get an event that triggers when a link is clicked with a {{event_link_text}} variable?

A usage example would be when clicking [[audiofile.mp3]] the event would trigger allowing me pass the mp3 name to a python script.

Thanks for the question! 🙂 To keep idea discussions separate from implementation issues, I answered your question in this events related discussion: #60 (comment)

Amazing plugin btw!

Thank you! 😎

[Taitava]

Released.