Skip to content

Conversation

@netlimpopo
Copy link

Hello!

This is my first github contribution ever :-).

script content

This script generates a list of clickable links which map to every single .md note within the active note folder (= "Map of contents (M.O.C.)"). It displays the links in a table format along with the relative filepaths of the files. Furthermore it sorts the links in alphabetical order.

The difference to the "Table of Contents" script lies in the fact, that the T.O.C script creates links to headings of the same document whereas this M.O.C. script creates references to every single notename in the active note folder.

Usage

  1. Select the highest folder hierachy (!).
  2. Create a new note with an arbitrary name in the highest note hierachy (note level).
  3. Click the M.O.C button in the script menu. Then the script will overwrite all of the current note content and will insert the linkslist.

Warning

Note that all of the content of the selcted note will be replaced by the table of contents link list. Therefore it is essential to create a new note and exclusive use this note for the M.O.C list.

automatic updates

In case you rename a note, the markdown links in the M.O.C will be automatically updated too, as QOwnNotes watches all markdownlinks and checks links for necessary updates.

However, if one creates a new note anywhere, the script must be excecuted again, as it will otherwise not watch for file additions nor will it add a new link to the list.

Also if you want to move the M.O.C file to a different location, all the links will be updated accordingly thanks to the QOwnNotes logic.

"authors": ["@netlimpopo"],
"platforms": ["linux", "macos", "windows"],
"version": "0.0.1",
"minAppVersion": "25.12.07",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use 25.12.7 please, just to make sure it is detected correctly?

@pbek
Copy link
Member

pbek commented Dec 30, 2025

Thank you for your contribution! Does your script do something different from https://github.com/qownnotes/scripts/tree/master/insert-toc? Edit: Seems it looks for other notes. 👍🏻️

@@ -0,0 +1,10 @@
{
"name": "Insert Table of Contents II (M.O.C. Map of Contents)",
"identifier": "insert-table-of-contents-II-map-of-contents",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The identifier needs to match the directory name and file base-names.

{
"name": "Insert Table of Contents II (M.O.C. Map of Contents)",
"identifier": "insert-table-of-contents-II-map-of-contents",
"script": "insert-table-of-contents-II-map-of-contents.qml",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here. Please use insert-moc.qml.

@@ -0,0 +1,10 @@
{
"name": "Insert Table of Contents II (M.O.C. Map of Contents)",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Best remove the Insert, just the name is enough

@pbek
Copy link
Member

pbek commented Dec 30, 2025

And the JSON file needs to be insert-moc/info.json. See: https://github.com/qownnotes/scripts?tab=readme-ov-file#contributing

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.

2 participants