Skip to content

Commit 56e668e

Browse files
supahgregsupahgreg
committed
Fix ridiculous use of hyphens introduced during conversion to Just the Docs.
Also some other minor tweaks.
1 parent b4c75c6 commit 56e668e

File tree

11 files changed

+67
-70
lines changed

11 files changed

+67
-70
lines changed

‎docs/API-Reference.md‎

Lines changed: 24 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ are not supported.
8080

8181
## Methods
8282

83-
### getApiLevel (since version:1.5.8, api level-1)
83+
### getApiLevel (since version:1.5.8, api level 1)
8484

8585
Return an abstracted integer API version level, increased with each API
8686
functionality change. This is the proper way to detect host API
@@ -132,7 +132,7 @@ password parameters.
132132

133133
### logout
134134

135-
Closes your login session. Returns either status-message <code>{"status":"OK"}</code> or an error (e.g.-<code>{"error":"NOT_LOGGED_IN"}</code>)
135+
Closes your login session. Returns either status message <code>{"status":"OK"}</code> or an error (e.g.-<code>{"error":"NOT_LOGGED_IN"}</code>)
136136

137137
### isLoggedIn
138138

@@ -162,8 +162,7 @@ Parameters:
162162
- ``unread_only`` (bool) - only return feeds which have unread articles
163163
- ``limit`` (integer) - limit amount of feeds returned to this value
164164
- ``offset`` (integer) - skip this amount of feeds first
165-
- ``include_nested`` (bool) - include child categories (as Feed-objects
166-
``with is_cat set)`` **requires version:1.6.0**
165+
- ``include_nested`` (bool) - include child categories (as Feed objects with `is_cat` set) **requires version:1.6.0**
167166

168167
Pagination:
169168

@@ -179,7 +178,7 @@ Special category IDs are as follows:
179178

180179
Added in version:1.5.0:
181180

182-
- -3 All feeds, excluding virtual feeds (e.g. Labels and-such)
181+
- -3 All feeds, excluding virtual feeds (e.g. Labels and such)
183182
- -4 All feeds, including virtual feeds
184183

185184
Known bug: Prior to version:1.5.0 passing null or 0 cat\_id to this
@@ -201,7 +200,7 @@ categories is returned and unread counters include counters for child
201200
categories.
202201

