Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements to website texts #138

Merged
merged 15 commits into from
Feb 13, 2022
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: documentation.categories.automation.feed-updates
title: documentation.categories.automation.refreshing-podcasts
layout: doc
level: "2"
group: "automation"
Expand Down
12 changes: 12 additions & 0 deletions _documentation/bugs-first-aid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: documentation.categories.bugs-first-aid.title
layout: doc
level: "1"
group: "bugs-first-aid"
icon: "fas fa-book-medical"
order: "70"
---

# {% t {{ page.title }} %}

{% t documentation.categories.{{ page.group }}.intro %}
12 changes: 12 additions & 0 deletions _documentation/bugs-first-aid/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: documentation.categories.bugs-first-aid.bug-report
layout: doc
level: "2"
group: "bugs-first-aid"
icon: "fas fa-bug"
order: 20
---

# {% t {{ page.title }} %}

{% tf documentation/{{ page.group }}/{{ page.slug }}.md %}
12 changes: 12 additions & 0 deletions _documentation/bugs-first-aid/database-error.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: documentation.categories.bugs-first-aid.database-error
layout: doc
level: "2"
group: "bugs-first-aid"
icon: "fas fa-history"
order: 40
---

# {% t {{ page.title }} %}

{% tf documentation/{{ page.group }}/{{ page.slug }}.md %}
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: documentation.categories.getting-started.episodes-missing
title: documentation.categories.bugs-first-aid.episodes-missing
layout: doc
level: "2"
group: "getting-started"
group: "bugs-first-aid"
icon: "fas fa-question"
order: "20"
order: "10"
---

# {% t {{ page.title }} %}
Expand Down
12 changes: 12 additions & 0 deletions _documentation/bugs-first-aid/typo-translations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: documentation.categories.bugs-first-aid.typo-translations
layout: doc
level: "2"
group: "bugs-first-aid"
icon: "fas fa-language"
order: 30
---

# {% t {{ page.title }} %}

{% tf documentation/{{ page.group }}/{{ page.slug }}.md %}
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: documentation.categories.general.donate
title: documentation.categories.general.episode-deletion
layout: doc
level: "2"
group: "general"
icon: "fas fa-heart"
icon: "fas fa-trash"
---

# {% t {{ page.title }} %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: documentation.categories.general.bug-report
title: documentation.categories.general.proxy
layout: doc
level: "2"
group: "general"
icon: "fas fa-bug"
icon: "fas fa-network-wired"
---

# {% t {{ page.title }} %}
Expand Down
2 changes: 1 addition & 1 deletion _documentation/podcasters-hosters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ layout: doc
level: "1"
group: "podcasters-hosters"
icon: "fas fa-microphone-alt"
order: "70"
order: "80"
---

# {% t {{ page.title }} %}
Expand Down
16 changes: 11 additions & 5 deletions _i18n/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ contribute:
introduction: "AntennaPod is under active development by volunteers. You can contribute too, with code or otherwise!"
translate:
title: "Translate"
text: "You speak any other language than English? Help us translate AntennaPod via Transifex."
text: "You speak any other language than English? Help us translate AntennaPod."
support:
title: "Support"
text: "You can explain well? Help other users on our forum."
Expand Down Expand Up @@ -122,18 +122,17 @@ documentation:
title: "Getting started"
intro: "Welcome to AntennaPod! Below, you can find some details on how to get started with AntennaPod."
subscribe: "Subscribing to a podcast"
episodes-missing: "Episodes are missing"
general:
title: "General"
intro: "Below, you can find more details about the AntennaPod project."
ads: "About ads in AntennaPod"
backup: "Backing up your episodes"
beta: "Beta testing"
bug-report: "Reporting a bug"
central-distributed: "Central and distributed podcast apps"
donate: "Donations"
external-storage: "Using external storage"
gpodder: "How to synchronize between devices"
proxy: "Leading traffic through a proxy or TOR network"
episode-deletion: "Deletion of episodes"
playback:
title: "Playback"
intro: "Below, you can find topics related to playback."
Expand All @@ -155,8 +154,15 @@ documentation:
title: "Automation"
intro: "Are you an experienced user and want to automate tasks? Have a look at the pages below."
deletion: "Automatic deletion"
feed-updates: "Feed updates"
refreshing-podcasts: "Refreshing podcasts"
tasker: "3rd party integration"
bugs-first-aid:
title: "Bugs, errors & first aid"
intro: "Making software is a human craft, so mistakes are inevitable. But there's often something we can do about it!"
bug-report: "Something isn't working"
typo-translations: "I found a typo"
database-error: "All my podcasts & episodes are gone"
episodes-missing: "Cannot download an episode"
podcasters-hosters:
title: "For Podcasters & Hosters"
intro: "Below, you can find our support information for podcasters & hosting providers."
Expand Down
68 changes: 68 additions & 0 deletions _i18n/en/contribute/translate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<!-- mdpo-disable -->

