<commit_before>
Thymeleaf Eclipse Plugin
========================

A plugin for the Eclipse IDE to add auto-completion support for the Thymeleaf
standard dialect processors in the Eclipse Web Tools Platform HTML source
editor.

 - Current version: 0.3.0-SNAPSHOT
 - Released: ?? ??? 2013

Note that this plugin is still _very_ beta, so I welcome any feedback and/or bug
reports, either through the Thymeleaf forum (on this thread: http://forum.thymeleaf.org/Thymeleaf-content-assist-plugin-for-Eclipse-td4025498.html),
or as issue reports through the GitHub page.


Minimum Requirements
--------------------

 - Java 6
 - Eclipse Indigo SR2 (3.7.2) w/ Web Tools Platform 3.3.2 (ie: the Java EE
   Developer bundle)


Installation
------------

Download the JAR from the Thymeleaf forum thread (http://forum.thymeleaf.org/Thymeleaf-content-assist-plugin-for-Eclipse-td4025498.html)
and place it in your Eclipse /dropins folder.


Usage
-----

Add the namespace for the Thymeleaf standard dialect to your HTML file, like so:

	<!DOCTYPE html>
	<html xmlns:th="http://www.thymeleaf.org">

You should now start getting content assistance for all of Thymeleaf's standard
processors: suggestions as you type and autocompletion if what you've entered so
far if it matches only one result (both of these can be invoked manually using
CTRL+SPACE), and help text when hovering over the text of a Thymeleaf processor.

Content assist features are only available for dialects whose namespaces (with
the matching prefix) are defined in your HTML files, and for any dialects that
supply help files with their JARs.  (Thymeleaf ones are already bundled with
this plugin.)

If you're developing a Thymeleaf dialect and would like to take advantage of
Eclipse content assist for your own dialect, read the next section.


Adding content assist for your dialect
--------------------------------------

TODO


Changelog
---------

### 0.3.0
 - Moved to become a Thymeleaf Extras project.
 - Added a dialect scanning feature, contributed by [<NAME>](https://github.com/tduchateau),
   so that content assist can extend to dialects other than the standard
   Thymeleaf ones bundled with the plugin.  See the [Adding content assist for
   your dialect](adding-content-assist-for-your-dialect) section to find out how
   dialect developers can take advantage of this plugin.
 - Added showing the basic help/documtation appear when hovering over a
   processor.

### 0.2.0
 - Added Eclipse API baseline support to work towards other versions of Eclipse.
 - Resolved [Issue #1](https://github.com/ultraq/thymeleaf-eclipse-plugin/issues/1)
   so the plugin can now work on Java 6, and Eclipse 3.7.2 w/ WTP 3.3.2.
 - Fixed some spelling mistakes in the standard attribute processor suggestions,
   which would insert misspelled processors into your code!  Whoops!
 - Started work on resolving [Issue #2](https://github.com/ultraq/thymeleaf-eclipse-plugin/issues/1)
   by adding some documentation to many of the standard attribute processors.
   
### 0.1.0
 - Initial release

<commit_msg>Add instructions for adding content assist to custom dialects.<commit_after>
Thymeleaf Eclipse Plugin
========================

A plugin for the Eclipse IDE to add auto-completion support for the Thymeleaf
standard dialect processors in the Eclipse Web Tools Platform HTML source
editor.

 - Current version: 0.3.0-SNAPSHOT
 - Released: ?? ??? 2013

Note that this plugin is still _very_ beta, so I welcome any feedback and/or bug
reports, either through the Thymeleaf forum (on this thread: http://forum.thymeleaf.org/Thymeleaf-content-assist-plugin-for-Eclipse-td4025498.html),
or as issue reports through the GitHub page.


Minimum Requirements
--------------------

 - Java 6
 - Eclipse Indigo SR2 (3.7.2) w/ Web Tools Platform 3.3.2 (ie: the Java EE
   Developer bundle)


Installation
------------

Download the JAR from the Thymeleaf forum thread (http://forum.thymeleaf.org/Thymeleaf-content-assist-plugin-for-Eclipse-td4025498.html)
and place it in your Eclipse /dropins folder.


Usage
-----

Add the namespace for the Thymeleaf standard dialect to your HTML file, like so:

	<!DOCTYPE html>
	<html xmlns:th="http://www.thymeleaf.org">

You should now start getting content assistance for all of Thymeleaf's standard
processors: suggestions as you type and autocompletion of what you've entered so
far if it matches only one result (both of these can be invoked manually using
CTRL+SPACE), and help text when hovering over the text of a Thymeleaf processor.

Content assist features are only available for dialects whose namespaces (with
the matching prefix) are defined in your HTML files, and for any dialects that
supply help files with their JARs.  (Thymeleaf ones are already bundled with
this plugin.)

If you're developing a Thymeleaf dialect and would like to take advantage of
Eclipse content assist for your own dialect, read the next section.


Adding content assist for your dialect
--------------------------------------

The content assist features and help content are driven by XML files containing
information about a dialect.  XML help files for the Thymeleaf Standard dialect
comes bundled with this plugin, and you can see how it's structured by
[taking a look at the XML file itself](https://github.com/thymeleaf/thymeleaf-extras-eclipse-plugin/blob/master/bundles/thymeleaf-extras-eclipse-plugin.content-assist/dialects/Standard-Dialect.xml),
as well as [taking a look at the schema file it conforms to](https://github.com/thymeleaf/thymeleaf-extras-eclipse-plugin/blob/master/bundles/thymeleaf-extras-eclipse-plugin.dialect/schemas/thymeleaf-dialect-help.xsd).

When content assist is invoked, this plugin will look for XML files in the
current project, or in the dependencies of the current project, whose XML
namespace is `http://www.thymeleaf.org/extras/dialect`.  If such a file is found,
it is loaded and the information in it becomes part of the plugin's content
assist.

Dialect developers can take advantage of this by including XML help files as
part of their dialect JARs.  All you need to do is create an XML file that
conforms to the schema above, then bundle that XML file with your JAR.

Some notes on where you put that file:

 - it cannot go in the default package
 - the directory it goes in must be a valid Java package name

These are just short-comings of the current dialect scanning method, which
itself is built upon Eclipse's own lookup mechanisms.

An example of a dialect bundled with an XML file in it's JAR: the [Thymeleaf Layout Dialect](https://github.com/ultraq/thymeleaf-layout-dialect/)
(see the Java/nz/net/ultraq/web/thymeleaf directory).


Changelog
---------

### 0.3.0
 - Moved to become a Thymeleaf Extras project.
 - Added a dialect scanning feature, contributed by [<NAME>](https://github.com/tduchateau),
   so that content assist can extend to dialects other than the standard
   Thymeleaf ones bundled with the plugin.  See the [Adding content assist for
   your dialect](adding-content-assist-for-your-dialect) section to find out how
   dialect developers can take advantage of this plugin.
 - Added showing the basic help/documtation appear when hovering over a
   processor.
 - Added autocomplete/suggestion support for element processors.

### 0.2.0
 - Added Eclipse API baseline support to work towards other versions of Eclipse.
 - Resolved [Issue #1](https://github.com/ultraq/thymeleaf-eclipse-plugin/issues/1)
   so the plugin can now work on Java 6, and Eclipse 3.7.2 w/ WTP 3.3.2.
 - Fixed some spelling mistakes in the standard attribute processor suggestions,
   which would insert misspelled processors into your code!  Whoops!
 - Started work on resolving [Issue #2](https://github.com/ultraq/thymeleaf-eclipse-plugin/issues/1)
   by adding some documentation to many of the standard attribute processors.
   
### 0.1.0
 - Initial release


{'fraction_non_alphanumeric': 0.0901836605446485, 'fraction_numerical': 0.012412919569347688, 'mean_word_length': 3.7767695099818512, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 9, 'lorem ipsum': 0, 'www.': 3, 'xml': 3}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '996632', 'n_tokens_mistral': 2322, 'n_tokens_neox': 2150, 'n_words': 996}