doomemacs/modules/editor/rotate-text/README.org

:editor rotate-text

• Description
  • Maintainers
  • Module flags
  • Packages
  • Hacks
  • Changelog
• Installation
• Usage
• Configuration
• Troubleshooting
• Frequently asked questions
• Appendix

Description   unfold

This module adds text rotation to Doom Emacs. I.e. The ability to cycle through keywords or text patterns at point, like true and false, or public, protected, and private (in c++-mode).

Maintainers

• @hlissner

Become a maintainer?

Module flags

This module has no flags.

Packages

• doom-package:rotate-text

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

TODO Usage

󱌣 This module's usage documentation is incomplete. Complete it?

For evil users: [r and ]r will cycle back and forward (respectively) through specified patterns for the text at point. Patterns will wrap around as you cycle through them.

TODO Configuration

󱌣 This module's configuration documentation is incomplete. Complete it?

To enable a set of items to cycle through globally:

;; in $DOOMDIR/config.el
(after! rotate-text
  (add-to-list 'rotate-text-words '("small" "medium" "large")))

To add a sequence to a specific mode:

;; in $DOOMDIR/config.el
(set-rotate-patterns! 'c++-mode
    :words '(("float" "double")))

When configuring a sequence of words or symbols that should be rotated through, it is important that all items are all lower case. The casing will be determined by the item that initiated the rotation. For example, Small will be replaced with Medium and SMALL will be replaced with MEDIUM using the example described above.

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

Appendix

󱌣 This module has no appendix yet. Write one?