Skip to content

Commit

Permalink
Update markdown files with new links/ltex-lsl-plus
Browse files Browse the repository at this point in the history
  • Loading branch information
spitzerd committed Aug 24, 2024
1 parent 4562e1f commit da50753
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 50 deletions.
48 changes: 24 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,28 @@

## Ways of Contribution

Thank you for considering contributing to LT<sub>E</sub>X. There are many ways to do so:
Thank you for considering contributing to LT<sub>E</sub>X+. There are many ways to do so:

- You can [report bugs](#how-to-report-bugs) to help make LT<sub>E</sub>X better.
- You can [request features](#how-to-request-features) to make LT<sub>E</sub>X more powerful.
- You can [contribute code](#how-to-contribute-code) to accelerate the pace of LT<sub>E</sub>X's development.
- You can [report bugs](#how-to-report-bugs) to help make LT<sub>E</sub>X+ better.
- You can [request features](#how-to-request-features) to make LT<sub>E</sub>X+ more powerful.
- You can [contribute code](#how-to-contribute-code) to accelerate the pace of LT<sub>E</sub>X+'s development.
- You can [test pre-release versions](#how-to-test-pre-releases) to help find bugs before they affect thousands of users.
- You can [edit the documentation](#how-to-edit-the-documentation) to make LT<sub>E</sub>X easier to use.
- You can [translate the user interface](#how-to-translate-the-user-interface) into your mother tongue to make LT<sub>E</sub>X more accessible.
- You can [edit the documentation](#how-to-edit-the-documentation) to make LT<sub>E</sub>X+ easier to use.
- You can [translate the user interface](#how-to-translate-the-user-interface) into your mother tongue to make LT<sub>E</sub>X+ more accessible.

If you like LT<sub>E</sub>X, but are not able to contribute in any of these ways, there are still some quick and simple alternatives to show your gratitude:
If you like LT<sub>E</sub>X+, but are not able to contribute in any of these ways, there are still some quick and simple alternatives to show your gratitude:

- You can star the [repository on GitHub](https://github.com/valentjn/ltex-ls).
- You can star the [repository on GitHub](https://github.com/ltex-plus/ltex-ls-plus).
- You can write a positive review of vscode-ltex on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=valentjn.vscode-ltex) or on [Open VSX](https://open-vsx.org/extension/valentjn/vscode-ltex).

## How to Report Bugs

1. Make sure that your issue is really an LT<sub>E</sub>X bug.
1. Make sure that your issue is really an LT<sub>E</sub>X+ bug.
2. Make sure that your issue can neither be found in the list of known issues below nor in the [list of all open and closed GitHub issues](https://github.com/valentjn/ltex-ls/issues?q=is%3Aissue).
3. Create a minimal example document for which the bug occurs. To do so, take your original document, for which the bug occurs, and delete roughly half of it. If the bug does not occur anymore, undo the deletion and delete the other half instead. If the bug occurs, repeat by deleting half of the remaining half etc., until you arrive at a very small document, for which the bug still occurs. This is the minimal example document.
4. Create a minimal example configuration for which the bug occurs. To do so, proceed as for the minimal example document, except that you delete half of your settings.
5. Set the setting `"ltex.trace.server": "verbose"`.
6. [Open an issue on GitHub](https://github.com/valentjn/ltex-ls/issues/new/choose), select the `Bug Report` template, and fill in as much info as you can. This will help us reproduce the issue.
6. [Open an issue on GitHub](https://github.com/ltex-plus/ltex-ls-plus/issues/new/choose), select the `Bug Report` template, and fill in as much info as you can. This will help us reproduce the issue.

**Important:** Please follow the issue template. Issues that don't follow the template or that don't contain the vital information requested in the template (especially minimal example document and settings) may be immediately closed as invalid.

Expand All @@ -42,16 +42,16 @@ If you like LT<sub>E</sub>X, but are not able to contribute in any of these ways

## How to Request Features

1. Make sure that your feature is actually about LT<sub>E</sub>X (not about LanguageTool, for example).
2. Make sure that your feature is not in the [list of all open and closed GitHub issues](https://github.com/valentjn/ltex-ls/issues?q=is%3Aissue).
3. [Open an issue on GitHub](https://github.com/valentjn/ltex-ls/issues/new/choose) and select the `Feature Request` template.
1. Make sure that your feature is actually about LT<sub>E</sub>X+ (not about LanguageTool, for example).
2. Make sure that your feature is not in the [list of all open and closed GitHub issues](https://github.com/ltex-plus/ltex-ls-plus/issues?q=is%3Aissue).
3. [Open an issue on GitHub](https://github.com/ltex-plus/ltex-ls-plus/issues/new/choose) and select the `Feature Request` template.
4. Enter a summary of the feature in the title field and fill out the template in the description field. Fill in as much info as you can. Using actual real-world examples that explain why you and many other users would benefit from the feature increases the request's chances of being implemented.

**Important:** Please follow the issue template. Issues that don't follow the template or that don't contain vital information requested in the template may be immediately closed as invalid.

## How to Set Up the Project

[As explained in the FAQ](https://ltex-plus.github.io/ltex-plus/faq.html#whats-the-difference-between-vscode-ltex-ltex-ls-and-languagetool), LT<sub>E</sub>X consists of two components: [vscode-ltex](https://github.com/valentjn/vscode-ltex) and [ltex-ls](https://github.com/valentjn/ltex-ls). This guide is only about the ltex-ls part. If you want to change vscode-ltex as well, [be sure to read and follow the contribution guidelines of ltex-ls](https://ltex-plus.github.io/ltex-plus/vscode-ltex/contributing.html).
[As explained in the FAQ](https://ltex-plus.github.io/ltex-plus/faq.html#whats-the-difference-between-vscode-ltex-ltex-ls-and-languagetool), LT<sub>E</sub>X+ consists of two components: [vscode-ltex-plus](https://github.com/ltex-plus/vscode-ltex-plus) and [ltex-ls](https://github.com/ltex-plus/ltex-ls-plus). This guide is only about the ltex-ls-plus part. If you want to change vscode-ltex-plus as well, [be sure to read and follow the contribution guidelines of ltex-ls](https://ltex-plus.github.io/ltex-plus/vscode-ltex/contributing.html).

1. Install VS Code, Git, and Apache Maven.
2. Fork ltex-ls on GitHub.
Expand All @@ -71,19 +71,19 @@ If you like LT<sub>E</sub>X, but are not able to contribute in any of these ways

## How to Test Pre-Releases

You can help find bugs before they affect thousands of LT<sub>E</sub>X users by testing pre-releases.
You can help find bugs before they affect thousands of LT<sub>E</sub>X+ users by testing pre-releases.

1. Check whether a pre-release is available on the [releases pages of ltex-ls](https://github.com/valentjn/ltex-ls/releases) (pre-releases, if there are any, are at the top of the page).
1. Check whether a pre-release is available on the [releases pages of ltex-ls](https://github.com/ltex-plus/ltex-ls-plus/releases) (pre-releases, if there are any, are at the top of the page).
2. Download and extract the pre-release.
3. Check if all currently listed changes in the [changelog on the `develop` branch](https://github.com/valentjn/ltex-ls/blob/develop/changelog.xml) work as announced.
3. Check if all currently listed changes in the [changelog on the `develop` branch](https://github.com/ltex-plus/ltex-ls-plus/blob/develop/changelog.xml) work as announced.

The availability of pre-releases varies. Pre-releases are only available if a pre-release tag (a tag with the name of a version number with a dash in it, e.g., `8.0.0-alpha.3`) has been pushed to the repository. Pre-releases are only available for a limited time; they will be deleted once the regular release has been taken place.

Of course, pre-releases are not for productive work, they even may be harmful.

## How to Edit the Documentation

You can improve the [documentation](https://valentjn.github.io/ltex):
You can improve the [documentation](https://ltex-plus.github.io/ltex-plus):

1. Check whether the page you want to edit is listed in the table below.
- If yes, then follow the corresponding link to the source.
Expand All @@ -96,21 +96,21 @@ You can improve the [documentation](https://valentjn.github.io/ltex):

| Page | Sources |
| ---- | ------- |
| [Settings](https://ltex-plus.github.io/ltex-plus/settings.html) | [`package.json`](https://github.com/valentjn/vscode-ltex/blob/develop/package.json), [`package.nls.json`](https://github.com/valentjn/vscode-ltex/blob/develop/package.nls.json) |
| [Code of Conduct](https://ltex-plus.github.io/ltex-plus/code-of-conduct.html) | [`CODE_OF_CONDUCT.md`](https://github.com/valentjn/vscode-ltex/blob/develop/CODE_OF_CONDUCT.md) |
| [ltex-ls → Changelog](https://ltex-plus.github.io/ltex-plus/ltex-ls-plus/changelog.html) | [`ltex-ls/changelog.xml`](https://github.com/valentjn/ltex-ls/blob/develop/changelog.xml) |
| [ltex-ls → Contributing](https://ltex-plus.github.io/ltex-plus/ltex-ls-plus/contributing.html) | [`ltex-ls/CONTRIBUTING.md`](https://github.com/valentjn/ltex-ls/blob/develop/CONTRIBUTING.md) |
| [Settings](https://ltex-plus.github.io/ltex-plus/settings.html) | [`package.json`](https://github.com/ltex-plus/vscode-ltex-plus/blob/develop/package.json), [`package.nls.json`](https://github.com/ltex-plus/vscode-ltex-plus/blob/develop/package.nls.json) |
| [Code of Conduct](https://ltex-plus.github.io/ltex-plus/code-of-conduct.html) | [`CODE_OF_CONDUCT.md`](https://github.com/ltex-plus/vscode-ltex-plus/blob/develop/CODE_OF_CONDUCT.md) |
| [ltex-ls → Changelog](https://ltex-plus.github.io/ltex-plus/ltex-ls-plus/changelog.html) | [`ltex-ls-plus/changelog.xml`](https://github.com/ltex-plus/ltex-ls-plus/blob/develop/changelog.xml) |
| [ltex-ls → Contributing](https://ltex-plus.github.io/ltex-plus/ltex-ls-plus/contributing.html) | [`ltex-ls-plus/CONTRIBUTING.md`](https://github.com/ltex-plus/ltex-ls-plus/blob/develop/CONTRIBUTING.md) |

## How to Translate the User Interface

The user interface of LT<sub>E</sub>X is currently available in the following languages:
The user interface of LT<sub>E</sub>X+ is currently available in the following languages:

- English
- German

You're welcome to help extend this list. To do so, only fluent proficiency (CEFR C1-level) in the target language is required, no programming skills.

1. Duplicate [`src/main/resources/LtexLsMessagesBundle_de.properties`](https://github.com/valentjn/ltex-ls/blob/develop/src/main/resources/LtexLsMessagesBundle_de.properties), replacing `de` with the [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of your language.
1. Duplicate [`src/main/resources/LtexLsMessagesBundle_de.properties`](https://github.com/ltex-plus/ltex-ls-plus/blob/develop/src/main/resources/LtexLsMessagesBundle_de.properties), replacing `de` with the [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of your language.
2. For each of the entries in the duplicated file: Look up the English original of the entry in the corresponding English file, and replace the German translation with the translation into your language.
3. [Use commit messages in the form as mentioned above.](#how-to-contribute-code)
4. Open a pull request with the `develop` branch as the target branch.
Expand Down
4 changes: 2 additions & 2 deletions MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@
- For bug fixes, the patch version is increased.
- For new features, the minor version is increased.
- For breaking changes, the major version is increased.
- *Explanation:* Breaking changes are changes that may require action from users (e.g., most changes of existing LT<sub>E</sub>X settings).
- *Explanation:* Breaking changes are changes that may require action from users (e.g., most changes of existing LT<sub>E</sub>X+ settings).

## Guidelines About Fundamental Changes

- **Fundamental changes** are announced as an issue, in the documentation, and/or as message boxes in VS Code three months before their implementation.
- *Explanation:* Fundamental changes are possibly breaking changes that change the foundation of LT<sub>E</sub>X (e.g., upgrade from Java 8 to Java 11).
- *Explanation:* Fundamental changes are possibly breaking changes that change the foundation of LT<sub>E</sub>X+ (e.g., upgrade from Java 8 to Java 11).
- **Documentation of fundamental changes** and associated deprecated settings may be deleted three months after their implementation.
26 changes: 7 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,17 @@
- file, You can obtain one at https://mozilla.org/MPL/2.0/.
-->

# LT<sub>E</sub>X LS — LT<sub>E</sub>X Language Server
# LT<sub>E</sub>X LS++ — LT<sub>E</sub>X Language Server

[![version number](https://badgen.net/github/release/valentjn/ltex-ls/stable)![release date](https://badgen.net/github/last-commit/valentjn/ltex-ls/release?label=)](https://github.com/valentjn/ltex-ls/releases)
LT<sub>E</sub>X LS+ (LT<sub>E</sub>X Language Server) implements a language server according to the [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) and provides grammar and spelling errors in markup documents (L<sup>A</sup>T<sub>E</sub>X, Markdown, etc.). The documents are checked with [LanguageTool](https://languagetool.org/).

[![vscode-ltex](https://badgen.net/github/license/valentjn/vscode-ltex?label=vscode-ltex)](https://github.com/valentjn/vscode-ltex)&nbsp;
[![CI status](https://github.com/valentjn/vscode-ltex/workflows/CI/badge.svg?branch=release)](https://github.com/valentjn/vscode-ltex/actions?query=workflow%3A%22CI%22+branch%3Arelease)&nbsp;
[![stars](https://badgen.net/github/stars/valentjn/vscode-ltex)](https://github.com/valentjn/vscode-ltex)&nbsp;
[![open issues](https://badgen.net/github/open-issues/valentjn/vscode-ltex?label=open/closed%20issues&color=blue)](https://github.com/valentjn/vscode-ltex/issues)&nbsp;[![closed issues](https://badgen.net/github/closed-issues/valentjn/vscode-ltex?label=)](https://github.com/valentjn/vscode-ltex/issues)\
[![ltex-ls](https://badgen.net/github/license/valentjn/ltex-ls?label=ltex-ls)](https://github.com/valentjn/ltex-ls)&nbsp;
[![CI status](https://github.com/valentjn/ltex-ls/workflows/CI/badge.svg?branch=release)](https://github.com/valentjn/ltex-ls/actions?query=workflow%3A%22CI%22+branch%3Arelease)&nbsp;
[![coverage](https://badgen.net/coveralls/c/github/valentjn/ltex-ls/release)](https://coveralls.io/github/valentjn/ltex-ls)&nbsp;
[![stars](https://badgen.net/github/stars/valentjn/ltex-ls)](https://github.com/valentjn/ltex-ls)&nbsp;
[![open issues](https://badgen.net/github/open-issues/valentjn/ltex-ls?label=open/closed%20issues&color=blue)](https://github.com/valentjn/ltex-ls/issues)&nbsp;[![closed issues](https://badgen.net/github/closed-issues/valentjn/ltex-ls?label=)](https://github.com/valentjn/ltex-ls/issues)
Typically, you start the language server (either locally or remotely), you send the language server your L<sup>A</sup>T<sub>E</sub>X or Markdown document, and it will respond with a list of the grammar and spelling errors in it. To use LT<sub>E</sub>X LS+ in this way, you have to use a language client (usually an editor or an extension of the editor) that communicates with LT<sub>E</sub>X LS+ according to the LSP.

LT<sub>E</sub>X LS (LT<sub>E</sub>X Language Server) implements a language server according to the [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) and provides grammar and spelling errors in markup documents (L<sup>A</sup>T<sub>E</sub>X, Markdown, etc.). The documents are checked with [LanguageTool](https://languagetool.org/).
However, it is also possible to supply LT<sub>E</sub>X LS+ paths to files and directories to be checked as command-line arguments. In this mode, LT<sub>E</sub>X LS+ will print the results to standard output, and no language client is necessary.

Typically, you start the language server (either locally or remotely), you send the language server your L<sup>A</sup>T<sub>E</sub>X or Markdown document, and it will respond with a list of the grammar and spelling errors in it. To use LT<sub>E</sub>X LS in this way, you have to use a language client (usually an editor or an extension of the editor) that communicates with LT<sub>E</sub>X LS according to the LSP.
The reference language client of LT<sub>E</sub>X LS+ is the [LT<sub>E</sub>X extension for Visual Studio Code (vscode-ltex)](https://ltex-plus.github.io/ltex-plus/), whose development LT<sub>E</sub>X LS+ follows closely and vice versa.

However, it is also possible to supply LT<sub>E</sub>X LS paths to files and directories to be checked as command-line arguments. In this mode, LT<sub>E</sub>X LS will print the results to standard output, and no language client is necessary.

The reference language client of LT<sub>E</sub>X LS is the [LT<sub>E</sub>X extension for Visual Studio Code (vscode-ltex)](https://valentjn.github.io/ltex), whose development LT<sub>E</sub>X LS follows closely and vice versa.

Find more information (how to install, how to use, etc.) at the [website of LT<sub>E</sub>X](https://valentjn.github.io/ltex).
Find more information (how to install, how to use, etc.) at the [website of LT<sub>E</sub>X](https://ltex-plus.github.io/ltex-plus/).

## Features

Expand All @@ -42,4 +30,4 @@ Find more information (how to install, how to use, etc.) at the [website of LT<s
- **User dictionaries**
- **Multilingual support** with babel commands or magic comments
- Possibility to use **external LanguageTool servers**
- **[Extensive documentation](https://valentjn.github.io/ltex)**
- **[Extensive documentation](https://ltex-plus.github.io/ltex-plus/)**
10 changes: 5 additions & 5 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@

# Security Policy

For the LT<sub>E</sub>X project, the security of its users is its top priority. This document contains information on which versions are supported with security updates and how to report potential security vulnerabilities.
For the LT<sub>E</sub>X+ project, the security of its users is its top priority. This document contains information on which versions are supported with security updates and how to report potential security vulnerabilities.

## Supported Versions

By default, only the most recent published version of LT<sub>E</sub>X is supported with security updates.
By default, only the most recent published version of LT<sub>E</sub>X+ is supported with security updates.

If deemed relevant by the maintainers (depending on the severity of the security vulnerability and the need to keep older versions for compatibility), older versions of LT<sub>E</sub>X might also get security updates in exceptional circumstances.
If deemed relevant by the maintainers (depending on the severity of the security vulnerability and the need to keep older versions for compatibility), older versions of LT<sub>E</sub>X+ might also get security updates in exceptional circumstances.

## Definition of Vulnerabilities

LT<sub>E</sub>X follows [Microsoft's definition of security vulnerabilities](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)).
LT<sub>E</sub>X+ follows [Microsoft's definition of security vulnerabilities](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)).

In this document, the term &ldquo;vulnerability&rdquo; is synonymous to &ldquo;security vulnerability.&rdquo;

Expand Down Expand Up @@ -57,7 +57,7 @@ You will obtain an update as soon as the next step has been completed, but no la

## Responsible Disclosure Policy

LT<sub>E</sub>X follows the principle of responsible disclosure. This means that security vulnerabilities are disclosed, but only a specific period of time.
LT<sub>E</sub>X+ follows the principle of responsible disclosure. This means that security vulnerabilities are disclosed, but only a specific period of time.

Vulnerabilities are disclosed as soon as a fix has been pushed and released or after 30 days after the initial report, whichever comes first. No information must be disclosed before the embargo ends, neither by the reporter nor by the maintainers.

Expand Down

0 comments on commit da50753

Please sign in to comment.