wolray / symbol-overlay

Highlight symbols with keymap-enabled overlays
346 stars 42 forks source link

[Document Improvement Request] How to use `symbol-overlay-mode` and `symbol-overlay-isearch-literally` #62

Open zw963 opened 4 years ago

zw963 commented 4 years ago

As a 8 year long emacs user, i still couldn't figure out what is the usage of following feature.


image image

What is the usage of symbol-overlay-mode? i am not see any different when i enable this minor mode.


image

It just isearch, no any difference?

Thank you.

purcell commented 4 years ago

The readme says "Minor mode for auto-highlighting symbol at point: symbol-overlay-mode". Does that help?

zw963 commented 4 years ago

The readme says "Minor mode for auto-highlighting symbol at point: symbol-overlay-mode". Does that help?

After i run (symbol-overlay-mode), but not see any visual effect, If i do somethings wrong?

purcell commented 4 years ago

If you now place point on a symbol which appears in multiple places in the current file, it should be automatically highlighted.

zw963 commented 4 years ago

If you now place point on a symbol which appears in multiple places in the current file, it should be automatically highlighted.

Oh, thank you, i guess it same as high-symbol.

Isearch symbol at point literally, without regexp-quote the symbol: symbol-overlay-isearch-literally Try symbol-overlay-isearch-literally via "s" to search the not-quoted symbol in isearch-mode.

Could you please explain more on not-quoted symbol, i could not figure out what the different with press "s" or press normal "Ctrl+S" when symbol is highlight.