sqrtminusone/reverso.el
1
0
Fork 0
mirror of https://github.com/SqrtMinusOne/reverso.el.git synced 2025-12-10 15:53:02 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: fix english once again

Browse source
This commit is contained in:
Pavel Korytov 2022-10-18 12:47:49 +03:00
parent cf1e589bfc
commit 0218de08a7
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.org
View file

@ -17,14 +17,14 @@ The package isn't yet available anywhere but in this repository. My preferred wa
Or clone the repository, and it to =load-path= and =require= the package.
* Usage
There's a single entrypoint for all implemented functions, =M-x reverso=. The entirety of the UI is made with the excellent [[https://github.com/magit/transient/][transient.el]].
There's a single entrypoint for all implemented functions, =M-x reverso=. The UI is made with the excellent [[https://github.com/magit/transient/][transient.el]].
** Input handling
All the commands handle the input the following way.
By default, the input string is empty. If the command was launched with a region selected, use the string of that region. If launched with the prefix argument (=C-u=), use the entire buffer.
By default, the input string is empty. If the command is launched with a region selected, use the string of that region. If launched with the prefix argument (=C-u=), use the entire buffer.
The results of these commands are displayed in =reverso-result-mode= buffers. If launched in that buffer, the command uses the input string for the buffer. If launched with =C-u=, it uses the output string of that buffer (if available).
Results are displayed in =reverso-result-mode= buffers. If launched in that buffer, the command uses the input string for the buffer. If launched with =C-u=, it uses the output string of that buffer (if available).
** Translation
Run =M-x reverso t= or =M-x reverso-translate= to invoke the translation transient.
@ -37,7 +37,7 @@ If "Brief translation output" is on, the output buffer will only show the transl
[[./img/translation-res.png]]
Otherwise, the buffer result can include the following sections:
Otherwise, the result buffer can include the following sections:
- *Source text* and *Translation*
- *Corrected text*, if available
- *Context results*, if available
@ -49,7 +49,7 @@ Run =M-x reverso c= or =M-x reverso-context= to invoke context search (or [[http
The input/output UI looks almost the same as in the translation command.
Strange enough though, the direct context search usually yields different results than the "Context results" section of the translation command, so you may want to check out both if you want more data.
Strange enough though, direct context search usually yields different results than the "Context results" section of the translation command, so you may want to check out both if you want more data.
** Synonyms
Run =M-x reverso s= or =M-x reverso-synonyms= to invoke the synonyms search.
@ -58,9 +58,9 @@ Run =M-x reverso s= or =M-x reverso-synonyms= to invoke the synonyms search.
[[./img/synonyms-res.png]]
The results may be split into sections by parts of speech if that is necessary.
If necessary, the results may be split into sections by parts of speech.
The section for each part of speech includes up to three sections:
A section for each part of speech includes up to three subsections:
- Synonyms
- Examples
- Antonyms
@ -92,7 +92,7 @@ Second, the service usually freaks out with special syntax, for instance, Org Mo
The third partly follows from the second, because the service usually finds errors in hidden parts of Org links. That is a problem because a completely hidden overlay may be somewhat hard to access. So either skip these errors or run =M-x org-toggle-link-display= in Org files beforehand.
Finally (and this concerns all other methods as well), the API usually limits the size of the input. So if the service returns an error, try running the check on a smaller region of the buffer.
Finally (and this concerns all other methods as well), the API usually limits the input size. So if the service returns an error, try running the command on a smaller region of the buffer.
[[./img/grammar-buffer-res.png]]
@ -142,7 +142,7 @@ In case you want to do something in Emacs Lisp, there are 4 main functions that
- =reverso--get-grammar=
- =reverso--get-context=
Take a look at docstrings for the output format description.
Take a look at the docstrings for more information.
Every function is asynchronous, and the results are returned via a callback.
@ -155,7 +155,7 @@ The [[https://github.com/emacs-grammarly][emacs-grammarly]] series of packages p
Moreover, Grammarly is less bothered by Org and Markdown syntax, although it still doesn't like inline code blocks. Grammarly generally seems to be better at grammar-checking than Reverso, especially when it comes to rephrasing wordy sentences and punctiation. However, Grammarly also gives more false positives.
Another notable grammar-checking solution is [[https://languagetool.org/][LanguageTool]], which you can [[https://dev.languagetool.org/http-server][run offline]] and use with [[https://github.com/mhayashi1120/Emacs-langtool][Emacs package]]. This one has the obvious advantage of having no limits on usage and not sending your data to a 3rd party server you can't control. But it still doesn't like markup syntaxes.
Another notable grammar-checking solution is [[https://languagetool.org/][LanguageTool]], which you can [[https://dev.languagetool.org/http-server][run offline]] and use with its [[https://github.com/mhayashi1120/Emacs-langtool][Emacs package]]. This one has the obvious advantage of having no limits on usage and not sending your data to a 3rd party server you can't control. But it still doesn't like markup syntaxes.
[[https://github.com/valentjn/ltex-ls][LTeX LS]] is a LanguageTool-based language server, designed specifically to work with markup files like Org, Markdown, LaTeX, and a bunch of others.