Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
jekuer committed Jan 31, 2024
1 parent f717dfe commit a60bbfd
Show file tree
Hide file tree
Showing 14 changed files with 445 additions and 16 deletions.
22 changes: 20 additions & 2 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,18 @@ export default {
}
},

transformPageData(pageData) {
const canonicalUrl = `https://docs.add-to-calendar-pro.com/${pageData.relativePath}`
.replace(/index\.md$/, '')
.replace(/\.md$/, '.html')

pageData.frontmatter.head ??= []
pageData.frontmatter.head.push([
'link',
{ rel: 'canonical', href: canonicalUrl }
])
},

lastUpdated: true,

locales: {
Expand Down Expand Up @@ -63,7 +75,10 @@ export default {
items: [
{ text: 'RSVP', link: '/de/recipes/rsvp' },
{ text: 'Newsletter-Promotion', link: '/de/recipes/newsletter-promotion' },
{ text: 'Dynamic Checkout', link: '/de/recipes/dynamic-checkout' }
{ text: 'Dynamic Checkout', link: '/de/recipes/dynamic-checkout' },
{ text: 'Individuelle Event-Texte', link: '/de/recipes/dynamic-text' },
{ text: 'Event-Webseite', link: '/de/recipes/event-website' },
{ text: 'Warteliste', link: '/de/recipes/waitlist' }
]
},
{ text: 'Fehlerbehebung', link: '/de/troubleshooting' },
Expand Down Expand Up @@ -194,7 +209,10 @@ export default {
items: [
{ text: 'RSVP', link: '/recipes/rsvp' },
{ text: 'Newsletter Promotion', link: '/recipes/newsletter-promotion' },
{ text: 'Dynamic Checkout', link: '/recipes/dynamic-checkout' }
{ text: 'Dynamic Checkout', link: '/recipes/dynamic-checkout' },
{ text: 'Individual Event Text', link: '/recipes/dynamic-text' },
{ text: 'Event Website', link: '/recipes/event-website' },
{ text: 'Waitlist', link: '/recipes/waitlist' }
]
},
{ text: 'Troubleshooting', link: '/troubleshooting' },
Expand Down
8 changes: 8 additions & 0 deletions .vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,14 @@
margin-bottom: 1.3em;
}

.vp-doc h3 {
margin-top: 2.5em;
}

.vp-doc h4 {
margin-top: 1.3em;
}

.VPDocFooter {
margin-top: 8em !important;
}
Expand Down
115 changes: 113 additions & 2 deletions src/application-manual/elements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,117 @@
---
outline: [2,3]
---

# Elements to discover

::: warning This site is currently still under heavy construction!
Have a second look in a few weeks. :)
At Add to Calendar PRO, we think of the different elements of event sharing and RSVP as building blocks.

That makes it easier to re-use specific things, keep it organized, and reduce maintenance effort on your side.

The hierarchy looks likes this:


```
└─ Event Group
└─ Event
├─ RSVP template *(optional)*
├─ CTA template *(optional)*
└─ Style *(optional)*
├─ Landingpage template *(optional)*
└─ Email template per RSVP email type *(optional)*
```

You will face this hierarchy during the creation of element. Still, within the app, they are organized a little different, in order to make them easily accessible - see the main navigation (Events - Styles - Templates).

Webhooks, Team, and Settings are additional elements, which are described here as well.

## Events

::: tip Events are the core.
Generally speaking, it is all about events.
:::

They are the core of everything you build with Add to Calendar PRO. This might be obvious for Add to Calendar Buttons, but also an RSVP always sits on top of an event (even in edge cases, where there is no specific date).

**You should always start with creating one of them first!**

*(Except for the case, where you want to offer a calendar subscription with an external calendar. Since the event are basically outside of our system, you would directly start with an event group.)*

