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

Feature Request: Custom Template #11

Open
bryanwhiting opened this issue Jan 15, 2025 · 7 comments
Open

Feature Request: Custom Template #11

bryanwhiting opened this issue Jan 15, 2025 · 7 comments
Labels
enhancement New feature or request planned

Comments

@bryanwhiting
Copy link

FYI - i just downloaded this yesterday and I was thrilled. Amazing. It's going to open worlds for me. If you have a coffee link please let me buy you one!

Is your feature request related to a problem? Please describe.
Template integration. Similar to #4 in a way, but different. I'm not talking about own prompts, but the formatting of the document.

Describe the solution you'd like
Right now it just has "transcription + summary + mermaid", etc.

What if in the settings you could expose a customizable box like this:

Default Template:

---
source:
created_by:
---

# Transcript
{{audio_link}}

# Summary
{{ai summary}} {{prompt: "Give 3 bullet points"}}

# Mermaid Chart
{{mermaid}}

And then the user could customize it like this if they want to remove the mermaid diagram, or update the tags/created date.

---
source:
created_by:
tags:
created: {{date:yyyy-mm-dd}}
---

# Transcript
{{audio_link}}

# Summary
{{prompt: "Give 3 bullet points describing {{transcript}}" }}

Describe alternatives you've considered

The following plugins already do something like this:

  • ReadItLater or
  • Obsidian WebClipper (Chrome extension)
  • Linter

They have mini-templates inside the settings that let you easily define what content you'd like where.

@Mikodin
Copy link
Owner

Mikodin commented Jan 15, 2025

Heya @bryanwhiting , thanks for feedback!
This sort of functionality should be covered in the other feature request!

I really appreciate surfacing the idea for the customizable box and doing it that way! That may be an easy way for me to approach doing this!

I'm super glad that you are getting use out of this and I most definitely hope it opens up worlds for you, it most definitely has for me!

I'd be honored to receive a coffee from ya, my link is here
https://buymeacoffee.com/mikealicea

@bryanwhiting bryanwhiting changed the title Feature Request: Custom Templat Feature Request: Custom Template Jan 16, 2025
@bryanwhiting
Copy link
Author

Coffee sent!

I'd also like to customize the filename. Is that covered in the prior PR?

YYYY-MM-DD-HHMM - title is my preferred way, as all of my files are datetime-stamped and putting scribe-Y-M-D throws off the alphabetical sort.

@bryanwhiting
Copy link
Author

I'm seeing this:

https://github.com/Mikodin/obsidian-scribe/blob/main/src/util/fileUtils.ts#L21

and this

const llmFileName = `scribe-${moment().format('YYYY-MM-DD')}-${normalizePath(llmSummary.title)}`;

as hard-coded. it'd be great if those were parameterized per settings!

@bryanwhiting
Copy link
Author

and this can also be parameterized as it is in Linter (as you already know):

await plugin.app.fileManager.processFrontMatter(noteFile, (frontMatter) => {
const newFrontMatter = {
...frontMatter,
source: [...(frontMatter.source || []), `[[${audioFile.path}]]`],
created_by: '[[Scribe]]',
};

The other part is the prompting, but that's a separate opportunity.

@Mikodin
Copy link
Owner

Mikodin commented Jan 17, 2025

I'd also like to customize the filename. Is that covered in the prior PR?

YYYY-MM-DD-HHMM - title is my preferred way, as all of my files are datetime-stamped and putting scribe-Y-M-D throws off the alphabetical sort.

Ah, this we can break out as a separate feature, I can get to this over the weekend!

The templating I am beginning to work on and what's taking shape right now is a solid improvement into how I add the notes to the file 🚀

Here's the feature request for this
#12

@Mikodin
Copy link
Owner

Mikodin commented Jan 17, 2025

@bryanwhiting Thank you so much for the donation man, it's a really nice thing to receive, thank you 🙏

@Mikodin
Copy link
Owner

Mikodin commented Jan 20, 2025

Coffee sent!

I'd also like to customize the filename. Is that covered in the prior PR?

YYYY-MM-DD-HHMM - title is my preferred way, as all of my files are datetime-stamped and putting scribe-Y-M-D throws off the alphabetical sort.

@bryanwhiting Just pushed this update closing out #12

Thanks for the input!

You can now do this, in the Scribe settings, just set your prefix to {{date}} -
and your Date format to YYYY-MM-DD-HHMM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request planned
Projects
None yet
Development

No branches or pull requests

2 participants