Code Monkey home page Code Monkey logo

obsidian-zettelflow's Introduction

Obsidian-ZettelFlow

GitHub release (latest SemVer) Github All Releases

Introduction: Designing Your Zettelkasten Workflow with the Obsidian-ZettelFlow

Welcome to the Obsidian-ZettelFlow - your essential solution for optimizing your Zettelkasten method within the Obsidian app. This innovative plugin empowers you to effortlessly configure a customized workflow, enabling the seamless creation of new notes while specifying properties, templates, and storage locations through the native canvas interface.

Navigating the Zettelkasten Approach: A Concise Overview

Zettelkasten, originally conceptualized by sociologist Niklas Luhmann, is a sophisticated technique for note-taking and knowledge organization. The method centers on the idea that insights are best captured as individual "Zettels," which are interconnected to form a dynamic network of ideas. This network encourages a deeper understanding and enhances creativity.

Introducing the Obsidian-ZettelFlow

Our plugin elevates the Zettelkasten experience by using visual canvas directly within Obsidian. This canvas serves as a blueprint for constructing a personalized workflow that streamlines the creation of new notes. As you design your canvas, you're effectively designing the structure and metadata of each note you'll generate.

Workflow Crafting: The Core Process

  • Select Your Canvas: Choose the canvas note that aligns with your note-taking style and preferences. This canvas defines the attributes and specifics of your notes-to-be.
  • Configure Note Elements: Begin designing your note by arranging elements on the canvas. These elements might represent properties, templates, or organizational criteria for your notes.
  • Establish Relationships: Define the relationships between canvas elements. These connections determine how your notes will be structured, tagged, or categorized once created.
  • Generate Notes Instantly: Once your canvas is refined, it becomes a template. When you're ready to create a new note, the plugin transforms your canvas configuration into a fully formed note in Obsidian.
  • Effortless Note-Taking: With a well-structured canvas, you're equipped to create notes with consistent attributes effortlessly. No more repetitive setups; it's all about instant productivity.

Embark on Enhanced Note-Taking Efficiency

The Obsidian-ZettelFlow revolutionizes the Zettelkasten approach by using the native canvas interface. This interface grants you the power to configure note properties, templates, and more, while expediting the note creation process. Experience the synergy of visual design and knowledge organization as you optimize your Zettelkasten workflow through this innovative plugin. Begin your journey towards a more efficient and structured note-taking experience today.

Support

If you enjoy ZettelFlow, consider buy me a coffee or sponsor me to support my work. Thank you!

GitHub Sponsors

"Buy Me A Coffee"

obsidian-zettelflow's People

Contributors

rafaelgb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

obsidian-zettelflow's Issues

Doesn't seem to want to create actions or interactions?

Not sure how to describe this one other than it seems like it's just not working. I'll include some screenshots here to help explain but I've tried uninstalling the plugin and reinstalling and even making a fresh vault and starting fresh. Maybe I'm missing something, hard to tell since I previously had the issue where the plug-in wouldn't enable, so haven't been able to set up a successful workflow yet.

Canvas was set and selected in settings. So far just two things on it, "Fleeting note" and what should be a prompt action.
image

When I go to edit the step for the Root fleeting note, it looks pretty sparse but that seems to be in-line with what normal root notes look like.
image

However when we go to look at the action note it too looks sparse.
image

When trying to add an action using the [+] button, I get nothing. Swapping to another action types produce the same effect.

The action names themselves look like maybe they're not rendering correctly as well, which is what I believe is maybe indicative of what the root cause of this issue is, but wouldn't know enough about the whole application to know how to fix it, but it's the one thing I can definitively say is different from what I've seen in other's screenshots.
image

usually they're labeled just "Prompt" or "Backlink" not "promptPrompt" etc.

I had some other plug-ins installed but have disabled/deleted them and just have ZettelFlow active, so don't believe that's the issue here.

If I go to create a note, it does recognize the root note, but won't let me progress through the dialogue modal.
image

not sure what the red note icon is but seems different as well.

Hopefully this is resolvable, as it seems like a very cool system/plugin!

New node type: Script file

option to just DnD a JS file into the canvas and execute it

  • Include a config property with a path of js files as library
  • Editor for files (right click to modal or native editor view with a toggle option => another js editors compatible)
  • Add js files as node option on canvas
  • Cache per builder external libs

Manage recursive steps

Find a way to work with posible recursive steps and control the errors related with save the configuration in that case

Modal step creator

Current Possibilities:

  • bridge
  • prompt

Manage the Zettelkasten settings for every option with a form

Load commands palette triggers the modal

When I click on the sidebar icon, an empty window appears.

image

When the plugin is activated when accessing the command palette the same thing happens.

image

