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

Update particular calendar names #376

Open
tukusejssirs opened this issue Oct 2, 2022 · 2 comments
Open

Update particular calendar names #376

tukusejssirs opened this issue Oct 2, 2022 · 2 comments
Milestone

Comments

@tukusejssirs
Copy link
Member

tukusejssirs commented Oct 2, 2022

ATM I am adding calendars for Slovak dioceses, however, I don’t we ever defined the filename and class naming rules.

Based on the current filenames and class names, I suggest to used the following rules:

  • particular calendar filenames:
    • use ${continent}.${subcontinent}.${region}.${country}.${dioceseCity}.${parishCity}.${parishName}.${churchName}.ts format for filenames of particular calendars, where:
      • continent: is the continent name:
        • america for North/Central/South Americas;
        • africa;
        • eurasia for Asia and Europe;
        • australia for Australia and Oceania;
        • antarctica for Antartica;
      • subcontinent: is the subcontinent name;
        • north-america;
        • central-america;
        • south-america;
        • europe;
        • asia;
      • region: for regional calendars (like Austria-Germany-Switzerland);
      • country: is the country name;
      • dioceseCity: is the diocese seat (city) name;
      • parishCity: parish city/town/vilage name;
      • parishName: parish name (patronage) when there are multiple parishes in a city/town/vilage;
      • churchName: a church name when a particular celebration is celebrated in a parcticular church only;
    • each part (one of the six format items of a filename) should be in kebab-case;
  • particular calendar class names:
    • same format but with underscores instead of dots and without .ts extension should be used for class names in particular calendars (i.e. ${continent}_${subcontinent}_${region}_${country}_${dioceseCity}_${parishCity}_${parishName}_${churchName});
    • each part (one of the six format items of a filename) should be in PascalCase/UpperCamelCase;
  • additional rules and notes:
    • we should omit any level as needed, based on the calendar inheritance of the particular calendar;
    • I decided to combine Americas, and Asia and Europe to America and Eurasia for simplicity purposes, because:
      • [America] some celebrations are celebrated thoughout Americas, others only in North/Central/South Americas (AFAIK);
      • [Eurasia] there are separate patrons of European and Asian part of Russia, thus Russia should be part of both Europe and Asia (in national calendar; thus eurasia.russia.ts), however on regional level (diocese, parish) it should be part of either Asia or Europe only (thus eurasia.europe.russia.ts or eurasia.asia.russia.ts):
        • this is not ideal; @emagnier, you might come up with a better solution;
        • if we won’t find a better solution, then (either):
          • we should add a way to to exclude a calendar from inheritance;
          • simply inherit from calendars based on the calendar name (either filename of class name) or explicitly define from which calendar should a calendar should inherit;

Examples

  • [continent] americas.tsamerica.ts (class name: America);
  • [continent] europe.tseurasia.europe.ts (Eurasia_Europe);
  • [country] argentina.tsamerica.south-america.argentina.ts or america.argentina.ts (America_SouthAmerica_Argentina or America_Argentina);
  • [country] australia.tsaustralia.australia.ts (Australia_Australia);
  • [country] russia.tseurasia.russia.ts (Eurasia_Russia);
  • Archdiocese of Moscow, Russia → eurasia.europe.russia.moscow.ts (Eurasia_Europe_Russia);
  • [country] slovakia.tseurasia.europe.slovakia.ts (Eurasia_Europe_Slovakia);
  • [diocese] slovakia.bratislava.tseurasia.europe.slovakia.bratislava.ts (Eurasia_Europe_Slovakia_Bratislava);
  • [diocese] slovakia.banska-bystrica.tseurasia.europe.slovakia.banska-bystrica.ts (Eurasia_Europe_Slovakia_BanskaBystrica);
  • [country: diocese: parish] slovakia.banska-bystrica.cathedral.tseurasia.europe.slovakia.banska-bystrica.cathedral.ts (Eurasia_Europe_Slovakia_BanskaBystrica_Cathedral);
  • [country: diocese: parish: church in parish] slovakia.bratislava.martin-of-tours.cathedral.tseurasia.europe.slovakia.bratislava.martin-of-tours.cathedral-of-saint-martin-of-tours.ts (Eurasia_Europe_Slovakia_Bratislava_MartinOfTours_CathedralOfMartinOfTours);
  • [country] france.tseurasia.europe.france.ts (Eurasia_Europe_France);
  • [diocese] france.paris.tseurasia.europe.france.paris.ts (Eurasia_Europe_France_Paris);
  • [diocese] france.strasbourg.tseurasia.europe.france.strasbourg.ts (Eurasia_Europe_France_Strasbourg);
  • [diocese] france.saint-denis.tseurasia.europe.france.saint-denis.ts (Eurasia_Europe_France_SaintDenis);
  • [country] scotland.tseurasia.europe.united-kingdom.scotland.ts or (when there is no united-kingdom regional calendar) eurasia.europe.scotland.ts (Eurasia_Europe_UnitedKingdom_Scotland or Eurasia_Europe_Scotland);
  • [country] wales.tseurasia.europe.united-kingdom.wales.ts or (when there is no united-kingdom regional calendar) eurasia.europe.wales.ts (Eurasia_Europe_UnitedKingdom_Wales or Eurasia_Europe_Wales);
  • [country] england.tseurasia.europe.united-kingdom.england.ts or (when there is no united-kingdom regional calendar) eurasia.europe.england.ts (Eurasia_Europe_UnitedKingdom_England or Eurasia_Europe_England);
  • [country] ireland.tseurasia.europe.united-kingdom.ireland.ts or (when there is no united-kingdom regional calendar) eurasia.europe.ireland.ts (Eurasia_Europe_UnitedKingdom_UnitedKingdom or Eurasia_Europe_UnitedKingdom);
  • [region: country] austria.tseurasia.europe.austria-germany-switzerland.austria.ts (Eurasia_Europe_AustriaGermanySwitzerland_Austria).
@tukusejssirs tukusejssirs added this to the romcal v3.0 milestone Oct 2, 2022
@tukusejssirs
Copy link
Member Author

Another thing we might consider is to move the particular calendars into subfolders, e.g. diocesan calendars would go to lib/particular-calendars/diocese. Thus the particular calendars would be easier to distinguish from other particular calendars.

Take for example the calendars for the Archdiocese of Košice, Slovakia and the City of Košice, Slovakia:

  • [diocesan calendar] slovakia.kosice.ts;
  • [city calendar] slovakia.kosice.kosice.ts;
  • [parish calendar] slovakia.kosice.kosice.elizabeth-of-hungary.cathedral.ts.

@tukusejssirs
Copy link
Member Author

The more I am into adding the calendars for Slovak dioceses to romcal, the more I think that explicit specification of calendars from which a calendar inherits is better way to deal with this. This, however, duplicates the list of calendars from which a calendar inherits and is thus non-KISS. 🤔

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

1 participant