{% capture img-transifex %}
{% include image.html
alt="
<!-- mdpo-enable-next-line -->
Overview of resources in Transifex

"
loc="/assets/images/documentation"
file="translation-resources-transifex.png"
%}
{% endcapture %}

{% capture img-weblate %}
{% include image.html
alt="
<!-- mdpo-enable-next-line -->
Overview of components in Weblate

"
loc="/assets/images/documentation"
file="translation-components-weblate.png"
%}
{% endcapture %}

<!-- mdpo-enable -->

Out of the estimated [world population](https://en.wikipedia.org/wiki/World_population) of 7.9 billion people, 'only' 1.3 billion [speak English](https://www.ethnologue.com/guides/ethnologue200). This may not mean much per say. But if anything, we can conclude that making AntennaPod available in more languages, makes the app accessible by more people. A translated app not only is usable for more people, it also helps our project grow beyond the current main userbases (Germany and the US).

We therfore much appreciate your help!

# The app
To help translate the app, we ask you to contribute via [Transifex](https://www.transifex.com/antennapod/antennapod/). Anyone can sign up there and start contributing. Transifex has helpful guides to [get started on their platform](https://docs.transifex.com/getting-started-1/translators) and to [get familiar with the Web Editor interface](https://docs.transifex.com/translation/translating-with-the-web-editor).

Under the AntennaPod project, you will find three 'resources':
- The app itself
- The short, one-sentence description for in app stores
- The more elaborate description for in app stores

<!-- mdpo-disable-next-line -->
{{ img-transifex | strip }}

The app is currently available in 34 languages. While there are more languages in Transifex, we don't include them in the app. We try to maintain a [threshold of 40% completion](https://github.com/AntennaPod/AntennaPod/pull/4112) for languages. If it goes below that, the app hardly provides a good user experience.

New translations are pulled from Transifex to GitHub (the development platform) at least for every 'point release'. These are releases like 2.0, 2.5, etc that introduce new features. But we also release updates with bug fixes and new translations in between. On average, it might take a month or two before your work is available in a release.

Translation contributors will find themselves mentioned in the app with their Transifex username, under `Settings` » `About` » `Contributors`.

# The website
For several reasons (outlined in a [blogpost on website translations](/blog/2022/01/website-translations)) we use a different translation system for our website: [Weblate](https://hosted.weblate.org/projects/antennapod/). Anyone can sign up there and start contributing. In Weblate's documentation you'll find [everything you need to know to start translating](https://docs.weblate.org/en/latest/user/translating.html).

In the AntennaPod project, you will find four 'components'. Each represents a part of the website. We encourage you to start with the components `General` and the `Short strings`, because these will be the first elements a user sees on the website. The component `Documentation` is a very close second priority, because this section is directly available via the app when people tap on Support. The `Contribute` component comes last, because a basic understanding of English is needed anyway to interact with the community.

<!-- mdpo-disable-next-line -->
{{ img-weblate | strip }}

New translations are pulled from Weblate to GitHub (the development platform) manually once in a while. When a language hits 90% translation (that's roughly the whole website minus the Contribute section), we can enable it on the live website. We always try to find a community member that can review a test version of the website, to improve the quality of translations.

# Other materials
In addition to the app and website, also the images in the app stores can be translated. They have screenshots and texts. Because there is very limited space we use a manual process with trial and error. Please let us know on the forum if you want to help with that. Because localised app store listings are more likely to be downloaded, help is very much welcome!

# Get in touch!
* Do you want to give **feedback** on the English texts or any of the translations?
* Are you **interested in helping** with translations but not sure yet? Or you are ready to get started?
* Do you (want to) contribute and **need support**? For example, because your language isn't available yet, or because you are not sure how to translate something?

Chip in on the [translation section on our forum](https://forum.antennapod.org/c/translations/11)! That is the best way to reach out to us. Comments and messages in the respective translation tools don't always reach us in a timely manner.
6 changes: 3 additions & 3 deletions _i18n/en/documentation/automation/deletion.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ Why are some downloaded episodes deleted?

AntennaPod has several mechanisms to make sure downloaded podcasts will not fill up your phone's memory. If you notice some downloaded episodes being deleted, have a look at these two settings:

## Auto Delete
Auto Delete is located in `Settings` » `Storage`. When enabled, episodes are deleted when playback completes (but not when manually marking an episode as 'played').

## Episode Cleanup
Episode Cleanup is located in `Settings` » `Network` » `Automatic Download`. If Automatic Download needs space for new episodes, it will delete old episodes that are not in the queue and not marked as favorite. You can add a delay (x time after playback) or Episode. The setting `Episode Cache` determines the maximum amount of downloaded episodes.

## Auto Delete
Auto Delete is located in `Settings` » `Storage`. When enabled, episodes are deleted when playback completes. You can disable this option.
1 change: 0 additions & 1 deletion _i18n/en/documentation/automation/feed-updates.md

This file was deleted.

5 changes: 5 additions & 0 deletions _i18n/en/documentation/automation/refreshing-podcasts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
By default, all podcasts are refreshed with a 12-hour interval to pick up new episodes. Via `Settings` » `Network` » `Refresh podcasts` you can change the interval period, select a specific time in the day, or turn off the automatic updates.

You can also turn off this process for individual podcasts in case keeping a podcast up to date is unnecessary. You can use this, for example, if no new episodes are released anymore for a podcast. Or when you have added a podcast of which you would listen an episode only occasionally. You can set this by going to a podcast, tapping on the `Gear` icon and changing the `Keep Updated` setting.

When you turn off this podcast setting, the podcast will no longer be updated when podcasts get refreshed automatically, or when you initiate this process from the Queue or the Episodes screen. You can still refresh that podcast, which will bring new episodes to AntennaPod. But these new episodes will not be visible in the New tab of the Episodes screen.
7 changes: 7 additions & 0 deletions _i18n/en/documentation/bugs-first-aid/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Did you encounter a bug? We're sorry to hear.

First, please make sure you have the latest version of AntennaPod. With every update we fix many small and bigger issues. Then search our forum to see if anyone else has the same issue. If you find the issue you have, you can see if there's any suggestions. Also consider providing information from your situation - it might help developers find the source of the problem.

If you have updated AntennaPod and searched our forum to no avail, then tell us about the issue. You can create a post on [on our forum](https://forum.antennapod.org/c/bug-report/9). To do so you need to create an account (if you don't have one already) or simply log in via Google.

Whichever way you contact us, please include the system information that is displayed in `Settings` » `Report bug`.
13 changes: 13 additions & 0 deletions _i18n/en/documentation/bugs-first-aid/database-error.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
You might feel like screaming *Help! I lost my podcasts/episodes/settings/everything!*

The problem is that the database with all information (episodes, listening states, etc) has some mistakes. AntennaPod cannot function with the broken database and had to start over with an empty one. While it's been happening less frequently in recent versions of AntennaPod, it still is occurring for some users. Our community of developers have not been able to pinpoint what exactly causes a database to break. The same issue occurs also in some other open source apps. But we realise it is very frustrating when this happens and are really sorry if you were affected too.

There may be some things you can do to recover your data. We list them below, starting with the solution that gives the easiest & best results:

1. Have you recently [exported a backup](/documentation/general/backup) from AntennaPod recently? Then restoring that is relatively easily: go to `Settings` » `Storage` » `Import/Export` » `Database import` and select the back-up.
2. If you don't have a back-up, the next step is to attempt to recover the broken database ('repair corrupted sql database'). If AntennaPod detects a broken database, it writes it to a file CorruptedDatabaseBackup.db in the app storage directory. It is a challenge and it requires some skills or learning. You will have to use a terminal.
* One community member [followed these steps](https://github.com/AntennaPod/AntennaPod/issues/2463#issuecomment-384088306) to repair the database and [indicated](https://github.com/AntennaPod/AntennaPod/issues/2463#issuecomment-404624614) that after this they could successfully import the repaired database.
* Another community member [took a clean database and moved content from the corrupted one in it](https://github.com/AntennaPod/AntennaPod/issues/2463#issuecomment-385341068), and then performed [another correction](https://github.com/AntennaPod/AntennaPod/issues/2463#issuecomment-385354995). After both steps, they managed to successfully imported the new database in AntennaPod.
3. While all the data *about* your subscriptions and episodes are gone, the media files will still be there.
* In AntennaPod you can add a folder as if it were a feed. To do this, go to `Add Podcast` and tap on `Add local folder`. Then go to this folder on your phone: `Android` » `data` » `de.danoeh.antennapod` » `files` » `media` and then the select the folder of a podcast. Note that this will only give you access to previously downloaded media - you will not receive new episodes.
* You can also start adding previous podcasts from scratch. You can look through the folder mentioned above to see which podcasts you were subscribed to.
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
AntennaPod is a decentralized podcast app. You can find some information about that [here](/documentation/general/central-distributed). This basically means that there is no central server that knows everything about each podcast. Episodes are loaded directly from the publisher's website. If the publisher deletes an episode from their website, AntennaPod can no longer access it.

Some publishers support a technique called "paged feeds". If a publisher supports this, AntennaPod displays all episodes automatically.
9 changes: 9 additions & 0 deletions _i18n/en/documentation/bugs-first-aid/typo-translations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Did you find a spelling mistake, or something that sounds odd? It's always possible that we made a mistake in English (in which we make the app & website), or that something has not been translated correctly. Luckily these issues are often easily fixed.

# Do you want to fix it yourself?
If the issue is in any other language than English, you can update **app translations** on [Transifex](https://www.transifex.com/antennapod/antennapod/core-values/). Issue with the **website translations** can be fixed on [Weblate](https://hosted.weblate.org/projects/antennapod/). You can [find more information in our Contribute section](/contribute/translate).

Is the issue with the **English texts**? Then you will need to be or get familiar with GitHub. You can send a Pull Request for [the app](https://github.com/AntennaPod/AntennaPod/) or for [the website](https://github.com/AntennaPod/antennapod.github.io).

# Do you just want to inform us?
You can create a post in the [translations section on our forum](https://forum.antennapod.org/c/translations/11). To do so you need to create an account (if you don't have one already) or simply log in via Google.
4 changes: 0 additions & 4 deletions _i18n/en/documentation/general/bug-report.md

This file was deleted.

1 change: 0 additions & 1 deletion _i18n/en/documentation/general/donate.md

This file was deleted.

5 changes: 5 additions & 0 deletions _i18n/en/documentation/general/episode-deletion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
When you are done listening with an episode, in most cases you want to delete it from your phone, to free up space. There is different ways that you can do that.

Firstly, you can of course manually delete episodes. When viewing the queue or a specific podcast, you can long-press an episode and tap `Delete`. When viewing the Completed tab in the Downloads screen you can also simply tap the bin icon. If you want, AntennaPod can automatically remove en episode from the queue if it is deleted. You can find this option under `Settings` » `Storage` » `Delete removes from Queue`.
ByteHamster marked this conversation as resolved.
Show resolved Hide resolved

Secondly, AntennaPod has some solutions to automatically delete episodes. Particularly, AntennaPod can automatically delete episodes when playback completes, and when it needs space for the Automatic Download process. For more information on these options, please see the [Automatic Deletion](/documentation/automation/deletion) article.
11 changes: 11 additions & 0 deletions _i18n/en/documentation/general/proxy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
It's possible to make AntennaPod lead all traffic (media files, cover images, RSS requests & searches) through a proxy or the TOR network. This may have two potential benefits:

- Privacy: depending on the type of proxy service, your downloading/streaming behaviour may be protected from podcast hosts
- Access: if podcast host prevents content downloading from other countries (based on IP addresses), setting a proxy with the origin country may allow you to still access its content

You will find this option under `Settings` » `Network` » `Proxy`.

In order to lead all traffic via the TOR network, you need to install a proxy app for TOR, and provide the following details in AntennaPod:
- Type: SOCKS
- Host: "localhost" or "127.0.0.1"
- Port: "9050"
Loading