203202
This should be used as a starting point, to display a root list of all
204-
(for backwards-compatibility) or topmost categories, use getFeeds to
203+
(for backwards compatibility) or topmost categories, use [`getFeeds`](#getFeeds) to
205204
traverse deeper.
206205

207206
### getHeadlines
@@ -210,11 +209,11 @@ Returns JSON-encoded list of headlines.
210209

211210
Parameters:
212211

213-
- ``feed_id`` (integer|string) - only output articles for this feed (supports string values to retrieve tag virtual feeds since API level 18, otherwise-integer)
214-
- ``limit`` (integer) - limits the amount of returned articles (see-below)
212+
- ``feed_id`` (integer|string) - only output articles for this feed (supports string values to retrieve tag virtual feeds since API level 18, otherwise integer)
213+
- ``limit`` (integer) - limits the amount of returned articles (see below)
215214
- ``skip`` (integer) - skip this amount of feeds first
216215
- ``filter`` (string) - currently unused (?)
217-
- ``is_cat`` (bool) - requested feed\_id is a category
216+
- ``is_cat`` (bool) - requested `feed_id` is a category
218217
- ``show_excerpt`` (bool) - include article excerpt in the output
219218
- ``show_content`` (bool) - include full article text in the output
220219
- ``view_mode`` (string = all\_articles, unread, adaptive,-marked,
@@ -230,24 +229,22 @@ Parameters:
230229
- ``sanitize`` (bool) - sanitize content or not **requires version:1.8**
231230
(default:-true)
232231
- ``force_update`` (bool) - try to update feed before showing headlines
233-
**requires version:1.14 (api-9)** (default: false)
232+
**requires version:1.14 (api 9)** (default: false)
234233
- ``has_sandbox`` (bool) - indicate support for sandboxing of iframe
235234
elements **<span class="10 api"></span>** (default: false)
236235
- ``include_header`` (bool) - adds status information when returning
237236
headlines, instead of array(articles) return value changes to
238-
array(header,-array(articles)) (api-12)
237+
array(header,-array(articles)) (api 12)
239238

240239
Limit:
241240

242241
Before **API level 6** maximum amount of returned headlines is capped at
243242
60, API 6 and above sets it to 200.
244243

245-
This parameters might change in the future (supported since **API-level
246-
2**):
244+
These parameters might change in the future (supported since **API level 2**):
247245

248-
- ``search`` (string) - search query (e.g. a list of-keywords)
249-
- ``search_mode`` (string) - all\_feeds, this\_feed (default), this\_cat
250-
(category containing requested-feed)
246+
- ``search`` (string) - search query (e.g. a list of keywords)
247+
- ``search_mode`` (string) - `all_feeds`, `this_feed` (default), `this_cat` (category containing requested feed)
251248
- ``match_on`` (string) - ignored
252249

253250
Special feed IDs are as follows:
@@ -271,13 +268,13 @@ Update information on specified articles.
271268

272269
Parameters:
273270

274-
- ``article_ids`` (comma-separated list of-integers) - article IDs to
271+
- ``article_ids`` (comma-separated list of integers) - article IDs to
275272
operate on
276273
- ``mode`` (integer) - type of operation to perform (0 - set to false, 1--
277274
set to true, 2 - toggle)
278-
- ``field`` (integer) - field to operate on (0 - starred, 1 - published, 2 - unread, 3 - article note **since api level-1**)
275+
- ``field`` (integer) - field to operate on (0 - starred, 1 - published, 2 - unread, 3 - article note **since api level 1**)
279276
- ``data`` (string) - optional data parameter when setting note field
280-
(since **api level-1**)
277+
(since **api level 1**)
281278

282279
E.g. to set unread status of articles X and Y to false use the
283280
following:
@@ -312,9 +309,9 @@ Returns tt-rss configuration parameters:
312309
- ``icons_dir`` - path to icons on the server filesystem
313310
- ``icons_url`` - path to icons when requesting them over http
314311
- ``daemon_is_running`` - whether update daemon is running
315-
- ``num_feeds`` - amount of subscribed feeds (this can be used to-refresh
312+
- ``num_feeds`` - amount of subscribed feeds (this can be used to refresh
316313
feedlist when this amount changes)
317-
- ``custom_sort_types`` - map of plugin-provided article sort types (API-17+)
314+
- ``custom_sort_types`` - map of plugin-provided article sort types (API 17+)
318315

319316
### updateFeed
320317

@@ -324,7 +321,7 @@ aborted by the HTTP server.
324321

325322
- ``feed_id`` (integer) - ID of feed to update
326323

327-
Returns status-message if the operation has been completed.
324+
Returns status message if the operation has been completed.
328325

329326
```json
330327
{"status":"OK"}
@@ -344,15 +341,15 @@ Returns preference value of specified key.
344341

345342
Required version: version:1.4.3
346343

347-
Tries to catchup (e.g. mark as-read) specified feed.
344+
Tries to catchup (e.g. mark as read) specified feed.
348345

349346
Parameters:
350347

351348
- ``feed_id`` (integer) - ID of feed to update
352349
- ``is_cat`` (boolean) - true if the specified feed\_id is a category
353350
- ``mode`` (string) - optional: one of `all`, `1day`, `1week`, `2week`. defaults to `all`. **since api level 15**.
354351

355-
Returns status-message if the operation has been completed.
352+
Returns status message if the operation has been completed.
356353

357354
```json
358355
{"status":"OK"}
@@ -379,7 +376,7 @@ to “flc”):
379376
Several global counters are returned as well, those can’t be disabled
380377
with output\_mode.
381378

382-
### getLabels (since API level-1)
379+
### getLabels (since API level 1)
383380

384381
Returns list of configured labels, as an array of label objects:
385382

@@ -402,7 +399,7 @@ Parameters:
402399

403400
* ``article_id`` (int) - set “checked” to true if specified article id has returned label.
404401

405-
### setArticleLabel (since API level-1)
402+
### setArticleLabel (since API level 1)
406403

407404
Assigns article\_ids to specified label.
408405

@@ -413,7 +410,7 @@ Parameters:
413410
* ``assign`` (boolean) - assign or remove label
414411

415412
Note: Up until version:1.15 setArticleLabel() clears the label cache for
416-
the specified articles. Make sure to regenerate it (e.g. by calling-API
413+
the specified articles. Make sure to regenerate it (e.g. by calling API
417414
method getLabels() for the respecting articles) when you’re using
418415
methods which don’t do that by themselves (e.g.-getHeadlines())
419416
otherwise getHeadlines() will not return labels for modified articles.

‎docs/Email-Digests.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Email Digests
44
nav_order: 42
55
---
66

7-
Users may opt into receiving daily (sent once every 24-hours) digests of unread headlines via email.
7+
Users may opt into receiving daily (sent once every 24 hours) digests of unread headlines via email.
88

99
Digests are sent out by the update daemon or if running <code>update.php —feeds</code>
1010
manually. At most 15 messages are sent in one batch.

‎docs/FAQ.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ nav_order: 30
99
1010
### I want to check how tt-rss renders my feed / the feed I'm trying to use is parsed incorrectly
1111

12-
tt-rss expects valid XML feed data which is parsed using libxml. Any XML parse errors, should you feel that libxml is misbehaving (which is-unlikely), should be reported to libxml developers. We don't add hacks for invalid XML on tt-rss side.
12+
tt-rss expects valid XML feed data which is parsed using libxml. Any XML parse errors, should you feel that libxml is misbehaving (which is unlikely), should be reported to libxml developers. We don't add hacks for invalid XML on tt-rss side.
1313

1414
Plugins may affect parsing, consider disabling any plugins before investigating XML-related issues.
1515

1616
### I managed to lock myself out of tt-rss
1717

18-
This assumes you can't simply reset your password via email (login form - forgot my-password).
18+
This assumes you can't simply reset your password via email (login form - forgot my password).
1919

2020
If you have OTP (2FA) enabled and know your password but can't provide an OTP token, you can disable OTP via SQL:
2121

@@ -48,7 +48,7 @@ Alternatively, you can either temporarily disable `auth_remote` (replace it with
4848
### UI is missing CSS or is otherwise visibly broken
4949

5050
- Try opening tt-rss using safe mode, clean browser profile, or an incognito
51-
window (a different browser would also-work)
51+
window (a different browser would also work)
5252
- Unless you're using SSL, try a different network connection in case your ISP is MITMing you
5353
- Some values of ``Content-Security-Policy`` header may break tt-rss, if you
5454
have this header set in your httpd config, try disabling it temporarily
@@ -59,7 +59,7 @@ Alternatively, you can either temporarily disable `auth_remote` (replace it with
5959

6060
### Third party theme or plugin broke after update making the UI unusable
6161

62-
Log in to tt-rss in safe mode (use an incognito window if you can't get to login-page).
62+
Log in to tt-rss in safe mode (use an incognito window if you can't get to login page).
6363

6464
### I want to limit height of images to something more manageable
6565

@@ -76,7 +76,7 @@ body.ttrss_main .cdm .content img, body.ttrss_main .cdm .content video {
7676

7777
### Feeds stop updating for users who rarely login
7878

79-
This is controlled by a global configuration setting. You can override (or-disable) it through environment or `config.php` by setting `TTRSS_DAEMON_UPDATE_LOGIN_LIMIT` to `0`.
79+
This is controlled by a global configuration setting. You can override (or disable) it through environment or `config.php` by setting `TTRSS_DAEMON_UPDATE_LOGIN_LIMIT` to `0`.
8080

8181
Note that this also effectively disables purging of articles stored for inactive users.
8282

@@ -86,11 +86,11 @@ Purging is performed on successful feed update, no updates = no purging.
8686

8787
Starred articles are never purged, unread articles are purged if relevant preference is enabled.
8888

89-
Purging is done based on import timestamp, internal to tt-rss. It may be different from article date specified by the feed (i.e. article says it was published on 1970/01/01 but it was imported-today). You can see import timestamp if you hover over date in tt-rss web UI.
89+
Purging is done based on import timestamp, internal to tt-rss. It may be different from article date specified by the feed (i.e. article says it was published on 1970/01/01 but it was imported today). You can see import timestamp if you hover over date in tt-rss web UI.
9090

9191
Import date is bumped every time article is encountered in the feed, otherwise it will get purged and reimported again on every feed refresh, creating duplicates.
9292

93-
When in doubt, use Feed debugger (`f D` on a-feed) to see additional purging-related information:
93+
When in doubt, use Feed debugger (`f D` on a feed) to see additional purging-related information:
9494

9595
```text
9696
[11:08:10/6783] purging feed...
@@ -117,7 +117,7 @@ Find and delete daemon lock file in <code>LOCK_DIRECTORY</code>. Usually, it's <
117117
https://example.com/tt-rss/public.php?op=bookmarklets--subscribe&feed_url=%s
118118
```
119119

120-
If feed URL is empty (or not-given) tt-rss will display feed subscription dialog.
120+
If feed URL is empty (or not given) tt-rss will display feed subscription dialog.
121121

122122
### I need to get the number of unread articles for specific user
123123

‎docs/Generated-Feeds.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Generated Feeds
44
nav_order: 45
55
---
66

7-
You can generate a feed (in Atom or JSON-format) for almost anything displayed
7+
You can generate a feed (in Atom or JSON format) for almost anything displayed
88
in headlines buffer (e.g. actual feeds, Labels, Categories,-etc.) by clicking
99
this icon:
1010

@@ -59,7 +59,7 @@ Feed ID values less than `-10` are considered Labels.
5959

6060
- ``0`` - Uncategorized
6161
- ``-1`` - Special category (includes Starred, Published,-etc.)
62-
- ``-2`` - Labels category (includes your-labels)
62+
- ``-2`` - Labels category (includes your labels)
6363

6464
### View mode values
6565

@@ -68,7 +68,7 @@ generated feeds.
6868

6969
- <code>adaptive</code> - shows unread articles only when they are
7070
unread articles, shows everything otherwise
71-
- <code>marked</code> (this means-starred), <code>has\_note</code>,
71+
- <code>marked</code> (this means starred), <code>has\_note</code>,
7272
<code>published</code>, <code>unread</code>,
7373
<code>unread\_first</code> - should be self explanatory
7474

‎docs/Installation-Guide.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ nav_order: 2
1414

1515
---
1616

17-
The main (and-recommended) way to run tt-rss is under Docker.
17+
The main (and recommended) way to run tt-rss is under Docker.
1818

1919
Docker images for <https://github.com/tt-rss/tt-rss> are being built (for `linux/amd64` and-`linux/arm64`) and published
2020
([via GitHub-Actions](https://github.com/tt-rss/tt-rss/actions/workflows/publish.yml)) to:
@@ -58,7 +58,7 @@ Place both `.env` and `docker-compose.yml` together in a directory, edit `.env`
5858
# 10 - admin
5959
#ADMIN_USER_ACCESS_LEVEL=
6060

61-
# Auto create another user (in addition to built-in-admin) unless it already exists.
61+
# Auto create another user (in addition to built-in admin) unless it already exists.
6262
#AUTO_CREATE_USER=
6363
#AUTO_CREATE_USER_PASS=
6464
#AUTO_CREATE_USER_ACCESS_LEVEL=0
@@ -88,7 +88,7 @@ HTTP_PORT=127.0.0.1:8280
8888

8989
{: .warning }
9090
> See [this FAQ entry](#i-got-the-updated-docker-compose-file-above-and-now-my-database-keeps-restarting)
91-
> if you're upgrading between PostgreSQL major versions (e.g. 15 to-17).
91+
> if you're upgrading between PostgreSQL major versions (e.g. 15 to 17).
9292
9393
{: .warning }
9494
> Regarding PostgreSQL 18:
@@ -206,10 +206,10 @@ services:
206206
```
207207

208208
`BUILDKIT_CONTEXT_KEEP_GIT_DIR` build argument is needed to display tt-rss version info properly.
209-
If that doesn't work for you (no-BuildKit?) you'll have to resort to terrible hacks.
209+
If that doesn't work for you (no BuildKit?) you'll have to resort to terrible hacks.
210210

211211
{: .warning }
212-
> Self-built images are not necessarily supported (i.e. best effort and/or community-support).
212+
> Self-built images are not necessarily supported (i.e. best effort and/or community support).
213213

214214
### I got the updated Docker Compose file above and now my database keeps restarting
215215

@@ -222,13 +222,13 @@ Using the aforementioned example, you could do one of the following:
222222

223223
1. Replace `postgres:15-alpine` with `postgres:12-alpine` in `docker-compose.yml` (or use `docker-compose.override.yml`, see-below) and keep using PG 12
224224
2. Use [this DB container](https://github.com/pgautoupgrade/docker-pgautoupgrade) which would automatically upgrade the database
225-
3. Migrate the data manually using `pg_dump` and `pg_restore` (somewhat complicated if you haven't done it-before)
225+
3. Migrate the data manually using `pg_dump` and `pg_restore` (somewhat complicated if you haven't done it before)
226226

227-
### I'm using docker-compose.override.yml and now I'm getting schema update (and-other) strange issues
227+
### I'm using docker-compose.override.yml and now I'm getting schema update (and other) strange issues
228228

229229
Alternatively, you've changed something related to `/var/www/html/tt-rss` in `docker-compose.yml`.
230230

231-
Your Docker setup is messed up for some reason, so tt-rss can't update itself to the persistent storage location on startup (this is just an example of one issue, there could be many-others).
231+
Your Docker setup is messed up for some reason, so tt-rss can't update itself to the persistent storage location on startup (this is just an example of one issue, there could be many others).
232232

233233
Consider undoing any recent changes, looking up error messages, etc.
234234

@@ -433,9 +433,9 @@ Note that `proxy_pass` in this example points to container website root.
433433
</IfModule>
434434
```
435435

436-
### I have internal web services tt-rss is complaining about (URL is invalid, loopback address, disallowed-ports)
436+
### I have internal web services tt-rss is complaining about (URL is invalid, loopback address, disallowed ports)
437437

438-
Put your local services on the same Docker network with tt-rss, then access them by service (=-host) names, i.e. `http://rss-bridge/`.
438+
Put your local services on the same Docker network with tt-rss, then access them by service (=host) names, i.e. `http://rss-bridge/`.
439439

440440
```yml
441441
services:
@@ -447,7 +447,7 @@ networks:
447447
name: ttrss-docker_default
448448
```
449449

450-
If your service uses a non-standard (i.e. not 80 or-443) port, make an internal reverse proxy sidecar container for it.
450+
If your service uses a non-standard (i.e. not 80 or 443) port, make an internal reverse proxy sidecar container for it.
451451

452452
### Backup and restore
453453

@@ -458,7 +458,7 @@ If you value your data, you should invest your time into setting up something li
458458

459459
#### Manually taking a backup
460460

461-
To run [`.docker/app/backup.sh`](https://github.com/tt-rss/tt-rss/blob/main/.docker/app/backup.sh) (the backup script that executes-weekly):
461+
To run [`.docker/app/backup.sh`](https://github.com/tt-rss/tt-rss/blob/main/.docker/app/backup.sh) (the backup script that executes weekly):
462462

463463
`docker compose exec backups /etc/periodic/weekly/backup`
464464

@@ -481,7 +481,7 @@ The process to restore the database from a `backups` container backup might look
481481

482482
1. Enter `backups` container shell: `docker compose exec backups /bin/sh`
483483
2. Inside the container, locate and choose the backup file: `ls -t /backups/*.sql.gz`
484-
3. Clear database (**THIS WOULD DELETE EVERYTHING IN THE-DB**): `psql -h db -U $TTRSS_DB_USER $TTRSS_DB_NAME -e -c "drop schema public cascade; create schema public"`
484+
3. Clear database (**THIS WOULD DELETE EVERYTHING IN THE DB**): `psql -h db -U $TTRSS_DB_USER $TTRSS_DB_NAME -e -c "drop schema public cascade; create schema public"`
485485
3. Restore the backup: `zcat /backups/ttrss-backup-yyyymmdd.sql.gz | psql -h db -U $TTRSS_DB_USER $TTRSS_DB_NAME`
486486

487487
### How do I use custom certificates?

‎docs/Plugins.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav_order: 10
66

77
Tiny Tiny RSS supports many kinds of plugins: social plugins which share
88
articles to various sites, article filter plugins which mangle feed-provided
9-
data on import (for example, inlining images or extracting full article-text
9+
data on import (for example, inlining images or extracting full article text
1010
using Readability), hotkey plugins which alter the way keyboard shortcuts work,
1111
etc.
1212

@@ -45,7 +45,7 @@ i.e. ``Af_ExamplePlugin`` should be copied to ``plugins.local/af_exampleplugin``
4545
>
4646
{: .note }
4747
> Third party plugins may be unmaintained and incompatible with newer tt-rss
48-
> code (especially those from the old-forums). Please report plugin-related
48+
> code (especially those from the old forums). Please report plugin-related
4949
> problems to their developers.
5050
5151
### Sharing plugins
@@ -76,7 +76,7 @@ i.e. ``Af_ExamplePlugin`` should be copied to ``plugins.local/af_exampleplugin``
7676

7777
<https://github.com/feediron/ttrss_plugin-feediron>
7878

79-
#### A simple plugin to assist in the display of images from NASA's Astronomy Picture of the Day feed in TT-RSS
79+
#### A simple plugin to assist in the display of images from NASA's Astronomy Picture of the Day feed in tt-rss
8080

8181
<https://github.com/joshp23/TTRSS-APOD-Fix>
8282

0 commit comments

Comments
 (0)