https://github.com/vspinu/company-math

Completion back-ends for for math unicode symbols and latex tags
https://github.com/vspinu/company-math

Last synced: 30 days ago
JSON representation

Completion back-ends for for math unicode symbols and latex tags

• Host: GitHub
• URL: https://github.com/vspinu/company-math
• Owner: vspinu
• Created: 2014-11-16T07:28:29.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2022-12-27T13:48:02.000Z (about 2 years ago)
• Last Synced: 2024-12-17T01:23:11.629Z (about 1 month ago)
• Language: Emacs Lisp
• Size: 36.1 KB
• Stars: 124
• Watchers: 5
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
This add-on defines three *[company-mode](http://company-mode.github.io/)* backends:

* `company-math-symbols-latex`	- math latex tags (_by default, active only on latex math faces_)

   ![symbols](https://raw.github.com/vspinu/company-math/master/img/latex-symbols.png)

* `company-math-symbols-unicode`	- math unicode symbols and sub(super)scripts (_by default, active everywhere except math faces_)

   ![math](https://raw.github.com/vspinu/company-math/master/img/unicode-symbols.png)

* `company-latex-commands` 		- latex commands 

## Usage ##

Start math completion by typing the prefix `\` key. To select the

completion type RET. Depending on the context and your configuration

unicode symbol or latex tag will be inserted. 

Since version 1.2 sub(super)script completion is available for the

`company-math-symbols-unicode` backend. Subscripts are inserted with either `__`

or `\_` prefixes. Superscripts with `^^` or `\^`. Customize

`company-math-subscript-prefix` and `company-math-superscript-prefix` if you

don't like this default.

## Activation ##

Install from ELPA or MELPA repositories.

You can either register each backend globally:

```elisp

;; global activation of the unicode symbol completion 

(add-to-list 'company-backends 'company-math-symbols-unicode)

```

or locally per emacs mode:

```elisp

;; local configuration for TeX modes

(defun my-latex-mode-setup ()

  (setq-local company-backends

              (append '((company-math-symbols-latex company-latex-commands))

                      company-backends)))

(add-hook 'tex-mode-hook 'my-latex-mode-setup)

 

```

If you are using `AUCTeX` you might need to use `TeX-mode-hook` instead:

```elisp

(add-hook 'TeX-mode-hook 'my-latex-mode-setup)

```

## Further Customization ##

Set `company-tooltip-align-annotations` to t in order to align symbols to the

right as in the snapshots from above.

By default unicode symbols backend (`company-math-symbols-unicode`) is not

active in latex math environments and latex math symbols

(`company-math-symbols-latex`) is not available outside of math latex

environments. You can use the following custom lists of faces to change this

behavior: `company-math-disallow-unicode-symbols-in-faces`,

`company-math-allow-unicode-symbols-in-faces`,

`company-math-disallow-latex-symbols-in-faces`,

`company-math-allow-latex-symbols-in-faces`.