Eclipse Template Editor plugin

From Chunk Java Template Engine

(Difference between revisions)
Jump to: navigation, search
(To Do)
(Installing the plugin)
Line 12: Line 12:
#** "HTML Chunk Template Editor"
#** "HTML Chunk Template Editor"
# Repeat step 5 for *.cxml (and whatever other extensions you wish to use for your templates).
# Repeat step 5 for *.cxml (and whatever other extensions you wish to use for your templates).
-
# (Optional) Add "HTML Chunk Template Editor" to the list of available editors for *.html files.  I make it the default but of course this is up to you.
+
# (Optional) Add "Chunk Template Editor" to the list of available editors for *.html files.  I make it the default but of course this is up to you.
Line 18: Line 18:
Hooray! Syntax highlighting!  Outline view!
Hooray! Syntax highlighting!  Outline view!
-
Bonus: Template references are hyperlinked!  Cmd-click any template reference to jump to that snippet's definition.
+
=== Bonus: Snippet Hyperlinks ===
-
From java code, right-click a template name anywhere in your code and select "Open Snippet" to jump to the definition.
+
Template references are hyperlinked!  Cmd-click any template reference to jump to that snippet's definition.
 +
 
 +
And from within your java code, right-click a template name anywhere in your code and select "Open Snippet" to jump to the definition.
 +
 
 +
=== UTF-8 ===
 +
 
 +
The Chunk template engine, as of 1.5, assumes that your templates use charset UTF-8.  If you use any accented or unusual characters in your templates, I strongly recommend to Eclipse users that you set your workspace default charset to UTF-8.
 +
 
 +
Eclipse -> Preferences -> General -> Workspace -> Text file encoding -> UTF-8

Revision as of 07:55, 11 April 2012

Installing the plugin

  1. Download the plugin jar from google code.
  2. Find your Eclipse installation's "dropins" folder and copy the plugin jar into that folder.
    • On OSX, this is /Applications/eclipse/dropins/
  3. Restart Eclipse.
  4. In Eclipse Preferences, find settings panel for File Associations. Should be in
    • General -> Editors -> File Associations
  5. Click the Add... button and add *.chtml
    • Select *.chtml and click the other "Add..." button down by the "Associated Editors" list below.
    • From the list of "Internal Editors" (make sure "External Programs" is not checked), scroll down and select
      • "HTML Chunk Template Editor"
  6. Repeat step 5 for *.cxml (and whatever other extensions you wish to use for your templates).
  7. (Optional) Add "Chunk Template Editor" to the list of available editors for *.html files. I make it the default but of course this is up to you.


Hooray! Syntax highlighting! Outline view!

Bonus: Snippet Hyperlinks

Template references are hyperlinked! Cmd-click any template reference to jump to that snippet's definition.

And from within your java code, right-click a template name anywhere in your code and select "Open Snippet" to jump to the definition.

UTF-8

The Chunk template engine, as of 1.5, assumes that your templates use charset UTF-8. If you use any accented or unusual characters in your templates, I strongly recommend to Eclipse users that you set your workspace default charset to UTF-8.

Eclipse -> Preferences -> General -> Workspace -> Text file encoding -> UTF-8
Personal tools