doc update

This commit is contained in:
les
2020-01-30 15:23:43 +01:00
parent fc9d11f150
commit 86aae4206f
35 changed files with 2114 additions and 6 deletions

1
.gitignore vendored
View File

@@ -5,6 +5,7 @@ config/development.json
gancio_config.json
config.json
db.sqlite
thumb
### Node template
# Logs

View File

@@ -0,0 +1,7 @@
---
layout: default
title: Add event
permalink: /usage/add_event
nav_order: 1
parent: Usage
---

View File

@@ -7,8 +7,4 @@ nav_order: 4
# Usage
## Add event
### Normal
### Multidate
### Recurrent
ehmmm, help needed here :smile: feel free to send a PR => [here](https://framagit.org/les/gancio/tree/master/docs)

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -106,10 +106,24 @@
},
"15": {
"id": "15",
"title": "Recurrent events",
"content": "Gancio supports recurrent events if enabled to (Admin &gt; Settings, disabled by default). When enabled, you are able to create recurrent events. Recurrent events are not shown by default to visitors, they have to enable it, or you can choose to show them by default in admin panel. Add a recurrent event Same as adding a normal event, but you can choose choose the details of event recurrence. Choose a frequency first: and use the calendar to select one or more days. How does it work Behind the scene, gancio ensures that at least the next three occurrences of the event are always created. It creates that single events by copying the properties of the parent event, so if you modify the parent events title, or the day of the week, each newly created occurrence will took the new title and the new selected day. Old occurrences will be preserved. You can edit a specific event occurrence with more details, a different poster/flyer, a different title/description or decide to completely hide it. Stop/pause a recurrent event (eg. during summer) A specific menu is shown viewing an instance of recurrent event…",
"url": "https://gancio.org/usage/recurrent",
"relUrl": "/usage/recurrent"
},
"16": {
"id": "16",
"title": "Project Structure",
"content": "Project structure API / backend Client / frontend Federation / ActivityPub API / backend Source code inside server/api/. index.js is basically a routing table pointing each PATH with specified HTTP VERB to a method of a controller. jwt is used to authenticate api request. Express.js is based on middleware, passing each request to a chain of methods. If you come from a PHP background, note that the main difference with Node.js is that the server process is always running and able to manage multiple requests and tasks together (asyncronically) while each php process is tied to a single request. Sequelize is used as ORM. Take a look in /server/api/models. Client / frontend Nuxt.js is used here! Nuxt is basically Vue plus SSR (Server Side Rendering). Client routing in nuxt is automatic (if you dont need something special), just put your page inside pages and thats it! Federation / ActivityPub Code inside server/federation.",
"url": "https://gancio.org/dev/structure",
"relUrl": "/dev/structure"
},
"17": {
"id": "17",
"title": "Usage",
"content": "sadf",
"url": "https://gancio.org/usage",
"relUrl": "/usage"
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
@@ -384,6 +453,8 @@
<li>
@@ -396,6 +467,8 @@
<li>
<a href="https://gancio.org/dev/oauth">OAuth</a>
</li>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link active">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/dev/structure" class="navigation-list-link active">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -1 +1 @@
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.8.6">Jekyll</generator><link href="https://gancio.org/feed.xml" rel="self" type="application/atom+xml" /><link href="https://gancio.org/" rel="alternate" type="text/html" /><updated>2020-01-24T01:03:10+01:00</updated><id>https://gancio.org/feed.xml</id><title type="html">Gancio</title><subtitle>A shared agenda for local communities with AP support</subtitle></feed>
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.8.6">Jekyll</generator><link href="https://gancio.org/feed.xml" rel="self" type="application/atom+xml" /><link href="https://gancio.org/" rel="alternate" type="text/html" /><updated>2020-01-30T15:22:37+01:00</updated><id>https://gancio.org/feed.xml</id><title type="html">Gancio</title><subtitle>A shared agenda for local communities with AP support</subtitle></feed>

View File

@@ -94,6 +94,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -146,6 +207,10 @@
@@ -191,6 +256,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -203,6 +270,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item active">
<a href="https://gancio.org/install" class="navigation-list-link active">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item active">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item active">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item active">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

View File

@@ -92,6 +92,67 @@
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
@@ -144,6 +205,10 @@
@@ -189,6 +254,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
@@ -201,6 +268,8 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>

466
docs/_site/usage.html Normal file
View File

@@ -0,0 +1,466 @@
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
<title>Usage - Gancio</title>
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
<script type="text/javascript" src="https://gancio.org/assets/js/just-the-docs.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://gancio.org/assets/js/jquery-3.3.1.min.js"></script>
<link rel="stylesheet" href="https://gancio.org/assets/css/jquery.fancybox.min.css"/>
<script src="https://gancio.org/assets/js/jquery.fancybox.min.js"></script>
<!-- Begin Jekyll SEO tag v2.6.1 -->
<title>Usage | Gancio</title>
<meta name="generator" content="Jekyll v3.8.6" />
<meta property="og:title" content="Usage" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="A shared agenda for local communities with AP support" />
<meta property="og:description" content="A shared agenda for local communities with AP support" />
<link rel="canonical" href="https://gancio.org/usage" />
<meta property="og:url" content="https://gancio.org/usage" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","headline":"Usage","url":"https://gancio.org/usage","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div class="page-wrap">
<div class="side-bar">
<a href="https://gancio.org/" class="site-title fs-6 lh-tight">Gancio</a>
<span class="fs-3"><button class="js-main-nav-trigger navigation-list-toggle btn btn-outline" type="button" data-text-toggle="Hide">Menu</button></span>
<div class="navigation main-nav js-main-nav">
<nav role="navigation" aria-label="Main navigation">
<ul class="navigation-list">
<li class="navigation-list-item active">
<a href="https://gancio.org/404.html" class="navigation-list-link"></a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/" class="navigation-list-link">Home</a>
</li>
<li class="navigation-list-item active">
<a href="https://gancio.org/usage" class="navigation-list-link active">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/install/debian" class="navigation-list-link">Debian</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/install/docker" class="navigation-list-link">Docker</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/config" class="navigation-list-link">Configuration</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/instances" class="navigation-list-link">Instances</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/changelog" class="navigation-list-link">Changelog</a>
</li>
</ul>
</nav>
</div>
<footer role="contentinfo" class="site-footer">
<p class="text-small text-grey-dk-000 mb-0">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
</footer>
</div>
<div class="main-content-wrap js-main-content" tabindex="0">
<div class="page-header">
<div class="main-content">
<div class="search js-search">
<div class="search-input-wrap">
<input type="text" class="js-search-input search-input" tabindex="0" placeholder="Search Gancio" aria-label="Search Gancio" autocomplete="off">
<svg width="14" height="14" viewBox="0 0 28 28" xmlns="http://www.w3.org/2000/svg" class="search-icon"><title>Search</title><g fill-rule="nonzero"><path d="M17.332 20.735c-5.537 0-10-4.6-10-10.247 0-5.646 4.463-10.247 10-10.247 5.536 0 10 4.601 10 10.247s-4.464 10.247-10 10.247zm0-4c3.3 0 6-2.783 6-6.247 0-3.463-2.7-6.247-6-6.247s-6 2.784-6 6.247c0 3.464 2.7 6.247 6 6.247z"/><path d="M11.672 13.791L.192 25.271 3.02 28.1 14.5 16.62z"/></g></svg>
</div>
<div class="js-search-results search-results-wrap"></div>
</div>
<ul class="list-style-none text-small mt-md-1 mb-md-1 pb-4 pb-md-0 js-aux-nav aux-nav">
<li class="d-inline-block my-0 mr-2"><a href="https://blog.gancio.org">Blog</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>
</div>
</div>
<div class="main-content">
<div id="main-content" class="page-content" role="main">
<p>sadf</p>
<hr>
<h2 class="text-delta">Table of contents</h2>
<ul>
<li>
<a href="https://gancio.org/usage/recurrent">Recurrent events</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,456 @@
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
<title>Recurrent events - Gancio</title>
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
<script type="text/javascript" src="https://gancio.org/assets/js/just-the-docs.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://gancio.org/assets/js/jquery-3.3.1.min.js"></script>
<link rel="stylesheet" href="https://gancio.org/assets/css/jquery.fancybox.min.css"/>
<script src="https://gancio.org/assets/js/jquery.fancybox.min.js"></script>
<!-- Begin Jekyll SEO tag v2.6.1 -->
<title>Recurrent events | Gancio</title>
<meta name="generator" content="Jekyll v3.8.6" />
<meta property="og:title" content="Recurrent events" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="A shared agenda for local communities with AP support" />
<meta property="og:description" content="A shared agenda for local communities with AP support" />
<link rel="canonical" href="https://gancio.org/usage/recurrent" />
<meta property="og:url" content="https://gancio.org/usage/recurrent" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","headline":"Recurrent events","url":"https://gancio.org/usage/recurrent","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div class="page-wrap">
<div class="side-bar">
<a href="https://gancio.org/" class="site-title fs-6 lh-tight">Gancio</a>
<span class="fs-3"><button class="js-main-nav-trigger navigation-list-toggle btn btn-outline" type="button" data-text-toggle="Hide">Menu</button></span>
<div class="navigation main-nav js-main-nav">
<nav role="navigation" aria-label="Main navigation">
<ul class="navigation-list">
<li class="navigation-list-item active">
<a href="https://gancio.org/404.html" class="navigation-list-link"></a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/" class="navigation-list-link">Home</a>
</li>
<li class="navigation-list-item active">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item active">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link active">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/install/debian" class="navigation-list-link">Debian</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/install/docker" class="navigation-list-link">Docker</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/config" class="navigation-list-link">Configuration</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/instances" class="navigation-list-link">Instances</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/changelog" class="navigation-list-link">Changelog</a>
</li>
</ul>
</nav>
</div>
<footer role="contentinfo" class="site-footer">
<p class="text-small text-grey-dk-000 mb-0">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
</footer>
</div>
<div class="main-content-wrap js-main-content" tabindex="0">
<div class="page-header">
<div class="main-content">
<div class="search js-search">
<div class="search-input-wrap">
<input type="text" class="js-search-input search-input" tabindex="0" placeholder="Search Gancio" aria-label="Search Gancio" autocomplete="off">
<svg width="14" height="14" viewBox="0 0 28 28" xmlns="http://www.w3.org/2000/svg" class="search-icon"><title>Search</title><g fill-rule="nonzero"><path d="M17.332 20.735c-5.537 0-10-4.6-10-10.247 0-5.646 4.463-10.247 10-10.247 5.536 0 10 4.601 10 10.247s-4.464 10.247-10 10.247zm0-4c3.3 0 6-2.783 6-6.247 0-3.463-2.7-6.247-6-6.247s-6 2.784-6 6.247c0 3.464 2.7 6.247 6 6.247z"/><path d="M11.672 13.791L.192 25.271 3.02 28.1 14.5 16.62z"/></g></svg>
</div>
<div class="js-search-results search-results-wrap"></div>
</div>
<ul class="list-style-none text-small mt-md-1 mb-md-1 pb-4 pb-md-0 js-aux-nav aux-nav">
<li class="d-inline-block my-0 mr-2"><a href="https://blog.gancio.org">Blog</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>
</div>
</div>
<div class="main-content">
<nav class="breadcrumb-nav">
<ol class="breadcrumb-nav-list">
<li class="breadcrumb-nav-list-item"><a href="https://gancio.org/usage">Usage</a></li>
<li class="breadcrumb-nav-list-item"><span>Recurrent events</span></li>
</ol>
</nav>
<div id="main-content" class="page-content" role="main">
<p>Gancio supports recurrent events if enabled to (<code class="highlighter-rouge">Admin &gt; Settings</code>,
disabled by default).</p>
<p><img src="/assets/usage/enable_recurrent.png" alt="/assets/usage/enable_recurrent.png" /></p>
<p>When enabled, you are able to create recurrent events. Recurrent
events are not shown by default to visitors, they have to enable it, or you
can choose to show them by default in admin panel.</p>
<p><img src="/assets/usage/show_recurrent.png" alt="/assets/usage/show_recurrent.png" /></p>
<h2 id="add-a-recurrent-event">Add a recurrent event</h2>
<p>Same as adding a normal event, but you can choose choose the details of
event recurrence. Choose a frequency first:</p>
<p><img src="/assets/usage/recurrent_details.png" alt="/assets/usage/recurrent_details.png" /></p>
<p>and use the calendar to select one or more days.</p>
<p><img src="/assets/usage/recurrent_details2.png" alt="/assets/usage/recurrent_details2.png" /></p>
<h2 id="how-does-it-work">How does it work</h2>
<p>Behind the scene, gancio ensures that at least the next three occurrences
of the event are always created. It creates that single events by copying
the properties of the parent event, so if you modify the parent
events title, or the day of the week, each newly created occurrence will took
the new title and the new selected day. Old occurrences will be preserved.</p>
<p>You can edit a specific event occurrence with more details, a different
poster/flyer, a different title/description or decide to completely hide it.</p>
<h2 id="stoppause-a-recurrent-event-eg-during-summer">Stop/pause a recurrent event (eg. during summer)</h2>
<p>A specific menu is shown viewing an instance of recurrent event…</p>
<p><img src="/assets/usage/recurrent_menu.png" alt="/assets/usage/recurrent_menu.png" /></p>
</div>
</div>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

50
docs/usage/recurrent.md Normal file
View File

@@ -0,0 +1,50 @@
---
layout: default
title: Recurrent events
permalink: /usage/recurrent
nav_order: 1
parent: Usage
---
Gancio supports recurrent events if enabled to (`Admin > Settings`,
disabled by default).
![/assets/usage/enable_recurrent.png](/assets/usage/enable_recurrent.png)
When enabled, you are able to create recurrent events. Recurrent
events are not shown by default to visitors, they have to enable it, or you
can choose to show them by default in admin panel.
![/assets/usage/show_recurrent.png](/assets/usage/show_recurrent.png)
## Add a recurrent event
Same as adding a normal event, but you can choose choose the details of
event recurrence. Choose a frequency first:
![/assets/usage/recurrent_details.png](/assets/usage/recurrent_details.png)
and use the calendar to select one or more days.
![/assets/usage/recurrent_details2.png](/assets/usage/recurrent_details2.png)
## How does it work
Behind the scene, gancio ensures that at least the next three occurrences
of the event are always created. It creates that single events by copying
the properties of the parent event, so if you modify the parent
event's title, or the day of the week, each newly created occurrence will took
the new title and the new selected day. Old occurrences will be preserved.
You can edit a specific event occurrence with more details, a different
poster/flyer, a different title/description or decide to completely hide it.
## Stop/pause a recurrent event (eg. during summer)
A specific menu is shown viewing an instance of recurrent event...
![/assets/usage/recurrent_menu.png](/assets/usage/recurrent_menu.png)

10
docs/usage/usage.md Normal file
View File

@@ -0,0 +1,10 @@
---
layout: default
title: Usage
permalink: /usage
nav_order: 1
has_children: true
---
sadf