From 3d7abd2ed87d2a3af581fd3999ea52917cc20bde Mon Sep 17 00:00:00 2001 From: Martin Rotter Date: Mon, 9 Nov 2020 13:06:13 +0100 Subject: [PATCH] Centralize docs completely. --- localization/rssguard_cs.ts | 267 +++++++++++++++++--------------- localization/rssguard_sv.ts | 2 +- resources/docs/Documentation.md | 37 +++-- resources/docs/Downloads.md | 28 ++++ resources/docs/Feed-formats.md | 4 +- 5 files changed, 193 insertions(+), 145 deletions(-) create mode 100755 resources/docs/Downloads.md diff --git a/localization/rssguard_cs.ts b/localization/rssguard_cs.ts index 21c82974c..e3d48c78d 100644 --- a/localization/rssguard_cs.ts +++ b/localization/rssguard_cs.ts @@ -198,11 +198,11 @@ ColorToolButton Click me to change color! - + Změnit barvu! Select new color - + Vybrat novou barvu @@ -241,11 +241,11 @@ Removing starred messages... - + Mažu důležité zprávy... Starred messages purged... - + Důležité zprávy smazány... @@ -284,7 +284,7 @@ Unknown error: '%1'. - + Neznámá chyba: '%1'. @@ -312,7 +312,7 @@ Tato stránka obsahuje %n kanálů. Feeds were detected, but no suitable accounts are configured. - + Byly detekovány kanály, ale není aktivován žádný účet. @@ -447,23 +447,23 @@ Klikněte sem pro otevření nadřazeného adresáře. EmailRecipientControl To - + Komu Cc - + Kopie Bcc - + Slepá kopie Reply-to - + Odpovědět komu E-mail address - + E-mailová adresa @@ -505,13 +505,15 @@ Klikněte sem pro otevření nadřazeného adresáře. uses global settings (global feed auto-updating is disabled) - + používá globální nastavení (globální automatická aktualizace kanálů není povolena) Auto-update status: %1 Active message filters: %2 Status: %3 - + Automatické aktualizace: %1 +Počet aktivních filtrů zpráv: %2 +Stav: %3 @@ -667,11 +669,11 @@ or this functionality is not implemented yet. Context menu for important messages - + Kontextové menu pro důležité zprávy Context menu for label - + Kontextové menu pro štítek @@ -754,11 +756,11 @@ or this functionality is not implemented yet. MIT License (applies to boolinq source code) - + MIT License (týká se zdrojového kódu komponenty boolinq) GNU GPL License (applies to RSS Guard; mimesis; Numix source codes) - + GNU GPL License (RSS Guard; mimesis; Numix) @@ -776,35 +778,35 @@ or this functionality is not implemented yet. FormAddEditEmail Write e-mail message - + Napsat e-mailovou zprávu Contents of your e-mail message - + Tělo e-mailové zprávy ... - + ... Add new recipient. - + Přidat adresáta. Subject - + Předmět Title of your message - + Nadpis zprávy E-mail NOT sent - + E-mail NEodeslán Your e-mail message wasn't sent. - + Váš e-mail nebyl odeslán. @@ -815,31 +817,31 @@ or this functionality is not implemented yet. ... - + ... Name for your label - + Jméno štítku Label's name cannot be empty. - + Jméno štítku nemůže být prázdné. Perfect! - + Skvěle! Hot stuff - + Dobrej matroš Create new label - + Vytvořit nový štítek Edit label '%1' - + Upravit štítek '%1' @@ -1095,7 +1097,7 @@ or this functionality is not implemented yet. Specified redirect URL must start with "http://localhost" and must be configured in your OAuth "application". - + Přesměrovávací URL musí být nastaveno na řetězec začínající na "http://localhost". No username entered. @@ -1202,13 +1204,15 @@ or this functionality is not implemented yet. Get my own Application ID - + Získat vlastní Application ID Specified redirect URL must start with "http://localhost" and must be configured in your OAuth "application". It is highly recommended to create your own "Application ID". - + Dané přesměrovávací URL musí začínat na "http://localhost" a mělo by odpovídat nastavení vaší OAuth "aplikace". + +Založení vlastního "Application ID" se vysoce doporučuje. @@ -1311,47 +1315,47 @@ It is highly recommended to create your own "Application ID". Download only unread messages - + Stahovat pouze nepřečtené zprávy Password for your Nextcloud account - + Heslo pro váš Nextcloud účet Username for your Nextcloud account - + Uživatelské jméno pro váš Nextcloud účet URL of your Nextcloud server, without any API path - + URL vaší Nextcloud instance, bez API cest Add new Nextcloud News account - + Přidat nový účet pro Nextcloud News Edit existing Nextcloud News account - + Upravit stávající účet Nextcloud News Selected Nextcloud News server is running unsupported version. - + Tento server pro Nextcloud News běží na nepodporované verzi Nextcloudu. Nextcloud News server is okay, running with version %1, while at least version %2 is required. - + Server Nextcloud News je v pořádku, běží na verzi %1, přičemž minimální vyžadovaná verze je %2. Nextcloud News server is okay. - + Server je v pořádku. Network error, have you entered correct Nextcloud endpoint and password? - + Síťová chyba, máte zadáno správné uživatelské jméno a heslo. Je URL k vašemu serveru správně? Selected Nextcloud News server is running unsupported version %1. At least version %2 is required. - + Server Nextcloud News běží na nepodporované verzi %1, přičemž minimální vyžadovaná verze je %2. @@ -1522,7 +1526,7 @@ It is highly recommended to create your own "Application ID". Download only unread messages - + Stahovat pouze nepřečtené zprávy @@ -2170,70 +2174,70 @@ It is highly recommended to create your own "Application ID". &Copy URLs of selected items - + &Kopírovat URL adresy vybraných položek Mark selected messages as &read - + Označit vybrané zprávy jako &přečtené Mark selected messages as &unread - + Označit vybrané zprávy jako &nepřečtené Show only &unread messages - + Zobrazit pouze &nepřečtené zprávy Message &filters - + &Filtry zpráv &Show tree branches - + Zobrazit &stromové šipky Update items with custom &timers - + Aktualizovat položky s aktivními filtry zpráv Alternate row colors in lists - + Alternovat barvy pozadí položek v seznamech Display &documentation - + Zobrazit &dokumentaci FormMessageFiltersManager Message filters - + Filtry zpráv Remove selected - + Smazat vybrané Add new - + Přidat nový Account - + Účet &Check all - + &Zaškrtnout vše &Uncheck all - + &Odškrtnout vše Message filter details - + Detaily filtru Title @@ -2241,19 +2245,19 @@ It is highly recommended to create your own "Application ID". Title of message filter - + Název filtru JavaScript code - + Kód JavaScript Your JavaScript-based message filtering logic - + Sem umístěte JavaScript kód vašeho filtru Sample message - + Ukázková zpráva Read @@ -2281,37 +2285,39 @@ It is highly recommended to create your own "Application ID". Script output - + Výstup skriptu &Test! - + &Otestovat! &Beautify! - + &Zkrášlit! Detailed &help - + Detailní &návod New message filter - + Nový filtr zpráv Message will be %1. - + Zpráva bude %1. + + ACCEPTED - + PŘIJATA REJECTED - + ZAMÍTNUTA Output (modified) message is: @@ -2321,43 +2327,49 @@ It is highly recommended to create your own "Application ID". Is read/important = '%4/%5' Created on = '%6' Contents = '%7' - + Výstupní zpráva je: + Nadpis = '%1' + URL = '%2' + Autor = '%3' + Je přečtená/důležitá = '%4/%5' + Vytvořena = '%6' + Tělo = '%7' yes - + ano no - + ne JavaScript-based filter contains errors: '%1'. - + JavaScriptový kód filtru obsahuje chybu: '%1'. Cannot find 'clang-format' - + Nelze najít utilitu 'clang-format' Script was not beautified, because 'clang-format' tool was not found. - + Skript nebyl zkrášlen, protože není nainstalovaná utilita 'clang-format'. Error - + Chyba Script was not beautified, because 'clang-format' tool thrown error. - + Skript nebyl zkrášlen, protože utilita 'clang-format' vrátila chybu. Beautifier was running for too long time - + Zkrášlovač běžel moc dlouho. Script was not beautified, is 'clang-format' installed? - + Skript nebyl zkrášlen, je 'clang-format' nainstalován? Cannot save new filter, error: ''. @@ -2895,7 +2907,7 @@ Nyní ho můžete nainstalovat. Cannot navigate to installation file. Download new installation file manually on project website. - + Nelze přejít k instalačnímu souboru. Stáhněte instalační soubor ručně na stránkách projektu. @@ -2906,7 +2918,7 @@ Nyní ho můžete nainstalovat. Your login to Gmail was authorized. - + Přístup na Gmail byl povolen. Click this to login again. Error is: '%1' @@ -2918,23 +2930,23 @@ Nyní ho můžete nainstalovat. No subject - + Bez předmětu Gmail: authentication error - + Gmail: chyba autentizace Gmail: authorization denied - + Gmail: přístup odepřen you are not logged in - + nejste přihlášen failed to get metadata - + chyba při stažení metadat @@ -2953,7 +2965,7 @@ Nyní ho můžete nainstalovat. Spam - + Odpad Authentication status: %1 @@ -2975,11 +2987,11 @@ Tokeny vyprší: %2 Write new e-mail message - + Nová e-mailová zpráva Reply to this message - + Odpovědět e-mailem @@ -2997,11 +3009,11 @@ Tokeny vyprší: %2 ImportantNode Important messages - + Důležité zprávy You can find all important messages here. - + Zde najdete všechny zprávy označené jako důležité. @@ -3063,19 +3075,19 @@ Tokeny vyprší: %2 You can see all your labels (tags) here. - + Zde najdete všechny štítky. New label - + Nový štítek This account does not allow you to create labels. - + Tento účet neumožňuje vytváření štítků. Not allowed - + Nepovoleno @@ -3483,19 +3495,19 @@ Tokeny vyprší: %2 You have to login first - + Je třeba se nejdříve přihlásit. Navigate to website - + Přejít na web To login, you need to navigate to this website: - + Pro přihlášení přejděte na tento web: You can close this window now. Go back to %1 - + Toto okno můžete nyní zavřít a přejděte do aplikace %1 @@ -3581,7 +3593,7 @@ Je vyžadování verze API minimálně %1. Simple Gmail integration via JSON API. Allows sending e-mails too. - + Posílání a přijímaní e-mailů přes Gmail. Welcome to %1. @@ -3595,11 +3607,11 @@ na tuto bublinu. Cannot insert message filter, because current database cannot return last inserted row ID. - + Nelze vložit filtr zpráv, protože databáze neumí vrátit ID. Standard online feeds (RSS/ATOM/JSON) - + Standardní kanály (RSS/ATOM/JSON) @@ -3637,7 +3649,7 @@ na tuto bublinu. SearchTextWidget Clear searched phrase - + Smazat hledanou frázi Seach text @@ -3645,11 +3657,11 @@ na tuto bublinu. Find previous occurence - + Najít předchozí výskyt Find next occurence - + Najít další výskyt @@ -3861,7 +3873,7 @@ File filter for external tool selection dialog. Parameters passed to executable - + Parametry předávané programu @@ -4050,7 +4062,7 @@ Autoři této aplikace nenesou žádnou odpovědnost za ztrátu Vašich dat. Only auto-update when application is unfocused - + Automaticky aktualizovat kanály, jen pokud aplikace není na popředí Feed connection timeout @@ -4118,27 +4130,27 @@ Autoři této aplikace nenesou žádnou odpovědnost za ztrátu Vašich dat. Feed list font - + Písmo seznamu kanálů Display placeholders to indicate locations of pictures - + Na pozicích obrázků zobrazovat zástupné symboly Message list font - + Písmo seznamu zpráv Internal message browser font - + Písmo zabudovaného zobrazovače zpráv Select new font - + Vybrat písmo Update all feeds on application startup with initial delay of - + Při startu aplikace aktualizovat všechny kanály s úvodní prodlevou @@ -4292,20 +4304,20 @@ Autoři této aplikace nenesou žádnou odpovědnost za ztrátu Vašich dat. Use monochrome icon - + Černobílá stavová ikona system icon theme Label for disabling icon theme. - + systémové téma ikon no icon theme - + žádné téma ikon Left mouse button double-click - + Dvojitý klik levého tlačítka myši @@ -4371,7 +4383,10 @@ Autoři této aplikace nenesou žádnou odpovědnost za ztrátu Vašich dat. - + +Síťový stav: %1 +Kódování: %2 +Typ: %3 @@ -4530,7 +4545,7 @@ Nepřečtené zprávy: %2 %n second(s) - + %n vteřina%n vteřiny%n vteřin%n vteřin @@ -4767,7 +4782,7 @@ Poslední čas přihlášení: %4 Open link in external browser - + Otevřít odkaz v externím prohlížeči \ No newline at end of file diff --git a/localization/rssguard_sv.ts b/localization/rssguard_sv.ts index f0b3a24fd..eb253266d 100644 --- a/localization/rssguard_sv.ts +++ b/localization/rssguard_sv.ts @@ -2204,7 +2204,7 @@ Det rekommenderas starkt att du skapar ditt eget applikations-ID. Display &documentation - + Visa &dokumentation diff --git a/resources/docs/Documentation.md b/resources/docs/Documentation.md index 0c8711490..c2ed75f22 100644 --- a/resources/docs/Documentation.md +++ b/resources/docs/Documentation.md @@ -1,18 +1,19 @@ # Documentation -* [Foreword](#foreword) +* [Introduction](#introduction) + * [Downloads](Downloads.md) * [Philosophy](#philosophy) * [Versioning](#versioning) * [Reporting bugs](#reporting-bugs) * [Localizations](#localizations) + * [Web-based and lite app variants](#web-based-and-lite-app-variants) * [Features](#features) * [List of main features](#list-of-main-features) - * [Web-based and lite app variants](#web-based-and-lite-app-variants) * [Supported feed formats and online feed services](Feed-formats.md) * [Message filtering](Message-filters.md) * [Database backends](#database-backends) * [Gmail](#gmail) * [GUI tweaking](#gui-tweaking) -* [Misc](#misc) +* [Miscellaneous](#miscellaneous) * [Cleaning database](#cleaning-database) * [Portable user data](#portable-user-data) * [Downloading new messages](#downloading-new-messages) @@ -20,7 +21,7 @@ -# Foreword +# Introduction First, let me say, that you can contact RSS Guard's lead developer via [e-mail](mailto:rotter.martinos@gmail.com) or just submit a ticket here in the repository. I am glad to accept any kind of donations, see ♥ **Sponsor** button on the top of this page. **I say "thank you" for all your support, my donators.** Also, I personally send "thank you" to all contributors (translators, source code contributors, issue reporters) and users. @@ -38,7 +39,9 @@ RSS Guard uses [semantic versioning](https://semver.org/). The versioning scheme * `Z` indicates that there are newly fixed bugs or small features introduced. ## Reporting bugs -Please, report all issues/bugs/ideas to [Issues](https://github.com/martinrotter/rssguard/issues) section. Describe your problem as precisely as possible. +Please report all issues/bugs/ideas to [Issues](https://github.com/martinrotter/rssguard/issues) section. Describe your problem as precisely as possible, along with steps taken leading up to the issue occurring. + +It is a good idea to read [this](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) before reporting the bug; it will save time and effort for everyone if all the required information is provided from the get-go. ## Localizations RSS Guard currently includes [many localizations](http://www.transifex.com/projects/p/rssguard). @@ -50,6 +53,18 @@ If you are interested in creating translations for RSS Guard, then do this: **All translators commit themselves to keep their translations up-to-date. If some translations are not updated by their authors regularly and only small number of strings is translated, then those translations along with their teams will be eventually REMOVED from the project!!! At least 50% of strings must be translated for translation to being added to project.** +## Web-based and lite app variants +RSS Guard is distributed in two variants: +* **Standard package with WebEngine-based bundled message viewer**: This variant displays messages with their full formatting and layout in embedded Chromium-based web viewer. This variant of RSS Guard should be nice for everyone who doesn't care about memory consumption. Also, installation packages are relatively big. + + + +* **Lite package with simple text-based message viewer**: This variant displays message in much simpler and more lightweight text-based component. Layout and formatting of displayed message is simplified, no big external web viewers are used, which results in much smaller installation packages, much smaller memory footprint and increased privacy of the user, because many web resources are not downloaded by default like pictures, JavaScript and so on. This variant of RSS Guard is meant for advanced users and offers faster GUI response in some use-cases. + + + +If you're not sure which version to use, **use the WebEngine-based RSS Guard**. + # Features RSS Guard is simple (yet powerful) feed reader. It is able to fetch the most known feed formats, including RSS/RDF/ATOM/JSON. RSS Guard is developed on top of the [Qt library](http://qt-project.org) and it supports these operating systems: @@ -102,16 +117,6 @@ RSS Guard is simple (yet powerful) feed reader. It is able to fetch the most kno * localizations to some languages, * ability to tweak columns in displayed list of messages. -## Web-based and lite app variants -RSS Guard is distributed in two variants: -* **Standard package with WebEngine-based bundled message viewer**: This variant displays messages with their full formatting and layout in embedded Chromium-based web viewer. This variant of RSS Guard should be nice for everyone who doesn't care about memory consumption. Also, installation packages are relatively big. - - - -* **Lite package with simple text-based message viewer**: This variant displays message in much simpler and more lightweight text-based component. Layout and formatting of displayed message is simplified, no big external web viewers are used, which results in much smaller installation packages, much smaller memory footprint and increased privacy of the user, because many web resources are not downloaded by default like pictures, JavaScript and so on. This variant of RSS Guard is meant for advanced users and can faster GUI response in some use-cases. - - - ## Database backends RSS Guard offers switchable database backends which hold your data. At this point, two backends are available: * MariaDB, @@ -151,7 +156,7 @@ Many people have very widescreen monitors nowadays and RSS Guard offers you hori -# Misc +# Miscellaneous Here you can find some useful insights into RSS Guard's modus operandi. ## Cleaning database diff --git a/resources/docs/Downloads.md b/resources/docs/Downloads.md new file mode 100755 index 000000000..7382107b1 --- /dev/null +++ b/resources/docs/Downloads.md @@ -0,0 +1,28 @@ +# Downloads +See here to know where to download prebuilt versions of RSS Guard. + +## Official downloads +Official downloads are available [here](https://github.com/martinrotter/rssguard/releases). Windows `exe/7zip` packages are published automatically when new RSS Guard version is released. + +[![RSS Guard in Instalki](http://www.instalki.pl/img/buttons/en/download_dark.png)](http://www.instalki.pl/programy/download/Windows/czytniki_RSS/RSS_Guard.html) + +![RSS Guard is 100% clean.](http://www.softpedia.com/_img/softpedia_100_free.png) + +## Development builds +Development builds can be downloaded [here for Windows](https://bintray.com/martinrotter/rssguard/Development/Windows) and [here for Linux or Mac OS](https://bintray.com/martinrotter/rssguard/Development/LinuxMacOs). + +## Installation packages naming +**Windows builds** of RSS Guard are generated automatically by the tool called AppVeyor. These builds have auto-generated names. In RSS Guard [downloads page](https://github.com/martinrotter/rssguard/releases) you can see filenames like: + * `rssguard-3.4.2-7bad9d1-nowebengine-win32.7z`, + * `rssguard-3.4.2-7bad9d1-win32.7z`, + * `rssguard-3.4.2-95ee6be-nowebengine-win32.exe`, + * `rssguard-3.4.2-95ee6be-win32.exe`. + +The structure of these filenames is quite trivial and easily understandable for advanced users. For beginners, the overall structure of the file is `---.`. Example: + * `` = `rssguard` (This is self-explanatory.), + * `` = `3.4.2` (This describes the version of the application packaged in the file), + * `` = `7bad9d1` (This describes the [Git commit](https://git-scm.com/docs/git-commit) used for the file. Whenever developers do some change to source code, that change gets assigned special ID, this is the ID.), + * `` = `win32` (This is the target platform which the application can run on.), + * `` = `exe` (This is self-explanatory.). + +Note that same file naming scheme is used for auto-generated builds for Linux and Mac OS. \ No newline at end of file diff --git a/resources/docs/Feed-formats.md b/resources/docs/Feed-formats.md index eeb441b75..da8df98b0 100755 --- a/resources/docs/Feed-formats.md +++ b/resources/docs/Feed-formats.md @@ -1,9 +1,9 @@ # Supported feed formats and online feed services -RSS Guard is modular application which supports plugins. It offers well-maintained and relatively stable [plugin API](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/services/abstract/serviceentrypoint.h) which can be used to add support for various online feed services, extend a way feeds are processed or add totally new functionality to RSS Guard. At this point RSS Guard offers these plugins which are bundled in all installation packages and some of their features are described in detail in this documentation: +RSS Guard is a modular application which supports plugins. It offers well-maintained and relatively stable [plugin API](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/services/abstract/serviceentrypoint.h) which can be used to add support for various online feed services, extend a way feeds are processed or add totally new functionality to RSS Guard. At this point RSS Guard offers these plugins which are bundled in all installation packages and some of their features are described in detail in this documentation: * Standard `RSS/RDF/ATOM/JSON` plugin: This is the core plugin of RSS Guard which allows you to user the app like normal standalone feed reader with great features everyone would expect, including `OPML` files export and import or feed metadata fetching. Also podcasts are supported. * [Tiny Tiny RSS](https://tt-rss.org) plugin: Adds ability to synchronize messages with TT-RSS instances, either self-hosted or via 3rd-party external service. * [Inoreader](https://www.inoreader.com) plugin: Adds ability to synchronize messages with Inoreader. All you need to do is create free account on their website and start rocking. -* [Nextcloud News](https://apps.nextcloud.com/apps/news) plugin: Nextcloud News is a Nextcloud app which adds feed reader abilities into your Nextcloud instances. Nextcloud is nearly perfect self-hosted artifact synchronization platform. +* [Nextcloud News](https://apps.nextcloud.com/apps/news) plugin: Nextcloud News is a Nextcloud app which adds feed reader abilities into your Nextcloud instances. * [Gmail](https://www.google.com/gmail) plugin: Yes, you are reading it right. RSS Guard can be used as very lightweight and simple e-mail client. This plugins uses [Gmail API](https://developers.google.com/gmail/api) and offers even e-mail sending. All plugins share almost all core RSS Guard's features, including labels, recycle bins, podcasts fetching or newspaper view. They are implemented in a very transparent way, making it easy to maintain them or add new ones.