Legal Notice
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.1 or any later version published by the
Free Software Foundation; with no
"Invariant Sections",
"Front-Cover Texts" or
"Back-Cover Texts",
each as defined in the license.
A copy of the license can be found in the file
COPYING.DOC.txt included with jEdit.
Table of Contents
- 1. Presentation
- 2. Default Options
"Spaces" optionsShow spaces by defaultSpace colorShow leading spaces by defaultShow inner spaces by defaultShow trailing spaces by default"Tabs" optionsShow tabs by defaultTab colorShow leading tabs by defaultShow inner tabs by defaultShow trailing tabs by default"Other whitespaces" optionsShow other whitespaces by defaultDisplay ISO control chars as whitespacesOther whitespace color"Fold guides" optionsShow fold guides by defaultShow fold tooltips by defaultFold guide color"Paragraph separators" optionsShow paragraph separators by defaultParagraph separators respect indentationParagraph separator color"On save" options
When chosen, these actions are performed when a buffer is saved:
Remove trailing whitespaces
All trailing tabs and spaces are removed, except those
preceded by one of the given escape characters.
The default escape character is \ (backslash). E.g.
Some Text\SpaceTabTab
will be replaced by
Some Text\Space
Tabify/untabify according to soft tabs setting
The soft tabs setting determines whether leading
whitespaces should be converted to tabs or spaces.
Tabify leading whitespaces
Leading whitespaces are replaced by a sequence of tabs
possibly followed by at most tabSize - 1 spaces.
The expanded length of leading whitespaces remains
the same.
Untabify leading whitespaces
All tabs are removed from the leading whitespaces and
replaced by an equivalent number of spaces.
The expanded length of leading whitespaces remains
the same.
- 3. Buffer Options
- 4. License
- 5. Feedback
- A. Change log
The main feature of WhiteSpace is to highlight whitespaces.
When highlighted,
- Spaces are represented by a

- Tabs are represented by a

- Other whitespaces are represented by a

Except for the space, the horizontal tabulation and the line feed,
other whitespaces are defined by the
Character.isWhitespace java function, i.e.:
- a Unicode space separator (category "Zs"), but not
a no-break space (\u00a0 or \ufeff).
- a Unicode line separator (category "Zl").
- a Unicode paragraph separator (category "Zp").
- \u000b, vertical tabulation.
- \u000c, form feed.
- \u000d, carriage return.
- \u001c, file separator.
- \u001d, group separator.
- \u001e, record separator.
- \u001f, unit separator.
When the
option is checked, the characters
in the range \u0000 through \u001f
or in the range \u007f through \u009f
are also highlighted.
WhiteSpace has also some other useful features:
- Paragraph separators:
a paragraph separator is displayed whenever two or more empty
lines are encoutered.
- Fold guides
show the different levels of indentations of your code by
displaying vertical grey (default) lines
- Fold tooltips
are displayed when the beginning of a block is not visible and
your mouse cursor is near a fold guide.
- On save actions:
- Remove trailing whitespaces
-
Tabify/untabify leading whitespaces according to soft tabs
settings
- Tabify leading whitespaces
- Untabify leading whitespaces
At last, some jEdit actions are related to spaces and tabs handling:
Chapter 2. Default Options
WhiteSpace default options are available under:
>
>
>
.
- Show spaces by default
- Space color
- Show leading spaces by default
- Show inner spaces by default
- Show trailing spaces by default
- Show tabs by default
- Tab color
- Show leading tabs by default
- Show inner tabs by default
- Show trailing tabs by default
"Other whitespaces" options
- Show other whitespaces by default
- Display ISO control chars as whitespaces
- Other whitespace color
- Show fold guides by default
- Show fold tooltips by default
- Fold guide color
"Paragraph separators" options
- Show paragraph separators by default
- Paragraph separators respect indentation
- Paragraph separator color
When chosen, these actions are performed when a buffer is saved:
- Remove trailing whitespaces
All trailing tabs and spaces are removed, except those
preceded by one of the given escape characters.
The default escape character is \ (backslash). E.g.
will be replaced by
Some Text\ |
- Tabify/untabify according to soft tabs setting
The soft tabs setting determines whether leading
whitespaces should be converted to tabs or spaces.
- Tabify leading whitespaces
Leading whitespaces are replaced by a sequence of tabs
possibly followed by at most tabSize - 1 spaces.
The expanded length of leading whitespaces remains
the same.
- Untabify leading whitespaces
All tabs are removed from the leading whitespaces and
replaced by an equivalent number of spaces.
The expanded length of leading whitespaces remains
the same.
Chapter 3. Buffer Options
The Buffer options are available from the
>
menu.
The following Buffer options enable you to control the highlighting of
spaces, tabs and other whitespaces for a given jEdit buffer.
It's also possible to highlight spaces and tabs depending on their
position (leading/inner/trailing) in the text.
The following Buffer options control the actions to be taken when
a buffer is saved.
Note that the last three actions are mutually exclusive.
Version 0.9.2. Requires JDK 1.3, jEdit 4.2pre1
- Updated for jEdit 4.2 plugin API
Version 0.9.1. Requires JDK 1.2, jEdit 4.0pre4
- Updated for jEdit 4.0 Buffer API
- Updated for jEdit 4.0 Highlighting API
Version 0.9. Requires JDK 1.1, jEdit 3.2.2
- Ant now used as build tool
- DocBook now used for the documentation
-
WhiteSpace options are now Buffer
properties
-
All highlighting options but fold highlighting default to false