andrewbrereton / obsidian-to-ical-plugin Goto Github PK

hello

The 🔁 is an icon used by the Tasks plugin
https://publish.obsidian.md/tasks/Getting+Started/Recurring+Tasks

It would be better if the information associated with this icon was not visible on the calendar

Hi,

Thanks for the cool plugin. I might be the only person in the world who uses the Dataview format for tasks rather than the emoji format. That is, [scheduled:: <date>] instead of ⏳<date>, etc. (Changing to the emoji format now prevents the tasks plugin from reading any of the tasks, so that's not a viable option at the moment.)

The iCal plugin still seems to be finding all of the dates correctly. They are being displayed in the calendar with the dates removed, but the surrounding square brackets and marker are still present:

I've never done any Obsidian plugin development, but I may be able to tinker with this myself. I suppose it could be straightforward to replace the emojis with their respective Dataview properties in TaskDate.ts and TaskSummary.ts, and then provide the user with an option in the settings. Is this all that would need to be changed?

Thanks

Allow users to choose whether they want to save the iCalendar file to disk and/or to Gist.

• Add setting so user can save the iCalendar file to disk
• Add setting to user can choose where the file should be saved to
• Add setting to user can choose the file name
• Change Gist settings so that they are optional
• During saveCalender(), interrogate settings to see if we should save to disk (and where) and/or save to Gist

Hi @andrewbrereton

As I understand how the plugin works, this one follows the following logic: 

1. if there's only one planning date, it's also used as a due date... and therefore appears in the export calendar on that date.
2. if there is only a due date, it is exported as a due date.
3. if there is both a planning date and a due date, the due date is given priority in the agenda (even if both exist in the file).

This behavior is quite logical in a pure planning strategy, but poses a bit of a problem in a GTD logic. In GTD, it's the planning dates that are important (when I decide to do it) and the due dates, when they exist, are indicative. Not every task has a hard deadline.

I'd like to find a solution to this problem. Would you be interested?

One solution might be to export tasks with only a deadline with an emoji 📅 and tasks with only a schedule with an emoji ⌛ (this follows the plugin in obsidian). For tasks with both, the task would be duplicated with a first task including 📅 and a second including ⌛

hello

- [ ] [[COCONUT]]
- [ ] [[APPLE|BANANA]]

In this case, these events are created

It would be cleaner to see only the event names COCONUT and BANANA

I think it would look better to hide the square brackets

This ticket is to discuss about wether or not it would be a good idea to create a singleton to store global settings as mentioned here

Uses:

• Show when scanning Vault
• Show when saving to file
• Show when uploading to Gist
• Show last update date/time
• Show if error writing to disk
• Show if error uploading to Gist

I created a task that doesn't include 🛫 in the task

In this case, DTSTART and DTEND will not be generated

Hi @andrewbrereton

First of all, thank you for this plugin. I've been waiting for this for a long time and it's a turning point for me. I want to export to local (.ics) for reading via thunderbird.
If I make a parameter change, the export goes well the first time but after 5 min (default time) the update doesn't work. I get no error message in the obsidian console. 🤔

I develop this plugin inside a vault that has Markdown files containing all types of tasks. While testing a feature, I will run the plugin and manually check that the output matches my expectations.

Improvements I want to make:

1. Add this test vault to the source code,
2. Symlink the plugin into the vault so that the plugin is at the root and the test vault is in a child directory. This means I can still open the vault in Obsidian and it will load the plugin in my development environment,
3. Create a way to unit test the logic so that a given line generates the expected VEVENT/VTODO iCalendar block,
4. Write a suite of unit tests to test all functionality and configurations programmatically,
5. Add a package script for bun run test, and
6. Add bun run test to the release workflow.

https://datatracker.ietf.org/doc/html/rfc5545#section-3.1

Lines of text SHOULD NOT be longer than 75 octets, excluding the line break. Long content lines SHOULD be split into a multiple line representations using a line "folding" technique. That is, a long line can be split between any two characters by inserting a CRLF immediately followed by a single linear white-space character (i.e., SPACE or HTAB). Any sequence of CRLF followed immediately by a single linear white-space character is ignored (i.e., removed) when processing the content type.

For example, the line:

DESCRIPTION:This is a long description that exists on a long line.

Can be represented as:

DESCRIPTION:This is a lo
 ng description
  that exists on a long line.

Context: .ics, .icalendar

First, thank you a lot. I was searching for something to synchronize my tasks with my calendar and this plugin is just perfect.

This would be even more perfect if the .ics file would also be populated with unscheduled tasks as "todo". I've try with both .ics and .icalendar format but does not seem to load the tasks.

This is compatible with .ics and .icalendar format:

BEGIN:VTODO
SUMMARY:Name
DESCRIPTION:Blablabla
STATUS:NEEDS-ACTION
PRIORITY:0
SEQUENCE:0
END:VTODO

This could be then enabled with a boolean switch in settings.

Thanks in advance

hello

'[[wikilink|custom display text]]' is visible

but '[[wikilink]]' is not visible

Is this an intended feature?

and...

could an option be added to make "A Different Name" visible when writing [[asd123|A Different Name]]?

Thank you for listening to my many requirements

I often have lots of tasks in a day but only need to calendar schedule a few of them that are really important. It'd be helpful if (say) a tag could be used to filter in (or out) tasks that go into the ics file.

[Nice work by the way. I found this only recently and will pull this into my workflow. At a quick test, it looks like the ics file can also be used with BusyCal on Mac]

Currently a manual process which is prone to error. Write a little script to get the current version and update to the next major.minor.patch. It could tag too I suppose.

When creating a task with Day planner, the text is prefixed with time

It would be nice to set this to the event time

Hi @andrewbrereton

Unless I'm mistaken, when a task is completed, it's simply marked with an icon ✅. This is very practical, but it would be even more so if the date were changed to match the completion date. Very useful when you visualize everything in a calendar.

For example. An event planned for tomorrow but finally carried out today could appear as ✅ today. For this to happen, the scheduled date would have to be adjusted. Without affecting the due date.

Eventually, "Initial planning: 2024-02-20" could appear in the description for those who need to keep track.

Your opinion about this ?

https://github.com/andrewbrereton/obsidian-to-ical-plugin/tree/6-render-calendarin-sidebar#how-to-generate-a-github-gist-id

Is the plugin not available yet?

I'm not being consistent. Linting will help.

test

I use SyncThing to synchronise my files between different devices. Occasionally SyncThing will encounter a sync conflict, and when this happens, it created a conflict file.

Example:

Because the conflict file is also a valid Markdown file, iCal sees this and adds it to the calendar. This is causing duplicate events.

iCal should ignore Markdown files that match this:

*.sync-conflict-*.md

Some people will have enormous calendars. Some people will not care about events from 1 day or a week ago or 1 year ago. Give them the option to exclude events from the past.

When I start Obsidian, the plugin executes but finds 0 Markdown files. Subsequent executions are fine.

It's as though the plugin is starting before Obsidian has initialised.

This may be related to #27

If we use the Location and link to the file that the task appears in (eg: obsidian://vault/other_vault/note then we may be able to click on an event in the calendar and open the file that it came from.

As a non coder I tried to connect gist with iCal plugin so that I can connect it with google calendar but it is not working. As I am also unfamiliar with github so is there any clear instruction which I could follow? It would be helpful.

So far I created a personal access token but I don't know whether I created it right or wrong. It was asking so many permission but I allowed the gist permission. I connected a random repository to it. Then I created the token and put its code in ical plugin.

Then I created a gist by watching a youtube video. I created a random readme .md file so that it allow me to create a gist but after that I don't know where to find its ID to put it in plugin.

And also I don't see any option to connect it with google calendar. That's why I got confused and opened this issue. Could you please help me🙏.

Add a setting so users can configure their preferred date format. Alternatively, am I able to extract the "date format" from the "Daily Planner" and/or "Day Planner" plugins?

Originally posted by @nilvanlopes in #65 (comment)

Hi,

In my day-to-day work I have tasks that start and tasks that finish. At present, they are all presented with the following emoji 🔲

I'd find it very useful to be able to distinguish between them (either visually, or in the description) ?

hello

obsidian://open?vault=OBvault&file=Inbox/TEST 01.md.md
this url does not work

obsidian://open?vault=OBvault&file=Inbox%2FTEST%2001.md.md
i modified it like above and it worked

Hi, thanks a lot for the plugin!

I've been trying to integrate it into my workflow, where I have a folder for Daily Tasks, and then other folders with all kind of tasks for long-term planning, project management, etc. For my use case, I want to have my personal daily tasks on an external calendar, which are only those within the Daily Tasks folder, but as of now all tasks are considered (unless I tag all wanted/removed tasks).

Feature request: Add a "Root path" setting which selects the folder from which start looking for tasks. By default, it is the Vault root, so functionality remains the same.

Besides my specific use case, I think having this option could be quite helpful to other uses, and should be easy enough to add.

Hi @andrewbrereton

Since you suggested it... 😃

Another idea came to me recently, so I'm writing it down here.
I sometimes put context to a task (an address, a clarification, etc.) in an indented line below the task line.

- [ ] Task test ⏳ 2024-02-06 📅 2024-02-11 🛫 2024-02-07 
      A short description

It might be interesting to retrieve the content of this line and integrate it into the event description in the ical or ics file 🤔

Hey! I followed your instructions from the README.md and from this issue, but I still haven't had any luck with getting the plugin to work. I have filled out all the sections in both the gist and local saving sections, but can't get either to update. I have filled out every section in both the gist and local sections. Here are the tasks I am trying to get recognized (in a To Do.md file):

- [ ] #task 2023-12-04 work on stuff

- [ ] 2023-12-05 tasks

I am running Obsidian on Macos 14. What other information do I need to provide?

One interesting note is that every time I paste in my github personal access key, the field gets cleared. I'm not sure if this is intentional or part of the problem.

It might be cool to be able to render the tasks calendar in the right sidebar so you can quickly see your tasks without having to leave Obsidian or wait the calendar application to use the latest version.

The UI could be similar to https://github.com/liamcain/obsidian-calendar-plugin

Hello, @andrewbrereton

I've been exploring the plugin and have implemented a few new features for my personal usage and I hope to contribute them to the repository.

However, before proceeding further, I wanted to discuss their potential inclusion in the plugin and gather your thoughts on them. If you think these features align with the plugin's direction, I would be more than happy to refine the documentation, provide setting instructions, and submit a separate PR for your review.

1. Add option to create multiple events without schedule icon.

Same as "Which task date should be used?" → "Create an event per start/scheduled/due date" but without the schedule icon.

This is useful if you have a lot of tasks that are scheduled and you don't want to clutter your calendar with them. Start and due icons will still be appended to the summary to help you identify them.

2. Customizable status icons.

Enable users to customize icons for statuses such as "Incomplete", "Done", "Cancelled" and so on. Users can select their preferred icon or even input an empty string to hide the icon entirely.

3. Parse [startTime::], [length::] and [endTime::] properties (Tasks & DataView format of time).

If enabled, the plugin will parse tasks such as "- [ ] Something. [startTime:: 18:00] [length:: 3h30m] ⏳ 2024-03-01", extracting start time, end time, and duration.

4. Save calendar to private server.

Although calendars can currently be uploaded to Gist, in certain regions and under specific conditions, the gist raw refresh rate can be exceptionally slow. For instance, even though new versions are visible in the revision history, the raw content often remains outdated.

I have developed a feature that allows users to upload their calendars to their own private servers. Users can then set up public file access services, such as Nginx, on their private servers to ensure timely updates.

Users are required to deploy the GitHub - TwoStoryRobot/docker-simple-file-upload: Simple, secure file upload API in a docker container on their private server. Subsequently, within the plugin settings, users need to input the server address, port, and KEY.

Plus, utilizing a GitHub private repository (instead of Gist or a private server) might be a more suitable option.

5. Bug Fix: All day event.

The current format for all-day tasks in the generated iCal is DTSTART:20240301. I have corrected it to comply with the standard format for all-day events: DTSTART;VALUE=DATE:20240301.

Please let me know your thoughts on these proposed features and how you'd like to proceed. I'm open to feedback and willing to make any adjustments needed to align with the plugin's goals.

Thank you for your work on developing this plugin. I look forward to potentially contributing to its growth.

Based on this post.

The ticket is to discuss and treat architecture problems / design patterns / standards and eventual cleaniness problems.