Screenshot 2024-05-29 at 22-50-29 API - Open Web Calendar @ Hosted Weblate

Assigned source strings

English	Assigned screenshots	Actions
The API of the Open Web Calendar allows more customization than the configuration page.	1	View
API	1	View
Generally, the Open Web Calendar is there to be used without restriction. You can use this API to customize the calendar on the fly.	1	View
This section can be of use if one of these applies:	1	View
You are a web developer who wants to embed the Open Web Calendar.	1	View
You want to exploit the full flexibility, not just what is exposed on the configuration page.	1	View
You want to use JavaScript to dynamically generate the calendar design and options.	1	View
You want to extend the functionality of the Open Web Calendar.	1	View
You want to use the Open Web Calendar as a proxy to request JSON events for your self-made event feed.	1	View
Endpoints	1	View
The basic parameters are the same at these endpoints:	1	View
`/index.html` - edit the calendar	1	View
`/about.html` - view the about page	1	View
`/calendar.html` - view the calendar	1	View
`/calendar.spec` - download the specification	1	View
`/calendar.ics` - subscribe to the ics file	1	View
`/calendar.events.json` - FLEXIBLE - get the events as JSON Please note that you CAN use this but you cannot be sure that the JSON schema remains the same. If you want that, add tests.	1	View
Additional parameters are required:	1	View
`timezone=UTC` - the timezone that you need to display the events in	1	View
`from=YYYY-MM-DD` - the start of the period in which events happen (inclusive)	1	View
`to=YYYY-MM-DD` - the end of the period in which events happen (exclusive)	1	View
Parameters	1	View
All configuration parameters are described sufficiently in the [default_specification]. That is the reference. E.g. if you find the parameter `title` in the [default_specification], you have several options:	1	View
Adding Parameters	1	View
If you add a new parameter as a developer,	1	View
Add the parameter with a default value to the [default_specification]	1	View
Add an implementation, depending on its use in the `app.py` or the templates of the JavaScript files. The specification is already available in all of them to use.	1	View
Add tests in [features/configure-the-calendar.feature](https://github.com/niccokunzmann/open-web-calendar/tree/master//features/configure-the-calendar.feature) to check that the calendar responds to the feature.	1	View
Add tests in [features/edit-the-calendar.feature](https://github.com/niccokunzmann/open-web-calendar/tree/master//features/edit-the-calendar.feature) to make sure that the parameter can be used when a calendar is edited.	1	View
Compiling the Specification	1	View
You can change the calendar behavior and looks with parameters. These are the places to specify parameters:	1	View
Query parameters All parameters to the calendar url are put into the specification. The query parameters have the highest precedence. Examples:	1	View
specification_url If you specify this query parameter, the editor configuration is loaded from this url, too. Query parameters are still more important than what is written in this file. The source format can be YAML or JSON. Examples:	1	View
[default_specification] This file contains the default parameters. They must not be hard-coded in the source code. All of them are there. Query parameters and the `specification_url` override these values.	1	View
Specification in the Calendar	1	View
[app.py](https://github.com/niccokunzmann/open-web-calendar/blob/85a72dab4561e250aec69b5ad7c3de074eefa1e8/app.py#L81) compiles the specification from the given parameters in `get_specification()`. In the [template](https://github.com/niccokunzmann/open-web-calendar/blob/85a72dab4561e250aec69b5ad7c3de074eefa1e8/templates/calendars/dhtmlx.html#L23) you can access the specification through the `specification` variable. The specification is available to JavaScript as the `specification` variable.	1	View
Specification in the Index Page	1	View
The default specification is available before the calendar is built via JavaScript in the `configuration.default_specification` variable. There is a [getSpecification()](https://github.com/niccokunzmann/open-web-calendar/blob/85a72dab4561e250aec69b5ad7c3de074eefa1e8/static/js/index.js#L93) function which created the specification from the inputs. Generally, the `specification` variable should be used.	1	View
Architecture	1	View
Below, you can find a picture of the architecture.	1	View
The base of a calendar is the specification, given in the various forms. This specification influences all the steps.	1	View
After the specification is compiled, the calendar (ics) files are downloaded from the locations on the Internet.	1	View
From the calendar files, the events are generated.	1	View
Then, different views are chosen to display the events.	1	View
In the end, these lead to HTML and style changes of the calendar website.	1	View
In the real application, these steps are bit bit mixed up and unordered or omitted but this explains simply the basic, initial idea behind the event processing.	1	View
[default_specification]: https://github.com/niccokunzmann/open-web-calendar/tree/master//default_specification.yml	1	View
Query parameters All parameters to the calendar url are put into the specification. The query parameters have the highest precedence. Examples: ```txt index.html?language=de calendar.html?title=CALENDAR ```	1	View
specification_url If you specify this query parameter, the editor configuration is loaded from this url, too. Query parameters are still more important than what is written in this file. The source format can be YAML or JSON. Examples: calendar.html?specification_url=https://github.com/niccokunzmann/open-web-calendar/raw/master/default_specification.yml	1	View
![architecture](/assets/img/architecture.svg)	1	View
Query Parameter	1	View
YAML	1	View
JSON	1	View
Change the title in a YAML specification:	1	View
Change the title in a JSON specification:	1	View
Change the title in a query parameter:	1	View

Screenshot is shown to add visual context for all listed source strings.

Image

Screenshot 2024-05-29 at 22-50-29 API - Open Web Calendar

Screenshot details

Created	a month ago
Uploaded by	niccokunzmann
Language	English