diff --git a/.gitignore b/.gitignore index 2ea2de15..c9e3f5cd 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ config/development.json gancio_config.json config.json db.sqlite +thumb ### Node template # Logs diff --git a/docs/_drafts/add_event.md b/docs/_drafts/add_event.md new file mode 100644 index 00000000..ca906023 --- /dev/null +++ b/docs/_drafts/add_event.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Add event +permalink: /usage/add_event +nav_order: 1 +parent: Usage +--- \ No newline at end of file diff --git a/docs/_drafts/usage.md b/docs/_drafts/usage.md index 9da6f3db..b28fc045 100644 --- a/docs/_drafts/usage.md +++ b/docs/_drafts/usage.md @@ -7,8 +7,4 @@ nav_order: 4 # Usage - -## Add event -### Normal -### Multidate -### Recurrent \ No newline at end of file +ehmmm, help needed here :smile: feel free to send a PR => [here](https://framagit.org/les/gancio/tree/master/docs) \ No newline at end of file diff --git a/docs/_site/404.html b/docs/_site/404.html index 145c2555..1f87ecc7 100644 --- a/docs/_site/404.html +++ b/docs/_site/404.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/about.html b/docs/_site/about.html index 0b347eb4..54f47cb7 100644 --- a/docs/_site/about.html +++ b/docs/_site/about.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/assets/js/search-data.json b/docs/_site/assets/js/search-data.json index 8804ff5c..51dabfd7 100644 --- a/docs/_site/assets/js/search-data.json +++ b/docs/_site/assets/js/search-data.json @@ -106,10 +106,24 @@ }, "15": { "id": "15", + "title": "Recurrent events", + "content": "Gancio supports recurrent events if enabled to (Admin > 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 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…", + "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 don’t need something special), just put your page inside pages and that’s 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" } } diff --git a/docs/_site/assets/usage/enable_recurrent.png b/docs/_site/assets/usage/enable_recurrent.png new file mode 100644 index 00000000..06b5b2d4 Binary files /dev/null and b/docs/_site/assets/usage/enable_recurrent.png differ diff --git a/docs/_site/assets/usage/recurrent_details.png b/docs/_site/assets/usage/recurrent_details.png new file mode 100644 index 00000000..b9d3f628 Binary files /dev/null and b/docs/_site/assets/usage/recurrent_details.png differ diff --git a/docs/_site/assets/usage/recurrent_details2.png b/docs/_site/assets/usage/recurrent_details2.png new file mode 100644 index 00000000..2e6b2fe3 Binary files /dev/null and b/docs/_site/assets/usage/recurrent_details2.png differ diff --git a/docs/_site/assets/usage/recurrent_menu.png b/docs/_site/assets/usage/recurrent_menu.png new file mode 100644 index 00000000..4b7679fd Binary files /dev/null and b/docs/_site/assets/usage/recurrent_menu.png differ diff --git a/docs/_site/assets/usage/show_recurrent.png b/docs/_site/assets/usage/show_recurrent.png new file mode 100644 index 00000000..4c95e9ec Binary files /dev/null and b/docs/_site/assets/usage/show_recurrent.png differ diff --git a/docs/_site/changelog.html b/docs/_site/changelog.html index c48e58b4..9312f331 100644 --- a/docs/_site/changelog.html +++ b/docs/_site/changelog.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/config.html b/docs/_site/config.html index 80bd0af8..47acc28a 100644 --- a/docs/_site/config.html +++ b/docs/_site/config.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/contacts.html b/docs/_site/contacts.html index 41012c21..6195d73c 100644 --- a/docs/_site/contacts.html +++ b/docs/_site/contacts.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/dev.html b/docs/_site/dev.html index 337df587..ad943992 100644 --- a/docs/_site/dev.html +++ b/docs/_site/dev.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth @@ -384,6 +453,8 @@ + +
  • @@ -396,6 +467,8 @@ + +
  • OAuth
    • diff --git a/docs/_site/dev/locales.html b/docs/_site/dev/locales.html index 44b98bcc..0bfff209 100644 --- a/docs/_site/dev/locales.html +++ b/docs/_site/dev/locales.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/dev/oauth.html b/docs/_site/dev/oauth.html index 85e186d9..119cd685 100644 --- a/docs/_site/dev/oauth.html +++ b/docs/_site/dev/oauth.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/dev/structure.html b/docs/_site/dev/structure.html index 37f81681..de3e5a85 100644 --- a/docs/_site/dev/structure.html +++ b/docs/_site/dev/structure.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/federation.html b/docs/_site/federation.html index 1534f323..c9a466a7 100644 --- a/docs/_site/federation.html +++ b/docs/_site/federation.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/feed.xml b/docs/_site/feed.xml index a4a201b7..c0acd6d6 100644 --- a/docs/_site/feed.xml +++ b/docs/_site/feed.xml @@ -1 +1 @@ -Jekyll2020-01-24T01:03:10+01:00https://gancio.org/feed.xmlGancioA shared agenda for local communities with AP support \ No newline at end of file +Jekyll2020-01-30T15:22:37+01:00https://gancio.org/feed.xmlGancioA shared agenda for local communities with AP support \ No newline at end of file diff --git a/docs/_site/index.html b/docs/_site/index.html index ff035ac0..1beb291f 100644 --- a/docs/_site/index.html +++ b/docs/_site/index.html @@ -94,6 +94,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -146,6 +207,10 @@ + + + + @@ -191,6 +256,8 @@ + +
  • Project Structure @@ -203,6 +270,8 @@ + +
  • OAuth diff --git a/docs/_site/install.html b/docs/_site/install.html index 59967102..90564953 100644 --- a/docs/_site/install.html +++ b/docs/_site/install.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/install/debian.html b/docs/_site/install/debian.html index b409deb2..d62b3ae2 100644 --- a/docs/_site/install/debian.html +++ b/docs/_site/install/debian.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/install/docker.html b/docs/_site/install/docker.html index 6c67a04f..f395303e 100644 --- a/docs/_site/install/docker.html +++ b/docs/_site/install/docker.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/install/nginx.html b/docs/_site/install/nginx.html index 866fdee5..8c1ccb33 100644 --- a/docs/_site/install/nginx.html +++ b/docs/_site/install/nginx.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/instances.html b/docs/_site/instances.html index 272b04eb..502e230b 100644 --- a/docs/_site/instances.html +++ b/docs/_site/instances.html @@ -92,6 +92,67 @@ + + + + +
  • + + Usage + + + + +
    • + + + + +
  • Install @@ -144,6 +205,10 @@ + + + + @@ -189,6 +254,8 @@ + +
  • Project Structure @@ -201,6 +268,8 @@ + +
  • OAuth diff --git a/docs/_site/usage.html b/docs/_site/usage.html new file mode 100644 index 00000000..72be3335 --- /dev/null +++ b/docs/_site/usage.html @@ -0,0 +1,466 @@ + + + + + + + + Usage - Gancio + + + + + + + + + + + + + + + + + + + + + + +Usage | Gancio + + + + + + + + + + + + + + + +
    +
    + Gancio + +
    + + +
    +
    +

    This site uses Just the Docs, a documentation theme for Jekyll.

    +
    +
    +
    +
    +
    + +
    +
    + + Search +
    +
    +
    + + + + +
    +
    +
    + + + +
    +

    sadf

    + + + + +
    +

    Table of contents

    + +
      + + + + + + + + + + + + + + + + + + + + +
    • + Recurrent events +
      • + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    +
    + + + diff --git a/docs/_site/usage/recurrent.html b/docs/_site/usage/recurrent.html new file mode 100644 index 00000000..0c09f7fa --- /dev/null +++ b/docs/_site/usage/recurrent.html @@ -0,0 +1,456 @@ + + + + + + + + Recurrent events - Gancio + + + + + + + + + + + + + + + + + + + + + + +Recurrent events | Gancio + + + + + + + + + + + + + + + +
    +
    + Gancio + +
    + + +
    +
    +

    This site uses Just the Docs, a documentation theme for Jekyll.

    +
    +
    +
    +
    +
    + +
    +
    + + Search +
    +
    +
    + + + + +
    +
    +
    + + + + + +
    +

    Gancio supports recurrent events if enabled to (Admin > Settings, +disabled by default).

    + +

    /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

    + +

    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

    + +

    and use the calendar to select one or more days.

    + +

    /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

    + + + + +
    +
    +
    +
    + + + diff --git a/docs/assets/usage/enable_recurrent.png b/docs/assets/usage/enable_recurrent.png new file mode 100644 index 00000000..06b5b2d4 Binary files /dev/null and b/docs/assets/usage/enable_recurrent.png differ diff --git a/docs/assets/usage/recurrent_details.png b/docs/assets/usage/recurrent_details.png new file mode 100644 index 00000000..b9d3f628 Binary files /dev/null and b/docs/assets/usage/recurrent_details.png differ diff --git a/docs/assets/usage/recurrent_details2.png b/docs/assets/usage/recurrent_details2.png new file mode 100644 index 00000000..2e6b2fe3 Binary files /dev/null and b/docs/assets/usage/recurrent_details2.png differ diff --git a/docs/assets/usage/recurrent_menu.png b/docs/assets/usage/recurrent_menu.png new file mode 100644 index 00000000..4b7679fd Binary files /dev/null and b/docs/assets/usage/recurrent_menu.png differ diff --git a/docs/assets/usage/show_recurrent.png b/docs/assets/usage/show_recurrent.png new file mode 100644 index 00000000..4c95e9ec Binary files /dev/null and b/docs/assets/usage/show_recurrent.png differ diff --git a/docs/usage/recurrent.md b/docs/usage/recurrent.md new file mode 100644 index 00000000..6efaa878 --- /dev/null +++ b/docs/usage/recurrent.md @@ -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) + diff --git a/docs/usage/usage.md b/docs/usage/usage.md new file mode 100644 index 00000000..991fe030 --- /dev/null +++ b/docs/usage/usage.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Usage +permalink: /usage +nav_order: 1 +has_children: true +--- + +sadf +