jan/miniflux-legacy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Frederic Guillot 2015-12-07 21:05:31 -05:00
parent a01cc4d006
commit e54c5eaa0c
7 changed files with 25 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.markdown
View File

@ -10,7 +10,7 @@ Features
- Readability (CSS optimized for readability, responsive design, compatible with mobile and tablet devices) - Readability (CSS optimized for readability, responsive design, compatible with mobile and tablet devices)
- Easy setup => **copy and paste the source code and you are done!** - Easy setup => **copy and paste the source code and you are done!**
- Use a lightweight Sqlite database instead of Mysql or Postgresql - Use a lightweight Sqlite database instead of Mysql or Postgresql
- Remove Feedburner Ads and analytics trackers (1x1 pixels) - Remove Feedburner Ads and analytic trackers (1x1 pixels)
- Open external links inside a new tab with a `rel="noreferrer"` attribute - Open external links inside a new tab with a `rel="noreferrer"` attribute
- Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed) - Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed)
- Article content is filtered before being displayed - Article content is filtered before being displayed

8
docs/config.markdown
View File

@ -18,11 +18,17 @@ Actually, the following constants can be overrided:
define('HTTP_TIMEOUT', '20'); define('HTTP_TIMEOUT', '20');
// HTTP_MAX_RESPONSE_SIZE => Maximum accepted size of the response body in MB (default 2MB) // HTTP_MAX_RESPONSE_SIZE => Maximum accepted size of the response body in MB (default 2MB)
defined('HTTP_MAX_RESPONSE_SIZE') or define('HTTP_MAX_RESPONSE_SIZE', 2097152); define('HTTP_MAX_RESPONSE_SIZE', 2097152);
// DATA_DIRECTORY => default is data (writable directory) // DATA_DIRECTORY => default is data (writable directory)
define('DATA_DIRECTORY', __DIR__.'/data'); define('DATA_DIRECTORY', __DIR__.'/data');
// FAVICON_DIRECTORY => default is favicons (writable directory)
define('FAVICON_DIRECTORY', DATA_DIRECTORY.DIRECTORY_SEPARATOR.'favicons');
// FAVICON_PUBLIC_DIRECTORY => default is data/favicons/
define('FAVICON_PUBLIC_DIRECTORY', 'data'.DIRECTORY_SEPARATOR.'favicons');
// DB_FILENAME => default value is db.sqlite (default database filename) // DB_FILENAME => default value is db.sqlite (default database filename)
define('DB_FILENAME', 'db.sqlite'); define('DB_FILENAME', 'db.sqlite');

2
docs/faq.markdown
View File

