Merge pull request #1 from mauricerenck/develop

First beta release

Author: mauricerenck

README.md

@@ -3,4 +3,63 @@
 Kirby 3 Podcast Plugin
 For first screens of the panel have a look here: https://maurice-renck.de/de/projects/kirby-podcaster
 
-**Current status can be seen in the `develop` branch.**
+## Status
+
+* ✅ new, slimmer ID3-Lib
+* ✅ ID3 parsing after upload (not as in Version 2 during first pageview of the episode/feed)
+* ✅ Panel blueprint section for episodes (so you can extend your article blueprint)
+* ✅ Panel blueprint for extended RSS feed (including all new iTunes specifications)
+* ✅ Completely rewritten RSS feed generator
+* ✅ Most settings now available per feed and in the panel not globally in your config.php
+* ✅ Run multiple podcasts with just one Kirby installation
+* ✅ Updated chapter syntax, now including image
+* ✅ Cover image per feed **and** episode
+* ✅ Author- and owner Settings per feed **and** episode
+* ✅ Upload as many mp3s as you want, select the one for your episode
+* ✅ Source selection, your feed can now be on another location than your episodes
+* ✅ Optimized iTunes Category Handling. Just select the categories from a dropdown. Categorylist updated via GitHub
+* ✅ Snippet for a simple HTML5-Player
+* ✅ Snippet for the advanced Podlove Player
+* ✅ Configure and style your website player within the panel
+* ✅ Routing for downloads/tracking
+* Snippet for Podlove Subscribe box
+* Tracking of downloads using Matomo
+* Tracking of downloads using Kirby and the episoden markdown
+* Tracking of downloads using Kirby and MySQL
+
+
+## Installation
+
+* Clone repository to `/site/plugins/podcaster`
+* In the panel create a new page for your podcast
+* within your new podcast page, create an unlistet page for your rss-feed
+* use the template `podcasterfeed` (currently it doesn't appear in the template list, I working on that)
+* in the panel go to the rss-feed-page and edit all needed information
+
+If you want to use the PodLove-Player and style it, you can try around here: https://docs.podlove.org/podlove-web-player/theme.html
+
+## Add Player to template
+
+If you want an audio player appear on your episode page, just add the follow snippet to your template: `<?php snippet('podcaster-player'); ?>`
+
+If your feed isn't a sibling of your episodes and you selected another source in your rss-settings, you can hand in the episode page and the feed page like so: `<?php snippet('podcaster-player', ['page' => $episodePageObject, 'podcast' => $rssFeedPageObject]); ?>`
+
+This could be also handy, if you want to show the player in your podcast listing.
+
+## Add episode section to your blueprint
+
+If you're using the panel you may want to edit the episode specific information in your article blueprint. You can do so, by adding a new tab using the blueprint `tabs/podcasterepisode` this could look like this:
+
+```
+tabs:
+    content:
+        label: Your sections and columns
+        icon: text
+    podcast:
+        extends: tabs/podcasterepisode
+```
+
+If you never used tabs before, have a look here: https://getkirby.com/docs/guide/blueprints/tabs
+
+You can now edit your episode as needed by iTunes and other directories.
+

UPDATE-FROM-K2.md

@@ -0,0 +1,23 @@
+# Changes
+
+title -> podcasterTitel
+Itunesimage -> podcasterCover
+Itunessubtitle -> podcasterSubtitle
+Language -> podcasterLanguage
+Ituneskeywords -> podcasterKeywords
+Description -> podcasterDescription
+Itunesblock -> podcasterBlock
+Itunesexplicit -> podcasterExplicit
+Itunesauthor -> podcasterAuthor
+Itunesowner, Itunesemail -> podcasterOwner
+iTunesType -> podcasterType
+iTunesCategories -> podcasterCategories
+
+
+```
+<?php snippet('podcaster-player'); ?>
+foreach($children as $episode) {
+    snippet('podcaster-player', ['page' => $episode]);
+}
+
+```

blueprints/files/podcaster-episode.yml

@@ -0,0 +1,9 @@
+title: Podcaster Audiofile
+type: fields
+fields:
+  episodeTitle: 
+    label: Episode Title
+    type: test
+  duration:
+    label: Duration
+    type: text

blueprints/pages/podcasterfeed.yml

@@ -0,0 +1,254 @@
+name: podcasterfeed
+title: Podcast Feed
+tabs:
+  content:
+    label: Content
+    icon: text
+    columns:
+      - width: 1/1
+        sections:
+          heading:
+            type: fields
+            fields:
+              headlineInfo:
+                type: headline
+                label: RSS Information
+      - width: 1/4
+        sections:
+          graphics:
+            type: fields
+            fields:
+              podcasterCover:
+                type: files
+                label: Cover Image
+                max: 1
+                width: 1/3
+                layout: cards
+                multiple: false
+                max: 1
+                cover: true
+          files:
+            type: files
+      - width: 2/4
+        sections:
+          infos:
+            type: fields
+            fields:
+              podcasterTitle:
+                label: Podcast Title
+                type: text
+                required: true
+              podcasterSubtitle:
+                label: Podcast Subtitle
+                type: text
+              podcasterDescription:
+                label: Description
+                type: textarea
+                size: medium
+              podcasterKeywords:
+                label: iTunes Keywords
+                type: tags
+              podcasterLink:
+                label: Link
+                required: true
+                type: url
+                help: Can be a link to your podcasts landing page
+              podcasterCopyright:
+                label: Copyright
+                type: text
+  settings:
+    label: RSS Settings
+    icon: text
+    columns:
+      - width: 1/1
+        sections:
+          heading2:
+            type: fields
+            fields:
+              headlineSettings:
+                type: headline
+                label: RSS Settings
+      - width: 1/4
+        sections:
+          settings:
+            type: fields
+            fields:
+              podcasterSource:
+                label: Source Page
+                type: pages
+                required: true
+                multiple: false
+                help: Select the page which will act as a parent of your episodes. Normally this is the page which is the parent of this feed, too.
+              podcasterLanguage:
+                label: Language
+                type: text
+                required: true
+              podcasterType:
+                label: Podcast type
+                type: select
+                default: episodic
+                options:
+                  episodic: Episodic
+                  serial: Serial
+              podcasterAtomLink:
+                label: Atom Link
+                type: url
+                help: If your want the target of your rss atom:link tag to point elsewhere, set the url here. This can be handy, if you want to use something like feedburner
+      - width: 2/4
+        sections:
+          categorySettings:
+            type: fields
+            fields:
+              podcasterCategories:
+                label: iTunes Categories
+                type: structure
+                required: true
+                fields:
+                  podcasterMainCategory:
+                    label: Main
+                    type: select
+                    options: api
+                    api: https://raw.githubusercontent.com/mauricerenck/kirby-podcaster/master/res/categories.json
+      - width: 1/4
+        sections:
+          authors:
+            type: fields
+            fields:
+              podcasterAuthor:
+                label: Author
+                type: users
+                max: 1
+              podcasterOwner:
+                label: Owner
+                type: users
+                max: 1
+  dangerzone:
+    label: Dangerzone
+    icon: text
+    sections:
+     dangerzone:
+      type: fields
+      fields:
+        headlineDanger:
+          type: headline
+          label: Dangerzone
+        infoDanger:
+          label: Be aware!️️
+          type: info
+          theme: negative
+          text: The following settings will influence how and if your podcast appears on directories like iTunes. Please be aware that setting the wrong option can harm your podcasts appearance.
+          width: 1/4
+        podcasterBlock:
+          label: Block
+          type: toggle
+          default: no
+          text: 
+            - Podcast is visible
+            - Podcast is BLOCKED
+          help: Enabling this will prevent your Podcast from appearing on the iTunes Store and other podcast directories.
+          width: 1/4
+        podcasterExplicit:
+          label: Explicit
+          type: toggle
+          default: no
+          text: 
+            - Suitable for all ages
+            - Podcast marked as explicit
+          help: Enabling this will mark your podcast as explicit and may cause that it's not available for certain age groups.
+          width: 1/4
+        podcasterComplete:
+          label: Complete
+          type: toggle
+          default: no
+          text: 
+            - New episodes will come
+            - No new episodes planned
+          help: Enabling this will tell podcast directories that there won't be any new episodes.
+          width: 1/4
+        podcasterNewFeedUrl:
+          label: New Feed URL
+          type: url
+          help: Leave empty if you do not want to change your feed url
+          width: 1/4
+  player:
+    label: Website Player
+    columns:
+      - width: 1/4
+        sections:
+          player:
+            type: fields
+            fields:
+              headlinePlayer:
+                type: headline
+                label: Website Player
+              playerType:
+                label: Player Type
+                type: select
+                default: podlove
+                options:
+                  html5: Standard HTML5 Player
+                  podlove: Advanced Podlove Player
+              infoPlayer:
+                type: info
+                theme: info
+                text: You need to put the player snippet in your template file. Just add <?php snippet('podcaster-player'); ?> where you want the player to appear.
+      - width: 2/4
+        sections:
+          podloveConfig:
+            type: fields
+            fields:
+              headlinePodlove:
+                type: headline
+                label: Podlove Player Configuration
+              infoPodlove:
+                type: info
+                theme: info
+                text: This settings will only work, if you chose the Podlove player.
+              podcasterPodloveMainColor: 
+                label: Main color (hex)
+                type: text
+                width: 1/2
+              podcasterPodloveHighlighColor: 
+                label: Highlight color (hex)
+                type: text
+                width: 1/2
+              podcasterPodloveTabsInfo:
+                label: Info Tab
+                type: toggle
+                default: yes
+                text: 
+                  - Invisible
+                  - Visible
+                width: 1/4
+              podcasterPodloveTabsShare:
+                label: Share Tab
+                type: toggle
+                default: yes
+                text: 
+                  - Invisible
+                  - Visible
+                width: 1/4
+              podcasterPodloveTabsChapters:
+                label: Chapters Tab
+                type: toggle
+                default: yes
+                text: 
+                  - Invisible
+                  - Visible
+                width: 1/4
+              podcasterPodloveTabsAudio:
+                label: Audio Tab
+                type: toggle
+                default: yes
+                text: 
+                  - Invisible
+                  - Visible
+                width: 1/4
+              podcasterPodloveTabsDownload:
+                label: Audio Tab
+                type: toggle
+                default: yes
+                text: 
+                  - Invisible
+                  - Visible
+                width: 1/4