Permalink
Browse files

🌟 New help page!

  • Loading branch information...
Joachim Robert
Joachim Robert committed Dec 14, 2018
1 parent 1c98707 commit c1a687e090b5178b4d18bbb7e62a166af2e28eae
@@ -0,0 +1,43 @@
{% extends 'layout.html' %}

{% block title %}Help{% endblock %}

{% block content %}
<div class="content">
<h2 class="is-size-4 title">Cast Rewinder gives you a podcast feed URL, and you can modify it to suit your needs.</h2>

<p class="is-size-5">Let’s say you want daily updates from a podcast through Cast Rewinder. Then after a few weeks, you want to switch to a weekly occurence. How would you go about it? You can generate a new feed URL, but you can also edit the feed URL you had for your daily updates. Here’s how it work.</p>

<h3 class="is-size-5 title">The basic URL</h3>

<p class="">A basic Cast Rewinder feed URL follows this form:<br>
<code>{{ request.host_url }}3/weekly/20181214+0000</code></p>
<ol>
<li><code>{{ request.host_url }}</code> is the domain, you won’t need to change that</li>
<li><code>/3/</code> is the identifier for the podcast in the database. You won’t need to change that either</li>
<li><code>/weekly/</code> is the code word for the frequency. This can be changed. Possible values are <code>daily</code>, <code>weekly</code>, <code>monthly</code>, or any combination of weekdays in the form of three-letter abbreviations.<br>E.g.: <code>mon-thu-sun</code> will publish new episodes on Mondays, Thursdays and Sundays</li>
<li><code>/20181214+0000/</code> is the start date and timezone info that Cast Rewinder uses to generate your feed. This can be changed. I follows the format <code>YYYYMMDD</code> for the date (with Y as the year, M as the month and D as the day), and <code>+</code> or <code>-</code> followed by the time offset compared to UTC, in the form <code>HHMM</code> for the timezone info (with H for the hours and M for the minutes), UTC+5 will be <code>+0500</code></li>
</ol>

<h3 class="is-size-5 title">Adding options</h3>
<p>More options can be added to the URL. They go at the end of the URL after the date and a slash (<code>/</code>), they are separated by a comma (<code>,</code>) and define their values with a colon (<code>:</code>).<br>
E.g.: <code>{{ request.host_url }}3/weekly/20181214+0000/start_at:5,order:desc</code></p>

<p>There are four options, and they can be arranged in any order:</p>
<ul>
<li><code>start_at</code> will define where to start the feed, from its start. If you want to start from the 5th episode (included) and not the first, the option will be: <code>start_at:5</code></li>
<li><code>order</code> sets your preference for the playing order. By default its value is <code>asc</code> (for ascending), you can set it to <code>desc</code> (for descending) to get your episodes from the most recent to the oldest</li>
<li><code>format</code> sets your preference for the feed format. <code>feed_rss</code>, <code>feed_atom</code> and <code>feed_json</code> are the available formats, if no option is provided it will be set on <code>feed_rss</code> to deliver you a RSS feed</li>
<li><code>keep_dates</code> will defines wether the original publication dates for the episodes are kept in the feed, as opposed to contemporary dates. You can specify <code>yes</code> or <code>no</code>, if that option isn’t enabled the default setting is <code>no</code></li>
</ul>
<h3 class="is-size-5 title">Wrapping this all together</h3>
<p>Remember our starting situation? You wanted to change your podcast from daily to weekly updates. Your URL was this:<br>
<code>{{ request.host_url }}3/daily/20181201+0500</code><br>
We’ll need to start by changing <code>daily</code> to <code>weekly</code>, then to change the date to today (e.g.: <code>20181215+0500</code>), and then adding the option to start the feed at the last episode published by your old feed. The hardest part here is to identify the number of the episode, if it’s not provided in your podcast’s episode titles.<br>
The end result might looks like this:<br>
<code>{{ request.host_url }}3/weekly/20181215+0500/start_at:14</code><br>
</p>
<p>I hope this has been enlightening ; if you still have doubts as to how to proceed when changing your Cast Rewinder feed URL you can <a href="{{ url_for('index') }}">re-generate one with the form</a>, or send me an email at <a href="mailto:hello@rewind.website">hello@rewind.website</a>.</p>

</div>
{% endblock %}
@@ -0,0 +1,42 @@
{% extends 'layout.html' %}

{% block title %}Aide{% endblock %}

{% block content %}
<div class="content">
<h2 class="is-size-4 title">Cast Rewinder vous fournit l’URL d’un flux de podcast, que vous pouvez modifier selon vos besoins.</h2>

<p class="is-size-5">Mettons que tu commences à suivre un podcast quotidiennement depuis le début avec Cast Rewinder. Puis, après quelques semaines, tu veux passer en diffusion hebdo. Comment faire pour changer ça&nbsp;? Tu peux générer à nouveau l’URL d'un flux, mais tu peux plus simplement modifier l’URL que tu avais déjà pour la diffusion quotidienne. Voilà comment ça marche.</p>

<h3 class="is-size-5 title">L’URL basique</h3>

