Provide install instructions in README

Created on 16 June 2024, 12 days ago
Updated 17 June 2024, 11 days ago

Problem/motivation

I just composer-required and enabled the module but after adding date fields to an existing content type (both core's date, datetime, or timestamps), no new formatting options became available. I can't find anything to show Add to calendar links and Configuration nor Help pages are available. Maybe the Smart date module is an undeclared dependency?

📌 Task
Status

Fixed

Version

1.1

Component

Documentation

Created by

🇮🇹Italy kopeboy Mainland

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @kopeboy
  • 🇨🇦Canada mandclu

    Hmmm looking again at this module's README file, I can see that more documentation would indeed be useful.

    Smart Date isn't declared as a dependency because the Date Augmenter API is meant to be compatible with other formatters, if they implement a small amount of code. That said, Smart Date is currently the only compatible formatter I know of.

    As such, a more explicit set of setup instructions would be:

    • Configure your date field to use a display formatter compatible with the Date Augmenter API, such as one of the Smart Date formatters
    • In the formatter's display configuration, enable this module's Augmenter. Note that for recurring events, you can choose to add calendar links to individual dates (which will only add a single date), to the series text (which will add the entire series to the calendar), or both.
  • 🇮🇹Italy kopeboy Mainland

    That would work perfectly!

  • 🇨🇦Canada mandclu
  • Merge request !13Issue #3252918: expand README → (Merged) created by mandclu
  • Status changed to Needs review 12 days ago
  • 🇨🇦Canada mandclu

    I added the text from #4, and some information about the configuration options.

  • I've reviewed the changes in merge request !13, and the detailed installation and configuration instructions have been added to the README file as discussed. These additions should help users set up the module correctly and address the initial confusion.
    RTBC +
    Thankyou.

  • Pipeline finished with Skipped
    11 days ago
    #200885
  • Status changed to Fixed 11 days ago
  • 🇨🇦Canada mandclu

    Thanks for the feedback! Merged in.

Production build 0.69.0 2024