Skip to content

Commit

Permalink
Fix typos in doc site.
Browse files Browse the repository at this point in the history
  • Loading branch information
knadh committed Jun 26, 2022
1 parent 78cb97a commit a1e164b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/documentation/docs/api/entries.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ EOF
| `initial` | `string` | The uppercase first character of the entry. Eg: `A` for Apple. If left empty, it is automatically picked up. |
| `lang` | `string` | Language of the entry as defined in the config. |
| `phones` | `[]string` | Optional phonetic notations representing the pronunciations of the entry. |
| `tokens` | `string` | Postgres fulltext search tokens for the entry (content). If this is left empty and the language config has `tokenizer_type` set as `Postgres`, the tokens are automatically created in the database using `TO_TSVECTOR($TSVectorLanguage, $content)`. For languages without Postgres tokenizers, the TSVectorToken strings should be computed externally and added here. |
| `tokens` | `string` | Postgres fulltext search tokens for the entry (content). If this is left empty and the language config has `tokenizer_type` set as `Postgres`, the tokens are automatically created in the database using `TO_TSVECTOR($tsvector_language, $content)`. For languages without Postgres tokenizers, the [tsvector](https://www.postgresql.org/docs/10/datatype-textsearch.html#DATATYPE-TSVECTOR) token string should be computed externally and provided here. |
| `tags` | `[]string` | Optional tags describing the entry. |
| `notes` | `string` | Optional notes describing the entry. |
| `weight` | `int` | Optional numerical weight to order the entry in the glossary and search results. If left empty, it is automatically computed as the last entry by the initial in ascending order. |
Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/docs/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ English and Italian definitions below them.
| 2 | initial | The uppercase first character of the entry. Eg: `A` for Apple. If left empty, it is automatically picked up. |
| 3 | language | Language of the entry (as defined in the config). |
| 4 | notes | Optional notes describing the entry. |
| 5 | TSVectorLanguage | If the language has a built in Postgres fulltext tokenizer, the name of the tokenizer language. For languages that do not have Postgres tokenizers, this should be empty. |
| 6 | TSVectorTokens | Postgres fulltext search tokens for the entry (Content). If `TSVectorLanguage` is specified, this field can be left empty as the tokens are automatically created in the database using `TO_TSVECTOR($TSVectorLanguage, $Content)`. For languages without Postgres tokenizers, the TSVectorToken strings should be computed externally and added here. |
| 5 | tsvector_language | If the language has a built in Postgres fulltext tokenizer, the name of the tokenizer language. For languages that do not have Postgres tokenizers, this should be empty. |
| 6 | tsVector_tokens | Postgres fulltext search tokens for the entry (Content). If `tsvector_language` is specified, this field can be left empty as the tokens are automatically created in the database using `TO_TSVECTOR($tsvector_language, $content)`. For languages without Postgres tokenizers, the [tsvector](https://www.postgresql.org/docs/10/datatype-textsearch.html#DATATYPE-TSVECTOR) token string should be computed externally and provided here. |
| 7 | tags | Optional tags describing the entry. Separate multiple tags by `\|`. |
| 8 | phones | Optional phonetic notations representing the pronunciations of the entry. Separate multiple phones by `\|`. |
| 9 | definition-types | This should only be set for definition entries that ar marked with `Type = ^`. One or more parts-of-speech types separated by `\|`. Example `noun\|verb`. |
12 changes: 6 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<h1 class="hero">Build dictionaries for any language</h1>
<p class="desc">
dictpress is a free and open source, single binary webserver application for building
and publishing fast, searchable, dictionaries for any language.
and publishing fast, searchable dictionaries for any language.
</p>
<br />
<a href="https://github.com/knadh/dictpress/releases" class="button">Download</a>
Expand All @@ -35,7 +35,7 @@ <h1 class="hero">Build dictionaries for any language</h1>
<div class="container">
<section>
<p>
dictpress allows publishing of dictionary websites and HTTP/JSON APIs for any language. Examples:
Examples dictionaries:
</p>
<ul>
<li><a href="https://alar.ink">Alar</a> &mdash; Kannada-English dictionary.</li>
Expand All @@ -57,14 +57,14 @@ <h3>Admin UI</h3>
<section>
<h2>Features</h2>
<ul>
<li>Supports dictionaries from any language (to any language).</li>
<li>Build dictionaries for any language to any language.</li>
<li>Supports multiple dictionaries and languages in the same database.</li>
<li>Custom themes and templates for publishing dictionary websites.</li>
<li>Paginated A-Z (or any alphabet for any language) glossaries.</li>
<li>Paginated A-Z (all alphabets for any language) glossaries.</li>
<li>HTTP/JSON API for search and everything else.</li>
<li>Pluggable search algorithms, eg: fulltext search, phonetic word search etc.</li>
<li>Admin UI for managing and curating dictionary data.</li>
<li>Moderation UI for crowd sourcing dictionary entries.</li>
<li>Admin moderation UI for crowd sourcing dictionary entries.</li>
<li>Bulk CSV to database import.</li>
</ul>
</section>
Expand Down Expand Up @@ -99,7 +99,7 @@ <h2>How it works</h2>
<h2>Getting started</h2>
<ol>
<li><a href="https://github.com/knadh/dict.press/releases">Download</a> the latest version of DictPress.</li>
<li><a href="docs">Read the docs</a> to see how to import data into DictPress.</li>
<li><a href="docs">Read the docs</a> to install the app and to import dictionary data.</li>
</ol>
</section>
</div>
Expand Down

0 comments on commit a1e164b

Please sign in to comment.