<p class="">Basiquement, l’URL d’un flux Cast Rewinder suit ce schéma:<br>
<code>{{ request.host_url }}3/weekly/20181214+0000</code></p>
<ol>
<li><code>{{ request.host_url }}</code> est le domaine, pas besoin de le changer</li>
<li><code>/3/</code> est l’identifiant du podcast dans la base de données. Pas besoin de changer ça non plus</li>
<li><code>/weekly/</code> est le nom de code pour la fréquence. Il peut être changé. Les valeurs possibles sont en anglais, c’est <code>daily</code> (diffusion quotidienne), <code>weekly</code> (hebdo), <code>monthly</code> (mensuelle), ou toute combinaison de jours de la semaine, sous la forme de troncation de trois lettres du nom anglais.<br>Exemple : <code>mon-thu-sun</code> publiera de nouveaux épisodes les lundi, jeudi et dimanche</li>
<li><code>/20181214+0000/</code> désigne la date de début et les informations de fuseau horaire que Cast Rewinder utilise pour générer le flux. Ça peut être changé. Il faut suivre le format <code>AAAAMMJJ</code> pour la date (A pour l’année, M pour le mois, J pour le jour), et <code>+</code> ou <code>-</code> suivi par la différence de temps avec le temps UTC, sous la forme <code>HHMM</code> pour l’information de fuseau horaire (H pour les heures, M pour les minutes), UTC+5 sera noté <code>+0500</code></li>
</ol>

<h3 class="is-size-5 title">Ajouter des options</h3>
<p>Plus d’options peuvent être ajoutées à l’URL. Elles sont ajoutées à la suite de la date, précédées par une barre oblique (ou <i lang="en">slash</i> : <code>/</code>), elles sont séparées entre elles par une virgule (<code>,</code>) et les options sont séparées de leurs valeurs par deux points (<code>:</code>).<br>
Exemple : <code>{{ request.host_url }}3/weekly/20181214+0000/start_at:5,order:desc</code></p>

<p>Il y a quatre options, qui peuvent être arrangées dans n’importe quel ordre&nbsp;:</p>
<ul>
<li><code>start_at</code> définit l’épisode de début du flux. Si tu veux que ton flux commence au cinquième épisode (inclus) et non au premier, l’option sera : <code>start_at:5</code></li>
<li><code>order</code> définit l’ordre de lecture. Par défaut, sa valeur est <code>asc</code> (pour ordre ascendant), mais ça peut être réglé en <code>desc</code> (pour descendant) si tu veux lire tes épisodes du plus récent au plus ancien</li>
<li><code>format</code> définit le format du flux. <code>feed_rss</code>, <code>feed_atom</code> et <code>feed_json</code> sont les formats disponibles, par défaut l’option a la valeur <code>feed_rss</code> ce qui transmet un flux au format RSS</li>
<li><code>keep_dates</code> définit si les dates de publication originales sont gardées dans le flux, au lieu d’utiliser des dates contemporaines. Tu peux spécifier <code>yes</code> (pour garder les dates originales) ou <code>no</code>, le réglage par défaut est <code>no</code> et le flux est généré avec des dates contemporaines</li>
</ul>
<h3 class="is-size-5 title">Cas d’exemple</h3>
<p>Au début de la page, tu voulais changer la fréquence de diffusion de tous les jours à toutes les semaines. Mettons que ton URL est comme ça :<br>
<code>{{ request.host_url }}3/daily/20181201+0500</code><br>
On va d’abord changer le réglage <code>daily</code> en <code>weekly</code>, puis on va changer la date à celle d’aujourd’hui (par exemple <code>20181215+0500</code>), puis on ajouter l’option pour commencer la diffusion au dernier épisode publié dans ton ancien flux. La partie la plus dure de cette manipulation, c’est de trouver le numéro de cet épisode, surtout si les titres d’épisodes du podcast ne sont pas numérotés.<br>
À la fin, le résultat doit ressembler à ça&nbsp;:<br>
<code>{{ request.host_url }}3/weekly/20181215+0500/start_at:14</code><br>
</p>
<p>J’espère que cette rubrique t’aura été utile ; si tu hésites toujours à modifier ton URL Cast Rewinder, tu peux en <a href="{{ url_for('index') }}">re-générer une à l’aide du formulaire</a>, ou m’envoyer un email à <a href="mailto:hello@rewind.website">hello@rewind.website</a>.</p>
</div>
{% endblock %}
@@ -18,7 +18,7 @@
<h1 class="title is-size-2">{% block header %}{{ config['WEBSITE_NAME'] }}{% endblock %}</h1>
<div class="level subtitle">
<p class="level-left is-size-4 menu">
{% for page in [('index',_('Home')),('about',_('About')),('about_api',_('API')),('donate',_('Donate'))] %}
{% for page in [('index',_('Home')),('about',_('About')),('help',_('Help')),('about_api',_('API')),('donate',_('Donate'))] %}
<a href="{{ url_for(page[0]) }}" {%- if request.path == url_for(page[0]) %} class="active"{% endif %}>{{ page[1] }}</a>
{% endfor %}
</p>
@@ -184,6 +184,10 @@ def serve_feed(feed_id, frequency, start_date, options):
def about():
return render_template('about.'+ g.locale +'.html')

@app.route('/help/')
def help():
return render_template('help.'+ g.locale +'.html')

@app.route('/donate/')
def donate():
return render_template('donate.'+ g.locale +'.html')
@@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: PROJECT VERSION\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2018-11-21 13:04+0100\n"
"POT-Creation-Date: 2018-12-14 18:16+0100\n"
"PO-Revision-Date: 2018-07-14 18:59+0200\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: fr\n"
@@ -173,6 +173,10 @@ msgstr "Accueil"
msgid "About"
msgstr "À propos"

#: castrewinder/templates/layout.html:21
msgid "Help"
msgstr "Aide"

#: castrewinder/templates/layout.html:21
msgid "API"
msgstr "l’API"

0 comments on commit c1a687e

Please sign in to comment.