yohours v0.0.14

YoHours

Read-me

YoHours is a web tool to create opening hours for the OpenStreetMap project, in the famous opening_hours syntax. You can define when a point of interest is open in a week, and YoHours will give you the opening_hours value to set in OpenStreetMap. This tool is written in JavaScript.

A live demo is available at github.pavie.info/yohours.

Usage

YoHours is simple to use. These are the basic actions you can do:

• Add an interval: drag with your mouse over the calendar
• Remove an interval: click on it
• Extend an interval: drag the "=" sign on intervals extremities

Seasons

YoHours is now able to handle opening hours which depends of seasons. You can define hours for specific days, weeks, months or holidays. To do so, start by defining the common opening hours ("All year" tab), then refine by adding a new season (the green "+" tab) and set the opening hours on the new calendar. You can add as many seasons as you want. You can also edit or remove a season by clicking on the pencil and trash buttons, between seasons tabs and calendar.

Supported opening_hours values

YoHours supports only a subset of the opening_hours syntax. Here are some examples of supported values.

• Basic hours: 08:00-18:00 or 08:00-12:00,14:00-18:00 or 10:00
• Weekday selectors: Mo-Fr,Su 09:00-17:00; Sa 10:00-19:00
• Week selectors: week 01-05: Mo,Tu 08:00-10:00; week 06-10: Mo,Tu 10:00-12:00
• Month selectors: Jan-Apr: We 10:00-15:00
• Monthday selectors: Jan 25-30,Feb 28-Apr 15: Tu 11:00-17:00
• Holidays selectors: PH 21:00-23:00 or SH Mo,Tu 06:00-09:00 or easter off...
• Always open: 24/7
• Any combination of the previous examples separated by semi-colons

Unsupported opening_hours values

The elements which are present in the opening_hours formal specification and not listed before aren't supported. You can contact me to discuss the integration of some new elements if needed.

Developers

Installation

To build YoHours, you need to have this software installed (preferably under a Linux environment):

• NodeJS (latest stable version) and npm
• make
• sed
• zip

Then you can build YoHours using these commands:

make

Then, you can upload the conten of dist/ repository to your own web server to make YoHours available.

If you just want to partially rebuild (when coding), use the make watchmain command instead.

Tests

For testing, run make test, and then start the tests by opening the test/unit_tests.html page into your web browser.

Integration

If you want to integrate parts of YoHours in another piece of software, you can use the following code to check if an opening_hours value will be properly shown. Only model.js file is needed to run this.

var checker = new YoHoursChecker();
checker.canRead("24/7; week 01: Su 01:00-08:00"); // returns true
checker.canRead("24/7; week 01: Su 01:00-08:00 || \"on appointment\""); // returns false
checker.canRead("completely invalid value"); // returns false

License

Copyright 2015-2018 Adrien PAVIE

See LICENSE for complete AGPL3 license.

YoHours is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

YoHours is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with YoHours. If not, see http://www.gnu.org/licenses/.