aboutsummaryrefslogtreecommitdiff
path: root/docs/en/users
AgeCommit message (Collapse)Author
2024-06-10fix broken sharing services (part 2): delete Blogotext (#6225)Gravatar maTh
2024-06-05Fix code for Czech language (#6514)Gravatar Alexandre Alapetite
Use the correct ISO 639-1 code: `cs` and not `cz` (which is the country) https://www.loc.gov/standards/iso639-2/php/langcodes_name.php?iso_639_1=cs
2024-06-05Add core extensions: UserCSS, UserJS (#6267)Gravatar hkcomori
* Copy CustomCSS and CustomJS Original: FreshRSS/Extensions@9f21984 * Rename CustomCSS -> UserCSS * Rename CustomJS -> UserJS * Change metadata The name is used for the directory where the configuration is stored and should not contain spaces. Since the name was changed, I reset the version number and changed to semantic versioning. * Change data directory Changed the location of the configuration file to the user data directory, because it is not `static`. That way, the user's configurations are gathered in the user directory, which makes it easier to backup them. * Edit documentations Remove procedures to install the extension because it is no longer necessary. * Fix wrong variables in the configuration page Remove permission error indication because the storage location is now in the user data directory managed by the application. * Remove the `xExtension-` prefix for core extensions * Set version to 1.0.0 for UserCSS, UserJS * Refactoring * Remove unused variables * Remove version 0.0.1 in Changelog Version 0.0.1 will not be merged, so only version 1.0.0 will remain. * public getFileUrl * Revert more protected * Use entrypoint for extension user path instead of name * Add space to extension name * Add `#[\Override]` * Add explains of User CSS and User JS to docs * Remove README of User CSS and User JS * Add migration code for extension user path --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-05-15Correct casing for GitHub (#6460)Gravatar Alexandre Alapetite
2024-03-06Bump the development-dependencies group with 6 updates (#6173)Gravatar dependabot[bot]
* Bump the development-dependencies group with 6 updates Bumps the development-dependencies group with 6 updates: | Package | From | To | | --- | --- | --- | | [eslint](https://github.com/eslint/eslint) | `8.56.0` | `8.57.0` | | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n) | `16.6.1` | `16.6.2` | | [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) | `0.38.0` | `0.39.0` | | [sass](https://github.com/sass/dart-sass) | `1.69.7` | `1.71.1` | | [stylelint](https://github.com/stylelint/stylelint) | `15.11.0` | `16.2.1` | | [stylelint-config-recommended-scss](https://github.com/stylelint-scss/stylelint-config-recommended-scss) | `13.1.0` | `14.0.0` | Updates `eslint` from 8.56.0 to 8.57.0 - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/compare/v8.56.0...v8.57.0) Updates `eslint-plugin-n` from 16.6.1 to 16.6.2 - [Release notes](https://github.com/eslint-community/eslint-plugin-n/releases) - [Commits](https://github.com/eslint-community/eslint-plugin-n/compare/16.6.1...16.6.2) Updates `markdownlint-cli` from 0.38.0 to 0.39.0 - [Release notes](https://github.com/igorshubovych/markdownlint-cli/releases) - [Commits](https://github.com/igorshubovych/markdownlint-cli/compare/v0.38.0...v0.39.0) Updates `sass` from 1.69.7 to 1.71.1 - [Release notes](https://github.com/sass/dart-sass/releases) - [Changelog](https://github.com/sass/dart-sass/blob/main/CHANGELOG.md) - [Commits](https://github.com/sass/dart-sass/compare/1.69.7...1.71.1) Updates `stylelint` from 15.11.0 to 16.2.1 - [Release notes](https://github.com/stylelint/stylelint/releases) - [Changelog](https://github.com/stylelint/stylelint/blob/main/CHANGELOG.md) - [Commits](https://github.com/stylelint/stylelint/compare/15.11.0...16.2.1) Updates `stylelint-config-recommended-scss` from 13.1.0 to 14.0.0 - [Release notes](https://github.com/stylelint-scss/stylelint-config-recommended-scss/releases) - [Changelog](https://github.com/stylelint-scss/stylelint-config-recommended-scss/blob/master/CHANGELOG.md) - [Commits](https://github.com/stylelint-scss/stylelint-config-recommended-scss/compare/v13.1.0...v14.0.0) --- updated-dependencies: - dependency-name: eslint dependency-type: direct:development update-type: version-update:semver-minor dependency-group: development-dependencies - dependency-name: eslint-plugin-n dependency-type: direct:development update-type: version-update:semver-patch dependency-group: development-dependencies - dependency-name: markdownlint-cli dependency-type: direct:development update-type: version-update:semver-minor dependency-group: development-dependencies - dependency-name: sass dependency-type: direct:development update-type: version-update:semver-minor dependency-group: development-dependencies - dependency-name: stylelint dependency-type: direct:development update-type: version-update:semver-major dependency-group: development-dependencies - dependency-name: stylelint-config-recommended-scss dependency-type: direct:development update-type: version-update:semver-major dependency-group: development-dependencies ... Signed-off-by: dependabot[bot] <support@github.com> * Fix conflict * Fix Markdown --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-03-05Fix OPML export regression and add token in RSS link (#6160)Gravatar Alexandre Alapetite
* OPML regression due to *shared user queries* (the XPath attributes were not exported anymore) https://github.com/FreshRSS/FreshRSS/pull/6052 * Add master token to HTML Meta RSS link and OPML link https://github.com/FreshRSS/FreshRSS/discussions/6159#discussioncomment-8678399
2024-02-26New feature: shareable user query (#6052)Gravatar Alexandre Alapetite
* New feature: shareable user query Share the output of a user query by RSS / HTML / OPML with other people through unique URLs. Replaces the global admin token, which was the only option (but unsafe) to share RSS outputs with other people. Also add a new HTML output for people without an RSS reader. fix https://github.com/FreshRSS/FreshRSS/issues/3066#issuecomment-648977890 fix https://github.com/FreshRSS/FreshRSS/issues/3178#issuecomment-769435504 * Remove unused method * Fix token saving * Implement HTML view * Update i18n for master token * Revert i18n get_favorite * Fix missing i18n for user queries from before this PR * Remove irrelevant tests * Add link to RSS version * Fix getGet * Fix getState * Fix getSearch * Alternative getSearch * Default getOrder * Explicit default state * Fix test * Add OPML sharing * Remove many redundant SQL queries from original implementation of user queries * Fix article tags * Use default user settings * Prepare public search * Fixes * Allow user search on article tags * Implement user search * Revert filter bug * Revert wrong SQL left outer join change * Implement checkboxes * Safe check of OPML * Fix label * Remove RSS button to favour new sharing method That sharing button was using a global admin token * First version of HTTP 304 * Disallow some recusrivity fix https://github.com/FreshRSS/FreshRSS/issues/6086 * Draft of nav * Minor httpConditional * Add support for offset for pagination * Fix offset pagination * Fix explicit order ASC * Add documentation * Help links i18n * Note about deprecated master token * Typo * Doc about format
2024-01-10JSONFeeds, JSON scraping, and POST requests for feeds (#5662)Gravatar eta-orionis
* allow POST requests for feeds * added json dotpath and jsonfeed subscriptions. No translation strings yet * debug and fix jsonfeed parser * bugfix params saved when editing feed * added translations for JSON features * Update docs for web scraping * make fix-all and revert unrelated changes, plus a few manual fixes, but there are still several type errors * Fix some i18n * refactor json parsing for both feed types * cleanup unnecessary comment * refactored generation of SimplePie for XPath and JSON feeds * Fix merge error * Update to newer FreshRSS code * A bit of refactoring * doc, whitespace * JSON Feed is in two words * Add support for array syntax * Whitespace * Add OPML export/import * Work on i18n * Accept application/feed+json * Rework POST * Fix update * OPML for cURL options * Fix types * Fix Typos --------- Co-authored-by: Erion Elmasllari <elmasllari@factorsixty.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-12-03Rework keepmax (#5905)Gravatar Alexandre Alapetite
* Rework keepmax fix https://github.com/FreshRSS/FreshRSS/issues/5702 fix https://github.com/FreshRSS/FreshRSS/issues/5870 * More WIP * Minor progress * Progress * Beta * Improved debug message * Revert noCommit * Fix variable reset * Remove debug syslogs
2023-11-14More WebSub doc (#5862)Gravatar Alexandre Alapetite
* More WebSub doc * UI for WebSub + more documentation And spellcheck Frech * Links to WebSub doc from readme * Add link to WebSub doc in admin interface * Fix checkbox * Plural
2023-11-12Docs: How to contribute new theme (#5863)Gravatar maTh
* Update 05_Configuration.md * Update 11_Themes.md * Update contributing.md * Update 02_Design.md * fix --------- Co-authored-by: math-gh <>
2023-11-08Update WebSub documentation a bit (#5829)Gravatar Alexandre Alapetite
* Update WebSub documentation a bit * Marien prefers not to promote his hub too much :-)
2023-10-08Minor update dependencies (#5693)Gravatar Alexandre Alapetite
* Minor update dependencies Follow-up of https://github.com/FreshRSS/FreshRSS/pull/5691 Mostly dev dependencies; nothing that affects our runtime * Update versions for GitHub Actions * Fix newly found typos * Fix exclude path
2023-08-15Add Hungarian language (#5589)Gravatar FromTheMoon
* Add Hungarian language * Fixed missing lines in Hungarian translation
2023-08-05[docs] Fix typos on the word 'scrape' and its variations (#5567)Gravatar Steve Jones
* Fix typos on the word 'scrape' and its variations * Fix spelling of 'Tipps'
2023-06-26docs: web scrapping with XPath (#5494)Gravatar maTh
* added docs * add correct link * typo * A bit of typography --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-06-20added: new sharing service: Omnivore (#5477)Gravatar maTh
* add Omnivore * fix i18n * Update app/i18n/en/gen.php Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-05-07docs: language table added (#5375)Gravatar maTh
* docs: language table added * Update 05_Configuration.md * Update 05_Configuration.md * french docs * Unicode quote and a few fixes (Same search&replace aslo applied to a few other files) --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-04-19Flat theme: un-deprecate (#5316)Gravatar maTh
* Update metadata.json * Update 05_Configuration.md
2023-04-12add Buffer.com as sharing service (#5286)Gravatar maTh
* add Buffer as sharing service * docs * add link the the sharing services list
2023-02-06Increase max HTTP timeout (#5074)Gravatar Alexandre Alapetite
* Increase maximum HTTP request timeout from 2 minutes to 15 minutes; * Reason: I have some RSS Bridge generating feeds, which can take several minutes. * Increase default HTTP request timeout from 15 to 20s. * Reason: I regularly observe feeds, which are slow to answer.
2023-01-17Docs: Explain the "Do not automatically refresh more often than" (#5017)Gravatar maTh
* reordering, config, TOC * fix markdownlint * fix
2023-01-17Added: Mark theme as deprecated (#4807)Gravatar maTh
* i18n + config * docs * deprecated marked themes * fix * fix markdown * i18n: fix link params * i18n: French * deprecated => no longer supported * i18n: German * Docs: deprecated => no longer supported * Docs: French * i18n: en-us * i18n German * isset() -> !empty() * i18n: fix German * i18n: English, delete // TODO
2023-01-17documentation improved: split en/users/03_Main_view.md into 3 parts (#5013)Gravatar maTh
* documentation * update the links * fix
2023-01-09Handling of parentheses as special characters in searches (#4989)Gravatar Alexandre Alapetite
#fix https://github.com/FreshRSS/FreshRSS/issues/4987
2022-10-13Added Linkding as a sharing method #4720 (#4721)Gravatar acbgbca
* Added Linkding as a sharing method #4720 * Fixed typo in docs #4720
2022-10-13i18n typographic quotes (#4714)Gravatar Alexandre Alapetite
* i18n typographic quotes * Missing whitespace * Update app/i18n/nl/conf.php Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Fix German-style typographic quotes * Fix missing closing ” * Fix Dutch quotes * French typography * <em>lazy load</em> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2022-08-16Basic support for negative searches with parentheses (#4503)Gravatar Alexandre Alapetite
* Basic support for negative searches with parentheses * `!((author:Alice intitle:hello) OR (author:Bob intitle:world))` * `(author:Alice intitle:hello) !(author:Bob intitle:world)` * `!(S:1 OR S:2)` * Minor documentation / comment * Remove syslog debug line
2022-06-19Update all test dependencies (#4419)Gravatar Alexandre Alapetite
* Update all test dependencies * Remove old false-positive * Minor update lock files * Increase PHPStan memory for Fedora https://github.com/FreshRSS/FreshRSS/pull/4400#issuecomment-1159514197 * Require PHP8+ for tests Due to small changes of signature in `ob_implicit_flush` and `simplexml_load_string`, cf. https://github.com/FreshRSS/FreshRSS/pull/4123 * Missing lint in CSS files
2022-06-02New search engine (#4378)Gravatar Alexandre Alapetite
* New possibility to invoke user queries from a search expression From the search field: `S:"My query"`. Can be combined with other filters such as `S:"My query" date:P3d` as long as the user queries do not contain `OR`. A use-case is to have an RSS filter with a stable address or an external API call with the ability to update the user query. * Draft of parenthesis logic * More draft * Working parenthesis (a OR b) (c OR d) * Working (A) OR (B) * Support nested parentheses + unit tests + documentation * search:MySearch and S:3
2022-05-19Fix doc anchor (#4376)Gravatar Alexandre Alapetite
* Fix doc anchor The "search an article" link lead to a dead anchor https://freshrss.github.io/FreshRSS/en/users/02_First_steps.html * Fix wording
2022-05-09Better documentation online cron (#4355)Gravatar Alexandre Alapetite
* Better documentation online cron #fix https://github.com/FreshRSS/FreshRSS/pull/3637#issuecomment-849073249 #fix https://github.com/FreshRSS/FreshRSS/issues/1676 * Forgotten line * Simplify examples * Rework structure slightly * More clarifications
2022-04-24Update 06_Mobile_access.md (#4325)Gravatar maTh
* Update 06_Mobile_access.md * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-03-15Improved: Sharing/Integration configuration (#4269)Gravatar maTh
* stick plus button to select list * HTML improved very much * drag and drop improved * add URL button * fix remove button behavior * prepare for PR#4238 * improve length of inputs * First draft of documentation of the sharing services * new config option: depricated * i18n for depricated text * Doc: Blogotext depricated to 2023 * dropdown menu with config link and depricated sign * Update entry_bottom.phtml * Update 08_sharing_services.md * Update template.rtl.css * Typo Deprecated/Depricated * typo * updated the documentation comment * Update shares.php * Update app/i18n/fr/conf.php Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Update p/scripts/draggable.js Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Update p/scripts/draggable.js Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Documentation: services from #4270 Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-02-28Update markdownlint-cli dev dependency (#4241)Gravatar Alexandre Alapetite
* Update markdownlint-cli dev dependency And fix https://github.com/advisories/GHSA-6vfc-qv3f-vr6c * npm ci
2022-02-27Documentation improved: mobile access (#4235)Gravatar maTh
* Update 06_Mobile_access.md * Readme: Windows + MacOS * fix markdown * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * MacOS -> macOS * Update 06_Mobile_access.md * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2022-01-21Fixup #3991 (#3992)Gravatar xnaas
* fixup #3991 * add xnaas to CREDITS.md * Update docs/en/users/03_Main_view.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * fix typo * Update docs/en/users/03_Main_view.md The lines were combined into one line and `'` was replaced with `’` for contracted words. Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: maTh <math-home@web.de> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-01-08Use typographic quotes (#4133)Gravatar Alexandre Alapetite
* Use typographic quotes * A few fixes * Fix * Fix not saved * Implement feedback * Detail * Revert spoken English fixes Left for a future dedicated discussion * More reverts * Final reverts * Final minor
2022-01-08Fix various typos and spelling errors in documentation, comments and code. ↵Gravatar Thomas Renes
(#4134)
2021-12-31Search on article IDs (#4058)Gravatar Alexandre Alapetite
* Search on article IDs Partial implementation of https://github.com/FreshRSS/FreshRSS/issues/4053
2021-12-10Update 02_First_steps.md (#4049)Gravatar happymacarts
spelling correction of "available"
2021-11-24Fix typo of 'envelope' and reference De Morgan's laws (#3991)Gravatar xnaas
2021-10-24Hot fix broken links documentationGravatar Alexandre Alapetite
Bug from https://github.com/FreshRSS/FreshRSS/pull/3905
2021-10-23Improved markdownlint (#3918)Gravatar Alexandre Alapetite
* Improved markdownlint * Relaxed rules slighlty * `npm run markdownlint` for automatic tests * `npm run markdownlint_fix` for automatic syntax fixing * Applied the fixes on all our Markdown files
2021-10-23Split fever & greader into two separate pages. (#3905)Gravatar Felix Bühler
* [docs] add newsflash to fever-clients * [docs] split fever&greader-apis into two pages and make the more consistent
2021-10-23Update Korean Translation with language code fix (#3914)Gravatar OctopusET
* Update Korean Translation * Fix Korean language code following IETF BCP 47 * Fix Korean language code in i18n/*/gen.php * Fix Korean language code in cli/i18n/* * Fix Korean language code in docs Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-07-24Search labels (#3709)Gravatar Alexandre Alapetite
* Search labels #fix https://github.com/FreshRSS/FreshRSS/issues/3704 * Documentation * Allow list without quotes * Allow boolean AND searches * Allow searching any label * fix labels alias
2021-04-08Newsboat support (#3574)Gravatar Petra Lamborn
* Newsboat support Newsboat is a feed reader for the unix-derived terminal, and is the successor to Newsbeuter. FreshRSS support has been merged into master <https://github.com/newsboat/newsboat/commit/f18145fc98700178429cbd137e0309f89ec89d5b> but there has not yet been a release since then. In the meantime I've created this pull request that can be merged whenever it becomes strictly accurate. I've filled out the table to the best of my ability, but I'm not completely clear on what "Fast sync" and "Fetch more in individual views" mean. * Does not work offline with freshrss * More doc Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-03-15Quick update the doc for master renaming to edgeGravatar Alexandre Alapetite
2021-03-10FocusReader (#3514)Gravatar Alexandre Alapetite