Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better differentiate the purpose of the two macros provided by the Calendar app #27

Open
evalica opened this issue Jun 28, 2019 · 3 comments

Comments

@evalica
Copy link

evalica commented Jun 28, 2019

If someone installs the "Calendar Application (Pro)", two macros will become available:

  • Calendar - Displays a calendar
  • Mocca Calendar - Displays a calendar

First of all, it's confusing why the Macro is still called "Mocca", since the application has been renamed in #3 . Apparently there are other translation keys that still contain Mocca.

But in terms of usability, what is the difference between the macros?
macros

We could:

  • fix the title to remove Mocca
  • improve the titles to be more descriptive of their purpose;
  • improve the description of the macros to state their purpose;
  • deprecate one of the macros;

Tested with XWiki 11.5 and Calendar Pro 2.8.4.

@evalica evalica changed the title Better differentiate the difference between the two macros provided Better differentiate the purpose of the two macros provided by Calendar app Jun 28, 2019
@evalica evalica changed the title Better differentiate the purpose of the two macros provided by Calendar app Better differentiate the purpose of the two macros provided by the Calendar app Jun 28, 2019
@CamiAndrei
Copy link

Also we need to change the macro from {{moccacalendar /}} to {{calendar pro/}}.

@lucaa
Copy link

lucaa commented Nov 25, 2020

Also we need to change the macro from {{moccacalendar /}} to {{calendar pro/}}.

even if this would be the best, I think we can improve the application for this issue even without actually renaming the macro id (which would also break backwards compat, so it's complicated to do).

The texts in @evalica's screenshot are actually all translations so all that can be improved only by improving translations (including the calendar macro name that contains the word Mocca).

@lucaa
Copy link

lucaa commented Nov 25, 2020

deprecate one of the macros;

We cannot deprecate anything, they are actually 2 very different macros that serve 2 different purposes:

  • one is the full calendar brought in by the "full calendar" macro dependency of the Calendar (Pro) application - which displays "calendars" from URLs, or JSON source -
  • the other one is the Calendar (Pro) macro that displays, on a calendar built with the full calendar macro ( ;) ) , one (or more) of the calendars created as part of the Calendar (Pro) application.

We need to improve the documentation to be crystal clear which one does what.

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

No branches or pull requests

3 participants