obsidian-toggl-integration icon indicating copy to clipboard operation
obsidian-toggl-integration copied to clipboard

Feature: Description of timers and projects parsed as Markdown

Open mihaibirsan opened this issue 1 year ago • 5 comments

Feature

Interpret the description of time entries as Markdown. This enables using the description to link to project notes.

Before: Pasted image 20230331153910

After: Pasted image 20230331153945

Remaining work

Completed partially

  • [x] Add toggle in settings; default behavior should be not to interpret as Markdown (compatibility for existing users)
  • [x] Consider parsing project names as well
  • [ ] Consider limiting markdown parsing to links only
  • [ ] Update tests

mihaibirsan avatar Mar 31 '23 12:03 mihaibirsan

This is technically ready to ship.

Considered out of scope:

  • Consider limiting markdown parsing to links only
    • Using Obsidian's own parser, which doesn't allow for much customization; when this becomes a real user issue, we may add more granular control over the markdown parser (and even consider discarding the innerHTML trick)
  • Update tests
    • Codebase doesn't have UI tests at this time (perhaps open an issue?)

mihaibirsan avatar May 13 '23 18:05 mihaibirsan

Published a pre-release version with all 2 features and 1 fix currently in PR!

See 0.10.0+87c4156 for instructions on how to test!

mihaibirsan avatar May 15 '23 15:05 mihaibirsan

Cool feature!

IMO I think this is a very niche option, as most users probably don't want raw Markdown syntax in their time entries (since it's not rendered anywhere outside of Obsidian)

But I don't see any harm in releasing this since it's opt-in. I'll release it after doing some further testing.

mcndt avatar Jul 23 '23 12:07 mcndt

I have thought before to link projects to pages in the opposite direction, namely using the frontmatter of a note we can store to which Toggl project it is related. I think that makes the UX a little better for non-power users like yourself, what are your thoughts?

mcndt avatar Jul 23 '23 12:07 mcndt

Thanks for the review @mcndt! I had checked out for the past six months, focused on work. 😅

Linking projects to pages in the opposite direction makes sense! I can prototype something with it separately. I hadn't thought about that before.

I also didn't like how it made the Toggl interface less usable. (And tinkering with user scripts to parse Markdown everywhere turned out to be a pointless task.)

mihaibirsan avatar Feb 18 '24 07:02 mihaibirsan