Skip to content

Commit 9dd68ec

Browse files
committed
Remove some more horrifying hyphens.
1 parent a4bbe0c commit 9dd68ec

11 files changed

+28
-28
lines changed

docs/API-Reference.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,11 @@ password parameters.
127127

128128
- On version:1.6.0 and above login also returns current API level as an
129129
<code>api\_level</code> integer, you can use that instead of calling `getApiLevel` after login.
130-
- Since API 17, also returns configuration object (see `getConfig`-below).
130+
- Since API 17, also returns configuration object (see [`getConfig`](#getconfig) below).
131131

132132
### logout
133133

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

136136
### isLoggedIn
137137

@@ -172,7 +172,7 @@ instead.
172172
Special category IDs are as follows:
173173

174174
* 0 Uncategorized
175-
* -1 Special (e.g. Starred, Published, Archived,-etc.)
175+
* -1 Special (e.g. Starred, Published, Archived, etc.)
176176
* -2 Labels
177177

178178
Added in version:1.5.0:
@@ -215,7 +215,7 @@ Parameters:
215215
- ``is_cat`` (bool) - requested `feed_id` is a category
216216
- ``show_excerpt`` (bool) - include article excerpt in the output
217217
- ``show_content`` (bool) - include full article text in the output
218-
- ``view_mode`` (string = all\_articles, unread, adaptive,-marked,
218+
- ``view_mode`` (string = all\_articles, unread, adaptive, marked,
219219
updated)
220220
- ``include_attachments`` (bool) - include article attachments (e.g.
221221
enclosures) **requires version:1.5.3**
@@ -233,7 +233,7 @@ Parameters:
233233
elements **<span class="10 api"></span>** (default: false)
234234
- ``include_header`` (bool) - adds status information when returning
235235
headlines, instead of array(articles) return value changes to
236-
array(header,-array(articles)) (api 12)
236+
array(header, array(articles)) (api 12)
237237

238238
Limit:
239239

@@ -411,7 +411,7 @@ Parameters:
411411
Note: Up until version:1.15 setArticleLabel() clears the label cache for
412412
the specified articles. Make sure to regenerate it (e.g. by calling API
413413
method getLabels() for the respecting articles) when you’re using
414-
methods which don’t do that by themselves (e.g.-getHeadlines())
414+
methods which don’t do that by themselves (e.g. getHeadlines())
415415
otherwise getHeadlines() will not return labels for modified articles.
416416

417417
### shareToPublished (since API level 4 --version:1.6.0)
@@ -433,7 +433,7 @@ subscribe\_to\_feed() in functions.php for details.
433433
Parameters:
434434

435435
* ``feed_url`` - Feed URL (string)
436-
* ``category_id`` - Category id to place feed into (defaults to 0,-Uncategorized) (int)
436+
* ``category_id`` - Category id to place feed into (defaults to 0, Uncategorized) (int)
437437
* ``login``, ``password`` - Self explanatory (string)
438438

439439
### unsubscribeFeed (API level 5 --version:1.7.6)

docs/Content-Filters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ final matching.
3737
all rules match.
3838
- Regular expressions may be matched against several article fields, such
3939
as, title, content, author, etc.
40-
- Do not include delimiters (e.g.-<code>/</code>) when writing regular
40+
- Do not include delimiters (e.g. <code>/</code>) when writing regular
4141
expressions.
4242

4343
### Matching articles and applying actions

docs/FAQ.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ This sets your password back to default (``password``) and disables OTP.
3737

3838
The problem is that if you have `auth_remote` enabled in [PLUGINS](Global-Config) tt-rss tries to automatically log you in as the user specified by the server using HTTP authentication, which may not have administrative privileges.
3939

40-
The easiest way is simply updating database using CLI (`php ./update.php---update-schema`). Docker setup does this on startup.
40+
The easiest way is simply updating database using CLI (`php ./update.php --update-schema`). Docker setup does this on startup.
4141

42-
Alternatively, you can either temporarily disable `auth_remote` (replace it with-`auth_internal`), temporarily disable HTTP authentication, or give yourself administrative permissions using SQL:
42+
Alternatively, you can either temporarily disable `auth_remote` (replace it with `auth_internal`), temporarily disable HTTP authentication, or give yourself administrative permissions using SQL:
4343

4444
```sql
4545
update ttrss_users set access_level = 10 where login = 'you';
@@ -105,7 +105,7 @@ Related question:
105105

106106
Because the articles are still in the feed XML and get pulled in (again) on next feed update.
107107

108-
See-also: [Archived Feed](Archived-Feed.md)
108+
See also: [Archived Feed](Archived-Feed.md)
109109

110110
### I have used update daemon before, but switched away from it. However, the UI keeps nagging me about the daemon not running or not updating feeds or whatever
111111

docs/Generated-Feeds.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ parent: Features
55
---
66

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

1111
![Generated feed icon](../images/gen_feed_icon.png)
@@ -58,7 +58,7 @@ Feed ID values less than `-10` are considered Labels.
5858
### Special category IDs (is\_cat=1)
5959

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

6464
### View mode values
@@ -78,9 +78,9 @@ specifier because unread articles are never part of the feed).
7878

7979
### Order values
8080

81-
- ``default`` - depends on the feed: either import batch date or (for published and starred-feeds) ``last_published`` and ``last_marked``
81+
- ``default`` - depends on the feed: either import batch date or (for published and starred feeds) ``last_published`` and ``last_marked``
8282
- ``title`` - sort by title
8383
- ``date_reverse`` - reverse sort by batch date
8484
- ``feed_dates`` - sort by feed-provided article dates
8585

86-
See-also: [Publish Articles](Publish-Articles.md)
86+
See also: [Publish Articles](Publish-Articles.md)

docs/Global-Config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ putenv('TTRSS_SESSION_COOKIE_LIFETIME='.(86400*30));
3232
Legacy plugin-required constants also go to `config.php`, using `define()`:
3333

3434
```js
35-
define('LEGACY_CONSTANT',-'value');
35+
define('LEGACY_CONSTANT', 'value');
3636
```
3737

3838
To set computed values via `putenv()` you have to get them evaluated by PHP, this would work:

docs/Installation-Guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ nav_order: 2
1616

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

19-
Docker images for <https://github.com/tt-rss/tt-rss> are being built (for `linux/amd64` and-`linux/arm64`) and published
19+
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:
21-
* Docker Hub (as-[supahgreg/tt-rss](https://hub.docker.com/r/supahgreg/tt-rss/) and [supahgreg/tt-rss-web-nginx](https://hub.docker.com/r/supahgreg/tt-rss-web-nginx/)).
21+
* Docker Hub (as [supahgreg/tt-rss](https://hub.docker.com/r/supahgreg/tt-rss/) and [supahgreg/tt-rss-web-nginx](https://hub.docker.com/r/supahgreg/tt-rss-web-nginx/)).
2222
* GitHub Container Registry (as-[ghcr.io/tt-rss/tt-rss](https://github.com/orgs/tt-rss/packages/container/package/tt-rss)
2323
and [ghcr.io/tt-rss/tt-rss-web-nginx](https://github.com/orgs/tt-rss/packages/container/package/tt-rss-web-nginx)).
2424

@@ -245,7 +245,7 @@ Don't forget to remove `/tt-rss/` from `TTRSS_SELF_URL_PATH`.
245245

246246
### How do I apply configuration options?
247247

248-
There are two sets of options you can change through the environment - options specific to tt-rss (those are prefixed with-`TTRSS_`) and options affecting container behavior.
248+
There are two sets of options you can change through the environment: those specific to tt-rss (those are prefixed with-`TTRSS_`) and those affecting container behavior.
249249

250250
#### Options specific to tt-rss
251251

docs/Making-Plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav_order: 1
66
---
77

88
Plugins may render new preference panes or embed themselves into several
9-
existing one, store data using simple key -\> value data or directly in
9+
existing one, store data using simple key/value data or directly in
1010
the database, modify how articles are rendered, alter feed data, and
1111
much more.
1212

docs/Plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ configuration](Global-Config) directive <code>PLUGINS</code> which is a
1616
comma-separated list of enabled system plugins, i.e.
1717

1818
```js
19-
putenv('TTRSS_PLUGINS=auth_internal,-other_plugin');
19+
putenv('TTRSS_PLUGINS=auth_internal, other_plugin');
2020
```
2121

2222
System plugins are always enabled for all users. If multiple search plugins are loaded, only the first one is used

docs/SSL-Certificate-Authentication.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You **must** have a working tt-rss installation with SSL. This guide is not inte
1717

1818
If you have no idea how certificates work (i.e. the terms x509 and PKI make no sense to you), stop now.
1919

20-
This guide includes steps for Nginx. Of course other web servers (e.g.-Apache) support client certificates so you're welcome to use them if you prefer, the steps just aren't included here (but might be added at some point).
20+
This guide includes steps for Nginx. Of course other web servers (e.g. Apache) support client certificates so you're welcome to use them if you prefer, the steps just aren't included here (but might be added at some point).
2121

2222
This guide was written with Debian 9 in mind, other distros will vary.
2323

@@ -28,7 +28,7 @@ Client certificates are typically created/issued by a private Certificate Author
2828
create a root certificate authority and install the **public** certificate for it on
2929
your web server. You then create certificates for each client, signed by the root
3030
certificate authority's private key. Each client is issued their certificate and
31-
private key (often as a single file with a `.p12`-extension).
31+
private key (often as a single file with a `.p12` extension).
3232

3333
Note:
3434

@@ -85,12 +85,12 @@ sudo systemctl restart nginx
8585
Update the tt-rss config file to add `auth_remote` to the `PLUGINS` constant (near the end of the file):
8686

8787
```php
88-
define('PLUGINS', 'auth_internal, auth_remote,-note');
88+
define('PLUGINS', 'auth_internal, auth_remote, note');
8989
```
9090

9191
You might be tempted to remove `auth_internal` but we still need it so don't.
9292

93-
Next, make sure your client certificate (the `.p12`-file) is installed on your
93+
Next, make sure your client certificate (the `.p12` file) is installed on your
9494
computer. Different operating systems and browsers do this differently, so you're
9595
pretty much on your own there. However, if you double-click the .p12 file from the
9696
desktop, the operating system should offer to install it for you.

docs/Search-Syntax.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Search query consists of several keywords. Keyword starting with "-" is consider
1111
* ``@{date}`` - match by date. For example, @yesterday or @2011-11-03. Please note that due to incomplete implementation, special date keywords like yesterday might not match all articles if user timezone is different from tt-rss internal timezone (UTC).
1212
* ``pub:{true,false}`` - match only published or unpublished articles
1313
* ``star:{true, false}`` - same, starred articles
14-
* ``unread:{true, false}`` - self explanatory (requires trunk as of-05.03.2015)
14+
* ``unread:{true, false}`` - self explanatory (requires trunk as of 05.03.2015)
1515
* ``note:{true, false, sometext}`` - same, for articles having an attached note or matching the specified text
1616
* ``label:Somelabel`` - articles that belong to a specified label
1717
* ``tag:mytag`` - articles which have specified tag
@@ -21,4 +21,4 @@ When searching by keyword with spaces, use quotes like this: `"title:string with
2121

2222
If no special keywords are specified, search is done using PostgreSQL [Full Text Search](https://www.postgresql.org/docs/current/textsearch-intro.html) engine.
2323

24-
Pointless as it may be, you can combine negative prefix with the special keywords: -star:true would essentially mean star:false.
24+
Pointless as it may be, you can combine negative prefix with the special keywords: `-star:true` would essentially mean `star:false`.

0 commit comments

Comments
 (0)