forked from podlove/podlove-publisher
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
411 lines (260 loc) · 16.2 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
=== Podlove Podcast Publisher ===
Contributors: eteubert
Donate link: https://opencollective.com/podlove
Tags: podlove, podcast, publishing, rss, audio
Tested up to: 6.6.1
Stable tag: 4.1.15
Requires at least: 4.9.6
Requires PHP: 8.0
License: MIT
The one and only next generation podcast publishing system. Seriously. It's magical and sparkles a lot.
== Description ==
We started the Podlove Podcast Publisher project in 2012 because existing solutions were stuck in the past, complex and unwieldy. The Publisher helps you save time, worry less and provides a cutting edge listening experience for your audience.
Official Site: [podlove.org/podlove-podcast-publisher](https://podlove.org/podlove-podcast-publisher)
### Video Tutorial: Getting started with Podlove Publisher
[youtube http://www.youtube.com/watch?v=Hmrm-jUe6u4]
### Compatible RSS Feeds
The Publisher makes it easy to create highly expressive, efficient and super compatible podcast feeds with fine grained control over client behavior (e.g. GUID control to replace faulty episodes and for clients to reload) supporting all important meta data.
### Multi-Format Publishing
The Publisher also makes multi-format publishing - embracing all modern and legacy audio and video codecs - a snap. By adopting simple file name conventions, the plugin allows the podcaster to provide individual feeds for certain use cases or audiences without adding work for the podcaster during the publishing process.
### Optimized Web Player
The Publisher also comes integrated with the Podlove Web Player plugin and fully supports its advanced options including multiple audio (MP4 AAC, MP3, Vorbis, Opus) and video (MP4 H.264, WebM, Theora) format support for web browsers. This Web Player is fully HTML5 compatible and is ready for all touch based clients too.
### Metadata Galore
* **Chapter Marks:** The Publisher also makes it easy to publish chapter information in the player to make access to structured episodes even easier. Full support for linking directly to any part of your podcast on the web with instant playback included.
* **Contributors:** Bring your team and guests front and center. Manage contributors, including their names, avatars and web urls.
* **Transcripts:** WebVTT transcripts can be imported and even connected to your contributors. They are referenced in the RSS feed so they can be displayed by podcast apps.
* **Seasons:** Does your podcast have seasons? We got you covered with a dedicated "Seasons" module.
* **Related Episodes:** Manage and display related episodes on your website.
### Auphonic Integration
Auphonic is your all-in-one audio post production webtool to achieve a professional quality result. We provide a first class integration module for ease of use and best automation experience.
### Flexible Templates
To round it all up, a flexible template system enables you to published Podcasts in a defined fashion and change the style at any time without having to touch your individual postings later on.
And this is just the beginning. We have a rich roadmap that will bring even more interesting features: integration with helpful services, much improved timeline metadata support (show notes) and much more.
= Further Reading =
* [Podlove Publisher](http://publisher.podlove.org/)
* [Podlove Project](http://podlove.org/)
* [Podlove Community](https://community.podlove.org/)
* [Documentation](http://docs.podlove.org/)
* [Bug Tracker](https://github.com/podlove/podlove-publisher/issues)
* [Donate](http://podlove.org/donations/)
Development of the plugin is an open process. The current version is available [on GitHub](https://github.com/podlove/podlove-publisher) Feel free to contribute and to fix errors or send improvements via GitHub.
Requires PHP 8.0+
== Frequently Asked Questions ==
### Is Podlove Podcast Publisher free?
Yes! The core features of Podlove Podcast Publisher are and always will be free.
### Are there Download Statistics?
Yes! Podcast Downloads can be tracked and analyzed. You can easily see how many people downloaded you podcast episodes, which clients they used, if they prefer to subscribe to the feed or listen on your website using the web player—and much more.
### Are there Privacy / GDPR considerations?
Podlove Publisher is GDPR compliant and provides prewritten text snippets for your privacy page. See https://docs.podlove.org/podlove-publisher/guides/dsgvo-gdpr.html
### Where can I host my podcast files?
Any storage where you have control over the file naming is compatible with Podlove Podcast Publisher. You can manage files using a simple FTP/sFTP or use services like Amazon S3.
### Where can I ask questions and get support?
Free support where questions are answered by the community is available in the [Podlove Community Forum](http://community.podlove.org/). There is a German community in the [Sendegate](https://sendegate.de/).
### How can I help the project?
The continued success of Open Source project relies on the community. There are many ways you can help:
Episode title in API now follows the same rules as in RSS feed. There's a new field 'title_clean' for accessing the specifically set plain episode title, but that might be null in some cases, so it's better to default the 'title' attribute to the usual rules.
- If you enjoy the plugin, please [leave a review](https://wordpress.org/support/plugin/podlove-podcasting-plugin-for-wordpress/reviews/#new-post).
- You can answer questions of other fellow podcasters in the [Podlove Community](https://community.podlove.org/).
---
This product includes GeoLite2 data created by MaxMind, available from http://www.maxmind.com.
== Installation ==
1. Download the Podlove Publisher Plugin to your desktop.
1. If downloaded as a zip archive, extract the Plugin folder to your desktop.
1. With your FTP program, upload the Plugin folder to the wp-content/plugins folder in your WordPress directory online.
1. Go to Plugins screen and find the newly uploaded Plugin in the list.
1. Click Activate Plugin to activate it.
== Screenshots ==
1. Custom episode post type separates media from your blog content.
2. Download analytics provide you with all the data you ever wanted.
3. The Publisher automatically checks the health of your media files.
4. The mighty template engine gives you full control over the episode presentation.
5. Includes the Podlove Subscribe Button, the easiest way for listeners to subscribe to your podcast.
6. Includes the Podlove Web Player. One more thing: you can manage and present all contributors easily.
== Changelog ==
= 4.1.16 =
* fix: plugin crash on setup when default WordPress roles do not exist
= 4.1.15 =
* security: disable unsafe Twig Template filters "filter", "map" and "reduce"
= 4.1.14 =
* security: add nonces to template actions
* security: use output escaping for episode slug
= 4.1.13 =
* add transcripts to import/export
* add confirmation button on modal to input episode image url
* fix: selecting an episode image updates the preview
= 4.1.12 =
* new: when selecting a file for Auphonic, its name is suggested to be used as episode slug
* fix: PHP deprecation warnings
= 4.1.11 =
* new: support `podcast:license` tag in RSS feed
* fix: imports correct chapter times from Auphonic (when using features that affect the episode duration)
* maintenance: update various javascript dependencies
= 4.1.10 =
* fix: bug introduced in latest patch that created duplicate database entries for media files
= 4.1.9 =
Various fixes regarding adjusted media file handling introduced in version 4.0.11:
- dashboard shows a grey bar again when the file is inactive
- RSS feed correctly skips items with inactive files again
= 4.1.8 =
* changes in an episode immediately affect the RSS feed
There are various caches in place to ensure efficient delivery of the RSS feed
to podcast clients. However it can be hard to guess how long it will take for a
change to appear in the feed and podcatchers. Now, any change to the episode
metadata or enabling/disabling an asset immediately clears the cache for that
feed item, resulting in the change to be visible in the RSS feed immediately.
* transcripts: contributors in voices selection are sorted alphabetically
* fix: episode license and explicit value are not emptied when saving the episode
* maintenance: fix various notices from WordPress Plugin Check tool
* maintenance: js dependency updates
= 4.1.7 =
* fix `itunes:explicit` RSS tag. It now contains the valid values "true" or "false".
* fix typo in API: `explicit` field was mistyped as `expicit`
= 4.1.6 =
* Shows Settings: sort Auphonic presets alphabetically
= 4.1.5 =
* Hotfix: Creating Auphonic productions works again
= 4.1.4 =
* Auphonic: reduce preset cache to 10 seconds so manual refreshing is not necessary (and remove broken refresh button on module page)
* Auphonic: select configured show preset when selecting a show
* Auphonic: fix status updates when opening an episode with an already running production
* performance: don't try to fetch file headers twice for unreachable URLs
* performance: faster saving of slug changes
= 4.1.3 =
* Shows selection in the episode was rewritten for the new frontend stack. It is now compatible with the Automatic Numbering module again.
= 4.1.2 =
* transcripts: include json link in RSS again when "Publisher Generated" is selected
* transcripts: polish timestamp rendering in preview (shorter, monospaced, right aligned, unselectable)
* chapters: fix "unknown" durations
= 4.1.1 =
* security: add nonces to tools actions
= 4.1.0 =
**Feature: Better control over transcripts in RSS feed**
There is a new feature under `Podlove > Podcast Feeds` called "Episode
Transcripts" to control how episode transcripts should be referenced in your RSS
feed. The default is "Publisher Generated vtt", which is nearly the same
behavior as before (In previous versions, three variants were referenced: vtt,
json and srt. The json and srt URLs still work but they are not referenced in
the RSS feed any more as they are not neccessary and removing them reduces feed
size). There is a dedicated "Do not include in feed" option, in case you do not
want the transcripts in your RSS feed.
Finally, you may prefer to host your transcript assets externally, just like
your audio files. If you have configured a transcript asset, you can now select
it in this setting. Then the RSS feed will reference this external file
directly.
**Auphonic improvements**
- add button to always access the import screen
- add button to delete a track
- show status in production selection
- rearrange / polish various some button and information positions
**Other**
- add: capability "podlove_manage_contributors" for contributors settings screens
- fix: sometimes missing voices in Podlove Web Player transcripts
- fix: sometimes an enabled asset is disabled a few moments later
- fix: show files as "not found" when they become unreachable
- transcripts: rename "delete" action to "clear"
- transcripts: show timestamps in editor preview
- upgrade heroicons (icon library) from v1 to v2
= 4.0.15 =
- security: add nonces to jobs management
= 4.0.14 =
- add: migrate episode license selector user interface
- change: show unknown duration as "--:--:--.---" instead of "00:00:00.000"
- fix: auto-generate file slug from episode-post-title
- fix: ensure slug field is always usable (wide enough, and prefix shortened if necessary)
- security: fix SQL injection vulnerability in Related Episodes module
- security: ensure only administrators can manage jobs
= 4.0.13 =
**Features**
- Templates: new `active` accessor for `File` objects. Returns if the file is marked as active.
**Bugfixes and Improvements**
- fix: don't use the Auphonic chapter image URL (real fix where chapter images are downloaded and served from WordPress will follow later)
- fix: only display active files in download widgets
- improve handling of upload directory
= 4.0.12 =
**Security**
- fix SSRF vulnerability in Slacknotes module
- add missing capability check and nonce validation to importer functions
- add missing capability check and nonce validation to exporter functions
= 4.0.11 =
- new: show admin notice when a database migration fails
- fix bug where tracking data could be lost by disabling a media file checkbox
- fix bug where imported Hindenburg chapters were not sorted by time
- fix build script (correctly delete all vendor prefixed dependencies)
- fix deprecation warnings ([#1431](https://github.com/podlove/podlove-publisher/pull/1431), [#1430](https://github.com/podlove/podlove-publisher/pull/1430))
- update js dependencies
- update help text for missing curl module
= 4.0.10 =
- fix security issues (XSS)
- do not unnecessarily flush rewrite rules ([Issue#1432](https://github.com/podlove/podlove-publisher/issues/1432))
- fix link to Slacknotes and Subscribe Button documentation
- fix psr library not removed after prefixing ([Issue#1421](https://github.com/podlove/podlove-publisher/issues/1421))
= 4.0.9 =
**Enhancements**
- trim whitespaces from beginning and end of file slug
- soundbite: change placeholder to HH:MM:SS to clarify format
**Bugfixes**
- fix division by zero in analytics
- fix default contributors missing position attribute
- fix Auphonic chapter timestamp import
- fix page reload when clicking chapter upload button
= 4.0.8 =
**Bugfixes**
- fix broken analytics episode screen
= 4.0.7 =
**Bugfixes**
- fix media verification not saving
- fix shownotes unfurling
- avoid failure during database migration
**Misc**
- update/cleanup various js dependencies
= 4.0.6 =
**Bugfixes**
- Auphonic: saving production not working when slug is not set (bug introduced in 4.0.5)
= 4.0.5 =
**Bugfixes**
- Auphonic: restore previous behaviour:
- automatically fill in file slug, validate media files and fill in duration when production finishes
- use slug as "output_basename" if it is set
**Misc**
- cleanup legacy js app (dependency updates, deletion of unused code etc.)
= 4.0.3 / 4.0.4 =
**Enhancements**
- Auphonic: sort presets alphabetically
- Contributors: make better use of available space
**Bugfixes**
- episode metadata not saving reliably for some people
- Auphonic: fix chapter time import
- WordPress File Upload: display slug input (should be filled automatically but does not seem to work reliably)
= 4.0.2 =
**Bugfixes**
- Auphonic: Chapters can be imported from production metadata
- Contributors: Add support for Gravatar and default contributor image on edit screens
- Dashboard: Asset Validation / Detection is working again [#1396](https://github.com/podlove/podlove-publisher/issues/1396)
- Automatic Numbering: error when selecting a show
= 4.0.1 =
**Enhancements**
- Auphonic: autosave before "Start Production" so it is not required to explicitly save before starting
**Bugfixes**
- Auphonic: open productions with missing algorithm information
- Templates: fix broken core templates `downloads-select` and `related-episodes-list`
- Classic Editor: display Episode Title Placeholder based on Blog Post Title
= 4.0.0 =
Podlove Publisher 4.0 is here, bringing a spring-clean (in November!) of the episode page. We tore up the foundation to bring you an all-new user interface.
**Warning:** PHP 8.0 and above is now required!
**Highlights**
- **Episode Form** User Interface is modernised and auto-saves, so no work is ever lost.
- **Auphonic module** includes Multitrack Support.
- **New Contributors** can be added without leaving the episode page.
- **Chapters** support images.
- **REST API V2** is now, including many more endpoints. See the [API documentation](https://docs.podlove.org/podlove-publisher/api) for all the details.
**Tidbits**
- file “slug” field is prefixed with the media location so it’s more obvious what it is used for
- episode duration is always auto-detected and not an input field any more
- Auphonic Preset can be selected directly in the episode and does not rely on global module setting any more
- removed module “Twitter Card Integration” (RIP). By the way, if you want to follow us on social media, find us here: https://fosstodon.org/@podlove
- fix various PHP notices and warnings to be PHP 8.0+ compatible
----
Changes for previous versions can be found in the [`changelog.txt`](https://github.com/podlove/podlove-publisher/blob/master/changelog.txt).
== Upgrade Notice ==
= 4.0.0 =
An all-new episode creation experience. Requires PHP 8.0 and above.