Skip to content

Patch 1 - Notes now separates [[maker]] from [[ general notes]]#89

Open
iantierney wants to merge 4 commits into
lmparppei:masterfrom
iantierney:patch-1
Open

Patch 1 - Notes now separates [[maker]] from [[ general notes]]#89
iantierney wants to merge 4 commits into
lmparppei:masterfrom
iantierney:patch-1

Conversation

@iantierney

@iantierney iantierney commented May 27, 2026

Copy link
Copy Markdown

[[maker]] notes are displayed and handled differently in Beat.
People use them for different purpose to general notes
So I've separated markers out.

I've done some basic testing all along the way, but let me know if you need me to go deeper before a merge,

iantierney and others added 4 commits May 27, 2026 18:57
Add a description for the Keywords plugin to improve documentation.
Removed header comment with title and description.
@lmparppei

Copy link
Copy Markdown
Owner

Keywords plugin is by @bode-p. He should check these changes before I can merge the request.

@bode-p

bode-p commented May 28, 2026

Copy link
Copy Markdown
Contributor

@iantierney

Hello,

What exactly are you trying to accomplish? You want to remove the keyword/tag pill from the notes ui?

@lmparppei

Copy link
Copy Markdown
Owner

On a quick read-through, one of the commits seems to refactor a ton of code with mostly stylistic choices (whitespace usage etc.) and breaks some parts into a separate method. If you make changes to code (especially other people's code) you should always explain the reasoning and what you tried to accomplish. Purely stylistic commits are not necessary, unless for a very good reason – and even if that's the case, commit stylistic/syntactic fixes separately with a helpful message and description.

If you refactor code written by someone else, try to explain why you are doing that. Most of the new code in 7a0f815 doesn't seem to do anything new.

@iantierney

iantierney commented May 28, 2026

Copy link
Copy Markdown
Author

Thanks guys.

It simply handles [[marker notes]] in a separate list to [[other notes]].

People use different types of notes for different things.

For example, I use [[markers]] for todos, and [[notes]] for research.

Having these in separate lists and with check boxes is REALLY handy. (yes you could filter them.)

Also I added some optimisations which makes parsing quicker.

Also now the GUI doesn't print the word marker, as its markup.

I was also thinking of using the revision system to mark notes as done, when you checkbox them.

This would have two benefits:

  • you could view which notes are done in the docs.
  • store the data in an existing system.

Let me know if you need more comments.

@bode-p

bode-p commented May 28, 2026

Copy link
Copy Markdown
Contributor

Ohh, gotcha. I haven't been able to properly review this, as I'm trying to meet a deadline on a project. I'll take a look sometime next week. FYI: I've been meaning to push a commit for Keywords, as the current public build is a bit behind the dev build.

@iantierney

iantierney commented May 29, 2026

Copy link
Copy Markdown
Author

Ah ok.
Basically keywords felt like the missing piece of Beat for me.
Apologies if went too far refactoring/optimisation for such a small change.
It was rude of me, and perhaps not useful. (I find it hard enough to understand my own code,let alone someone else's!)

Let me add some more comments, and see if that helps.

When you get sometime, let me know what you think about these ideas:

Group markers by Act/Scene

Using revision system to mark notes as done,

when you checkbox them in keywords they are marked as done using the revision system.

This would have two benefits:

  1. you could view which notes are done in the docs.
  2. store the data in an existing system.

I've made an implementation plan and tried to prompt any backwards compatibility issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants