Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guide user to enable word-wrap permanently for AsciiDoc #316

Closed
ahus1 opened this issue Aug 8, 2019 · 3 comments
Closed

Guide user to enable word-wrap permanently for AsciiDoc #316

ahus1 opened this issue Aug 8, 2019 · 3 comments

Comments

@ahus1
Copy link
Contributor

ahus1 commented Aug 8, 2019

Situation

A user performs the "activate word wrap" in the tool bar several times. She/he might not know that IntelliJ has a setting to make this permanent.

Options

  1. when the user toggles this multiple times, show a EditorNotification similar to "JavaFX could be enabled" (JavaFxCouldBeEnabledNotificationProvider) or "Preview might be blurry" (JavaFxMightBeBlurredNotificationProvider). The user could directly trigger "activate word wrap". In newer versions of IntelliJ the word wrap can be restricted to specific asciidoc extensions. By default this already contains "adoc", but the action should make sure that "adoc" (and all other AsciiDoc filename suffixes and/or the suffix of the current file) are included

  2. make the "word wrap" permanent within AsciiDoc (?) this would actually provide to places to do the same, this should be avoided AFAIK.

  3. The state could be persisted on a per-file base; to me it is unclear how this would behave if the global setting changes; would that clear all file-specific settings? If we would implement this, we could put it into MyFileEditorState that already preserves some of the state.

Suggestion

Implement Option 1 (please discuss if you think differently)

(this has been created after a user shared his experience in #314)

@rdmueller
Copy link
Member

hm I guess this is the right place to add some counter:

I guess a counter could be implemented as static property?

@ahus1
Copy link
Contributor Author

ahus1 commented Oct 1, 2019

Looks good to me. The property (or a boolean result derived from the counter to show the notification) needs to be exposed. The minimal implementation of a EditorNotification would be a link to the wiki. Everything else is optional and could be implemented later.

@ahus1 ahus1 self-assigned this Feb 2, 2020
@ahus1 ahus1 added this to the 0.30.36 milestone Feb 2, 2020
@ahus1
Copy link
Contributor Author

ahus1 commented Feb 2, 2020

Will be part of next release.

image

@ahus1 ahus1 closed this as completed Feb 2, 2020
ahus1 added a commit that referenced this issue Feb 2, 2020
…when toggling soft wrap in the editor toolbar multiple times (#316)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants