Skip to content

Commit

Permalink
Update docs to prepare for 1.3.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
abrookins committed Dec 18, 2015
1 parent 215fa2e commit bb7c78c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 17 deletions.
2 changes: 1 addition & 1 deletion META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<change-notes><![CDATA[
<b>1.3.0</b>
<ul>
<li>Use a "minimum raggedness" algorithm by default. You can disable this in Tools -> Wrap to Column.</li>
<li>New feature: Use an optional "minimum raggedness" algorithm. You can enable this in Tools -> Wrap to Column.</li>
</ul>
<b>1.2.0</b>
Expand Down
37 changes: 21 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
# Wrap to Column: an Intellij Plugin

This plugin wraps selected text or, if no text is selected, the current line
to the column width specified in the editor's "Right Margin (columns)" setting.

As of version 1.0, the plugin respects per-language right column settings (assuming
your version of Intellij-based editor supports that feature).

As of version 1.1.0, the plugin allows you to specify a column width that
overrides the current language setting and global column setting. See the
"Settings" section for more details.
This plugin wraps selected text or, if no text is selected, the current line to
the column width specified in the editor's "Right Margin (columns)" setting.

This is a replacement for the Fill Paragraph command, which doesn't work for me.

Expand All @@ -19,9 +12,10 @@ You can install this plugin directly from an Intellij editor (like Intellij
Ultimate, PyCharm, etc.) inside the Preferences -> Plugins -> Browse
repositories... window.

To install the latest zip from GitHub, clone the repository, open your Intellij
editor of choice, go to the Preferences window -> Plugins -> Install plugin
from disk, then choose the WrapToColumn.zip file located in the source repo.
To install the plugin from GitHub, download the latest release from
https://github.com/abrookins/WrapToColumn/releases, unzip it, open your Intellij
editor of choice, go to the Preferences window -> Plugins -> Install plugin from
disk, then choose the WrapToColumn.jar file that you unzipped.


## Keyboard shortcut
Expand All @@ -42,6 +36,16 @@ This setting exists in Settings (Preferences on OS X) -> Tools -> Wrap to Column

The setting is named "Column width override" and accepts an integer value.

### Minimum raggedness

By default, text is wrapped using a greedy line-breaking algorithm. This can
result in some lines having more whitespace than others.

You can turn on an alternative "minimum raggedness" algorithm in Settings ->
Tools -> Wrap to Column. When this setting is on, the plugin will reconfigure
text in a paragraph to produce the least amount of whitespace possible. Try it
and see if you like it!


### Tab width

Expand All @@ -54,7 +58,8 @@ to your co-maintainer whose tab width is 8. This seems to be the best trade-off.

## Menu item

A menu item should exist for the plugin in the Edit drop-down menu: Edit -> Wrap to Column
A menu item for the plugin exists in the Edit drop-down menu: Edit -> Wrap to
Column


## A note about monospaced versus variable width fonts
Expand All @@ -72,10 +77,10 @@ position won't match Intellij's right margin guide.
Annnyway, I recommend that you use a monospaced font if you can.


## Roadmap
* Bug fixes
## Roadmap Bug fixes


## License

This plugin is licensed under the GPLv2 and Apache License 2.0 (I hear they're incompatible, but IANAL). See COPYING.txt and LICENSE.txt.
This plugin is licensed under the GPLv2 and Apache License 2.0 (I hear they're
incompatible, but I'm not a lawyer). See COPYING.txt and LICENSE.txt.

0 comments on commit bb7c78c

Please sign in to comment.