@ -43,4 +43,4 @@ I want to send bookmarks to Pinboard. How do I find my Pinboard API token?
-------------------------------------------------------------------------- --------------------------------------------------------------------------
You can find your API token by going to [https://api.pinboard.in/v1/user/api_token/](https://api.pinboard.in/v1/user/api_token/). You can find your API token by going to [https://api.pinboard.in/v1/user/api_token/](https://api.pinboard.in/v1/user/api_token/).
Miniflux requires you add your Pinboard username before this, followed by a colon (eg. bobsmith:12FC235692DF53DD1). Miniflux requires you to add your Pinboard username before this, followed by a colon (eg. bobsmith:12FC235692DF53DD1).

4
docs/multiple-users.markdown
View File

@ -1,9 +1,9 @@
Multiple users Multiple users
============== ==============
Since the begining, Miniflux was a single user software. Since the beginning, Miniflux was a single user software.
However, it is now possible to create multiple databases. However, it is now possible to create multiple databases.
Each user have his own Sqlite database and people can choose which database they want to use before the authentication. Each user has his own Sqlite database and people can choose which database they want to use before the authentication.
To create a new database: To create a new database:

4
docs/tests.markdown
View File

@ -31,7 +31,7 @@ PHPUnit 4.4.0 by Sebastian Bergmann.
Install the latest version of Selenium Server Install the latest version of Selenium Server
--------------------------------------------- ---------------------------------------------
Download the distribution archive of [Selenium Server](http://www.seleniumhq.org/download/) and the platform and browser specific driver. The following browser driver exist: Download the distribution archive of [Selenium Server](http://www.seleniumhq.org/download/) and the platform and browser specific driver. The following browser driver exists:
- Firefox webdriver is default included - Firefox webdriver is default included
- [Chrome webdriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) - [Chrome webdriver](https://sites.google.com/a/chromium.org/chromedriver/downloads)
@ -86,7 +86,7 @@ The following `phpunit.xml` is used to run phpunit on a linux system with apache
``` ```
Some tests don't run with every browser. You have to exclude those tests by using the ```--exclude-group``` commandline parameter. The following exclude groups exists: Some tests don't run with every browser. You have to exclude those tests by using the ```--exclude-group``` command line parameter. The following exclude groups exist:
* moz_unsupported (Due to https://github.com/SeleniumHQ/selenium/issues/386) * moz_unsupported (Due to https://github.com/SeleniumHQ/selenium/issues/386)
* ie_unsupported (Due to https://code.google.com/p/selenium/issues/detail?id=4973) * ie_unsupported (Due to https://code.google.com/p/selenium/issues/detail?id=4973)

14
docs/translations.markdown
View File

@ -5,21 +5,21 @@ How to translate Miniflux to a new language?
-------------------------------------------- --------------------------------------------
- Translations are stored inside the directory `locales` - Translations are stored inside the directory `locales`
- There is a sub-directory for each language, by example for the French we have `fr_FR`, Italian `it_IT` etc... - There is a sub-directory for each language, for example in French we have `fr_FR`, Italian `it_IT` etc...
- A translation is a PHP file that return an Array with a key-value pairs - A translation is a PHP file that return an Array with a key-value pairs
- The key is the original text in english and the value is the translation for the corresponding language - The key is the original text in English and the value is the translation of the corresponding language
- **French translations are always up to date** - **French translations are always up to date**
- Always use the last version (branch master) - Always use the last version (branch master)
### Plurals ### Plurals
Each translation file has a plural formula defined. This formula is used to determine wether a plural for the current number is needed. For languages with multiple plurals, the formula determine which plural form is the right one. Each translation file has a plural formula defined. This formula is used to determine whether a plural for the current number is needed. For languages with multiple plurals, the formula determine which plural form is the right one.
You can get the formula for your language from https://localization-guide.readthedocs.org/en/latest/l10n/pluralforms.html. You can get the formula for your language from https://localization-guide.readthedocs.org/en/latest/l10n/pluralforms.html.
The formula need to be adjusted to be valid php code. Do not hesitate to ask for an adjusted formula in the bug tracker. The formula need to be adjusted to be valid php code. Do not hesitate to ask for an adjusted formula in the bug tracker.
You need to create a list of strings for terms that have a plural. For example the plural for the English translation looks like the following: You need to create a list of strings for terms that have a plural. For example, the plural of the English translation looks like the following:
``` ```
'plural' => function($n) { return ($n != 1); }, 'plural' => function($n) { return ($n != 1); },
@ -51,7 +51,7 @@ Translations are displayed with the following functions in the source code:
- `tne()`: displayed with no escaping - `tne()`: displayed with no escaping
- `dt()`: date using `strftime()` formats - `dt()`: date using `strftime()` formats
Always use the english version in the source code. Always use the English version in the source code.
How to find missing translations in the applications? How to find missing translations in the applications?
----------------------------------------------------- -----------------------------------------------------
@ -62,7 +62,7 @@ From a Unix shell run:
./scripts/find-strings.sh ./scripts/find-strings.sh
``` ```
All missing translations are displayed on the screen. Put that in the french locale and sync other locales (see below). All missing translations are displayed on the screen. Put that in the French locale and sync other locales (see below).
How to synchronize translation files? How to synchronize translation files?
------------------------------------- -------------------------------------
@ -73,4 +73,4 @@ From a Unix shell run this command:
./scripts/sync-locales.php ./scripts/sync-locales.php
``` ```
The french translation is used a reference for other locales. The French translation is used a reference to other locales.

8
docs/upgrade.markdown
View File

@ -5,15 +5,15 @@ Upgrade to a new version
1. Close your session (logout) 1. Close your session (logout)
2. Rename your actual miniflux directory (to keep a backup) 2. Rename your actual miniflux directory (to keep a backup)
3. Uncompress the new archive and copy your database file `db.sqlite` in the directory `data` 3. Decompress the new archive and copy your database file `db.sqlite` in the directory `data`
4. Make the directory `data` writeable by the web server user 4. Make the directory `data` writeable by the web server user
5. Login and check if everything is ok 5. Login and check if everything is OK
6. Remove the old miniflux directory 6. Remove the old miniflux directory
### From the repository (development version) ### From the repository (development version)
1. Close your session (logout) 1. Close your session (logout)
2. `git pull` 2. `git pull`
3. Login and check if everything is ok 3. Login and check if everything is OK
Note: Always do a backup of your database before! Note: Always make a backup of your database before!