SYSTEM INFO:
Obsidian version: v1.4.5
Installer version: v1.3.5
Operating system: Windows 10 Pro 10.0.22621
Login status: logged in
Catalyst license: insider
Insider build toggle: on
Live preview: on
Legacy editor: off
Base theme: dark
Community theme: Minimal v7.2.1
Snippets enabled: 16
Restricted mode: off
Plugins installed: 192
Plugins enabled: 4
1: Dataview v0.5.56
2: Style Settings v1.0.6
3: ZettelFlow v0.0.3
4: Minimal Theme Settings v7.2.2

new action: JS script

Implementation of a pipeline concept where we can execute code with a defined I/O JSON

  • run JS correctly
  • js editor to construct scripts
  • Autocompletion functions
  • Refactor of note builder to create the note after the actions
  • Documentation

First steps of settings

  • CRUD for root flow options of zettelkasten in settings
  • CRUD of properties for every flow option in settings
  • First step to CRUD of add Childs into flow options/ sections

API for other plugins to create their own workflows and steps

Each plugin will have 2 configurations:

  • path of the canvas with the workflow
  • an Object with the persisted workflow once is configured

Also the idea of create its own steps:

  • settings handler to define the properties that will be used
  • icon
  • UI Component to render for the step
  • logic to execute once the note is built

Search and keyMap on Select component

To improve the experience of use:

  • Include arrow keyMaps to navigate the options of a select component
  • In case of any other key is pressed, open a search to filter the available options

improve save canvas experience

currently the canvas is saved when he canvas note is opened or the open-file is triggered ( resizing or focus actions)

A save button or a visual feedback when something is not saved yet could help

add action: Add link of this note into another one

With the idea of add the note into a Kanban note , could be a nice idea to include a link to some section of another note (top or bottom)

  • preconfigure the link of the note and the section but you can modify it in the own action

Provide installation instructions

I didn't think I was a newbie but I am not able to install this plug-in. This plug-in does not appear in the community plug-ins section in the app so I attempted to install it by dropping the source folder into the hidden plugins directory. After doing this, I still was not able to find the plug anywhere in the plug ins listing.

If there is some step I am missing, perhaps an install guide would be helpful. I read the readme and it did not offer any guidance.

Refactor the way of save the workflow

factor the way of save the workflow to just read the file instead of use an event every time the canvas is opened

The reason it is to allow a future capacity to offer multiple configurations

Bug: Cannot enable plugin

Hi RafaeGB,

after I successfully installed the plugin in Obsidian, enabling it fails with the error message "Failed to load plugin Zettelflow".

Looking into the console log the following message appears:

grafik

Any ideas how to resolve this?

Best,
jtvilm

Basic Shortcuts

  • Open canvas of the workflow
  • Modal: create a new note
  • Modal: create new canvas step (#8)

Use of canvas group as node of selection

Currently we can't use the groups of the canvas for the workflow configuration.

The idea will be to allow selector menus with all the nodes inside the group

  • Nested groups
  • group node works with all of nodes

Preview mode for the note

a button or a bottom of the modal to show the note that will be created at the current step or some info about the flow

  • elements added and with the name of the action
  • paths added and how many times

rename the project so it's findable

this project is called obsidian-zettlelflow which makes it impossible to find because the correct spelling is ZETTEL so suggest renaming the project to obsidian-zettelflow or just zettelflow for simplicity and to help people searching for zettelkasten plugins to find this one.

Good luck.

new action - tags

A multiple selector to add dynamically tags into the built-in note

Action with no UI inside multiple actions cut the chain

To reproduce the problem

---
zettelFlowSettings:
  root: false
  label: Choose priority
  childrenHeader: ""
  optional: false
  actions:
    - type: selector
      key: priority
      label: choose a priority
      options:
        "1": The most important thing
        "2": Urgent
        "3": Moderate
        "4": Minor
        "5": Trivial
      defaultOption: "3"
      hasUI: true
      description: Priority of the task
    - type: prompt
      key: description
      label: description of the task
      placeholder: |-
        write your objetive 
        here...
      hasUI: true
      description: Description of the task
      zone: body
    - type: backlink
      hasDefault: true
      defaultFile: path/to/file
      defaultHeading:
        heading: ๐Ÿ“ Backlog
        level: 2
        position:
          start:
            line: 6
            col: 0
            offset: 32
          end:
            line: 6
            col: 13
            offset: 45
      hasUI: false
      insertPattern: "- [ ] {{wikilink}}"
      description: Add task to Kanban
    - type: calendar
      description: Deadline of the task
      key: deadline
      label: Deadline
      hasUI: true
  targetFolder: path/to/file
---
# Description
{{description}}

Once the chain arrives to backlink, the process finishes

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.