fix #297; fix #292

Author: mProjectsCode

bun.lockb

@@ -10,4 +10,17 @@ action:
   type: "replaceSelf"
   replacement: "templates/templater/Templater Template.md"
   templater: true
+```
+
+```meta-bind-button
+label: Insert Text
+hidden: false
+class: ""
+tooltip: ""
+id: ""
+style: default
+action:
+  type: "replaceSelf"
+  replacement: "[[Templater Template]]"
+  templater: true
 ```

exampleVault/Buttons/Templater Buttons.md

@@ -23,6 +23,7 @@ import { expectType, openURL } from 'packages/core/src/utils/Utils';
 import { parseLiteral } from 'packages/core/src/utils/Literal';
 
 import { type NotePosition } from 'packages/core/src/config/APIConfigs';
+import { ErrorLevel, MetaBindParsingError } from 'packages/core/src/utils/errors/MetaBindErrors';
 
 export class ButtonActionRunner {
 	plugin: IPlugin;
@@ -31,6 +32,20 @@ export class ButtonActionRunner {
 		this.plugin = plugin;
 	}
 
+	resolveFilePath(filePath: string, relativeFilePath?: string | undefined): string {
+		const targetFilePath = MDLinkParser.isLink(filePath) ? MDLinkParser.parseLink(filePath).target : filePath;
+		const resolvedFilePath = this.plugin.internal.getFilePathByName(targetFilePath, relativeFilePath);
+		if (resolvedFilePath === undefined) {
+			throw new MetaBindParsingError({
+				errorLevel: ErrorLevel.ERROR,
+				cause: 'file not found',
+				effect: `could not resolve path or link "${filePath}" relative to "${relativeFilePath}"`,
+			});
+		}
+
+		return resolvedFilePath;
+	}
+
 	createDefaultButtonConfig(): ButtonConfig {
 		return {
 			label: 'This is a button',
@@ -288,7 +303,7 @@ export class ButtonActionRunner {
 		}
 
 		const replacement = action.templater
-			? await this.plugin.internal.evaluateTemplaterTemplate(action.replacement, filePath)
+			? await this.plugin.internal.evaluateTemplaterTemplate(this.resolveFilePath(action.replacement), filePath)
 			: action.replacement;
 
 		splitContent = [
@@ -329,7 +344,7 @@ export class ButtonActionRunner {
 		}
 
 		const replacement = action.templater
-			? await this.plugin.internal.evaluateTemplaterTemplate(action.replacement, filePath)
+			? await this.plugin.internal.evaluateTemplaterTemplate(this.resolveFilePath(action.replacement), filePath)
 			: action.replacement;
 
 		splitContent = [
@@ -362,11 +377,15 @@ export class ButtonActionRunner {
 			throw new Error('Line number out of bounds');
 		}
 
-		const replacement = action.templater
-			? await this.plugin.internal.evaluateTemplaterTemplate(action.value, filePath)
+		const insertString = action.templater
+			? await this.plugin.internal.evaluateTemplaterTemplate(this.resolveFilePath(action.value), filePath)
 			: action.value;
 
-		splitContent = [...splitContent.slice(0, action.line - 1), replacement, ...splitContent.slice(action.line - 1)];
+		splitContent = [
+			...splitContent.slice(0, action.line - 1),
+			insertString,
+			...splitContent.slice(action.line - 1),
+		];
 
 		await this.plugin.internal.writeFilePath(filePath, splitContent.join('\n'));
 	}

packages/core/src/fields/button/ButtonActionRunner.ts

@@ -5,14 +5,15 @@
 		createInputFieldFAQExamples,
 		VIEW_FIELD_EXAMPLE_DECLARATIONS,
 	} from 'packages/core/src/utils/InputFieldExamples';
-	import InputFieldExampleComponent from 'packages/core/src/utils/faq/InputFieldExampleComponent.svelte';
-	import ViewFieldExampleComponent from 'packages/core/src/utils/faq/ViewFieldExampleComponent.svelte';
+	import InputFieldExampleComponent from 'packages/core/src/utils/playground/InputFieldExampleComponent.svelte';
+	import ViewFieldExampleComponent from 'packages/core/src/utils/playground/ViewFieldExampleComponent.svelte';
 	import Button from 'packages/core/src/utils/components/Button.svelte';
 	import { ErrorCollection } from 'packages/core/src/utils/errors/ErrorCollection';
 	import { ErrorLevel, MetaBindExampleError } from 'packages/core/src/utils/errors/MetaBindErrors';
 	import { DocsUtils } from 'packages/core/src/utils/DocsUtils';
 	import { ButtonStyleType } from 'packages/core/src/config/ButtonConfig';
 	import { IPlugin } from 'packages/core/src/IPlugin';
+	import FlexRow from '../components/FlexRow.svelte';
 
 	export let plugin: IPlugin;
 
@@ -44,32 +45,37 @@
 </script>
 
 <div class="mb-faq-view markdown-rendered">
-	<h1>Meta Bind FAQ</h1>
+	<FlexRow>
+		<h1>Meta Bind Playground</h1>
+		<span>
+			<Button
+				variant={ButtonStyleType.PRIMARY}
+				on:click={() => {
+					DocsUtils.open(DocsUtils.linkToHome());
+				}}
+			>
+				Docs
+			</Button>
+			<Button
+				on:click={() => {
+					DocsUtils.open(DocsUtils.linkToGithub());
+				}}
+			>
+				GitHub
+			</Button>
+			<Button
+				on:click={() => {
+					DocsUtils.open(DocsUtils.linkToIssues());
+				}}
+			>
+				Report Issue
+			</Button>
+		</span>
+	</FlexRow>
 
-	<h2>Quick Access</h2>
-	<p>
-		<Button
-			variant={ButtonStyleType.PRIMARY}
-			on:click={() => {
-				DocsUtils.open(DocsUtils.linkToHome());
-			}}
-			>Docs
-		</Button>
-		<Button
-			on:click={() => {
-				DocsUtils.open(DocsUtils.linkToGithub());
-			}}
-			>GitHub
-		</Button>
-		<Button
-			on:click={() => {
-				DocsUtils.open(DocsUtils.linkToIssues());
-			}}
-			>Report Issue
-		</Button>
-	</p>
+	<h2>Quick Reference</h2>
 
-	<h2>Error Messages</h2>
+	<h3>Error Messages</h3>
 	<p>
 		When creating <a href={DocsUtils.linkToInputFields()}>Input Fields</a> or
 		<a href={DocsUtils.linkToViewFields()}>View Fields</a>
@@ -93,7 +99,28 @@
 		when clicked.
 	</p>
 
-	<h2>Input Fields</h2>
+	<h3>Unloaded Message</h3>
+	<p>
+		A message like this <span class="mb-warning">[MB_UNLOADED] ...</span> means that Obsidian told Meta Bind to unload
+		the field that was once displayed there. This usually happens when Meta Bind was disabled, such as after a plugin
+		update, or when another plugin is interfering with Meta Bind.
+	</p>
+	<p>Usually reopening the note or restarting Obsidian causes the field to display normally again.</p>
+
+	<h3>Bind Targets</h3>
+	<p>
+		<a href="https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/guides/inputfields/#binding-to-metadata"
+			>Bind Targets</a
+		>
+		let the plugin know what frontmatter properties to bind
+		<a href={DocsUtils.linkToInputFields()}>Input Fields</a>
+		and
+		<a href={DocsUtils.linkToViewFields()}>View Fields</a> to.
+	</p>
+
+	<h2>Playground</h2>
+
+	<h3>Input Fields</h3>
 	<p>
 		<a href={DocsUtils.linkToInputFields()}>Input Fields</a> let you change the frontmatter of your notes from inside
 		of notes.
@@ -103,7 +130,7 @@
 		<InputFieldExampleComponent declaration={example[1]} plugin={plugin}></InputFieldExampleComponent>
 	{/each}
 
-	<h2>View Fields</h2>
+	<h3>View Fields</h3>
 	<p>
 		<a href={DocsUtils.linkToViewFields()}>View Fields</a> let you view and perform calculations using the frontmatter
 		of your notes from inside of notes. They will update instantly to reflect changes to the frontmatter made by input
@@ -115,15 +142,4 @@
 			<ViewFieldExampleComponent declaration={example} plugin={plugin}></ViewFieldExampleComponent>
 		{/each}
 	{/each}
-
-	<h2>Bind Targets</h2>
-	<p>
-		<a href="https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/guides/inputfields/#binding-to-metadata"
-			>Bind Targets</a
-		>
-		let the plugin know what frontmatter properties to bind
-		<a href={DocsUtils.linkToInputFields()}>Input Fields</a>
-		and
-		<a href={DocsUtils.linkToViewFields()}>View Fields</a> to.
-	</p>
 </div>

packages/core/src/utils/faq/InputFieldExampleComponent.svelte renamed to packages/core/src/utils/playground/InputFieldExampleComponent.svelte

@@ -20,7 +20,7 @@ import { registerCm5HLModes } from 'packages/obsidian/src/cm6/Cm5_Modes';
 import { createMarkdownRenderChildWidgetEditorPlugin } from 'packages/obsidian/src/cm6/Cm6_ViewPlugin';
 import { DependencyManager } from 'packages/obsidian/src/dependencies/DependencyManager';
 import { Version } from 'packages/obsidian/src/dependencies/Version';
-import { FaqView, MB_FAQ_VIEW_TYPE } from 'packages/obsidian/src/faq/FaqView';
+import { PlaygroundView, MB_PLAYGROUND_VIEW_TYPE } from 'packages/obsidian/src/playground/PlaygroundView';
 import { MetaBindSettingTab } from 'packages/obsidian/src/settings/SettingsTab';
 import { ObsidianNotePosition } from 'packages/obsidian/src/ObsidianNotePosition';
 import { RenderChildType } from 'packages/core/src/config/APIConfigs';
@@ -98,7 +98,7 @@ export default class MetaBindPlugin extends Plugin implements IPlugin {
 		registerCm5HLModes(this);
 
 		// misc
-		this.registerView(MB_FAQ_VIEW_TYPE, leaf => new FaqView(leaf, this));
+		this.registerView(MB_PLAYGROUND_VIEW_TYPE, leaf => new PlaygroundView(leaf, this));
 		this.addStatusBarBuildIndicator();
 
 		if (this.settings.enableEditorRightClickMenu) {
@@ -259,18 +259,18 @@ export default class MetaBindPlugin extends Plugin implements IPlugin {
 		});
 
 		this.addCommand({
-			id: 'open-faq',
-			name: 'Open Meta Bind FAQ',
+			id: 'open-playground',
+			name: 'Open Meta Bind Playground',
 			callback: () => {
-				void this.activateView(MB_FAQ_VIEW_TYPE);
+				void this.activateView(MB_PLAYGROUND_VIEW_TYPE);
 			},
 		});
 
 		this.addCommand({
 			id: 'open-help',
 			name: 'Open Meta Bind Help',
 			callback: () => {
-				void this.activateView(MB_FAQ_VIEW_TYPE);
+				void this.activateView(MB_PLAYGROUND_VIEW_TYPE);
 			},
 		});
 

packages/core/src/utils/faq/FaqComponent.svelte renamed to packages/core/src/utils/playground/PlaygroundComponent.svelte

@@ -1,10 +1,10 @@
 import { ItemView, type WorkspaceLeaf } from 'obsidian';
-import FaqComponent from 'packages/core/src/utils/faq/FaqComponent.svelte';
+import FaqComponent from 'packages/core/src/utils/playground/PlaygroundComponent.svelte';
 import type MetaBindPlugin from 'packages/obsidian/src/main';
 
-export const MB_FAQ_VIEW_TYPE = 'mb-faq-view-type';
+export const MB_PLAYGROUND_VIEW_TYPE = 'mb-playground-view-type';
 
-export class FaqView extends ItemView {
+export class PlaygroundView extends ItemView {
 	component: FaqComponent | undefined;
 	plugin: MetaBindPlugin;
 
@@ -14,11 +14,11 @@ export class FaqView extends ItemView {
 	}
 
 	getViewType(): string {
-		return MB_FAQ_VIEW_TYPE;
+		return MB_PLAYGROUND_VIEW_TYPE;
 	}
 
 	getDisplayText(): string {
-		return 'Meta Bind FAQ';
+		return 'Meta Bind Playground';
 	}
 
 	// eslint-disable-next-line @typescript-eslint/require-await

packages/core/src/utils/faq/ViewFieldExampleComponent.svelte renamed to packages/core/src/utils/playground/ViewFieldExampleComponent.svelte

@@ -1,7 +1,7 @@
 import { type App, ButtonComponent, PluginSettingTab, Setting } from 'obsidian';
 import { DEFAULT_SETTINGS, weekdays } from 'packages/core/src/Settings';
 import { DocsUtils } from 'packages/core/src/utils/DocsUtils';
-import { MB_FAQ_VIEW_TYPE } from 'packages/obsidian/src/faq/FaqView';
+import { MB_PLAYGROUND_VIEW_TYPE } from 'packages/obsidian/src/playground/PlaygroundView';
 import type MetaBindPlugin from 'packages/obsidian/src/main';
 import { MetaBindBuild } from 'packages/obsidian/src/main';
 import { ButtonTemplatesSettingModal } from 'packages/obsidian/src/settings/buttonTemplateSetting/ButtonTemplatesSettingModal';
@@ -46,7 +46,7 @@ export class MetaBindSettingTab extends PluginSettingTab {
 			.addButton(cb => {
 				cb.setButtonText('Open FAQ');
 				cb.onClick(() => {
-					void this.plugin.activateView(MB_FAQ_VIEW_TYPE);
+					void this.plugin.activateView(MB_PLAYGROUND_VIEW_TYPE);
 				});
 			})
 			.addButton(cb => {