[Learn more »](/application-manual/groups-and-events.html#events)

## Groups

**An event group basically is a container for events.**

It can be used for structuring and organize all of your data, or to link to an external calendar instead of individual events. When creating a new event, you will be asked to specify a group to place it in (or to create a new group).

[Learn more »](/application-manual/groups-and-events.html#groups)

## Styles

[Styles](/application-manual/styles-and-templates.html#styles) define the look and feel of all public elements.

They can be created directly when creating a new event.

You can also create them independently within the "Styles" section.
All events you create, can be linked to an event with just one click. This makes it easy to use the same style for multiple buttons or forms, without the need to define them over and over again.

*Bascially, "Styles" are also templates. We differentiate, because they play a more vital role, but that's all.*

::: info Mind that there are some exceptions.
Landingpages and RSVP emails are also partly styled within the respective template blocks and not only by the *style*!
:::

## Templates

Similar to the "Styles", all other elements are also built as template blocks.
This means, that you can re-use them for multiple events. **They are also actively connected, which means that changing a template (or style) will directly affect any linked event!**

All templates can also be directly created during event creation, but their central home is the respective section in the app.

### RSVP

An [RSVP template](/application-manual/styles-and-templates.html#rsvp) defines RSVP functionality, like expiration, limitations, or fields.

Connect this to an event, while activating the RSVP option, and you turn the Add-to-Calendar-Button into a fully functional RSVP form.

### CTA

A [Call-to-Action (CTA)](/application-manual/styles-and-templates.html#cta) is quite similar to the RSVP template.

It can be also linked to an event and will show up after users added the event to their calendar. It can be a slogan, sharing options, some link to another product/website/event, or even a form (e.g. Newsletter signup).

Create the functionality here, link it to your event, and it will automatically show up - styled, based on any linked style.

### Emails

[Email templates](/application-manual/styles-and-templates.html#emails) can be linked to a Style.

When setting them, you overwrite the default emails, that we send for any RSVP interaction of the user (like Double-Opt-In, confirmation, etc.).

You can also adjust the look of the email within the template.

### Landingpages

For every event, we automatically generate a nice responsive landingpage for it.

This makes it easy to share your RSVP or event on social media and beyond.

By creating a [landingpage template](/application-manual/styles-and-templates.html#landingpages), you can adjust the look as well as additional content of this landingpage.
Link this template to the style, which is used at the respective event, and you are done.

## Webhooks

With [webhooks](/automation-integration/webhooks.html), you can easily push information to other services, whenever something important happens with your RSVP or event (except for users saving events to their calendar - this needs to be tracked differently).

## Team Members

You can invite your colleagues to your [team](/application-manual/team.html) and work on stuff together.

**No worries, there is no limitation on seats!**

within the "Team" section, you can manage the invites and roles.

## Settings

While the [settings](/application-manual/settings.html) are mainly about your account, the look of the application, and your license, some parts also affect your projects. For example, you can upload a logo, which then is also used at the email templates as footer image.
2 changes: 1 addition & 1 deletion src/application-manual/groups-and-events.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Groups and Events

An **event group** acts as a container for multiple events.
An **event group** acts as a container for one or multiple events.

It can be used for structuring and organize all of your data, or to link to an external calendar instead of individual events.
The latter one creates a button, which will trigger a subscription to this calendar. In this case, styles, RSVPs, and CTAs can be directly connected to the group.
Expand Down
114 changes: 112 additions & 2 deletions src/de/application-manual/elements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,116 @@
---
outline: [2,3]
---

# Elemente

::: warning Diese Seite befindet sich aktuell noch im Aufbau!
Schau in wenigen Wochen nochmal vorbei. :)
Bei Add to Calendar PRO betrachten wir die verschiedenen Elemente im Kontext von Event-Sharing und RSVP als Bausteine.

Das erleichtert die Wiederverwendung spezifischer Setups, hält alles aufgeräumt und reduziert den Wartungsaufwand auf deiner Seite.

Die Hierarchie sieht folgendermaßen aus:

```
└─ Event-Gruppe
└─ Event
├─ RSVP-Template *(optional)*
├─ CTA-Template *(optional)*
└─ Style *(optional)*
├─ Landingpage-Template *(optional)*
└─ E-Mail-Template je RSVP-E-Mail-Typ *(optional)*
```

Du wirst auf diese Hierarchie während der Erstellung eines Elements stoßen. Innerhalb der App sind sie jedoch etwas anders organisiert, um sie leichter zugänglich zu machen - siehe Hauptnavigation (Events - Styles - Templates).

Webhooks, Team und Einstellungen sind zusätzliche Elemente, die wir auf dieser Seite ebenfalls beschreiben.

## Events

::: tip Events sind der Kern von allem.
Generell geht es um Events.
:::

Sie sind der Kern von allem, was du mit Add to Calendar PRO erstellst. Das mag offensichtlich für Add-to-Calendar-Buttons sein, aber auch ein RSVP basiert immer auf einem Event (selbst in Sonderfällen, wo es kein spezifisches Datum gibt).

**Du solltest immer damit beginnen, zuerst ein Event zu erstellen!**

*(Ausgenommen der Fall, wo du ein Kalender-Abonnement mit einem externen Kalender anbieten möchtest. Da die Events im Grunde außerhalb unseres Systems liegen, würdest du direkt mit einer Eventgruppe beginnen.)*

[Mehr erfahren »](/de/application-manual/groups-and-events.html#events)

## Gruppen

**Eine Eventgruppe ist im Grunde ein Container für Events.**

Sie kann verwendet werden, um alle deine Termine zu strukturieren und zu organisieren, oder um auf einen externen Kalender zu verlinken, anstatt auf einzelne Events. Wenn du ein neues Event erstellst, wirst du gefragt, in welcher Gruppe du es platzieren möchtest (oder ob du eine neue Gruppe erstellen möchtest).

[Mehr erfahren »](/de/application-manual/groups-and-events.html#groups)

## Styles

[Styles](/de/application-manual/styles-and-templates.html#styles) definieren den Look aller öffentlichen Elemente.

Sie können direkt bei der Erstellung eines neuen Events erstellt werden.

Du kannst sie auch unabhängig davon im Abschnitt "Styles" erstellen.
Alle Events, die du erstellst, können mit nur einem Klick mit einem Style verknüpft werden. Dies erleichtert es, denselben Stil für mehrere Buttons oder Formulare zu verwenden, ohne sie immer wieder neu definieren zu müssen.

*Im Grunde genommen sind "Styles" auch Templates. Wir unterscheiden hierbei im Wording, weil sie eine zentralere Rolle spielen - aber das ist auch schon alles.*

::: info Beachte, dass es einige Ausnahmen gibt.
Landingpages und RSVP-E-Mails werden auch teilweise innerhalb der jeweiligen Template-Blöcke und nicht nur durch den *Style* gestaltet!
:::

## Templates

Ähnlich wie bei den "Styles" werden auch alle anderen Elemente als Template-Blöcke erstellt.
Das bedeutet, dass du sie für mehrere Events wiederverwenden kannst. **Sie sind auch aktiv damit verbunden, was bedeutet, dass eine Änderung eines Templates (oder eines Styles) direkt jedes verknüpfte Event beeinflusst!**

Alle Templates können auch direkt bei der Eventerstellung erstellt werden. Ihr "Zuhause" ist allerdings der jeweilige Abschnitt in der App.

### RSVP

Ein [RSVP-Template](/de/application-manual/styles-and-templates.html#rsvp) definiert RSVP-Funktionalitäten wie Ablaufdatum, Limitationen oder zusätzliche Angaben/Felder.

Verbinde diese mit einem Event, während du die RSVP-Option aktivierst, und du verwandelst den Add-to-Calendar-Button in ein voll funktionsfähiges RSVP-Formular.

### CTA

Ein [Call-to-Action (CTA)](/de/application-manual/styles-and-templates.html#cta) ist einem RSVP-Template sehr ähnlich.

Er kann auch mit einem Event verknüpft werden und wird angezeigt, nachdem Benutzer das Event zu ihrem Kalender hinzugefügt haben. Es kann ein Slogan, "Teilen"-Buttons, ein Link zu einem anderen Produkt/einer anderen Webseite/einem anderen Event oder sogar ein Formular (z. B. Newsletter-Anmeldung) sein.

Erstelle hier die Funktionalität, verlinke sie mit deinem Event, und der CTA wird automatisch angezeigt - im Look eines verknüpften Styles.

### E-Mails

[E-Mail-Templates](/de/application-manual/styles-and-templates.html#emails) können mit einem Style verknüpft werden.

Wenn du sie definierst, überschreibst du die Standard-E-Mails, die wir für jede RSVP-Interaktion des Benutzers senden (wie Double-Opt-In, Bestätigung usw.).

Du kannst auch das Aussehen der E-Mail innerhalb des Templates anpassen.

### Landingpages

Für jedes Event generieren wir automatisch eine ansprechende, responsive Landingpage.

Dies erleichtert das Teilen deines RSVPs oder Events in sozialen Medien und darüber hinaus.

Indem du ein [Landingpage-Template](/de/application-manual/styles-and-templates.html#landingpages) erstellst, kannst du das Aussehen sowie zusätzliche Inhalte dieser Landingpage anpassen.
Verknüpfe das Template mit dem Style, der beim jeweiligen Event verwendet wird, und du bist fertig.

## Webhooks

Mit [Webhooks](/de/automation-integration/webhooks.html) kannst du Informationen problemlos an andere Dienste weiterleiten, wann immer etwas Wichtiges mit deinem RSVP oder Event passiert (außer, wenn Benutzer Events in ihren Kalender speichern - dies muss anders getrackt werden).

## Teammitglieder

Du kannst deine Kolleginnen und Kollegen zu deinem [Team](/de/application-manual/team.html) einladen und gemeinsam an Projekten arbeiten.

**Keine Sorge, es gibt keine Begrenzung in der Anzahl, bzw. entstehen keine Kosten durch mehr Mitglieder!**

Im Abschnitt "Team" kannst du die Einladungen und Rollen verwalten.

## Einstellungen

Während die [Einstellungen](/de/application-manual/settings.html) hauptsächlich deinen Account, das Aussehen der Anwendung und deine Lizenz betreffen, beeinflussen einige Teile auch deine Projekte. Zum Beispiel kannst du ein Logo hochladen, das dann auch in den E-Mail-Templates als Abbinder verwendet wird.
2 changes: 1 addition & 1 deletion src/de/application-manual/groups-and-events.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Gruppen und Events

Eine **Event-Gruppe** ist eine Art Container für mehrere Events.
Eine **Event-Gruppe** ist eine Art Container für ein oder mehrere Events.

Sie kann zur Strukturierung und Organisation deiner Daten genutzt oder mit einem externen Kalender verknüpft werden.
Letzteres erzeugt einen Button, über den man einen Kalender abonnieren kann. Entsprechend kannst du Styles, RSVPs und CTAs in diesem Fall direkt mit der Gruppe verknüpfen.
Expand Down
4 changes: 0 additions & 4 deletions src/de/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ lastUpdated: false

Hier findest du alles, was du brauchst, um unsere Tools bedienen und in deinen Tech-Stack und Use Cases integrieren zu können.

::: warning Diese Seite befindet sich aktuell noch im Aufbau!
Schau in wenigen Wochen nochmal vorbei. :)
:::

<br />

---
Expand Down
Loading

0 comments on commit a60bbfd

Please sign in to comment.