Giter Site home page Giter Site logo

ordodo's Introduction

OrdoDO - Ordo Divini Officii

Generates an ordo (also known as directory) for a hierarchically organized set of Roman Catholic liturgical calendars.

OrdoDO logo

The problem

Every year, hundreds of Catholics around the world spend possibly hundreds of hours each, compiling an ordo, a liturgical calendar of their country, diocese or religious institute, for the new liturgical year. Usually by hand.

Ordo is basically a combination of a set of closely related liturgical calendars, e.g. calendars of dioceses of one country or of houses of one province of some religious institute.

The task of compiling an ordo is extremely repetitive and can be - completely or at least to a great extent - automated. Let ordodo do the heavy lifting for you!

Features

Example output:

The current sample is a simple HTML page. Support for multiple output formats will be added later, with special focus on print-ready pdf output.

  • liturgical calendar computing
  • variants from proper calendars (with support for unlimited calendar levels)
  • Gloria and Credo
  • prefaces and the eucharistic prayer IV
  • occasional parts of the Roman Canon
  • Divine Office hints (Vespers, Compline, Daytime Prayer)
  • votive masses
  • burial masses
  • occasional blessings and other rites
  • support for other date-related directions (often "International day of ..., should be mentioned in the universal prayer")

Installation

is not really possible yet. But you can play with ordodo nevertheless: install Ruby and Bundler, then clone ordodo sources,

bundle install

in the project's root directory to install dependencies and then execute ordodo like

bundle exec ruby -Ilib bin/ordodo ...

Basic usage

$ ordodo myconfig.xml

generates ordo according to configuration in myconfig.xml for the upcoming liturgical year. Definitely the most common task you will use ordodo for.

Output is by default produced in directory ordo_YEAR, created in the current working directory.

$ ordodo myconfig.xml 2050

generates ordo for the year specified (which, of course, knows nothing about calendar updates which will probably happen in the meantime).

In the examples/ directory you can find a few example configurations to start with.

Configuration

ordodo's main user interface is it's configuration file.

Philosophy behind it: ordo is prepared only once a year, and it's content is "mostly the same". As a user you don't want to remember anything about ordodo - this program used once a year - and it's controls and settings. You want to set it up once (or have someone set it up for you) - and then it should, if possible, just work forever. Once a year you run ordodo with the configuration from the last year, check that the output is correct, send it to print. All done.

See examples/czech_republic.xml for a complete and commented configuration of an ordo for Czech dioceses. It uses most features currently available, and mentions those which are not used.

Preparing calendar data

For calendar computations ordodo relies on calendarium-romanum. It also expects calendar data in it's data format.

Customization of translation strings and output templates

License

MIT

Credits

ordodo logo incorporates a drawing of a dodo by Pearson Scott Foresman. The drawing is in public domain.

ordodo's People

Contributors

dependabot[bot] avatar igneus avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

martindonat

ordodo's Issues

Output formatting

Hi,

I run ordodo for the first time and have some minor suggestions, which I will try to implement as a first exercise to get to know the code (and Ruby, I'm a Pythonist).

  • the output filename should include the filename of the config file. Otherwise the file will be overwritten if you use different configs.
  • The std output should state the location of the output file at the end.
  • Maybe a log file would be nice (but I guess Ruby has some module for logging, I think I will leave that as it is).

Lectionary

In some countries it is customary that the ordo also contains lectionary data for each celebration.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.